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.4.1: 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 Version
147 (s.a. Liste der unterstützten Betriebssysteme) benötigt.</para>
149 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht
150 Bestandteil einer Standard-Perl-Installation sind. Um zu überprüfen,
151 ob die erforderlichen Pakete installiert und aktuell genug sind, wird
152 ein Script mitgeliefert, das wie folgt aufgerufen wird:</para>
154 <programlisting>./scripts/installation_check.pl</programlisting>
156 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
160 <para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para>
164 <para><literal>Archive::Zip</literal></para>
168 <para><literal>Algorithm::CheckDigits</literal></para>
172 <para><literal>CGI</literal></para>
176 <para><literal>Clone</literal></para>
180 <para><literal>Config::Std</literal></para>
184 <para><literal>DateTime</literal></para>
188 <para><literal>DateTime::Format::Strptime</literal></para>
192 <para><literal>DBI</literal></para>
196 <para><literal>DBD::Pg</literal></para>
200 <para><literal>Email::Address</literal></para>
204 <para><literal>Email::MIME</literal></para>
208 <para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71
209 inklusive; siehe <xref
210 linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para>
214 <para><literal>File::Copy::Recursive</literal></para>
218 <para><literal>GD</literal></para>
222 <para><literal>HTML::Parser</literal></para>
226 <para><literal>HTML::Restrict</literal></para>
230 <para><literal>Image::Info</literal></para>
234 <para><literal>JSON</literal></para>
238 <para><literal>List::MoreUtils</literal></para>
242 <para><literal>List::UtilsBy</literal></para>
246 <para><literal>Net::SMTP::SSL</literal> (optional, bei
247 E-Mail-Versand über SSL; siehe Abschnitt "<xref
248 linkend="config.sending-email.smtp"/>")</para>
252 <para><literal>Net::SSLGlue</literal> (optional, bei
253 E-Mail-Versand über TLS; siehe Abschnitt "<xref
254 linkend="config.sending-email.smtp"/>")</para>
258 <para><literal>Params::Validate</literal></para>
262 <para><literal>PBKDF2::Tiny</literal></para>
266 <para><literal>PDF::API2</literal></para>
270 <para><literal>Rose::Object</literal></para>
274 <para><literal>Rose::DB</literal></para>
278 <para><literal>Rose::DB::Object</literal> Version 0.788 oder
283 <para><literal>String::ShellQuote</literal></para>
287 <para><literal>Sort::Naturally</literal></para>
291 <para><literal>Template</literal></para>
295 <para><literal>Text::CSV_XS</literal></para>
299 <para><literal>Text::Iconv</literal></para>
303 <para><literal>URI</literal></para>
307 <para><literal>XML::Writer</literal></para>
311 <para><literal>YAML</literal></para>
315 <para>Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen:
316 <literal>Algorithm::CheckDigits</literal><literal>PBKDF2::Tiny</literal></para>
318 <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen:
319 <literal>GD</literal>, <literal>HTML::Restrict</literal>,
320 <literal>Image::Info</literal></para>
322 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen:
323 <literal>File::Copy::Recursive</literal>.</para>
325 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen:
326 <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
327 <literal>Net::SSLGlue</literal>.</para>
329 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
330 hinzugekommen, <literal>URI</literal> und
331 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
334 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
335 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
336 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
337 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
339 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
340 hinzugekommen.</para>
342 <para><literal>Email::Address</literal> und
343 <literal>List::MoreUtils</literal> sind schon länger feste
344 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
345 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
346 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
347 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
351 <title>Debian und Ubuntu</title>
353 <para>Für Debian und Ubuntu stehen die meisten der benötigten
354 Perl-Pakete als Debian-Pakete zur Verfügung. Sie können mit
355 folgendem Befehl installiert werden:</para>
357 <programlisting>apt-get install apache2 libarchive-zip-perl libclone-perl \
358 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
359 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
360 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
361 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
362 librose-db-perl librose-object-perl libsort-naturally-perl \
363 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
364 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
365 libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \
366 libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \
367 libcrypt-pbkdf2-perl git
370 <para>Für das Paket HTML::Restrict gibt es kein Debian-Paket, dies
371 muß per CPAN installiert werden. Unter Ubuntu funktioniert das
374 <programlisting>apt-get install build-essential
375 cpan HTML::Restrict</programlisting>
379 <title>Fedora</title>
381 <para>Für Fedora stehen die meisten der benötigten Perl-Pakete als
382 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
383 installiert werden:</para>
385 <programlisting>dnf install httpd mod_fcgid perl-Archive-Zip perl-Clone perl-DBD-Pg \
386 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
387 perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
388 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
389 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
390 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
391 perl-XML-Writer perl-YAML perl-parent postgresql-server perl-CPAN \
392 perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor perl-Text-Balanced</programlisting>
394 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
395 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
397 <programlisting>cpan Config::Std HTML::Restrict</programlisting>
401 <title>openSUSE</title>
403 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als
404 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
405 installiert werden:</para>
407 <programlisting>zypper install apache2 apache2-mod_fcgid perl-Archive-Zip perl-Clone \
408 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
409 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
410 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
411 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
412 perl-URI perl-XML-Writer perl-YAML perl-CPAN \
413 perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor postgresql-server</programlisting>
415 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
416 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
418 <programlisting>cpan Rose::Db::Object</programlisting>
423 <sect1 id="Manuelle-Installation-des-Programmpaketes"
424 xreflabel="Manuelle Installation des Programmpaketes">
425 <title>Manuelle Installation des Programmpaketes</title>
427 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github
428 gehostet und kann <ulink
429 url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
430 heruntergeladen werden.</para>
432 <para>Die kivitendo ERP Installationsdatei
433 (<filename>kivitendo-erp-3.4.1.tgz</filename>) wird im
434 Dokumentenverzeichnis des Webservers (z.B.
435 <filename>/var/www/html/</filename>,
436 <filename>/srv/www/htdocs</filename> oder
437 <filename>/var/www/</filename>) entpackt:</para>
439 <programlisting>cd /var/www
440 tar xvzf kivitendo-erp-3.4.1.tgz</programlisting>
442 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
444 <programlisting>cd kivitendo-erp</programlisting>
446 <para>Alternativ können Sie auch einen Alias in der
447 Webserverkonfiguration benutzen, um auf das tatsächliche
448 Installationsverzeichnis zu verweisen.</para>
450 <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
451 WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
453 <programlisting>mkdir webdav</programlisting>
455 <para>Die Verzeichnisse <filename>users</filename>,
456 <filename>spool</filename> und <filename>webdav</filename> müssen für
457 den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
458 restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer-
459 und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich
460 (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
461 <constant>apache</constant> oder bei OpenSUSE
462 <constant>wwwrun</constant>).</para>
464 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
465 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
467 <programlisting>chown -R www-data users spool webdav</programlisting>
469 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen
470 <filename>templates</filename> und <filename>users</filename>
471 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in
472 kivitendo angelegt wird:</para>
474 <programlisting>chown www-data templates users</programlisting>
477 <para>Wir empfehlen eine Installation mittels des Versionsmanagager
478 git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr
479 viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte
480 die Pfade anpassen) bspw. wie folgt: <programlisting>cd /usr/local/src/
481 git clone https://github.com/kivitendo/kivitendo-erp.git
483 git checkout `git tag -l | egrep -ve "(beta|rc)" | tail -1`</programlisting>
484 Sehr sinnvoll ist es, direkt im Anschluss einen eigenen Branch zu
485 erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen damit zu
486 verwalten. Hierfür reicht ein simples <programlisting> git checkout -b meine_eigenen_änderungen</programlisting>
487 nach dem letzten Kommando (weiterführende Informationen <ulink
488 url="http://git-scm.com/book/en/v2/Getting-Started-Git-Basics">getting
489 started with git</ulink>).</para>
493 <sect1 id="config.config-file">
494 <title>kivitendo-Konfigurationsdatei</title>
496 <sect2 id="config.config-file.introduction"
497 xreflabel="Einführung in die Konfigurationsdatei">
498 <title>Einführung</title>
500 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
501 benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die
502 Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von
503 kivitendo bzw. der Migration von älteren Versionen angelegt
506 <para>Als Vorlage dient die Datei
507 <filename>config/kivitendo.conf.default</filename> (kurz: "die
508 Default-Datei"):</para>
510 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
512 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
513 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
514 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
515 Abschnitte und Werte enthalten, die von denen der Default-Datei
519 <para>Vor der Umbenennung in kivitendo hieß diese Datei noch
520 <filename>config/lx_office.conf</filename>. Aus Gründen der
521 Kompatibilität wird diese Datei eingelesen, sofern die Datei
522 <filename>config/kivitendo.conf</filename> nicht existiert.</para>
525 <para>Diese Hauptkonfigurationsdatei ist dann eine
526 installationsspezifische Datei, d.h. sie enthält bspw. lokale
527 Passwörter und wird auch nicht im Versionsmanagement (git)
530 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
531 Mandaten, bzw. Datenbanken gleich.</para>
534 <sect2 id="config.config-file.sections-parameters">
535 <title>Abschnitte und Parameter</title>
537 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
538 entsprechend kommentiert sind:</para>
542 <para><literal>authentication</literal> (siehe Abschnitt "<xref
543 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
544 in diesem Kapitel)</para>
548 <para><literal>authentication/database</literal></para>
552 <para><literal>authentication/ldap</literal></para>
556 <para><literal>system</literal></para>
560 <para><literal>paths</literal></para>
564 <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
565 linkend="config.sending-email.smtp"/>)</para>
569 <para><literal>applications</literal></para>
573 <para><literal>environment</literal></para>
577 <para><literal>print_templates</literal></para>
581 <para><literal>task_server</literal></para>
585 <para><literal>periodic_invoices</literal></para>
589 <para><literal>self_tests</literal></para>
593 <para><literal>console</literal></para>
597 <para><literal>testing</literal></para>
601 <para><literal>testing/database</literal></para>
605 <para><literal>debug</literal></para>
609 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
610 einzustellen oder zu kontrollieren sind, sind:</para>
612 <programlisting>[authentication]
613 admin_password = geheim
615 [authentication/database]
623 default_manager = german</programlisting>
625 <para>Für kivitendo Installationen in der Schweiz sollte hier <varname>german</varname>
626 durch <varname>swiss</varname> ersetzt werden.</para>
627 <para>Die Einstellung <varname>default_manager = swiss</varname> bewirkt:</para>
630 <para>Beim Erstellen einer neuen Datenbank in der kivitendo Administration
631 werden automatisch die Standard-Werte für die Schweiz voreingestellt:
632 Währung CHF, 5er-Rundung, Schweizer KMU-Kontenplan, Sollversteuerung,
633 Aufwandsmethode, Bilanzierung (die Werte können aber manuell angepasst werden).</para>
636 <para>Einstellen der Standardkonten für Rundungserträge und -aufwendungen
637 (unter Mandantenkonfiguration → Standardkonten veränderbar)</para>
640 <para>das verwendete Zahlenformat wird auf <varname>1'000.00</varname> eingestellt
641 (unter Programm → Benutzereinstellungen veränderbar)</para>
644 <para>DATEV-Automatik und UStVA werden nicht angezeigt, Erfolgsrechnung
645 ersetzt GUV ( unter Mandantenkonfiguration → Features veränderbar)</para>
649 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
650 <varname>[periodic_invoices]</varname> den Login eines Benutzers
651 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
652 mit Informationen über die erstellten Rechnungen bekommt.</para>
654 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
655 Ausführung bestimmter Aufgaben mit, den <link
656 linkend="config.task-server">Taskserver</link>. Er wird u.a. für
657 Features wie die <link
658 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
659 benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
660 daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
661 <link linkend="config.task-server">Task-Server</link> genauer
664 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
665 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
668 <sect2 id="config.config-file.prior-versions">
669 <title>Versionen vor 2.6.3</title>
671 <para>In älteren kivitendo Versionen gab es im Verzeichnis
672 <filename>config</filename> die Dateien
673 <filename>authentication.pl</filename> und
674 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
675 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
676 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
677 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
679 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
680 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
681 manuell übertragen und die alten Konfigurationsdateien anschließend
682 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
683 entsprechende Fehlermeldung an.</para>
687 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
688 <title>Anpassung der PostgreSQL-Konfiguration</title>
690 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
692 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
693 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
695 <para>kivitendo setzt zwingend voraus, dass die Datenbank
696 Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
697 Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
699 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
700 Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
701 man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
703 <programlisting>su postgres
705 exit </programlisting>
707 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
708 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
709 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
712 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
714 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
715 Versionsnummer angepasst werden.</para>
717 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
719 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
720 <literal>\l</literal> geprüft werden.</para>
723 <sect2 id="Änderungen-an-Konfigurationsdateien">
724 <title>Änderungen an Konfigurationsdateien</title>
726 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
727 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
728 <filename>/var/lib/pgsql/data/</filename> oder
729 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
730 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
731 Parameter <varname>listen_address</varname> gesteuert. Laufen
732 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
733 <literal>localhost</literal> verwendet werden. Andernfalls müssen
734 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
735 was mit dem Wert <literal>*</literal> geschieht.</para>
737 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
738 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
739 sein sollte, müssen die Berechtigungen für den Zugriff geändert
740 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
741 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
742 Datenbank zum Beispiel:</para>
744 <programlisting>local all kivitendo password
745 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
748 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
749 <title>Erweiterung für servergespeicherte Prozeduren</title>
751 <para>In der Datenbank <literal>template1</literal> muss die
752 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
753 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
754 <programlisting>su - postgres
755 psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
757 <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
761 <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
762 bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
763 anzulegen. In diesen Versionen ist die Extension meist auch schon
764 vorhanden. Sollten Sie eine ältere Version von Postgres haben,
765 benutzen Sie stattdessen den folgenden Befehl.</para>
767 <programlisting>CREATE LANGUAGE 'plpgsql';
772 <sect2 id="Datenbankbenutzer-anlegen">
773 <title>Datenbankbenutzer anlegen</title>
775 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
776 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
777 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
780 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
781 nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
782 generieren nicht nötig.</para>
784 <programlisting>su - postgres
785 createuser -d -P kivitendo
786 exit</programlisting>
788 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
789 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
790 bzw. den hier gewählten Benutzernamen.</para>
794 <sect1 id="Apache-Konfiguration">
795 <title>Webserver-Konfiguration</title>
798 <title>Grundkonfiguration mittels CGI</title>
801 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
802 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
803 <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
806 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
807 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
808 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
809 anderen Datei hinzu, die beim Starten des Webservers eingelesen
812 <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
813 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
815 <Directory /var/www/kivitendo-erp>
816 AddHandler cgi-script .pl
817 Options ExecCGI Includes FollowSymlinks
820 <Directory /var/www/kivitendo-erp/users>
823 </Directory></programlisting>
825 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
826 das kivitendo-Archiv entpacket haben.</para>
829 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
830 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
832 <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
833 noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
834 aktiviert werden.</para>
837 <para>Auf einigen Webservern werden manchmal die Grafiken und
838 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
839 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
841 <programlisting>EnableSendfile Off</programlisting>
844 <sect2 id="Apache-Konfiguration.FCGI"
845 xreflabel="Konfiguration für FastCGI/FCGI">
846 <title>Konfiguration für FastCGI/FCGI</title>
848 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
849 <title>Was ist FastCGI?</title>
851 <para>Direkt aus <ulink
852 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
855 <para><citation> FastCGI ist ein Standard für die Einbindung
856 externer Software zur Generierung dynamischer Webseiten in einem
857 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
858 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
859 umgehen. </citation></para>
862 <sect3 id="Apache-Konfiguration.FCGI.Warum">
863 <title>Warum FastCGI?</title>
865 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
866 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
867 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
868 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
869 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
870 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
871 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
872 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
873 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
874 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
875 deutlich länger dauert als früher, und dass davon 90% für das Laden
876 der Module verwendet wird.</para>
878 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
879 wird nur die eigentliche Programmlogik ausgeführt.</para>
882 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
883 <title>Getestete Kombinationen aus Webservern und Plugin</title>
885 <para>Folgende Kombinationen sind getestet:</para>
889 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
893 <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
897 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
901 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
902 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
903 mod_fastcgi nicht mehr explizit eingegangen.</para>
905 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
909 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
910 strict in der Behandlung von Unicode, und verweigern bestimmte
911 Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
912 Installation gibt, muss zwingend Version 0.68 oder aber Version
913 0.72 und neuer eingesetzt werden.</para>
915 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
916 sich die Vorgängerversion wie folgt installieren:</para>
918 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
922 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
923 <title>Konfiguration des Webservers</title>
925 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
926 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
927 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
928 debuggen die beim ersten aufsetzen auftreten können. Sollte die
929 Installation schon funktionieren, lesen Sie weiter.</para>
931 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
932 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
934 <programlisting>a2enmod fcgid</programlisting>
936 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
937 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
938 und <function>Directory</function>-Direktiven. Dabei wird zwischen
939 dem Installationspfad von kivitendo im Dateisystem
940 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
941 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
942 ("<filename>/url/for/kivitendo-erp</filename>").</para>
944 <para>Folgender Konfigurationsschnipsel funktioniert mit
947 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
948 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
950 <Directory /path/to/kivitendo-erp>
952 Options ExecCGI Includes FollowSymlinks
956 <DirectoryMatch /path/to/kivitendo-erp/users>
958 </DirectoryMatch></programlisting>
961 <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
962 muss entsprechend die Syntax der Directorydirektiven verändert.
965 <programlisting>Require all granted</programlisting>
967 <para>muß man Folgendes einstellen:</para>
971 Allow from All </programlisting>
973 <para>und statt</para>
975 <programlisting>Require all denied</programlisting>
977 <para>muss stehen:</para>
981 Deny from All </programlisting>
985 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
986 die maximale Größe eines Requests. Diese sollte wie folgt
987 hochgesetzt werden:</para>
989 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
991 <para>Das Ganze sollte dann so aussehen:</para>
993 <programlisting>AddHandler fcgid-script .fpl
994 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
995 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
996 FcgidMaxRequestLen 10485760
998 <Directory /path/to/kivitendo-erp>
1000 Options ExecCGI Includes FollowSymlinks
1005 <DirectoryMatch /path/to/kivitendo-erp/users>
1008 </DirectoryMatch></programlisting>
1010 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
1011 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
1012 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
1013 gibt es hier kleine Performance-Einbußen.</para>
1015 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
1016 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
1017 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
1019 <programlisting># Zugriff über CGI
1020 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
1022 # Zugriff mit mod_fcgid:
1023 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1024 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
1026 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
1027 die normale Version erreichbar, und unter
1028 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
1029 FastCGI-Version.</para>
1034 <title>Weitergehende Konfiguration</title>
1036 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
1037 von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1038 weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1039 Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1040 Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1041 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1042 (Stand Sept. 2015)</ulink></para>
1046 <sect1 id="config.task-server">
1047 <title>Der Task-Server</title>
1049 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1050 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1051 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1052 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1053 essenzielle Aufgaben benutzt.</para>
1055 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1056 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1057 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1059 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1060 Servers integriert werden muss, damit er automatisch gestartet wird.
1061 Dies kann kivitendo nicht für Sie erledigen.</para>
1063 <sect2 id="Konfiguration-des-Task-Servers">
1064 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1066 <para>Die Konfiguration erfolgt über den Abschnitt
1067 <literal>[task_server]</literal> in der Datei
1068 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1069 Optionen sind:</para>
1073 <term><varname>run_as</varname></term>
1076 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1077 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1078 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1079 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1081 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1082 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1083 unter dem auch der Webserver läuft.</para>
1088 <term><varname>debug</varname></term>
1091 <para>Schaltet Debug-Informationen an und aus.</para>
1097 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1098 <title>Konfiguration der Mandanten für den Task-Server</title>
1100 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1101 anschließend jeder Mandant, für den der Task-Server laufen soll,
1102 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1103 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1104 ausgewählt werden, unter der der Task-Server seine Arbeit
1107 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1108 wird der Task-Server für diesen Mandanten keine Aufgaben
1112 <sect2 id="Einbinden-in-den-Boot-Prozess">
1113 <title>Automatisches Starten des Task-Servers beim Booten</title>
1115 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1116 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1117 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1119 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1120 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1121 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1122 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1123 anstelle eines symbolischen Links verwendet werden können.</para>
1126 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE,
1127 ältere Fedora)</title>
1129 <para>Kopieren Sie die Datei
1130 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1131 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1132 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1133 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1134 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1138 <para>Debian-basierende Systeme:</para>
1140 <programlisting>update-rc.d kivitendo-task-server defaults
1141 # Nur bei Debian Squeeze und neuer:
1142 insserv kivitendo-task-server</programlisting>
1146 <para>Ältere OpenSUSE und ältere Fedora:</para>
1148 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1152 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1155 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1159 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1161 <para>Kopieren Sie die Datei
1162 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1163 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1164 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1165 <literal>exec ....</literal>).</para>
1167 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1170 <programlisting>service kivitendo-task-server start</programlisting>
1174 <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1175 Fedora, neuere Ubuntu und Debians)</title>
1177 <para>Kopieren Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
1178 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeilen
1179 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>).</para>
1181 <para>Machen Sie anschließend das Script systemd bekannt, und binden Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden
1184 <programlisting>systemctl daemon-reload
1185 systemctl enable kivitendo-task-server.service</programlisting>
1187 <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt den Server neu zu starten, so können Sie das mit dem
1188 folgenden Befehl tun:</para>
1190 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1194 <sect2 id="Prozesskontrolle">
1195 <title>Wie der Task-Server gestartet und beendet wird</title>
1197 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1199 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1201 <para><literal>Befehl</literal> ist dabei eine der folgenden
1206 <para><literal>start</literal> startet eine neue Instanz des
1207 Task-Servers. Die Prozess-ID wird innerhalb des
1208 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1212 <para><literal>stop</literal> beendet einen laufenden
1217 <para><literal>restart</literal> beendet und startet ihn
1222 <para><literal>status</literal> berichtet, ob der Task-Server
1227 <para>Der Task-Server wechselt beim Starten automatisch in das
1228 kivitendo-Installationsverzeichnis.</para>
1230 <para>Dieselben Optionen können auch für die SystemV-basierenden
1231 Runlevel-Scripte benutzt werden (siehe oben).</para>
1235 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1236 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1238 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1239 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1241 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1242 <title>Grundlagen zur Benutzerauthentifizierung</title>
1244 <para>kivitendo verwaltet die Benutzerinformationen in einer
1245 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1246 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1247 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1248 können, müssen aber nicht unterschiedlich sein.</para>
1250 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1251 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1252 abgelegt werden.</para>
1254 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
1255 entweder gegen die Authentifizierungsdatenbank oder gegen einen
1256 LDAP-Server überprüft werden.</para>
1258 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1259 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1260 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1261 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1262 einer Version vor v2.6.0 angelegt werden. Eine
1263 Beispielkonfigurationsdatei
1264 <filename>config/kivitendo.conf.default</filename> existiert, die als
1265 Vorlage benutzt werden kann.</para>
1268 <sect2 id="Administratorpasswort">
1269 <title>Administratorpasswort</title>
1271 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1272 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1273 gespeichert. Es kann auch nur dort und nicht mehr im
1274 Administrationsinterface selber geändert werden. Der Parameter dazu
1275 heißt <varname>admin_password</varname> im Abschnitt
1276 <varname>[authentication]</varname>.</para>
1279 <sect2 id="Authentifizierungsdatenbank">
1280 <title>Authentifizierungsdatenbank</title>
1282 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1283 Parametern in <varname>[authentication/database]</varname>
1284 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1288 <term><literal>host</literal></term>
1291 <para>Der Rechnername oder die IP-Adresse des
1292 Datenbankservers</para>
1297 <term><literal>port</literal></term>
1300 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1305 <term><literal>db</literal></term>
1308 <para>Der Name der Authentifizierungsdatenbank</para>
1313 <term><literal>user</literal></term>
1316 <para>Der Benutzername, mit dem sich kivitendo beim
1317 Datenbankserver anmeldet (z.B.
1318 "<literal>postgres</literal>")</para>
1323 <term><literal>password</literal></term>
1326 <para>Das Passwort für den Datenbankbenutzer</para>
1331 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1332 automatisch anlegen (mehr dazu siehe unten).</para>
1335 <sect2 id="Passwortüberprüfung">
1336 <title>Passwortüberprüfung</title>
1338 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1339 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1340 Active-Directory-Server. Welche davon benutzt wird, regelt der
1341 Parameter <varname>module</varname> im Abschnitt
1342 <varname>[authentication]</varname>.</para>
1344 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1345 gespeichert werden, so muss der Parameter <varname>module</varname>
1346 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1347 der Administrator als auch die Benutzer selber ihre Passwörter in
1348 kivitendo ändern.</para>
1350 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1351 benutzt werden, so muss der Parameter <varname>module</varname> auf
1352 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1353 zusätzliche Informationen über den LDAP-Server im Abschnitt
1354 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1358 <term><literal>host</literal></term>
1361 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1362 Active-Directory-Servers. Diese Angabe ist zwingend
1363 erforderlich.</para>
1368 <term><literal>port</literal></term>
1371 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1376 <term><literal>tls</literal></term>
1379 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1380 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1381 ‘<literal>0</literal>’ belassen</para>
1386 <term><literal>attribute</literal></term>
1389 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1390 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1391 meist ‘<literal>sAMAccountName</literal>’, für andere
1392 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1393 zwingend erforderlich.</para>
1398 <term><literal>base_dn</literal></term>
1401 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1402 Diese Angabe ist zwingend erforderlich.</para>
1407 <term><literal>filter</literal></term>
1410 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1411 <literal><%login%></literal>, so wird dieses durch den vom
1412 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1413 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1414 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1419 <term><literal>bind_dn</literal> und
1420 <literal>bind_password</literal></term>
1423 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1424 durchsucht werden kann (z.B. ist dies bei
1425 Active-Directory-Servern der Fall), so kann diese hier angegeben
1426 werden. Für Active-Directory-Server kann als
1427 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1428 z.B. ‘<literal>cn=Martin
1429 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1430 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1431 also ‘<literal>Martin Mustermann</literal>’.</para>
1437 <sect2 id="Name-des-Session-Cookies">
1438 <title>Name des Session-Cookies</title>
1440 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1441 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1442 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1443 Parameter <varname>cookie_name</varname> im Abschnitt
1444 <varname>[authentication]</varname>gesetzt.</para>
1446 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1447 Server existiert.</para>
1450 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1451 <title>Anlegen der Authentifizierungsdatenbank</title>
1453 <para>Nachdem alle Einstellungen in
1454 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1455 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1456 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1457 der folgenden URL erreichbar sein sollte:</para>
1460 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1464 <sect1 id="Benutzer--und-Gruppenverwaltung">
1465 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1467 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1468 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1469 das Sie unter folgender URL finden:</para>
1472 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1474 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1475 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1477 <sect2 id="Zusammenhänge">
1478 <title>Zusammenhänge</title>
1480 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1481 in einer oder zwei Datenbanken gespeichert werden.</para>
1483 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1484 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1485 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1486 Diese Informationen werden in der Authentifizierungsdatenbank
1487 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1488 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1489 gespeichert werden.</para>
1491 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1492 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1493 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1494 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1495 einer solchen Mandantendatenbank werden im Administrationsbereich
1496 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1497 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1499 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1500 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1501 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1502 mehr als einem Mandanten, wird empfohlen, für die
1503 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1504 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1507 <sect2 id="Mandanten-Benutzer-Gruppen">
1508 <title>Mandanten, Benutzer und Gruppen</title>
1510 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1511 die sich frei zueinander zuordnen lassen.</para>
1513 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1514 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1515 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1516 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1517 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1518 Diese sollte über die <link
1519 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1522 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1523 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1524 der Administrator fest, an welchen Mandanten sich ein Benutzer
1525 anmelden kann, was beim Login verifiziert wird.</para>
1527 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1528 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1529 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1530 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1531 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1532 dann an einem Mandanten an, so erhält er alle Rechte von allen
1533 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1534 denen der Benutzer zum Anderen Mitglied ist,</para>
1536 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1537 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1538 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1540 <orderedlist numeration="arabic">
1542 <para>Datenbank anlegen</para>
1546 <para>Gruppen anlegen</para>
1550 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1554 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1559 <sect2 id="Datenbanken-anlegen">
1560 <title>Datenbanken anlegen</title>
1562 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1563 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1564 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1567 <sect2 id="Gruppen-anlegen">
1568 <title>Gruppen anlegen</title>
1570 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1571 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1572 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1573 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1575 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1576 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1577 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1578 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1579 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1580 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1581 A, B und C gültig").</para>
1583 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1584 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1585 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1586 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1587 Gruppen A, B und C").</para>
1590 <sect2 id="Benutzer-anlegen">
1591 <title>Benutzer anlegen</title>
1593 <para>Beim Anlegen von Benutzern werden für viele Parameter
1594 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1595 deutschen Raumes entsprechen.</para>
1597 <para>Zwingend anzugeben ist der Loginname. Wenn die
1598 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
1599 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
1600 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1603 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
1604 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
1605 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
1606 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
1607 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
1608 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
1609 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
1610 sind Benutzer A, B und C Mitglieder").</para>
1613 <sect2 id="Mandanten-anlegen">
1614 <title>Mandanten anlegen</title>
1616 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
1617 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
1618 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
1619 einer der eben angelegten Datenbanken eingetragen werden.</para>
1621 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
1622 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
1623 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
1624 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
1625 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
1626 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
1627 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
1628 Gruppe ist für Mandanten A, B und C gültig").</para>
1632 <sect1 id="Drucker--Systemverwaltung">
1633 <title>Drucker- und Systemverwaltung</title>
1635 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
1636 Druckeradministration und System.</para>
1638 <sect2 id="Druckeradministration">
1639 <title>Druckeradministration</title>
1641 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
1642 viele "Druckbefehle" im System verwalten. Diese Befehle werden
1643 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
1644 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
1645 angezeigt wird.</para>
1647 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
1648 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
1649 meinDrucker' oder ein kompletter Pfad zu einem Skript
1650 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
1651 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
1652 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
1653 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
1654 Ausdruck eines Angebots folgende Vorlage geparst:
1655 sales_quotation_epson_drucker.tex.</para>
1659 <title>System sperren / entsperren</title>
1661 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
1662 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
1663 gesamten kivitendo Installation gesperrt.</para>
1665 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
1666 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
1667 Wartungsarbeiten nicht zugänglich.'.</para>
1669 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
1670 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
1671 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
1672 inkonsistenten Datenbestand weitergearbeitet werden.</para>
1676 <sect1 id="config.sending-email"
1677 xreflabel="E-Mail-Versand aus kivitendo heraus">
1678 <title>E-Mail-Versand aus kivitendo heraus</title>
1680 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
1681 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
1682 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
1683 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
1684 Versand über einen lokalen E-Mail-Server (z.B. mit
1685 <productname>Postfix</productname> oder <productname>Exim</productname>,
1686 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
1687 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
1689 <para>Welche Methode und welcher Server verwendet werden, wird über die
1690 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1691 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
1692 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1694 <sect2 id="config.sending-email.sendmail"
1695 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1696 <title>Versand über lokalen E-Mail-Server</title>
1698 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
1699 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
1700 <productname>Postfix</productname>, <productname>Exim</productname>
1701 oder <productname>Sendmail</productname> läuft.</para>
1703 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1704 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1705 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1707 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
1708 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
1709 Standardwert verweist auf das Programm
1710 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1711 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1713 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
1714 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
1718 <sect2 id="config.sending-email.smtp"
1719 xreflabel="E-Mail-Versand über einen SMTP-Server">
1720 <title>Versand über einen SMTP-Server</title>
1722 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
1723 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
1726 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1727 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1728 Parameter dienen dabei der weiteren Konfiguration:</para>
1732 <term><varname>hostname</varname></term>
1735 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
1736 '<literal>localhost</literal>'</para>
1741 <term><varname>port</varname></term>
1744 <para>Portnummer. Der Standardwert hängt von der verwendeten
1745 Verschlüsselungsmethode ab. Gilt '<literal>security =
1746 none</literal>' oder '<literal>security = tls</literal>', so ist
1747 25 die Standardportnummer. Für '<literal>security =
1748 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
1749 geändert werden.</para>
1754 <term><varname>security</varname></term>
1757 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
1758 mit dem Server. Standardwert ist '<literal>none</literal>',
1759 wodurch keine Verschlüsselung verwendet wird. Mit
1760 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
1761 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
1762 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
1763 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
1764 (siehe unten).</para>
1769 <term><varname>login</varname> und
1770 <varname>password</varname></term>
1773 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
1774 so können mit diesen zwei Parametern der Benutzername und das
1775 Passwort angegeben werden. Wird Authentifizierung verwendet, so
1776 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
1777 aktiviert werden.</para>
1784 <sect1 id="Drucken-mit-kivitendo">
1785 <title>Drucken mit kivitendo</title>
1787 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
1788 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1789 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1790 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
1792 <para><programlisting>apt-get install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1793 exlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1795 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
1797 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
1798 texlive-collection-latexrecommended texlive-collection-langgerman \
1799 texlive-collection-langenglish</programlisting></para>
1801 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
1803 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
1804 texlive-collection-latexrecommended texlive-collection-langgerman \
1805 texlive-collection-langenglish</programlisting></para>
1807 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1819 <para>rev-odt</para>
1823 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version
1824 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
1826 <sect2 id="Vorlagenverzeichnis-anlegen"
1827 xreflabel="Vorlagenverzeichnis anlegen">
1828 <title>Vorlagenverzeichnis anlegen</title>
1830 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
1831 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1833 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1835 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
1836 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
1837 <xref linkend="Gruppen-anlegen"/>.</para>
1839 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
1840 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
1841 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
1842 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1846 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
1847 Vorlagensatz aus, der kopiert werden soll
1848 (<filename>RB</filename>, <filename>f-tex</filename> oder
1849 <filename>odt-rev</filename>.)</para>
1853 <para><option>Neuer Name</option>: Der Verzeichnisname für den
1854 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
1855 für Verzeichnisnamen frei gewählt werden.</para>
1859 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
1860 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
1861 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1862 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
1863 vorgenommen werden. Den Ordner findet man im Dateisystem unter
1864 <filename>./templates/[Neuer Name]</filename></para>
1867 <sect2 id="Vorlagen-RB">
1868 <title>Der Druckvorlagensatz RB</title>
1870 <para>Hierbei handelt es sich um einen vollständigen LaTeX
1871 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
1872 sind nicht gepflegt.</para>
1874 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
1875 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1876 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
1877 eigenen Firmendaten finden sich in der Datei Readme.tex im
1878 Vorlagenverzeichnis.</para>
1880 <para>Eine kurze Übersicht der Features:</para>
1884 <para>Mehrsprachenfähig, mit Deutscher und Englischer
1889 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
1890 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
1895 <para>mehrere vordefinierte Varianten für
1896 Logos/Hintergrundbilder</para>
1900 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
1901 "Außerhalb EU"</para>
1907 <title>f-tex</title>
1909 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur
1910 Verfügung stellt.</para>
1912 <sect3 id="f-tex-Feature-Übersicht">
1913 <title>Feature-Übersicht</title>
1917 <para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage
1918 für alle briefartigen Dokumente verwendet. Also Angebot,
1919 Rechnung, Proformarechnung, Lieferschein, aber eben nicht für
1920 Paketaufkleber etc.</para>
1924 <para>Leichte Anpassung an das Firmen-Layout durch Verwendung
1925 eines Hintergrund-PDFs. Dieses kann leicht mit dem eigenen
1926 Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp,
1931 <para>Hintergrund-PDF umschaltbar auf "nur erste Seite"
1932 (Standard) oder "alle Seiten" (Option
1933 "<option>bgPdfFirstPageOnly</option>" in Datei
1934 <filename>letter.lco</filename>)</para>
1938 <para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem
1939 Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1940 versendeten Dokumenten eingebunden (Option
1941 "<option>bgPdfEmailOnly</option>" in Datei
1942 <filename>letter.lco</filename>).</para>
1946 <para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch,
1947 Wiederholung von Kopfzeilen, Zwischensummen etc. (danke an
1948 Kai-Martin Knaak für die Vorarbeit)</para>
1952 <para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom
1953 Land des eigenen Unternehmens abweicht (also die Rechnung das
1954 Land verlässt).</para>
1958 <para>Multisprachfähig leicht um weitere Sprachen zu erweitern,
1959 alle Übersetzungen in der Datei
1960 <filename>translatinos.tex</filename>.</para>
1964 <para>Auflistung von Bruttopreisen für Endverbraucher.</para>
1969 <sect3 id="f-tex-Installation">
1970 <title>Die Installation</title>
1974 <para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref
1975 linkend="Vorlagenverzeichnis-anlegen"/>. Das Vorlagensystem
1976 funktioniert jetzt schon, hat allerdings noch einen
1977 Beispiel-Briefkopf.</para>
1981 <para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
1982 <filename>./letter_head.pdf</filename>.</para>
1986 <para>Editiere den Bereich "<option>settings</option>" in der
1987 datei <filename>letter.lco</filename>.</para>
1991 <para>oder etwas detaillierter:</para>
1993 <para>Es wird eine Datei <filename>sample.lco</filename> erstellt
1994 und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
1995 ist dies die Datei die für die firmenspezifischen Anpassungen
1996 gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist,
1997 wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle
1998 über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und
1999 <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung
2000 über eine <filename>*.lco</filename>-Datei, die letztlich auf
2001 <filename>letter.lco</filename> verlinkt ist ist aber auch
2004 <para>Es wird eine Datei <filename>sample_head.pdf</filename> mit
2005 ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
2006 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage.
2007 Schau Dir nach Abschluss der Installation die Datei
2008 <filename>sample_head.pdf</filename> an und erstelle ein
2009 entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
2010 Template Verzeichniss ablegen und statt
2011 <filename>sample_head.pdf</filename> nach
2012 <filename>letter_head.pdf</filename> verlinken.</para>
2014 <para>Letzlich muss <filename>letter_head.pdf</filename> auf das
2015 passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
2018 <para>Es wird eine Datei <filename>mydata.tex.example</filename>
2019 ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
2020 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das
2021 Land verwendet. Die Datei muss also nicht angefasst werden. Die
2022 anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit
2023 nicht im öffentlichen Zweig).</para>
2025 <para>Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
2026 sollten über die Hintergrund-PDF-Datei oder die
2027 <filename>*.lco</filename>-Datei erfolgen.</para>
2030 <sect3 id="f-tex-Funktionsübersicht">
2031 <title>f-tex Funktionsübersicht</title>
2033 <para>Das Konzept von kivitendo sieht vor, für jedes Dokument
2034 (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
2035 LaTeX-Vorlage vorzuhalten, dies ist sehr wartungsunfreundlich. Auch
2036 das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
2037 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen
2038 aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
2039 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
2040 LaTeX-Vorlage verwendet, welche über Codeweichen die Besonderheiten
2041 der jeweiligen Dokumente berücksichtigt:</para>
2045 <para>Tabellen mit oder ohne Preis</para>
2049 <para>Sprache der Tabellenüberschriften etc.</para>
2053 <para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
2054 Angebotsnummer)</para>
2058 <para>Darstellung von Brutto oder Netto-Preisen in der
2059 Auflistung (Endverbraucher versus gewerblicher Kunde)</para>
2063 <para>Nachteil:</para>
2065 <para>LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei
2066 <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
2067 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder
2068 geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch
2069 innerhalb der Tabellendarstellung gut persönliche Anpassungen
2070 vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell
2071 heftig in den Fuss schiessen.</para>
2073 <para>Wer nicht so tief in die Materie einsteigen will oder leicht
2074 zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
2075 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen,
2076 und sich an der Form der dargestellten Tabellen, wie sie
2077 ausgeliefert werden, erfreuen.</para>
2079 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine,
2080 kontinuierliche Schritte gehen.</para>
2083 <sect3 id="f-tex-Bruttopreise">
2084 <title>Bruttopreise für Endverbraucher</title>
2086 <para>Der auszuweisende Bruttopreis wird innerhalb der
2087 LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen
2088 "alle Preise Brutto" auszuwählen, aber:</para>
2092 <para>hierfür müssen die Preise auch in Brutto in der Datenbank
2093 stehen (ja - das lässt sich über die Preisgruppen und die
2094 Zuordung einer Default-Preisgruppe handhaben)</para>
2098 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses
2099 Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
2100 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche
2105 <para>Es gibt mit f-tex eine weitere Alternative. Die Information ob
2106 Brutto oder Nettorechnung wird mit den Zahlarten verknüpft.
2107 Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben
2108 werden sollen, enden mit "_E" (für Endverbraucher). Falls identische
2109 Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt
2110 man diese einfach doppelt an (einmal mit der Namensendung "_E").
2115 <para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist
2116 nicht mehr fix mit einer Preisliste verbunden.</para>
2120 <para>Die Default-Zahlart kann im Kundendatensatz hinterlegt
2121 werden, und man muss nicht mehr daran denken, "alle Preise
2122 Netto" auszuwählen.</para>
2126 <para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen
2127 werden, kann direkt beim Drucken revidiert werden, ohne dass
2128 sich der Auftragswert ändert.</para>
2133 <sect3 id="f-tex-lieferadressen">
2134 <title>Lieferadressen</title>
2136 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen
2137 im Adressfeld zum Einsatz. Wenn die
2138 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende
2139 Adressvariable eingesetzt. Wenn also die Lieferadresse in Straße,
2140 Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
2141 Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert
2142 der Hauptadresse angezeigt.</para>
2146 <sect2 id="Vorlagen-rev-odt">
2147 <title>Der Druckvorlagensatz rev-odt</title>
2149 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2150 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2151 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2152 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2153 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2154 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2155 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2157 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2158 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2159 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2160 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2161 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2162 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2164 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2165 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2166 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2167 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2168 die vom Parser nicht korrekt gelesen werden kann.</para>
2170 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2171 odt-Vorlagen bei Mahnungen, Briefen und Pflichtenheften einzusetzen.
2172 Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2174 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2175 empfang@revamp-it.ch</para>
2178 <sect2 id="allgemeine-hinweise-zu-latex">
2179 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2181 <para>In den allermeisten Installationen sollte das Drucken jetzt
2182 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2183 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2184 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2185 sind zum Beispiel:</para>
2189 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2190 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2191 allem bei Vorlagen aus der Community auf. Installieren Sie die
2192 entsprechenden Pakete.</para>
2196 <para>! Package inputenc Error: Unicode char \u8:... set up for
2197 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2198 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2199 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2200 diversen Tricks dazu gebracht werden andere Zeichen zu
2201 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2206 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2207 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2208 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2209 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2210 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2213 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2214 verifizieren lässt:</para>
2218 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2219 "keep_temp_files" auf 1</para>
2221 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2225 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2229 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2233 <para>wechsel in das users Verzeichnis von kivitendo</para>
2235 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2239 <para>LaTeX Suchpfad anpassen:</para>
2241 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2245 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2248 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2250 <para>Es sollte die letzte Datei ganz unten sein</para>
2254 <para>für besseren Hinweis auf Fehler texdatei nochmals
2257 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2259 <para>in der *.tex datei nach dem Fehler suchen.</para>
2265 <sect1 id="OpenDocument-Vorlagen">
2266 <title>OpenDocument-Vorlagen</title>
2268 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2269 OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2) erzeugen.
2270 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
2271 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2272 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2273 <filename>config/kivitendo.conf</filename> die Variable
2274 <literal>opendocument</literal> im Abschnitt
2275 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2276 Dieses ist die Standardeinstellung.</para>
2278 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2279 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2280 LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt werden, so muss
2281 neben LibreOffice oder OpenOffice auch der “X virtual frame buffer”
2282 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
2283 Andere Distributionen enthalten ihn in anderen Paketen.</para>
2285 <para>Nach der Installation müssen in der Datei
2286 <filename>config/kivitendo.conf</filename> im Abschnitt
2287 <literal>applications</literal> zwei weitere Variablen
2288 angepasst werden:</para>
2289 <para><literal>openofficeorg_writer</literal> muss den
2290 vollständigen Pfad zu LibreOffice oder OpenOffice enthalten.
2291 Dabei dürfen keine Anführungszeichen eingesetzt werden.</para>
2292 <para>Beispiel für Debian oder Ubuntu:</para>
2293 <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2294 <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2297 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2298 LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die benutzt
2299 wird, wenn die Variable <literal>$openofficeorg_daemon</literal> gesetzt
2300 ist, startet ein LibreOffice oder OpenOffice, das auch nach der Umwandlung
2301 des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen wird dann diese
2302 laufende Instanz benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung
2303 deutlich reduziert wird, weil nicht für jedes Dokument ein LibreOffice bzw.
2304 OpenOffice gestartet werden muss. Der Nachteil ist, dass diese Methode
2305 Python und die Python-UNO-Bindings benötigt, die Bestandteil von LibreOffice
2306 bzw. OpenOffice sind.</para>
2309 <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2310 normalerweise der Python-Interpreter
2311 <filename>/usr/bin/python</filename> benutzt.
2312 Sollte dies nicht der richtige sein, so kann man mit zwei
2313 Konfigurationsvariablen entscheiden, welcher Python-Interpreter
2314 genutzt wird. Mit der Option <literal>python_uno</literal> aus dem
2315 Abschnitt <literal>applications</literal> wird der Interpreter selber
2316 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2317 <literal>/usr/bin/python</literal>.</para>
2319 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2320 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2321 z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2322 OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2323 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2324 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2325 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2326 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2327 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2331 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2332 wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet
2333 und die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses
2334 Makro muss in der Dokumentenvorlage enthalten sein und
2335 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2336 ‘<literal>templates/print/rev-odt/invoice.odt</literal>’
2337 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
2338 ebenfalls enthalten sein muss.</para>
2340 <para>Als letztes muss herausgefunden werden, welchen Namen
2341 OpenOffice bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen
2342 gibt. Unter Debian ist dies momentan
2343 <literal>~/.config/libreoffice</literal>. kivitendo verwendet das
2344 Verzeichnis <literal>users/.openoffice.org2</literal>.
2345 Eventuell muss dieses Verzeichnis umbenannt werden.</para>
2347 <para>Dieses Verzeichnis, wie auch das komplette
2348 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2349 sein. Dieses wurde bereits erledigt (siehe <xref
2350 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber
2351 erneut überprüft werden, wenn die Konvertierung nach PDF
2355 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2357 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2358 Aufgaben erfüllen.</para>
2360 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2361 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2362 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2363 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2364 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2365 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2366 Anpassungen aufgeführt</emphasis>):</para>
2369 <title>Bezeichnung der Vorlagen</title>
2371 <para>Rechnung: invoice_besr.odt, Auftrag:
2372 sales_order_besr.odt</para>
2376 <title>Vorbereitungen im Adminbereich</title>
2378 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2379 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2380 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2381 ein Drucker eingerichtet werden:</para>
2385 <para>Druckeradministration → Drucker hinzufügen</para>
2389 <para>Mandant wählen</para>
2393 <para>Druckerbeschreibung → aussagekräftiger Text: wird in
2394 der Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B.
2395 mit Einzahlungsschein Bank xy)</para>
2399 <para>Druckbefehl → beliebiger Text (hat für das Erzeugen
2400 von Aufträgen oder Rechnungen als odt-Datei keine Bedeutung,
2401 darf aber nicht leer sein)</para>
2405 <para>Vorlagenkürzel → besr bzw. selbst gewähltes
2406 Vorlagensuffix (muss genau der Zeichenfolge entsprechen, die
2407 zwischen "invoice_" bzw. "sales_order_" und ".odt"
2412 <para>speichern</para>
2418 <title>Benutzereinstellungen</title>
2420 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2421 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2422 dies persönlich für sich bei den Benutzereinstellungen
2423 konfigurieren:</para>
2427 <para>Programm → Benutzereinstellungen →
2428 Druckoptionen</para>
2432 <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2436 <para>Standardausgabekanal → Bildschirm</para>
2440 <para>Standarddrucker → gewünschte Druckerbeschreibung
2441 auswählen (z.B. mit Einzahlungsschein Bank xy)</para>
2445 <para>Anzahl Kopien → leer</para>
2449 <para>speichern</para>
2455 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2457 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2458 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2459 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2460 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2465 <para>Für den Einzahlungsschein ist die letzte Seite des
2466 Dokuments reserviert</para>
2470 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2471 Zeile mit folgenden Angaben (<emphasis
2472 role="bold">Bank-Konto-Identifikationsnummer und
2473 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2474 Bank angepasst werden</emphasis>):<itemizedlist>
2476 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2477 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2479 <para>erster Wert: <emphasis
2480 role="bold">Bank-Konto-Identifikation</emphasis>
2481 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2482 angepasst werden</emphasis>.</para>
2486 <para>zweiter Wert: <%customernumber%>
2487 (Kundennummer: nur Ziffern, maximal 6)</para>
2491 <para>dritter Wert: <%ordnumber%>
2492 (Auftragsnummer bei Auftragsvorlage
2493 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2494 führende Buchstaben werden vom Makro entfernt</para>
2498 <para>vierter Wert: <%invnumber%>
2499 (Rechnungsnummer bei Rechnungsvorlage
2500 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2501 führende Buchstaben werden vom Makro entfernt</para>
2503 </itemizedlist></para>
2507 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2508 Bank, muss angepasst werden</emphasis>.</para>
2512 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2513 falls Einzahlungsschein ohne Betrag</para>
2517 <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2519 </itemizedlist></para>
2523 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2524 der Name und die Adresse der Bank, die Postkonto-Nummer der
2525 Bank, sowie der eigene Firmenname und die Firmenadresse
2526 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2527 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2528 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2534 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2535 ändernde Einträge in rot</screeninfo>
2539 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2546 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2547 odt-Rechnung (analog bei Auftrag)</title>
2549 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2550 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2551 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2552 den Benutzereinstellungen als persönlicher Standard gewählt
2557 <title>Makroeinstellungen in LibreOffice anpassen</title>
2559 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2560 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2561 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2562 angepasst werden:</para>
2566 <para>Extras → Optionen → Sicherheit →
2567 Makrosicherheit</para>
2571 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2572 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2573 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2578 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2579 der entsprechenden Nachfrage "Makros ausführen" auswählen.
2582 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2583 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2584 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2585 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2593 <sect1 id="config.eur">
2594 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
2597 <sect2 id="config.eur.introduction"
2598 xreflabel="Einführung in die Konfiguration zur EUR">
2599 <title>Einführung</title>
2601 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
2602 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
2603 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
2604 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
2605 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
2607 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
2608 die Mandantendatenbank verschoben und dabei auch gleich in drei
2609 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
2610 steuern lässt.</para>
2613 <sect2 id="config.eur.parameters"
2614 xreflabel="Konfigurationsparameter für EUR">
2615 <title>Konfigurationsparameter</title>
2617 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
2618 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
2622 <term><varname>profit_determination</varname></term>
2625 <para>Dieser Parameter legt die Berechnungsmethode für die
2626 Gewinnermittlung fest. Er enthält entweder
2627 <literal>balance</literal> für
2628 Betriebsvermögensvergleich/Bilanzierung oder
2629 <literal>income</literal> für die
2630 Einnahmen-Überschuss-Rechnung.</para>
2635 <term><varname>accounting_method</varname></term>
2638 <para>Dieser Parameter steuert die Buchungs- und
2639 Berechnungsmethoden für die Versteuerungsart. Er enthält
2640 entweder <literal>accrual</literal> für die Soll-Versteuerung
2641 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
2646 <term><varname>inventory_system</varname></term>
2649 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
2650 enthält entweder <literal>perpetual</literal> für die
2651 Bestandsmethode oder <literal>periodic</literal> für die
2652 Aufwandsmethode.</para>
2657 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
2658 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
2659 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
2660 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
2661 Bestandsmethode.</para>
2663 <para>Die Konfiguration "<varname>eur</varname>" unter
2664 <varname>[system]</varname> in der <link
2665 linkend="config.config-file">Konfigurationsdatei</link>
2666 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
2667 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
2670 <sect2 id="config.eur.setting-parameters">
2671 <title>Festlegen der Parameter</title>
2673 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
2674 der Admininstration können diese Optionen nun unabhängig voneinander
2675 eingestellt werden.</para>
2677 <para>Für die Schweiz sind folgende Einstellungen üblich:
2680 <para>Sollversteuerung</para>
2683 <para>Aufwandsmethode</para>
2686 <para>Bilanzierung</para>
2689 Diese Einstellungen werden automatisch beim Erstellen einer neuen
2690 Datenbank vorausgewählt, wenn in <filename>config/kivitendo.conf</filename> unter
2691 <varname>[system]</varname> <literal>default_manager = swiss</literal> eingestellt ist.
2694 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
2695 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
2698 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
2699 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
2700 angezeigt. Unter <guimenu>System</guimenu> →
2701 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
2702 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
2703 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
2704 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
2705 auch <link linkend="config.eur.inventory-system-perpetual">
2706 Bemerkungen zur Bestandsmethode</link>).</para>
2709 <sect2 id="config.eur.inventory-system-perpetual">
2710 <title>Bemerkungen zur Bestandsmethode</title>
2712 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
2713 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
2714 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
2715 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
2716 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
2717 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
2718 Einkaufsrechnungen berechnet wird.</para>
2720 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
2721 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
2722 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
2726 <sect2 id="config.eur.knonw-issues">
2727 <title>Bekannte Probleme</title>
2729 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
2730 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
2731 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
2732 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
2733 die Konfigurationsvariable
2734 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
2737 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
2738 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
2742 <sect1 id="config.skr04-update-3804">
2743 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
2745 <sect2 id="config.skr04-update-3804.introduction">
2746 <title>Einführung</title>
2748 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
2749 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
2750 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
2751 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
2752 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
2753 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
2754 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
2755 vielleicht schon selbst geholfen hat und mit seinen Änderungen
2756 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
2757 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
2758 Screenshots dargestellt.</para>
2760 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
2761 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
2762 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
2763 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
2766 <sect2 id="config.skr04-update-3804.create-chart">
2767 <title>Konto 3804 manuell anlegen</title>
2769 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
2770 anzulegen und zu konfigurieren. Zuerst wird in
2771 <guimenu>System</guimenu> →
2772 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konto
2773 erfassen</guimenuitem> das Konto angelegt.</para>
2776 <screeninfo>Konto 3804 erfassen</screeninfo>
2780 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
2785 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
2786 werden. Dazu unter <guimenu>System</guimenu> →
2787 <guisubmenu>Steuern</guisubmenu> →
2788 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
2789 13 auswählen und ihn wie im folgenden Screenshot angezeigt
2793 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
2797 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
2802 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
2803 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
2804 <guisubmenu>Steuern</guisubmenu> →
2805 <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem
2806 Screenshot übernehmen.</para>
2809 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
2813 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
2818 <para>Als Nächstes sind alle Konten anzupassen, die als
2819 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
2820 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
2821 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
2822 müssen Sie dazu unter <guimenu>System</guimenu> →
2823 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
2824 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
2825 wie im Screenshot gezeigt vornehmen.</para>
2828 <screeninfo>Konto 4315 anpassen</screeninfo>
2832 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
2837 <para>Als Letztes sollte die Steuerliste unter
2838 <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
2839 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
2840 Vergleich der Screenshot.</para>
2843 <screeninfo>Steuerliste vergleichen</screeninfo>
2847 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
2854 <sect1 id="config.bilanz">
2855 <title>Verhalten des Bilanzberichts</title>
2857 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
2858 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
2859 monatsweise führt dies zu falschen Werten.</para>
2861 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
2862 einstellen indem man:</para>
2866 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
2871 <para>immer den Jahresanfang nimmt (1.1. relativ zum
2876 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
2878 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
2881 <para>- oder mit "alle Buchungen" als Alternative"</para>
2885 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
2890 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
2894 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
2895 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
2896 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
2897 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
2898 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
2899 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
2900 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
2901 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
2902 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
2903 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
2904 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
2905 Erfolgsrechnung.</para>
2908 <sect1 id="config.erfolgsrechnung">
2909 <title>Erfolgsrechnung</title>
2911 <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht <emphasis role="bold">
2912 Erfolgsrechnung</emphasis>.</para>
2914 <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter Features
2915 an- oder abgeschaltet werden. Mit der Einstellung <varname>default_manager = swiss
2916 </varname> in der <filename>config/kivitendo.conf</filename> wird beim neu Erstellen
2917 einer Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü <guimenu>Berichte
2918 </guimenu> ausgewählt und ersetzt dort die GUV.</para>
2920 <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche Aufwands- und
2921 Erlöskonten einzeln aufgelistet (analog zur Bilanz), sortiert nach ERTRAG und AUFWAND.</para>
2923 <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der Erfolgsrechnung
2924 erscheinen soll, unter <varname>Sonstige Einstellungen/Erfolgsrechnung</varname>
2925 entweder <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal> ausgewählt
2928 <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal> ausgewählt,
2929 so wird dieses Konto als Aufwandsminderung unter AUFWAND aufgelistet.</para>
2931 <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal> ausgewählt,
2932 so wird dieses Konto als Ertragsminderung unter ERTRAG aufgelistet.</para>
2934 <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft zusätzlich
2935 die Erfolgsrechnung als Bericht verwendet werden, so müssen die Einstellungen
2936 zu allen Erlös- und Aufwandskonten unter <varname>Sonstige
2937 Einstellungen/Erfolgsrechnung</varname> überprüft und allenfalls neu gesetzt werden.</para>
2940 <sect1 id="config.rounding">
2941 <title>Rundung in Verkaufsbelegen</title>
2943 <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert von 5 Rappen (0.05 CHF).</para>
2945 <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer Genauigkeit
2946 von 0.01 CHF verwendet werden können, ist es trotzdem nach wie vor üblich,
2947 Rechnungen mit auf 0.05 CHF gerundeten Beträgen auszustellen.</para>
2949 <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine solche
2950 Rundung pro Mandant / Datenbank festgelegt werden.</para>
2952 <para>Die Einstellung wird beim Erstellen der Datenbank bei <literal>Genauigkeit</literal>
2953 festgelegt. Sie kann anschliessend über das Webinterface von kivitendo nicht mehr
2954 verändert werden.</para>
2956 <para>Abhängig vom Wert für <varname>default_manager</varname> in
2957 <filename>config/kivitendo.conf</filename> werden dabei folgende
2958 Werte voreingestellt:</para>
2961 <para>0.05 (default_manager = swiss)</para>
2964 <para>0.01 (default_manager = german)</para>
2967 <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
2968 </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
2970 <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
2971 und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet,
2972 wenn dieser nicht der eingestellten Genauigkeit entspricht.</para>
2974 <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
2975 automatisch auf die in der Mandantenkonfiguration festgelegten
2976 Standardkonten für Rundungserträge bzw. Rundungsaufwendungen gebucht.</para>
2978 <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr verändert.)</para>
2980 <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
2981 <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
2982 <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
2984 <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege
2985 in anderen Währungen als der Standardwährung erstellt, so muss in
2986 kivitendo 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
2987 <para>Das heisst, Firmen in der Schweiz, die teilweise Verkaufsrechnungen
2988 in Euro oder anderen Währungen erstellen wollen, müssen beim Erstellen
2989 der Datenbank als Genauigkeit 0.01 wählen und können zur Zeit die
2990 5er Rundung noch nicht nutzen.</para>
2993 <sect1 id="config.client">
2994 <title>Einstellungen pro Mandant</title>
2996 <para>Einige Einstellungen können von einem Benutzer mit dem <link
2997 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
2998 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
2999 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3000 Die Einstellungen sind unter <guimenu>System</guimenu> →
3001 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3003 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3004 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3005 geändert werden (siehe auch <link
3006 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3007 Bestandsmethode</link>).</para>
3009 <para>Die Einstellungen <literal>show_bestbefore</literal> und
3010 <literal>payments_changeable</literal> aus dem Abschnitt
3011 <literal>features</literal> und die Einstellungen im Abschnitt
3012 <literal>datev_check</literal> (sofern schon vorhanden) der <link
3013 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3014 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3015 Diese Einträge können danach aus der Konfigurationsdatei entfernt
3019 <sect1 id="kivitendo-ERP-verwenden">
3020 <title>kivitendo ERP verwenden</title>
3022 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3023 folgender URL erreichbar:</para>
3026 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3028 <para>Die Administrationsseite erreichen Sie unter:</para>
3031 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3035 <chapter id="features" xreflabel="Features und Funktionen">
3036 <title>Features und Funktionen</title>
3038 <sect1 id="features.periodic-invoices"
3039 xreflabel="Wiederkehrende Rechnungen">
3040 <title>Wiederkehrende Rechnungen</title>
3042 <sect2 id="features.periodic-invoices.introduction"
3043 xreflabel="Einführung in wiederkehrende Rechnungen">
3044 <title>Einführung</title>
3046 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3047 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3048 Die konfigurierten Aufträge werden später automatisch in Rechnungen
3049 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3050 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3051 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3052 wiederzufinden sind.</para>
3055 <sect2 id="features.periodic-invoices.configuration"
3056 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3057 <title>Konfiguration</title>
3059 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3060 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3061 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3062 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3063 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3066 <para>Folgende Parameter kann man konfigurieren:</para>
3073 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3074 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3075 eines neuen Monats).</para>
3077 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3078 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3079 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3080 nächsten Periodenwechsel für alle Perioden, seit der letzten
3081 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3082 verhindern, muss man vorher das Startdatum neu setzen.</para>
3084 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3085 erstellt. Man kann sich diese Aufträge aber gesondert in den
3086 Berichten anzeigen lassen.</para>
3091 <term>Periodizität</term>
3094 <para>Ob monatlich, quartalsweise oder jährlich auf neue
3095 Rechnungen überprüft werden soll. Für jede Periode seit dem
3096 Startdatum wird überprüft, ob für die Periode (beginnend immer
3097 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3098 wurde. Unter Umständen können bei einem Startdatum in der
3099 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3104 <term>Buchen auf</term>
3107 <para>Das Forderungskonto, in der Regel "Forderungen aus
3108 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3109 Buchungsgruppen der betreffenden Waren.</para>
3114 <term>Startdatum</term>
3117 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3123 <term>Enddatum</term>
3126 <para>ab wann keine Rechnungen mehr erstellt werden
3132 <term>Automatische Verlängerung um x Monate</term>
3135 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3136 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3137 hier die Anzahl der Monate eingeben, um die das Enddatum
3138 automatisch nach hinten geschoben wird.</para>
3143 <term>Drucken</term>
3146 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3147 Rechnungen auch gleich ausdrucken lassen.</para>
3152 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3153 Informationen zu den erstellten Rechnungen verschickt werden.
3154 Konfiguriert wird dies in der <link
3155 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3156 <filename>config/kivitendo.conf</filename> im Abschnitt
3157 <varname>[periodic_invoices]</varname>.</para>
3160 <sect2 id="features.periodic-invoices.variables">
3161 <title>Spezielle Variablen</title>
3163 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3164 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3165 formatierte Variablen durch für die jeweils aktuelle
3166 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3167 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3168 die Syntax <literal><%variablenname%></literal>.</para>
3170 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3171 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3172 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3173 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3174 Die zur verfügung stehenden Formatinformationen werden unten genauer
3177 <para>Diese Variablen können auch beim automatischen Versand der
3178 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3179 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3181 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3186 <para>Bemerkungen</para>
3190 <para>Interne Bemerkungen</para>
3194 <para>Vorgangsbezeichnung</para>
3198 <para>In den Beschreibungs- und Langtextfeldern aller
3203 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3207 <term><varname><%current_quarter%></varname>,
3208 <varname><%previous_quarter%></varname>,
3209 <varname><%next_quarter%></varname></term>
3212 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3213 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3218 <term><varname><%current_month%></varname>,
3219 <varname><%previous_month%></varname>,
3220 <varname><%next_month%></varname></term>
3223 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3224 <literal>1</literal> und <literal>12</literal>.</para>
3229 <term><varname><%current_month_long%></varname>,
3230 <varname><%previous_month_long%></varname>,
3231 <varname><%next_month_long%></varname></term>
3234 <para>Aktueller, vorheriger und nächster Monat als Name
3235 (<literal>Januar</literal>, <literal>Februar</literal>
3241 <term><varname><%current_year%></varname>,
3242 <varname><%previous_year%></varname>,
3243 <varname><%next_year%></varname></term>
3246 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3247 Jahreszahl (<literal>2013</literal> etc.).</para>
3252 <term><varname><%period_start_date%></varname>,
3253 <varname><%period_end_date%></varname></term>
3256 <para>Formatiertes Datum des ersten und letzten Tages im
3257 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3258 ersten Quartal von 2013 wären dies der
3259 <literal>01.01.2013</literal> und
3260 <literal>31.03.2013</literal>).</para>
3265 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3266 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3267 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3268 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3273 <term><varname>%a</varname></term>
3276 <para>Der abgekürzte Wochentagsname.</para>
3281 <term><varname>%A</varname></term>
3284 <para>Der ausgeschriebene Wochentagsname.</para>
3289 <term><varname>%b</varname></term>
3292 <para>Der abgekürzte Monatsname.</para>
3297 <term><varname>%B</varname></term>
3300 <para>Der ausgeschriebene Monatsname.</para>
3305 <term><varname>%C</varname></term>
3308 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3314 <term><varname>%d</varname></term>
3317 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3322 <term><varname>%D</varname></term>
3325 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3330 <term><varname>%e</varname></term>
3333 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3334 werden führende Nullen durch Leerzeichen ersetzt.</para>
3339 <term><varname>%F</varname></term>
3342 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3347 <term><varname>%j</varname></term>
3350 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3356 <term><varname>%m</varname></term>
3359 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3364 <term><varname>%u</varname></term>
3367 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3368 die 1 dem Montag entspricht.</para>
3373 <term><varname>%U</varname></term>
3376 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3377 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3383 <term><varname>%V</varname></term>
3386 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3387 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3388 vier Tage im Jahr liegen; Montag ist erster Tag der
3394 <term><varname>%w</varname></term>
3397 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3398 die 0 dem Sonntag entspricht.</para>
3403 <term><varname>%W</varname></term>
3406 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3407 wobei der erste Montag im Jahr das Startdatum von Woche 01
3413 <term><varname>%y</varname></term>
3416 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3422 <term><varname>%Y</varname></term>
3425 <para>Das Jahr als vierstellige Zahl.</para>
3430 <term><varname>%%</varname></term>
3433 <para>Das Prozentzeichen selber.</para>
3438 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3439 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3440 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3441 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3444 <sect2 id="features.periodic-invoices.reports">
3445 <title>Auflisten</title>
3447 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3448 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3449 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3450 wiederkehrenden Rechnungen verschaffen kann.</para>
3453 <sect2 id="features.periodic-invoices.task-server">
3454 <title>Erzeugung der eigentlichen Rechnungen</title>
3456 <para>Die zeitliche und periodische Überprüfung, ob eine
3457 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3458 durch den <link linkend="config.task-server">Taskserver</link>, einen
3459 externen Dienst, der automatisch beim Start des Servers gestartet
3460 werden sollte.</para>
3463 <sect2 id="features.periodic-invoices.create-for-current-month">
3464 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3466 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3467 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3468 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
3469 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3470 generiert hat. Alternativ setzt man das Startdatum auf den
3471 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3472 manuell über den Workflow.</para>
3476 <sect1 id="features.bank" xreflabel="bankerweiterung">
3477 <title>Bankerweiterung</title>
3479 <sect2 id="features.bank.introduction"
3480 xreflabel="Einführung in die Bankerweiterung">
3481 <title>Einführung</title>
3483 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3484 im Wiki und soll von dort später hierhin übernommen werden:</para>
3487 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3491 <sect1 id="dokumentenvorlagen-und-variablen">
3492 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3494 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3495 <title>Einführung</title>
3497 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3498 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3499 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3500 <function><%variablenname%></function> verwendet wird. Für
3501 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3503 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3505 <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3506 Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im
3507 Folgenden gesagte für alle Vorlagenarten.</para>
3509 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3510 verfügbar als hier aufgelistet werden. Die meisten davon können
3511 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3512 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3513 diese wie folgt erhalten werden:</para>
3517 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3518 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3522 <para>In <filename>Form.pm</filename> die Funktion
3523 <function>parse_template</function> suchen und hier die Zeile
3524 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3528 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3529 ein PDF für eine Rechnung erzeugen.</para>
3533 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3534 der Variablen <varname>$self</varname> in der Form <varname>'key'
3535 => 'value',</varname>. Alle <varname>key</varname>s sind
3541 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3542 <title>Variablen ausgeben</title>
3544 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3545 Tags geschrieben werden, also z.B.
3546 <varname><%variablenname%></varname>.</para>
3548 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3549 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3550 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
3551 werden die folgenden Flags unterstützt:</para>
3555 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3556 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3557 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3558 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3562 <para><option>NOESCAPE</option> unterdrückt das Escapen von
3563 Sonderzeichen für die Vorlagensprache. Wenn also in einer
3564 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
3565 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
3566 ist dieses Flag sinnvoll.</para>
3570 <para>Beispiel:</para>
3572 <programlisting><%quototal NOFORMAT%></programlisting>
3575 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
3576 <title>Verwendung in Druckbefehlen</title>
3578 <para>In der Admininstration können Drucker definiert werden. Auch im
3579 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
3580 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
3581 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
3582 <function>`...`</function> nicht zu unerwünschtem Verhalten
3585 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
3586 für das die Telefonnummer eines Ansprechpartners als Teil der
3587 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
3588 z.B. wie folgt aussehen:</para>
3590 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
3593 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
3594 xreflabel="Anfang und Ende der Tags verändern">
3595 <title>Anfang und Ende der Tags verändern</title>
3597 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
3598 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
3599 Prozentzeichen und dem Größerzeichen endet, beispielsweise
3600 <function><%customer%></function>. Da diese Form aber z.B. in
3601 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
3602 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
3603 Stil umgestellt werden.</para>
3605 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
3606 Format gültigen Kommentarzeichen anfangen, dann
3607 <function>config:</function> enthalten, die entsprechende Option
3608 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
3609 enden. Beispiel für LaTeX:</para>
3611 <programlisting>% config: tag-style=($ $)</programlisting>
3613 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
3614 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
3615 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
3617 <programlisting><!-- config: tag-style=($ $) --></programlisting>
3620 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
3621 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
3623 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
3624 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
3625 "<filename>.ext</filename>" geeignet zu ersetzen:
3626 "<filename>.tex</filename>" für LaTeX-Vorlagen und
3627 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
3631 <term><filename>bin_list.ext</filename></term>
3634 <para>Lagerliste</para>
3639 <term><filename>check.ext</filename></term>
3647 <term><filename>invoice.ext</filename></term>
3650 <para>Rechnung</para>
3655 <term><filename>packing_list.ext</filename></term>
3658 <para>Packliste</para>
3663 <term><filename>pick_list.ext</filename></term>
3666 <para>Sammelliste</para>
3671 <term><filename>purchase_delivery_order.ext</filename></term>
3674 <para>Lieferschein (Einkauf)</para>
3679 <term><filename>purcharse_order.ext</filename></term>
3682 <para>Bestellung an Lieferanten</para>
3687 <term><filename>request_quotation.ext</filename></term>
3690 <para>Anfrage an Lieferanten</para>
3695 <term><filename>sales_delivery_order.ext</filename></term>
3698 <para>Lieferschein (Verkauf)</para>
3703 <term><filename>sales_order.ext</filename></term>
3706 <para>Bestellung</para>
3711 <term><filename>sales_quotation.ext</filename></term>
3714 <para>Angebot an Kunden</para>
3719 <term><filename>zahlungserinnerung.ext</filename></term>
3722 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
3727 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
3730 <para>Rechnung über Mahngebühren (Dateiname im Programm
3731 konfigurierbar)</para>
3737 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
3738 <title>Sprache, Drucker und E-Mail</title>
3740 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
3741 eingearbeitet. So wird aus der Vorlage
3742 <filename>sales_order.ext</filename> bei Sprache
3743 <function>de</function> und Druckerkürzel <function>lpr2</function>
3744 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
3745 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
3746 bekommen dann noch das Kürzel <filename>_email</filename>, der
3747 vollständige Vorlagenname wäre dann
3748 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
3749 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
3750 werden. Diese wird verwendet, wenn keine der anderen Varianten
3751 gefunden wird.</para>
3753 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
3754 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
3755 verschickt wird, ist:</para>
3759 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
3763 <para><filename>sales_order_de_lpr2.tex</filename></para>
3767 <para><filename>sales_order.tex</filename></para>
3771 <para><filename>default.tex</filename></para>
3775 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
3776 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
3778 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
3781 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
3782 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
3785 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
3786 xreflabel="Metainformationen zur angeforderten Vorlage">
3787 <title>Metainformationen zur angeforderten Vorlage</title>
3789 <para>Diese Variablen liefern Informationen darüber welche Variante
3790 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
3791 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
3792 Formulare einbinden möchten.</para>
3796 <term><varname>template_meta.formname</varname></term>
3799 <para>Basisname der Vorlage. Identisch mit der <link
3800 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
3801 zu den Dateinamen</link> ohne die Erweiterung. Ein
3802 Verkaufsauftrag enthält hier
3803 <constant>sales_order</constant>.</para>
3808 <term><varname>template_meta.language.description</varname></term>
3811 <para>Beschreibung der verwendeten Sprache</para>
3816 <term><varname>template_meta.language.template_code</varname></term>
3819 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
3820 dem Kürzel das im Dateinamen verwendetet wird.</para>
3825 <term><varname>template_meta.language.output_numberformat</varname></term>
3828 <para>Zahlenformat der verwendeten Sprache in der Form
3829 "<constant>1.000,00</constant>". Experimentell! Nur
3830 interessant für Vorlagen die mit unformatierten Werten
3836 <term><varname>template_meta.language.output_dateformat</varname></term>
3839 <para>Datumsformat der verwendeten Sprache in der Form
3840 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
3841 interessant für Vorlagen die mit unformatierten Werten
3847 <term><varname>template_meta.format</varname></term>
3850 <para>Das angeforderte Format. Kann im Moment die Werte
3851 <constant>pdf</constant>, <constant>postscript</constant>,
3852 <constant>html</constant>, <constant>opendocument</constant>,
3853 <constant>opendocument_pdf</constant> und
3854 <constant>excel</constant> enthalten.</para>
3859 <term><varname>template_meta.extension</varname></term>
3862 <para>Dateierweiterung, wie im Dateinamen. Wird aus
3863 <constant>format</constant> entschieden.</para>
3868 <term><varname>template_meta.media</varname></term>
3871 <para>Ausgabemedium. Kann zur Zeit die Werte
3872 <constant>screen</constant> für Bildschirm,
3873 <constant>email</constant> für E-Mail (triggert das
3874 <constant>_email</constant> Kürzel im Dateinamen),
3875 <constant>printer</constant> für Drucker, und
3876 <constant>queue</constant> für Warteschlange enthalten.</para>
3881 <term><varname>template_meta.printer.description</varname></term>
3884 <para>Beschreibung des ausgewählten Druckers</para>
3889 <term><varname>template_meta.printer.template_code</varname></term>
3892 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
3893 dem Kürzel das im Dateinamen verwendetet wird.</para>
3898 <term><varname>template_meta.tmpfile</varname></term>
3901 <para>Datei-Prefix für temporäre Dateien.</para>
3907 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
3908 <title>Stammdaten von Kunden und Lieferanten</title>
3912 <term><varname>account_number</varname></term>
3915 <para>Kontonummer</para>
3920 <term><varname>bank</varname></term>
3923 <para>Name der Bank</para>
3928 <term><varname>bank_code</varname></term>
3931 <para>Bankleitzahl</para>
3936 <term><varname>bic</varname></term>
3939 <para>Bank-Identifikations-Code (Bank Identifier Code,
3945 <term><varname>business</varname></term>
3948 <para>Kunden-/Lieferantentyp</para>
3953 <term><varname>city</varname></term>
3961 <term><varname>contact</varname></term>
3964 <para>Kontakt</para>
3969 <term><varname>country</varname></term>
3977 <term><varname>c_vendor_id</varname></term>
3980 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
3985 <term><varname>v_customer_id</varname></term>
3988 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
3993 <term><varname>cp_email</varname></term>
3996 <para>Email des Ansprechpartners</para>
4001 <term><varname>cp_givenname</varname></term>
4004 <para>Vorname des Ansprechpartners</para>
4009 <term><varname>cp_greeting</varname></term>
4012 <para>Anrede des Ansprechpartners</para>
4017 <term><varname>cp_name</varname></term>
4020 <para>Name des Ansprechpartners</para>
4025 <term><varname>cp_phone1</varname></term>
4028 <para>Telefonnummer 1 des Ansprechpartners</para>
4033 <term><varname>cp_phone2</varname></term>
4036 <para>Telefonnummer 2 des Ansprechpartners</para>
4041 <term><varname>cp_title</varname></term>
4044 <para>Titel des Ansprechpartners</para>
4049 <term><varname>creditlimit</varname></term>
4052 <para>Kreditlimit</para>
4057 <term><varname>customeremail</varname></term>
4060 <para>Email des Kunden; nur für Kunden</para>
4065 <term><varname>customerfax</varname></term>
4068 <para>Faxnummer des Kunden; nur für Kunden</para>
4073 <term><varname>customernotes</varname></term>
4076 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4081 <term><varname>customernumber</varname></term>
4084 <para>Kundennummer; nur für Kunden</para>
4089 <term><varname>customerphone</varname></term>
4092 <para>Telefonnummer des Kunden; nur für Kunden</para>
4097 <term><varname>discount</varname></term>
4105 <term><varname>email</varname></term>
4108 <para>Emailadresse</para>
4113 <term><varname>fax</varname></term>
4116 <para>Faxnummer</para>
4121 <term><varname>gln</varname></term>
4124 <para>GLN (Globale Lokationsnummer)</para>
4129 <term><varname>greeting</varname></term>
4137 <term><varname>homepage</varname></term>
4140 <para>Homepage</para>
4145 <term><varname>iban</varname></term>
4148 <para>Internationale Kontonummer (International Bank Account
4149 Number, IBAN)</para>
4154 <term><varname>language</varname></term>
4157 <para>Sprache</para>
4162 <term><varname>name</varname></term>
4165 <para>Firmenname</para>
4170 <term><varname>payment_description</varname></term>
4173 <para>Name der Zahlart</para>
4178 <term><varname>payment_terms</varname></term>
4181 <para>Zahlungskonditionen</para>
4186 <term><varname>phone</varname></term>
4189 <para>Telefonnummer</para>
4194 <term><varname>shiptocity</varname></term>
4197 <para>Stadt (Lieferadresse) <link
4198 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4203 <term><varname>shiptocontact</varname></term>
4206 <para>Kontakt (Lieferadresse) <link
4207 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4212 <term><varname>shiptocountry</varname></term>
4215 <para>Land (Lieferadresse) <link
4216 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4221 <term><varname>shiptodepartment_1</varname></term>
4224 <para>Abteilung 1 (Lieferadresse) <link
4225 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4230 <term><varname>shiptodepartment_2</varname></term>
4233 <para>Abteilung 2 (Lieferadresse) <link
4234 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4239 <term><varname>shiptoemail</varname></term>
4242 <para>Email (Lieferadresse) <link
4243 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4248 <term><varname>shiptofax</varname></term>
4251 <para>Fax (Lieferadresse) <link
4252 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4257 <term><varname>shiptogln</varname></term>
4260 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4261 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4266 <term><varname>shiptoname</varname></term>
4269 <para>Firmenname (Lieferadresse) <link
4270 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4275 <term><varname>shiptophone</varname></term>
4278 <para>Telefonnummer (Lieferadresse) <link
4279 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4284 <term><varname>shiptostreet</varname></term>
4287 <para>Straße und Hausnummer (Lieferadresse) <link
4288 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4293 <term><varname>shiptozipcode</varname></term>
4296 <para>Postleitzahl (Lieferadresse) <link
4297 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4302 <term><varname>street</varname></term>
4305 <para>Straße und Hausnummer</para>
4310 <term><varname>taxnumber</varname></term>
4313 <para>Steuernummer</para>
4318 <term><varname>ustid</varname></term>
4321 <para>Umsatzsteuer-Identifikationsnummer</para>
4326 <term><varname>vendoremail</varname></term>
4329 <para>Email des Lieferanten; nur für Lieferanten</para>
4334 <term><varname>vendorfax</varname></term>
4337 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4342 <term><varname>vendornotes</varname></term>
4345 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4350 <term><varname>vendornumber</varname></term>
4353 <para>Lieferantennummer; nur für Lieferanten</para>
4358 <term><varname>vendorphone</varname></term>
4361 <para>Telefonnummer des Lieferanten; nur für
4367 <term><varname>zipcode</varname></term>
4370 <para>Postleitzahl</para>
4375 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4376 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4377 Stammdaten nicht eingetragen, so haben die Variablen
4378 <varname>shipto*</varname> den gleichen Wert wie die die
4379 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4380 einige <varname>shipto*</varname>-Variablen so nicht in den
4381 Stammdaten wiederfinden sondern schlicht Kopien der
4382 Lieferdatenvariablen sind (z.B.
4383 <varname>shiptocontact</varname>).</para>
4387 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4388 <title>Informationen über den Bearbeiter</title>
4392 <term><varname>employee_address</varname></term>
4395 <para>Adressfeld</para>
4400 <term><varname>employee_businessnumber</varname></term>
4403 <para>Firmennummer</para>
4408 <term><varname>employee_company</varname></term>
4411 <para>Firmenname</para>
4416 <term><varname>employee_co_ustid</varname></term>
4419 <para>Usatzsteuer-Identifikationsnummer</para>
4424 <term><varname>employee_duns</varname></term>
4427 <para>DUNS-Nummer</para>
4432 <term><varname>employee_email</varname></term>
4440 <term><varname>employee_fax</varname></term>
4448 <term><varname>employee_name</varname></term>
4451 <para>voller Name</para>
4456 <term><varname>employee_signature</varname></term>
4459 <para>Signatur</para>
4464 <term><varname>employee_taxnumber</varname></term>
4467 <para>Steuernummer</para>
4472 <term><varname>employee_tel</varname></term>
4475 <para>Telefonnummer</para>
4481 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4482 <title>Informationen über den Verkäufer</title>
4486 <term><varname>salesman_address</varname></term>
4489 <para>Adressfeld</para>
4494 <term><varname>salesman_businessnumber</varname></term>
4497 <para>Firmennummer</para>
4502 <term><varname>salesman_company</varname></term>
4505 <para>Firmenname</para>
4510 <term><varname>salesman_co_ustid</varname></term>
4513 <para>Usatzsteuer-Identifikationsnummer</para>
4518 <term><varname>salesman_duns</varname></term>
4521 <para>DUNS-Nummer</para>
4526 <term><varname>salesman_email</varname></term>
4534 <term><varname>salesman_fax</varname></term>
4542 <term><varname>salesman_name</varname></term>
4545 <para>voller Name</para>
4550 <term><varname>salesman_signature</varname></term>
4553 <para>Signatur</para>
4558 <term><varname>salesman_taxnumber</varname></term>
4561 <para>Steuernummer</para>
4566 <term><varname>salesman_tel</varname></term>
4569 <para>Telefonnummer</para>
4575 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
4576 <title>Variablen für die einzelnen Steuern</title>
4580 <term><varname>tax</varname></term>
4588 <term><varname>taxbase</varname></term>
4591 <para>zu versteuernder Betrag</para>
4596 <term><varname>taxdescription</varname></term>
4599 <para>Name der Steuer</para>
4604 <term><varname>taxrate</varname></term>
4607 <para>Steuersatz</para>
4613 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
4614 <title>Variablen für Lieferbedingungen</title>
4618 <term><varname>delivery_term</varname></term>
4621 <para>Datenbank-Objekt der Lieferbedingung</para>
4626 <term><varname>delivery_term.description</varname></term>
4629 <para>Beschreibung der Lieferbedingung</para>
4634 <term><varname>delivery_term.description_long</varname></term>
4637 <para>Langtext bzw. übersetzter Langtext der
4638 Lieferbedingung</para>
4645 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
4646 <title>Variablen in Rechnungen</title>
4648 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
4649 <title>Allgemeine Variablen</title>
4653 <term><varname>creditremaining</varname></term>
4656 <para>Verbleibender Kredit</para>
4661 <term><varname>currency</varname></term>
4664 <para>Währung</para>
4669 <term><varname>cusordnumber</varname></term>
4672 <para>Bestellnummer beim Kunden</para>
4677 <term><varname>deliverydate</varname></term>
4680 <para>Lieferdatum</para>
4685 <term><varname>duedate</varname></term>
4688 <para>Fälligkeitsdatum</para>
4693 <term><varname>globalprojectnumber</varname></term>
4696 <para>Projektnummer des ganzen Beleges</para>
4701 <term><varname>globalprojectdescription</varname></term>
4704 <para>Projekbeschreibung des ganzen Beleges</para>
4709 <term><varname>intnotes</varname></term>
4712 <para>Interne Bemerkungen</para>
4717 <term><varname>invdate</varname></term>
4720 <para>Rechnungsdatum</para>
4725 <term><varname>invnumber</varname></term>
4728 <para>Rechnungsnummer</para>
4733 <term><varname>invtotal</varname></term>
4736 <para>gesamter Rechnungsbetrag</para>
4741 <term><varname>notes</varname></term>
4744 <para>Bemerkungen der Rechnung</para>
4749 <term><varname>orddate</varname></term>
4752 <para>Auftragsdatum</para>
4757 <term><varname>ordnumber</varname></term>
4760 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
4761 erstellt wurde</para>
4766 <term><varname>payment_description</varname></term>
4769 <para>Name der Zahlart</para>
4774 <term><varname>payment_terms</varname></term>
4777 <para>Zahlungskonditionen</para>
4782 <term><varname>quodate</varname></term>
4785 <para>Angebotsdatum</para>
4790 <term><varname>quonumber</varname></term>
4793 <para>Angebotsnummer</para>
4798 <term><varname>rounding</varname></term>
4801 <para>Betrag, um den <varname>invtotal</varname> gerundet wurde
4802 (kann positiv oder negativ sein)</para>
4807 <term><varname>shippingpoint</varname></term>
4810 <para>Versandort</para>
4815 <term><varname>shipvia</varname></term>
4818 <para>Transportmittel</para>
4823 <term><varname>subtotal</varname></term>
4826 <para>Zwischensumme aller Posten ohne Steuern</para>
4831 <term><varname>total</varname></term>
4834 <para>Restsumme der Rechnung (Summe abzüglich bereits
4835 bezahlter Posten)</para>
4840 <term><varname>transaction_description</varname></term>
4843 <para>Vorgangsbezeichnung</para>
4848 <term><varname>transdate</varname></term>
4851 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
4852 erstellt wurde</para>
4858 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
4859 <title>Variablen für jeden Posten auf der Rechnung</title>
4863 <term><varname>bin</varname></term>
4866 <para>Stellage</para>
4871 <term><varname>description</varname></term>
4874 <para>Artikelbeschreibung</para>
4879 <term><varname>cusordnumber_oe</varname></term>
4882 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
4883 Posten ursprünglich stammt (nur Verkauf)</para>
4888 <term><varname>discount</varname></term>
4891 <para>Rabatt als Betrag</para>
4896 <term><varname>discount_sub</varname></term>
4899 <para>Zwischensumme mit Rabatt</para>
4904 <term><varname>donumber_do</varname></term>
4907 <para>Lieferscheinnummer des Lieferscheins, aus dem die
4908 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
4909 Workflows aus einem Lieferschein erstellt wurde.</para>
4914 <term><varname>drawing</varname></term>
4917 <para>Zeichnung</para>
4922 <term><varname>ean</varname></term>
4925 <para>EAN-Code</para>
4930 <term><varname>image</varname></term>
4938 <term><varname>linetotal</varname></term>
4941 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
4946 <term><varname>longdescription</varname></term>
4949 <para>Langtext</para>
4954 <term><varname>microfiche</varname></term>
4957 <para>Mikrofilm</para>
4962 <term><varname>netprice</varname></term>
4965 <para>Alternative zu <varname>sellprice</varname>, aber
4966 <varname>netprice</varname> entspricht dem effektiven
4967 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
4968 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
4969 / Menge. Diese Variable ist nützlich, wenn man den gewährten
4970 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
4971 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
4972 <varname>netprice</varname> hat nichts mit Netto/Brutto im
4973 Sinne von Steuern zu tun.</para>
4978 <term><varname>nodiscount_linetotal</varname></term>
4981 <para>Zeilensumme ohne Rabatt</para>
4986 <term><varname>nodiscount_sub</varname></term>
4989 <para>Zwischensumme ohne Rabatt</para>
4994 <term><varname>number</varname></term>
4997 <para>Artikelnummer</para>
5002 <term><varname>ordnumber_oe</varname></term>
5005 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5006 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5007 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5008 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5009 letzterem Fall wird die unsprüngliche Auftragsnummer
5015 <term><varname>p_discount</varname></term>
5018 <para>Rabatt in Prozent</para>
5023 <term><varname>partnotes</varname></term>
5026 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5031 <term><varname>partsgroup</varname></term>
5034 <para>Warengruppe</para>
5039 <term><varname>price_factor</varname></term>
5042 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5048 <term><varname>price_factor_name</varname></term>
5051 <para>Der Name des Preisfaktors, sofern einer eingestellt
5057 <term><varname>projectnumber</varname></term>
5060 <para>Projektnummer</para>
5065 <term><varname>projectdescription</varname></term>
5068 <para>Projektbeschreibung</para>
5073 <term><varname>qty</varname></term>
5081 <term><varname>reqdate</varname></term>
5084 <para>Lieferdatum</para>
5089 <term><varname>runningnumber</varname></term>
5092 <para>Position auf der Rechnung (1, 2, 3...)</para>
5097 <term><varname>sellprice</varname></term>
5100 <para>Verkaufspreis</para>
5105 <term><varname>serialnumber</varname></term>
5108 <para>Seriennummer</para>
5113 <term><varname>tax_rate</varname></term>
5116 <para>Steuersatz</para>
5121 <term><varname>transdate_do</varname></term>
5124 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5125 Workflows aus einem Lieferschein stammte.</para>
5130 <term><varname>transdate_oe</varname></term>
5133 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5134 Workflows aus einem Auftrag erstellt wurde. Wenn es
5135 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5141 <term><varname>transdate_quo</varname></term>
5144 <para>Datum des Angebots, wenn die Position im Rahmen des
5145 Workflows aus einem Angebot stammte.</para>
5150 <term><varname>unit</varname></term>
5153 <para>Einheit</para>
5158 <term><varname>weight</varname></term>
5161 <para>Gewicht</para>
5166 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5167 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5168 einer <function>foreach</function>-Schleife ausgegeben werden, da
5169 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5170 können. Die Variablen dafür lauten:</para>
5174 <term><varname>make</varname></term>
5177 <para>Lieferant</para>
5182 <term><varname>model</varname></term>
5185 <para>Lieferantenartikelnummer</para>
5191 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5192 <title>Variablen für die einzelnen Zahlungseingänge</title>
5196 <term><varname>payment</varname></term>
5204 <term><varname>paymentaccount</varname></term>
5212 <term><varname>paymentdate</varname></term>
5220 <term><varname>paymentmemo</varname></term>
5228 <term><varname>paymentsource</varname></term>
5237 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5238 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5240 <para>Die vom Benutzer definierten Variablen für Kunden und
5241 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5242 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5243 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5244 Variablennamen zusammen.</para>
5246 <para>Beispiel: Der Benutzer hat eine Variable namens
5247 <varname>number_of_employees</varname> definiert, die die Anzahl der
5248 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5249 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5252 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5253 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5254 Präfix <varname>shiptocvar_</varname>.</para>
5258 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5259 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5261 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5262 <title>Namen der Vorlagen</title>
5264 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5265 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5266 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5267 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5268 Vorlagenname für diese Mahnstufe mit dem Zusatz
5269 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5270 für die ausgewählte Sprache und den ausgewählten Drucker
5274 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5275 <title>Allgemeine Variablen in Mahnungen</title>
5277 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5278 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5279 Kunden stehen als Variablen <varname>name</varname>,
5280 <varname>street</varname>, <varname>zipcode</varname>,
5281 <varname>city</varname>, <varname>country</varname>,
5282 <varname>department_1</varname>, <varname>department_2</varname>,
5283 und <varname>email</varname> zur Verfügung.</para>
5285 <para>Weitere Variablen beinhalten:</para>
5289 <term><varname>dunning_date</varname></term>
5292 <para>Datum der Mahnung</para>
5297 <term><varname>dunning_duedate</varname></term>
5300 <para>Fälligkeitsdatum für diese Mahhnung</para>
5305 <term><varname>dunning_id</varname></term>
5308 <para>Mahnungsnummer</para>
5313 <term><varname>fee</varname></term>
5316 <para>Kumulative Mahngebühren</para>
5321 <term><varname>interest_rate</varname></term>
5324 <para>Zinssatz per anno in Prozent</para>
5329 <term><varname>total_amount</varname></term>
5332 <para>Gesamter noch zu zahlender Betrag als
5333 <function>fee</function> + <function>total_interest</function>
5334 + <function>total_open_amount</function></para>
5339 <term><varname>total_interest</varname></term>
5342 <para>Zinsen per anno über alle Rechnungen</para>
5347 <term><varname>total_open_amount</varname></term>
5350 <para>Summe über alle offene Beträge der Rechnungen</para>
5356 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5357 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5361 <term><varname>dn_amount</varname></term>
5364 <para>Rechnungssumme (brutto)</para>
5369 <term><varname>dn_duedate</varname></term>
5372 <para>Originales Fälligkeitsdatum der Rechnung</para>
5377 <term><varname>dn_dunning_date</varname></term>
5380 <para>Datum der Mahnung</para>
5385 <term><varname>dn_dunning_duedate</varname></term>
5388 <para>Fälligkeitsdatum der Mahnung</para>
5393 <term><varname>dn_fee</varname></term>
5396 <para>Kummulative Mahngebühr</para>
5401 <term><varname>dn_interest</varname></term>
5404 <para>Zinsen per anno für diese Rechnung</para>
5409 <term><varname>dn_invnumber</varname></term>
5412 <para>Rechnungsnummer</para>
5417 <term><varname>dn_linetotal</varname></term>
5420 <para>Noch zu zahlender Betrag (ergibt sich aus
5421 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5422 + <varname>dn_interest</varname>)</para>
5427 <term><varname>dn_netamount</varname></term>
5430 <para>Rechnungssumme (netto)</para>
5435 <term><varname>dn_open_amount</varname></term>
5438 <para>Offener Rechnungsbetrag</para>
5443 <term><varname>dn_ordnumber</varname></term>
5446 <para>Bestellnummer</para>
5451 <term><varname>dn_transdate</varname></term>
5454 <para>Rechnungsdatum</para>
5459 <term><varname>dn_curr</varname></term>
5462 <para>Währung, in der die Rechnung erstellt wurde. (Die
5463 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5469 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5470 <title>Variablen in automatisch erzeugten Rechnungen über
5471 Mahngebühren</title>
5473 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5474 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5475 Kunden stehen als Variablen <varname>name</varname>,
5476 <varname>street</varname>, <varname>zipcode</varname>,
5477 <varname>city</varname>, <varname>country</varname>,
5478 <varname>department_1</varname>, <varname>department_2</varname>,
5479 und <varname>email</varname> zur Verfügung.</para>
5481 <para>Weitere Variablen beinhalten:</para>
5485 <term><varname>duedate</varname></term>
5488 <para>Fälligkeitsdatum der Rechnung</para>
5493 <term><varname>dunning_id</varname></term>
5496 <para>Mahnungsnummer</para>
5501 <term><varname>fee</varname></term>
5504 <para>Mahngebühren</para>
5509 <term><varname>interest</varname></term>
5517 <term><varname>invamount</varname></term>
5520 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
5521 <varname>interest</varname>)</para>
5526 <term><varname>invdate</varname></term>
5529 <para>Rechnungsdatum</para>
5534 <term><varname>invnumber</varname></term>
5537 <para>Rechnungsnummer</para>
5544 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
5545 <title>Variablen in anderen Vorlagen</title>
5548 <title>Einführung</title>
5550 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
5551 Rechnung. Allerdings heißen die Variablen, die mit
5552 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
5553 fangen sie mit <varname>quo</varname> für "quotation" an:
5554 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
5555 wiederum fangen sie mit <varname>ord</varname> für "order" an:
5556 <varname>ordnumber</varname> für Bestellnummer etc.</para>
5558 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
5559 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
5560 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
5561 Vorlage keine Bedeutung haben oder noch nicht belegt sein
5564 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
5565 in Rechnungen aufgeführt.</para>
5568 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
5569 <title>Angebote und Preisanfragen</title>
5573 <term><varname>quonumber</varname></term>
5576 <para>Angebots- bzw. Anfragenummer</para>
5581 <term><varname>reqdate</varname></term>
5584 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
5585 Preisanfragen)</para>
5590 <term><varname>transdate</varname></term>
5593 <para>Angebots- bzw. Anfragedatum</para>
5599 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
5600 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
5604 <term><varname>ordnumber</varname></term>
5607 <para>Auftragsnummer</para>
5612 <term><varname>reqdate</varname></term>
5615 <para>Lieferdatum</para>
5620 <term><varname>transdate</varname></term>
5623 <para>Auftragsdatum</para>
5629 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
5630 <title>Lieferscheine (Verkauf und Einkauf)</title>
5634 <term><varname>cusordnumber</varname></term>
5637 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
5638 des Lieferanten (im Einkauf)</para>
5643 <term><varname>donumber</varname></term>
5646 <para>Lieferscheinnummer</para>
5651 <term><varname>transdate</varname></term>
5654 <para>Lieferscheindatum</para>
5659 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
5660 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
5661 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
5662 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
5663 <function>foreach</function>-Schleife ausgegeben werden. Diese
5664 Variablen sind:</para>
5668 <term><varname>si_bin</varname></term>
5671 <para>Lagerplatz</para>
5676 <term><varname>si_chargenumber</varname></term>
5679 <para>Chargennummer</para>
5684 <term><varname>si_bestbefore</varname></term>
5687 <para>Mindesthaltbarkeit</para>
5692 <term><varname>si_number</varname></term>
5695 <para>Artikelnummer</para>
5700 <term><varname>si_qty</varname></term>
5703 <para>Anzahl bzw. Menge</para>
5708 <term><varname>si_runningnumber</varname></term>
5711 <para>Positionsnummer (1, 2, 3 etc)</para>
5716 <term><varname>si_unit</varname></term>
5719 <para>Einheit</para>
5724 <term><varname>si_warehouse</varname></term>
5733 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
5734 <title>Variablen für Sammelrechnung</title>
5738 <term><varname>c0total</varname></term>
5741 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
5747 <term><varname>c30total</varname></term>
5750 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
5751 und < 60 Tage</para>
5756 <term><varname>c60total</varname></term>
5759 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
5760 und < 90 Tage</para>
5765 <term><varname>c90total</varname></term>
5768 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
5774 <term><varname>total</varname></term>
5777 <para>Gesamtbetrag aller Rechnungen</para>
5782 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
5786 <term><varname>invnumber</varname></term>
5789 <para>Rechnungsnummer</para>
5794 <term><varname>invdate</varname></term>
5797 <para>Rechnungsdatum</para>
5802 <term><varname>duedate</varname></term>
5805 <para>Fälligkeitsdatum</para>
5810 <term><varname>amount</varname></term>
5813 <para>Summe der Rechnung</para>
5818 <term><varname>open</varname></term>
5821 <para>Noch offener Betrag der Rechnung</para>
5826 <term><varname>c0</varname></term>
5829 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
5835 <term><varname>c30</varname></term>
5838 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
5844 <term><varname>c60</varname></term>
5847 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
5853 <term><varname>c90</varname></term>
5856 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
5864 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
5865 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
5867 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
5868 <title>Einführung</title>
5870 <para>Der Parser kennt neben den Variablen einige weitere
5871 Konstrukte, die gesondert behandelt werden. Diese sind wie
5872 Variablennamen in spezieller Weise markiert:
5873 <command><%anweisung%> ... <%end%></command></para>
5875 <para>Anmerkung zum <command><%end%></command>: Der besseren
5876 Verständlichkeit halber kann man nach dem <command>end</command>
5877 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
5878 Anweisung (z.B. <command>if</command> oder
5879 <command>foreach</command>) damit abgeschlossen wird.</para>
5881 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
5882 <command><%if type == "sales_quotation"%></command>, so könnte
5883 er mit <command><%end%></command> genauso abgeschlossen werden
5884 wie mit <command><%end if%></command> oder auch
5885 <command><%end type == "sales_quotation"%></command>.</para>
5888 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
5889 <title>Der if-Block</title>
5891 <programlisting><%if variablenname%>
5893 <%end%></programlisting>
5895 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
5896 und dem "end" werden nur ausgegeben, wenn die Variable
5897 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
5899 <para>Handelt es sich bei der benannten Variable um ein Array, also
5900 um einen Variablennamen, über den man mit <command><%foreach
5901 variablenname%></command> iteriert, so wird mit diesem Konstrukt
5902 darauf getestet, ob das Array Elemente enthält. Somit würde im
5903 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
5904 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
5905 welche getätigt wurden:</para>
5907 <programlisting><%if payment%>
5909 <%foreach payment%>
5910 Am <%paymentdate%>: <%payment%> €
5911 <%end foreach%>
5912 <%end if%></programlisting>
5914 <para>Die Bedingung kann auch negiert werden, indem das Wort
5915 <function>not</function> nach dem <filename>if</filename> verwendet
5916 wird. Beispiel:</para>
5918 <programlisting><%if not cp_greeting%>
5920 <%end%></programlisting>
5922 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
5923 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
5924 einer Variablen mit einer festen Zeichenkette oder einer anderen
5925 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
5926 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
5927 die rechte Seite des Vergleichsoperators in Anführungszeichen
5928 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
5929 anderer Variablen). Zwei Beispiele, die beide Vergleiche
5932 <programlisting><%if var1 == "Wert"%></programlisting>
5934 <para>Testet die Variable <varname>var1</varname> auf
5935 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
5936 Mittels <function>!=</function> anstelle von <function>==</function>
5937 würde auf Ungleichheit getestet.</para>
5939 <programlisting><%if var1 == var2%></programlisting>
5941 <para>Testet die Variable <varname>var1</varname> auf
5942 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
5943 <function>!=</function> anstelle von <function>==</function> würde
5944 auf Ungleichheit getestet.</para>
5946 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
5947 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
5948 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
5949 dieselbe Syntax wie oben nur mit <function>=~</function> und
5950 <function>!~</function> als Vergleichsoperatoren.</para>
5952 <para>Beispiel für einen Test, ob die Variable
5953 <varname>intnotes</varname> (interne Bemerkungen) das Wort
5954 <constant>schwierig</constant> enthält:</para>
5956 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
5959 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
5960 <title>Der foreach-Block</title>
5962 <programlisting><%foreach variablenname%>
5964 <%end%></programlisting>
5966 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
5967 wie das Perl-Array der Variablen <varname>variablenname</varname>
5968 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
5969 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
5970 benutzt. In jedem Durchlauf werden die <link
5971 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
5972 Variablen</link> jeweils auf den Wert für die aktuelle Position
5975 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
5977 <programlisting><%foreach number%>
5978 Position: <%runningnumber%>
5979 Anzahl: <%qty%>
5980 Artikelnummer: <%number%>
5981 Beschreibung: <%description%>
5983 <%end%></programlisting>
5985 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
5986 <function><%foreach%></function>-Block innerhalb einer
5987 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
5988 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
5989 Inhalt zwischen <function><%foreach%></function> und
5990 <function><%end%></function> wiederholt, nicht aber die
5991 komplette Zeile, in der er steht.</para>
5995 <sect2 id="dokumentenvorlagen-und-variablen.markup">
5996 <title>Markup-Code zur Textformatierung innerhalb von
5999 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6000 anders formatiert haben möchte, so ist dies begrenzt möglich.
6001 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6002 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6003 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6004 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6005 (HTML oder PDF über LaTeX) umgesetzt.</para>
6007 <para>Die unterstützen Formatierungen sind:</para>
6011 <term><b>Text</b></term>
6014 <para>Text wird in Fettdruck gesetzt.</para>
6019 <term><i>Text</i></term>
6022 <para>Text wird kursiv gesetzt.</para>
6027 <term><u>Text</u></term>
6030 <para>Text wird unterstrichen.</para>
6035 <term><s>Text</s></term>
6038 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6039 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6044 <term><bullet></term>
6047 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6053 <para>Der Befehl <command><bullet></command> funktioniert
6054 momentan auch nur in Latex-Vorlagen.</para>
6058 <sect1 id="excel-templates">
6059 <title>Excel-Vorlagen</title>
6061 <sect2 id="excel-templates.summary">
6062 <title>Zusammenfassung</title>
6064 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6065 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6069 <sect2 id="excel-templates.usage">
6070 <title>Bedienung</title>
6072 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6073 werden. Die Konfigurationsoption heißt <varname>excel_templates =
6074 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6076 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6077 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6078 werden. In den normalen Verkaufsmasken taucht nun
6079 <constant>Excel</constant> als auswählbares Format auf und kann von da
6080 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6082 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6083 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6084 <filename>sales_quotation.xls</filename> gespeichert.</para>
6087 <sect2 id="excel-templates.syntax">
6088 <title>Variablensyntax</title>
6090 <para>Einfache Syntax:
6091 <command><<varname>></command></para>
6093 <para>Dabei sind <constant><<</constant> und
6094 <constant>>></constant> die Delimiter. Da Excel auf festen
6095 Breiten besteht, kann der Tag künstlich verlängert werden, indem
6096 weitere <constant><</constant> oder <constant>></constant>
6097 eingefügt werden. Der Tag muss nicht symmetrisch sein.
6100 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6102 <para>Um die Limitierung der festen Breite zu reduzieren, können
6103 weitere Variablen in einem Block interpoliert werden. Whitespace wird
6104 dazwishen dann erhalten. Beispiel:</para>
6106 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6108 <para>Die Variablen werden interpoliert, und linksbündig mit
6109 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6110 lang, werden überzählige Zeichen abgeschnitten.</para>
6112 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6113 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6115 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6117 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6118 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6122 <sect2 id="excel-templates.limitations">
6123 <title>Einschränkungen</title>
6125 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6126 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6127 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6128 Text zu ersetzen.</para>
6130 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6131 <command><%if%></command> und
6132 <command><%foreach%></command> nicht vorhanden. Der Delimiter
6133 <constant><% %></constant> kommt in den Headerinformationen
6134 evtl. vor. Deshalb wurde auf den sichereren Delimiter
6135 <constant><<</constant> und <constant>>></constant>
6140 <sect1 id="features.warehouse">
6143 <title>Mandantenkonfiguration Lager</title>
6146 Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6147 Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. Ferner kann jede Position eines Lieferscheins
6148 ein-, bzw. ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele Lager mit beliebig vielen Lagerplätzen abgebildet
6149 werden. Die Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder Einzelposition und das Auswählen dieser Position zu
6150 einem Lager mit Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je nachdem wie die Einstellungen in der
6151 Mandatenkonfiguration gesetzt werden.
6156 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6157 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6158 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6159 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6163 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6164 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6165 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6166 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6167 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6168 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6173 Zusätzliche Funktionshinweise:
6178 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6179 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6180 Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6184 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6185 Stammdaten definiert</option> Wird beim 'Auslagern über
6186 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6187 so wird mit dieser Option einfach der Standardlagerplatz
6195 <sect1 id="features.swiss-charts-of-accounts">
6196 <title>Schweizer Kontenpläne</title>
6198 <para>Seit der Version 3.4.1 stehen in kivitendo 2 Kontenpläne für
6199 den Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6200 Organisationen, die nicht mehrwertsteuerpflichtig sind, und einer
6201 für Firmen, die mehrwertsteuerpflichtig sind.</para>
6203 <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6204 verwendeten KMU-Kontenrahmen und sind mit der Revision des Schweizerischen
6205 Obligationenrechts (OR) vom 1.1.2013 kompatibel, insbesondere
6206 <literal>Art.957a Abs.2</literal>.</para>
6208 <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der aktuellen
6209 Version von kivitendo noch nicht integriert.</para>
6211 <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6212 Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6213 Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen
6214 alle Aufwandskonten editiert werden und dort der Steuersatz auf 0%
6215 gesetzt werden.</para>
6217 <para>So werden bei Kreditorenbuchungen keine Vorsteuern verbucht.</para>
6219 <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6220 Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne
6221 bitte an <literal>empfang@revamp-it.ch</literal> senden.</para>
6226 <title>Entwicklerdokumentation</title>
6228 <sect1 id="devel.globals" xreflabel="Globale Variablen">
6229 <title>Globale Variablen</title>
6232 <title>Wie sehen globale Variablen in Perl aus?</title>
6234 <para>Globale Variablen liegen in einem speziellen namespace namens
6235 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
6236 globs global und die meisten speziellen Variablen sind...
6239 <para>Daraus ergeben sich folgende Formen:</para>
6243 <term><literal>$main::form</literal></term>
6246 <para>expliziter Namespace "main"</para>
6251 <term><literal>$::form</literal></term>
6254 <para>impliziter Namespace "main"</para>
6259 <term><literal>open FILE, "file.txt"</literal></term>
6262 <para><varname>FILE</varname> ist global</para>
6267 <term><literal>$_</literal></term>
6270 <para>speziell</para>
6275 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
6276 Schlüsselwort wie "<function>global</function>", mit dem man
6277 importieren kann. <function>my</function>, <function>our</function>
6278 und <function>local</function> machen was anderes.</para>
6282 <term><literal>my $form</literal></term>
6285 <para>lexikalische Variable, gültig bis zum Ende des
6291 <term><literal>our $form</literal></term>
6294 <para><varname>$form</varname> referenziert ab hier
6295 <varname>$PACKAGE::form</varname>.</para>
6300 <term><literal>local $form</literal></term>
6303 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
6304 des scopes zurückgesetzt</para>
6311 <title>Warum sind globale Variablen ein Problem?</title>
6313 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
6315 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
6316 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
6317 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
6318 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
6319 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
6320 Datenbankverbindungen, weil die sehr lange zum Initialisieren
6323 <para>Das zweite Problem ist <function>strict</function>. Unter
6324 <function>strict</function> werden alle Variablen die nicht explizit
6325 mit <function>Package</function>, <function>my</function> oder
6326 <function>our</function> angegeben werden als Tippfehler angemarkert,
6327 dies hat, seit der Einführung, u.a. schon so manche langwierige
6328 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
6329 angegeben werden, werden die nicht geprüft, und somit kann sich
6330 schnell ein Tippfehler einschleichen.</para>
6334 <title>Kanonische globale Variablen</title>
6336 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
6337 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
6338 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
6339 umhergereicht werden.</para>
6341 <para>Diese Variablen sind im Moment die folgenden neun:</para>
6345 <para><varname>$::form</varname></para>
6349 <para><varname>%::myconfig</varname></para>
6353 <para><varname>$::locale</varname></para>
6357 <para><varname>$::lxdebug</varname></para>
6361 <para><varname>$::auth</varname></para>
6365 <para><varname>$::lx_office_conf</varname></para>
6369 <para><varname>$::instance_conf</varname></para>
6373 <para><varname>$::dispatcher</varname></para>
6377 <para><varname>$::request</varname></para>
6381 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
6382 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
6383 Eigenschaften (Konventionen):</para>
6386 <title>$::form</title>
6390 <para>Ist ein Objekt der Klasse
6391 "<classname>Form</classname>"</para>
6395 <para>Wird nach jedem Request gelöscht</para>
6399 <para>Muss auch in Tests und Konsolenscripts vorhanden
6404 <para>Enthält am Anfang eines Requests die Requestparameter vom
6409 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
6410 cachen, das wird aber momentan absichtlich zerstört</para>
6414 <para><varname>$::form</varname> wurde unter <productname>SQL
6415 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
6416 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
6417 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
6418 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
6419 <function>IS->retrieve_customer()</function> in Sicherheit
6422 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
6423 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
6424 3552, Stand version 2.7beta), um dies hinterher wieder auf den
6425 richtigen Wert zu setzen:</para>
6427 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
6428 $::myconfig{numberformat} = $numberformat;
6429 # (...) div Berechnungen
6430 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
6432 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
6433 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
6434 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
6435 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
6436 Es geht ziemlich sicher etwas kaputt.</para>
6438 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
6439 in den <productname>Template::Toolkit</productname> Templates
6440 außerhalb der Controller: der Ausdruck <function>[% var
6441 %]</function> greift auf <varname>$::form->{var}</varname> zu.
6442 Unter Controllern ist der Standard Scope anders, da lautet der
6443 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
6444 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
6445 <function><%var%></function> zeigt auf
6446 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
6447 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
6450 <programlisting>[%- IF business %]
6451 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
6452 [%- END %]</programlisting>
6454 <para>Entweder wird hier dann $::form->{business} ausgewertet
6455 oder aber der Funktion
6456 <function>$form->parse_html_template</function> wird explizit
6457 noch ein zusätzlicher Hash übergeben, der dann auch in den
6458 (Web-)Templates zu Verfügung steht, bspw. so:</para>
6460 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
6462 <para>Innerhalb von Schleifen wird
6463 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
6464 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
6465 welches über alle Positionen eines Lieferscheins in Schleife
6468 <programlisting>for $i (1 .. $form->{rowcount}) {
6470 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
6471 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
6472 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
6478 <title>%::myconfig</title>
6482 <para>Das einzige Hash unter den globalen Variablen</para>
6486 <para>Wird spätestens benötigt wenn auf die Datenbank
6487 zugegriffen wird</para>
6491 <para>Wird bei jedem Request neu erstellt.</para>
6495 <para>Enthält die Userdaten des aktuellen Logins</para>
6499 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
6500 extern serialisiert werden, weil da auch der Datenbankzugriff
6501 für diesen user drinsteht.</para>
6505 <para>Enthält unter anderem Listenbegrenzung vclimit,
6506 Datumsformat dateformat und Nummernformat numberformat</para>
6510 <para>Enthält Datenbankzugriffinformationen</para>
6514 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
6515 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
6516 aktuellen Users entscheiden müssen, befragen
6517 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
6518 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
6519 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
6520 Informationen über den Benutzer die über die
6521 Administrator-Schnittstelle eingegeben wurden.</para>
6525 <title>$::locale</title>
6529 <para>Objekt der Klasse "Locale"</para>
6533 <para>Wird pro Request erstellt</para>
6537 <para>Muss auch für Tests und Scripte immer verfügbar
6542 <para>Cached intern über Requestgrenzen hinweg benutzte
6547 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
6548 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
6552 <title>$::lxdebug</title>
6556 <para>Objekt der Klasse "LXDebug"</para>
6560 <para>Wird global gecached</para>
6564 <para>Muss immer verfügbar sein, in nahezu allen
6569 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
6570 bereit, wie "<function>enter_sub</function>" und
6571 "<function>leave_sub</function>", mit denen in den alten Modulen ein
6572 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
6573 der man die Wallclockzeit seit Requeststart loggen kann, sowie
6574 "<function>message</function>" und "<function>dump</function>" mit
6575 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
6578 <para>Beispielsweise so:</para>
6580 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
6581 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
6585 <title>$::auth</title>
6589 <para>Objekt der Klasse "SL::Auth"</para>
6593 <para>Wird global gecached</para>
6597 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
6601 <para>Wird nach jedem Request resettet.</para>
6605 <para><varname>$::auth</varname> stellt Funktionen bereit um die
6606 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
6607 vom aktuellen User abhängen wird das Objekt aus
6608 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
6609 Request kurz resettet.</para>
6611 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
6612 Dessen Einstellungen können über
6613 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
6614 ist ein Hash mit den Werten aus der Tabelle
6615 <literal>auth.clients</literal>.</para>
6619 <title>$::lx_office_conf</title>
6623 <para>Objekt der Klasse
6624 "<classname>SL::LxOfficeConf</classname>"</para>
6628 <para>Global gecached</para>
6632 <para>Repräsentation der
6633 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
6637 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
6638 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
6639 das Programm die Konfiguration ändern kann oder sollte.</para>
6641 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
6642 Debug- und Trace-Log-Datei wie folgt konfiguriert und
6645 <programlisting>[debug]
6646 file_name = /tmp/kivitendo-debug.log</programlisting>
6648 <para>ist der Key <varname>file</varname> im Programm als
6649 <varname>$::lx_office_conf->{debug}{file}</varname>
6653 <para>Zugriff auf die Konfiguration erfolgt im Moment über
6654 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
6659 <title>$::instance_conf</title>
6663 <para>Objekt der Klasse
6664 "<classname>SL::InstanceConfiguration</classname>"</para>
6668 <para>wird pro Request neu erstellt</para>
6672 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
6673 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
6674 ist hier eine Mandantendatenbank. Beispielsweise überprüft
6675 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
6676 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
6680 <title>$::dispatcher</title>
6684 <para>Objekt der Klasse
6685 "<varname>SL::Dispatcher</varname>"</para>
6689 <para>wird pro Serverprozess erstellt.</para>
6693 <para>enthält Informationen über die technische Verbindung zum
6698 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
6699 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
6700 Objekt untergebracht.</para>
6704 <title>$::request</title>
6708 <para>Hashref (evtl später Objekt)</para>
6712 <para>Wird pro Request neu initialisiert.</para>
6716 <para>Keine Unterstruktur garantiert.</para>
6720 <para><varname>$::request</varname> ist ein generischer Platz um
6721 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
6722 at a distance benutzt werden, sondern um lokales memoizing zu
6723 ermöglichen, das garantiert am Ende des Requests zerstört
6726 <para>Vieles von dem, was im moment in <varname>$::form</varname>
6727 liegt, sollte eigentlich hier liegen. Die groben
6728 Differentialkriterien sind:</para>
6732 <para>Kommt es vom User, und soll unverändert wieder an den
6733 User? Dann <varname>$::form</varname>, steht da eh schon</para>
6737 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
6738 Requests gebraucht werden? Dann
6739 <varname>$::request</varname></para>
6743 <para>Muss ich von anderen Teilen des Programms lesend drauf
6744 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
6745 Wrappermethode</para>
6752 <title>Ehemalige globale Variablen</title>
6754 <para>Die folgenden Variablen waren einmal im Programm, und wurden
6758 <title>$::cgi</title>
6762 <para>war nötig, weil cookie Methoden nicht als
6763 Klassenfunktionen funktionieren</para>
6767 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
6768 Klassennamespace gehalten wird und über Requestgrenzen
6773 <para>liegt jetzt unter
6774 <varname>$::request->{cgi}</varname></para>
6780 <title>$::all_units</title>
6784 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
6785 ein paar hundert mal pro Request eine Liste der Einheiten
6786 brauchen, und de als Parameter durch einen Riesenstack von
6787 Funktionen geschleift werden müssten.</para>
6791 <para>Liegt jetzt unter
6792 <varname>$::request->{cache}{all_units}</varname></para>
6797 <function>AM->retrieve_all_units()</function> gesetzt oder
6804 <title>%::called_subs</title>
6808 <para>wurde benutzt um callsub deep recursions
6813 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
6814 möglichen Rekursioenen darstellt, und da nie welche
6819 <para>komplette recursion protection wurde entfernt.</para>
6826 <sect1 id="devel.fcgi">
6827 <title>Entwicklung unter FastCGI</title>
6829 <sect2 id="devel.fcgi.general">
6830 <title>Allgemeines</title>
6832 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
6833 werden, muss der Webserver neu gestartet werden.</para>
6835 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
6836 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
6837 müssen folgende Aspekte beachtet werden.</para>
6840 <sect2 id="devel.fcgi.exiting">
6841 <title>Programmende und Ausnahmen</title>
6843 <para>Betrifft die Funktionen <function>warn</function>,
6844 <function>die</function>, <function>exit</function>,
6845 <function>carp</function> und <function>confess</function>.</para>
6847 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
6848 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
6849 am Laufen zu halten. Man kann mit <function>die</function>,
6850 <function>confess</function> oder <function>carp</function> Fehler
6851 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
6852 eigene <function>$::form-</function>error()> tut im Prinzip das
6853 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
6854 <function>exit</function> hingegen werden nicht abgefangen.
6855 <function>warn</function> wird direkt nach STDERR, also in Server Log
6856 eine Nachricht schreiben (sofern in der Konfiguration nicht die
6857 Warnungen in das kivitendo Log umgeleitet wurden), und
6858 <function>exit</function> wird die Ausführung beenden.</para>
6860 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
6861 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
6862 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
6863 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
6866 <sect2 id="devel.fcgi.globals">
6867 <title>Globale Variablen</title>
6869 <para>Um zu vermeiden, dass Informationen von einem Request in einen
6870 anderen gelangen, müssen alle globalen Variablen vor einem Request
6871 sauber initialisiert werden. Das ist besonders wichtig im
6872 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
6873 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
6876 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
6877 abgetrennten Block, der alle kanonischen globalen Variablen listet und
6878 erklärt. Bitte keine anderen einführen ohne das sauber zu
6879 dokumentieren.</para>
6881 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
6882 man sicher geht, dass man die richtige erwischt.</para>
6885 <sect2 id="devel.fcgi.performance">
6886 <title>Performance und Statistiken</title>
6888 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
6889 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
6890 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
6891 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
6892 sind es je nach Menge der definierten Variablen 1-2s. Ab der
6893 Moose/Rose::DB Version sind es 5-6s.</para>
6895 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
6896 den kritischen Pfaden, unter 0,15 sonst.</para>
6900 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
6901 <title>SQL-Upgradedateien</title>
6903 <sect2 id="db-upgrade-files.introduction"
6904 xreflabel="Einführung in die Datenbank-Upgradedateien">
6905 <title>Einführung</title>
6907 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
6908 gesteuert, die sich im Verzeichnis
6909 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
6910 muss pro Datenbankupgrade eine Datei existieren, die neben den
6911 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
6912 Kontrollinformationen enthält.</para>
6914 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
6915 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
6916 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
6917 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
6918 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
6919 Versionsnummern braucht.</para>
6921 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
6922 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
6923 führt diese nicht erneut aus. Dazu dient die Tabelle
6924 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
6925 angelegt wird.</para>
6928 <sect2 id="db-upgrade-files.format"
6929 xreflabel="Format der Upgradedateien">
6930 <title>Format der Kontrollinformationen</title>
6932 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
6933 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
6934 hat dabei das folgende Format:</para>
6936 <para>Für SQL-Upgradedateien:</para>
6938 <programlisting>-- @key: value</programlisting>
6940 <para>Für Perl-Upgradedateien:</para>
6942 <programlisting># @key: value</programlisting>
6944 <para>Leerzeichen vor "<varname>value</varname>" werden
6947 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
6951 <term><varname>tag</varname></term>
6954 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
6955 Dieser "tag" kann von anderen Kontrolldateien in ihren
6956 Abhängigkeiten verwendet werden (Schlüsselwort
6957 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
6958 in der Datenbank eingetragen wird.</para>
6960 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
6961 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
6963 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
6964 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
6965 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
6971 <term><varname>charset</varname></term>
6974 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
6975 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
6976 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
6977 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
6978 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
6979 hingegen müssen immer in UTF-8 encodiert sein und sollten
6980 demnach auch ein "<literal>use utf8;</literal>"
6986 <term><varname>description</varname></term>
6989 <para>Benötigt. Eine Beschreibung, was in diesem Update
6990 passiert. Diese wird dem Benutzer beim eigentlichen
6991 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
6992 sein sollte, sollte die Beschreibung auf Deutsch
6998 <term><varname>depends</varname></term>
7001 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
7002 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
7003 dass die in dieser Liste aufgeführten Scripte bereits
7004 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
7006 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
7007 Script "b" existiert, das von Änderungen in "a" abhängt, und
7008 eine neue Kontrolldatei für "c" erstellt wird, die von
7009 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
7010 Tag "b" als Abhängigkeit zu definieren.</para>
7012 <para>Es ist nicht erlaubt, sich selbst referenzierende
7013 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
7014 und "c" -> "a").</para>
7019 <term><varname>priority</varname></term>
7022 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
7023 der Scripte ausgeführt werden, die die gleichen
7024 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
7025 der Wert 1000 benutzt.</para>
7027 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
7028 "depends" benutzt werden. kivitendo sortiert die auszuführenden
7029 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
7030 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
7031 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
7032 dann "y", dann "z"), dann nach der Priorität und bei gleicher
7033 Priorität alphabetisch nach dem "tag".</para>
7038 <term><varname>ignore</varname></term>
7041 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
7042 Skript bei der Anmeldung ignoriert und entsprechend nicht
7049 <sect2 id="db-upgrade-files.format-perl-files"
7050 xreflabel="Format von Perl-Upgradedateien">
7051 <title>Format von in Perl geschriebenen
7052 Datenbankupgradescripten</title>
7054 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
7055 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
7056 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
7058 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
7059 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
7060 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
7061 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
7062 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
7063 aufgerufen wird.</para>
7065 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
7066 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
7067 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
7068 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
7069 "<literal>SL::DBUpgrade2::tag</literal>".</para>
7071 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
7072 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
7073 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
7075 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
7078 <programlisting># @tag: beispiel-upgrade-file42
7079 # @description: Ein schönes Beispielscript
7080 # @depends: release_3_1_0
7081 package SL::DBUpgrade2::beispiel_upgrade_file42;
7086 use parent qw(SL::DBUpgrade2::Base);
7091 # hier Aktionen ausführen
7100 <sect2 id="db-upgrade-files.dbupgrade-tool"
7101 xreflabel="Hilfsscript dbupgrade2_tool.pl">
7102 <title>Hilfsscript dbupgrade2_tool.pl</title>
7104 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
7105 existiert ein Hilfsscript namens
7106 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
7107 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
7108 liest alle Datenbankupgradescripte aus dem Verzeichnis
7109 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
7110 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
7111 von der Kommandozeile überprüft werden können.</para>
7113 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
7114 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
7115 sich aber auch Informationen auf verschiedene Art ausgeben
7120 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
7121 --list</command>"</para>
7123 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
7124 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
7125 würde. Es werden neben der Listenposition der Tag, die
7126 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
7130 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
7131 --tree</command>"</para>
7133 <para>Listet alle Tags in Baumform basierend auf den
7134 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
7135 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
7136 beim übergeordneten Script als Abhängigkeit eingetragen
7140 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
7141 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
7142 --rtree</command>"</para>
7144 <para>Listet alle Tags in Baumform basierend auf den
7145 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
7146 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
7147 die das übergeordnete Script als Abhängigkeit eingetragen
7152 <para>Baumform mit Postscriptausgabe:
7153 "<command>./scripts/dbupgrade2_tool.pl
7154 --graphviz</command>"</para>
7156 <para>Benötigt das Tool "<command>graphviz</command>", um mit
7157 seiner Hilfe die <link
7158 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
7159 Baumform</link> in eine Postscriptdatei namens
7160 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
7161 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
7162 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
7163 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
7168 <para>Scripte, von denen kein anderes Script abhängt:
7169 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
7171 <para>Listet die Tags aller Scripte auf, von denen keine anderen
7172 Scripte abhängen.</para>
7178 <sect1 id="translations-languages" xreflabel="Translations and languages">
7179 <title>Translations and languages</title>
7181 <sect2 id="translations-languages.introduction"
7182 xreflabel="Introduction to translations and languages">
7183 <title>Introduction</title>
7186 <para>Dieser Abschnitt ist in Englisch geschrieben, um
7187 internationalen Übersetzern die Arbeit zu erleichtern.</para>
7190 <para>This section describes how localization packages in kivitendo
7191 are built. Currently the only language fully supported is German, and
7192 since most of the internal messages are held in English the English
7193 version is usable too.</para>
7196 <sect2 id="translations-languages.character-set"
7197 xreflabel="Character set">
7198 <title>Character set</title>
7200 <para>All files included in a language pack must use UTF-8 as their
7204 <sect2 id="translations-languages.file-structure"
7205 xreflabel="File structure">
7206 <title>File structure</title>
7208 <para>The structure of locales in kivitendo is:</para>
7210 <programlisting>kivitendo/locale/<langcode>/</programlisting>
7212 <para>where <langcode> stands for an abbreviation of the
7213 language package. The builtin packages use two letter <ulink
7214 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
7215 but the actual name is not relevant for the program and can easily be
7217 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
7218 tags</ulink> (i.e. "en_GB"). In fact the original language packages
7219 from SQL Ledger are named in this way.</para>
7221 <para>In such a language directory the following files are
7226 <term>LANGUAGE</term>
7229 <para>This file is mandatory.</para>
7231 <para>The <filename>LANGUAGE</filename> file contains the self
7232 descripted name of the language. It should contain a native
7233 representation first, and in parenthesis an english translation
7234 after that. Example:</para>
7236 <programlisting>Deutsch (German)</programlisting>
7244 <para>This file is mandatory.</para>
7246 <para>The central translation file. It is essentially an inline
7247 Perl script autogenerated by <command>locales.pl</command>. To
7248 generate it, generate the directory and the two files mentioned
7249 above, and execute the following command:</para>
7251 <programlisting>scripts/locales.pl <langcode></programlisting>
7253 <para>Otherwise you can simply copy one of the other languages.
7254 You will be told how many are missing like this:</para>
7256 <programlisting>$ scripts/locales.pl en
7257 English - 0.6% - 2015/2028 missing</programlisting>
7259 <para>A file named "<filename>missing</filename>" will be
7260 generated and can be edited. You can also edit the
7261 "<filename>all</filename>" file directly. Edit everything you
7262 like to fit the target language and execute
7263 <command>locales.pl</command> again. See how the missing words
7269 <term>Num2text</term>
7272 <para>Legacy code from SQL Ledger. It provides a means for
7273 numbers to be converted into natural language, like
7274 <literal>1523 => one thousand five hundred twenty
7275 three</literal>. If you want to provide it, it must be inlinable
7276 Perl code which provides a <function>num2text</function> sub. If
7277 an <function>init</function> sub exists it will be executed
7280 <para>Only used in the check and receipt printing module.</para>
7285 <term>special_chars</term>
7288 <para>kivitendo comes with a lot of interfaces to different
7289 formats, some of which are rather picky with their accepted
7290 charset. The <filename>special_chars</filename> file contains a
7291 listing of chars not suited for different file format and
7292 provides substitutions. It is written in "Simple Ini" style,
7293 containing a block for every file format.</para>
7295 <para>First entry should be the order of substitution for
7296 entries as a whitespace separated list. All entries are
7297 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
7298 and <literal>\\</literal> all work.</para>
7300 <para>After that every entry is a special char that should be
7301 translated when writing text into such a file.</para>
7303 <para>Example:</para>
7305 <programlisting>[Template/XML]
7306 order=& < > \n
7310 \n=<br></programlisting>
7312 <para>Note the importance of the order in this example.
7313 Substituting < and > befor & would lead to $gt; become
7316 <para>For a list of valid formats, see the German
7317 <filename>special_chars</filename> entry. As of this writing the
7318 following are recognized:</para>
7320 <programlisting>HTML
7325 Template/OpenDocument
7326 filenames</programlisting>
7328 <para>The last of which is very machine dependant. Remember that
7329 a lot of characters are forbidden by some filesystems, for
7330 example MS Windows doesn't like ':' in its files where Linux
7331 doesn't mind that. If you want the files created with your
7332 language pack to be portable, find all chars that could cause
7338 <term>missing</term>
7341 <para>This file is not a part of the language package
7344 <para>This is a file generated by
7345 <command>scripts/locales.pl</command> while processing your
7346 locales. It's only to have the missing entries singled out and
7347 does not belong to a language package.</para>
7355 <para>This file is not a part of the language package
7358 <para>Another file generated by
7359 <command>scripts/locales.pl</command>. If for any reason a
7360 translation does not appear anymore and can be deleted, it gets
7361 moved here. The last 50 or so entries deleted are saved here in
7362 case you made a typo, so that you don't have to translate
7363 everything again. If a tranlsation is missing, the lost file is
7364 checked first. If you maintain a language package, you might
7365 want to keep this safe somewhere.</para>
7370 <term>more/all</term>
7373 <para>This subdir and file is not a part of the language package
7376 <para>If the directory more exists and contains a file called
7377 all it will be parsed in addition to the mandatory all (see
7378 above). The file is useful if you want to change some
7379 translations for the current installation without conflicting
7380 further upgrades. The file is not autogenerated and has the same
7381 format as the all, but needs another key (more_texts). See the
7382 german translation for an example or copy the following code:
7385 # -*- coding: utf-8; -*-
7390 # These are additional texts for custom translations.
7391 # The format is the same as for the normal file all, only
7392 # with another key (more_texts instead of texts).
7393 # The file has the form of 'english text' => 'foreign text',
7395 $self->{more_texts} = {
7397 'Ship via' => 'Terms of delivery',
7398 'Shipping Point' => 'Delivery time',
7400 </programlisting></para>
7407 <sect1 id="devel.testsuite">
7408 <title>Die kivitendo-Test-Suite</title>
7410 <sect2 id="devel.testsuite.intro">
7411 <title>Einführung</title>
7413 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
7414 basiert auf dem Standard-Perl-Modul
7415 <literal>Test::More</literal>.</para>
7417 <para>Die grundlegenden Fakten sind:</para>
7421 <para>Alle Tests liegen im Unterverzeichnis
7422 <filename>t/</filename>.</para>
7426 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
7427 enthält einen oder mehrere Testfälle.</para>
7431 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
7432 Es sind selbstständig ausführbare Perl-Scripte.</para>
7436 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
7437 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
7438 auf <literal>.t</literal> endet.</para>
7443 <sect2 id="devel.testsuite.prerequisites">
7444 <title>Voraussetzungen</title>
7446 <para>Für die Ausführung werden neben den für kivitendo eh schon
7447 benötigten Module noch weitere Perl-Module benötigt. Diese
7452 <para><literal>Test::Deep</literal> (Debian-Paketname:
7453 <literal>libtest-deep-perl</literal>; Fedora:
7454 <literal>perl-Test-Deep</literal>; openSUSE:
7455 <literal>perl-Test-Deep</literal>)</para>
7459 <para><literal>Test::Exception</literal> (Debian-Paketname:
7460 <literal>libtest-exception-perl</literal>; Fedora:
7461 <literal>perl-Test-Exception</literal>; openSUSE:
7462 <literal>perl-Test-Exception</literal>)</para>
7466 <para><literal>Test::Output</literal> (Debian-Paketname:
7467 <literal>libtest-output-perl</literal>; Fedora:
7468 <literal>perl-Test-Output</literal>; openSUSE:
7469 <literal>perl-Test-Output</literal>)</para>
7473 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
7474 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
7475 kann für frühere Versionen aus dem <ulink
7476 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
7480 <para><literal>LWP::Simple</literal> aus dem Paket
7481 <literal>libwww-perl</literal> (Debian-Panetname:
7482 <literal>libwww-perl</literal>; Fedora:
7483 <literal>perl-libwww-perl</literal>; openSUSE:
7484 <literal>perl-libwww-perl</literal>)</para>
7488 <para><literal>URI::Find</literal> (Debian-Panetname:
7489 <literal>liburi-find-perl</literal>; Fedora:
7490 <literal>perl-URI-Find</literal>; openSUSE:
7491 <literal>perl-URI-Find</literal>)</para>
7495 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
7496 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
7497 müssen in der Konfigurationsdatei im Abschnit
7498 <literal>testing/database</literal> Datenbankverbindungsparameter
7499 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
7500 Recht haben, Datenbanken anzulegen und zu löschen.</para>
7503 <sect2 id="devel.testsuite.execution">
7504 <title>Existierende Tests ausführen</title>
7506 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
7507 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
7508 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
7509 <filename>t/test.pl</filename>.</para>
7511 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
7512 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
7513 kivitendo-Basisverzeichnis heraus ausführen.</para>
7515 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
7516 an <filename>t/test.pl</filename>. Beispielsweise:</para>
7518 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
7521 <sect2 id="devel.testsuite.meaning_of_scripts">
7522 <title>Bedeutung der verschiedenen Test-Scripte</title>
7524 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
7525 Programmierstil. Einige besonders zu erwähnende, weil auch während der
7526 Entwicklung nützliche Tests sind:</para>
7530 <para><filename>t/001compile.t</filename> -- compiliert alle
7531 Quelldateien und bricht bei Fehlern sofort ab</para>
7535 <para><filename>t/002goodperl.t</filename> -- überprüft alle
7536 Perl-Dateien auf Anwesenheit von '<literal>use
7537 strict</literal>'-Anweisungen</para>
7541 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
7542 <function>system()</function> und <function>exec()</function> auf
7547 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
7548 Tab-Zeichen enthalten</para>
7552 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
7553 Rechtschreibfehlern</para>
7557 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
7558 Dokumentation im POD-Format auf Gültigkeit</para>
7562 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
7563 einzelner Funktionen und Module.</para>
7566 <sect2 id="devel.testsuite.create_new">
7567 <title>Neue Test-Scripte erstellen</title>
7569 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
7570 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
7571 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
7574 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
7575 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
7578 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
7583 <para>Überprüfung auf fehlende symbolische Links</para>
7587 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
7588 gewissen Einschränkungen wie das Erlauben von deutschen
7593 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
7597 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
7601 <para>Test, ob alle zu übersetzenden Strings in
7602 <filename>locale/de/all</filename> vorhanden sind</para>
7606 <para>Test, ob alle Webseiten-Templates in
7607 <filename>templates/webpages</filename> mit vom Perl-Modul
7608 <literal>Template</literal> compiliert werden können</para>
7613 <sect3 id="devel.testsuite.directory_and_test_names">
7614 <title>Konvention für Verzeichnis- und Dateinamen</title>
7616 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
7617 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
7618 und ihnen soweit es geht folgen:</para>
7622 <para>Die Dateiendung muss <filename>.t</filename>
7627 <para>Namen sind englisch, komplett klein geschrieben und
7628 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
7629 <filename>bad_function_params.t</filename>).</para>
7633 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
7634 benannt sein, mit dem sich die Scripte darin befassen
7635 (beispielsweise <filename>background_jobs</filename> für Tests
7636 rund um Hintergrund-Jobs).</para>
7640 <para>Test-Scripte sollten einen überschaubaren Bereich von
7641 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
7642 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
7643 Test-Scripte schreiben.</para>
7648 <sect3 id="devel.testsuite.minimal_example">
7649 <title>Minimales Skelett für eigene Scripte</title>
7651 <para>Der folgenden Programmcode enthält das kleinstmögliche
7652 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
7655 <programlisting>use Test::More tests => 0;
7659 use Support::TestSetup;
7661 Support::TestSetup::login();</programlisting>
7663 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
7664 benötigt (Stichwort: alle globalen Variablen wie
7665 <varname>$::auth</varname>, <varname>$::form</varname> oder
7666 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
7667 <filename>config/kivitendo.conf</filename> im Abschnitt
7668 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
7669 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
7671 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
7672 kann die letzte Zeile <code>Support::TestSetup::login();</code>
7673 weggelassen werden, was die Ausführungszeit des Scripts leicht
7679 <sect1 id="devel.style-guide">
7680 <title>Stil-Richtlinien</title>
7682 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
7683 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
7684 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
7685 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
7687 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
7690 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
7691 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
7696 <para>Es werden keine echten Tabs sondern Leerzeichen
7701 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
7703 <programlisting>foreach my $row (@data) {
7705 # do something with $row
7709 $row->{modules} = MODULE->retrieve(
7710 id => $row->{id},
7711 date => $use_now ? localtime() : $row->{time},
7715 $report->add($row);
7720 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
7721 Zeile wie der letzte Befehl. Beispiele:</para>
7723 <programlisting>sub debug {
7729 <programlisting>if ($form->{item_rows} > 0) {
7735 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
7736 der Befehl / die öffnende schließende Klammer, die den Block
7737 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
7738 Beispiele wie bei 3. gelten.</para>
7742 <para>Die Wörter "<function>else</function>",
7743 "<function>elsif</function>", "<function>while</function>" befinden
7744 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
7747 <programlisting>if ($form->{sum} > 1000) {
7749 } elsif ($form->{sum} > 0) {
7757 } until ($a > 0);</programlisting>
7761 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
7762 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
7763 und grep-ähnliche Operatoren. Beispiel:</para>
7765 <programlisting>$main::lxdebug->message("Could not find file.");
7766 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
7770 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
7772 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
7773 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
7774 Blöcke schon. Beispiel:</para>
7776 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
7781 $form->{sum} += $form->{"row_$i"};
7782 $form->{ $form->{index} } += 1;
7784 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
7788 <para>Mehrzeilige Befehle</para>
7792 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
7793 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
7794 werden, in der die ersten Funktionsparameter in der ersten Zeile
7795 stehen. Beispiel:</para>
7797 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
7798 $form->{some_col_value});</programlisting>
7802 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
7803 besten in einer übersichtlichen Tabellenstruktur organisiert
7804 wird. Beispiel:</para>
7806 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
7807 : $form->{oldcount} ? $form->{oldcount} + 1
7808 : $form->{rowcount} - $form->{rowbase};</programlisting>
7814 <para>Kommentare</para>
7818 <para>Kommentare, die alleine in einer Zeile stehen, sollten
7819 soweit wie der Code eingerückt sein.</para>
7823 <para>Seitliche hängende Kommentare sollten einheitlich
7824 formatiert werden.</para>
7828 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
7829 auf Englisch zu verfassen. So wie ich keine Lust habe,
7830 französischen Quelltext zu lesen, sollte auch der kivitendo
7831 Quelltext für nicht-Deutschsprachige lesbar sein.
7834 <programlisting>my $found = 0;
7842 $i = 0 # initialize $i
7844 $i *= $const; # do something crazy
7845 $i = $n; # recover $i</programlisting>
7851 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
7852 Interpolation gewünscht ist. Beispiel:</para>
7854 <programlisting>$form->{sum} = 0;
7855 $form->{"row_$i"} = $form->{"row_$i"} - 5;
7856 $some_hash{42} = 54;</programlisting>
7860 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
7861 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
7862 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
7863 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
7865 <para>Als Beispiel sei die Funktion
7866 <function>print_options</function> aus
7867 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
7871 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
7872 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
7875 <para>Emacs und vim haben beide recht einfache Methoden zur
7876 Entfernung von trailing whitespace. Emacs kennt das Kommande
7877 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
7878 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
7879 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
7884 <para>Es wird kein <command>perltidy</command> verwendet.</para>
7886 <para>In der Vergangenheit wurde versucht,
7887 <command>perltidy</command> zu verwenden, um einen einheitlichen
7888 Stil zu erlangen. Es hat sich aber gezeigt, dass
7889 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
7890 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
7891 den Interessierten sind hier die
7892 <command>perltidy</command>-Optionen, die grob den beschriebenen
7893 Richtlinien entsprechen:</para>
7895 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
7896 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
7897 -lp -vt=1 -vtc=1</programlisting>
7901 <para><varname>STDERR</varname> ist tabu. Unkonditionale
7902 Debugmeldungen auch.</para>
7904 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
7905 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
7906 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
7908 <para>Die <classname>LXDebug</classname>-Methode
7909 "<function>message</function>" nimmt als ersten Paramter außerdem
7910 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
7911 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
7912 und werden in den meisten Fällen auch vom Repository
7913 zurückgewiesen.</para>
7917 <para>Alle neuen Module müssen use strict verwenden.</para>
7919 <para><varname>$form</varname>, <varname>$auth</varname>,
7920 <varname>$locale</varname>, <varname>$lxdebug</varname> und
7921 <varname>%myconfig</varname> werden derzeit aus dem main package
7922 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
7923 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
7928 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
7929 <title>Dokumentation erstellen</title>
7931 <sect2 id="devel.build-doc.introduction">
7932 <title>Einführung</title>
7934 <para>Diese Dokumentation ist in <productname>DocBook</productname>
7935 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
7936 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
7937 Editor nutzt, der spezielle Unterstützung für
7938 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
7939 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
7940 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
7944 <sect2 id="devel.build-doc.required-software">
7945 <title>Benötigte Software</title>
7947 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
7948 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
7949 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
7950 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
7951 <command>scripts/build_doc.sh</command>.</para>
7953 <para>Das Script benötigt zur Konvertierung verschiedene
7954 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
7960 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
7961 in einer halbwegs aktuellen Version</para>
7965 <para>Das Java-Build-System <ulink
7966 url="http://ant.apache.org/">Apache Ant</ulink></para>
7970 <para>Das Dokumentations-System Dobudish für
7971 <productname>DocBook</productname> 4.5, eine Zusammenstellung
7972 diverser Stylesheets und Grafiken zur Konvertierung von
7973 <productname>DocBook</productname> XML in andere Formate. Das
7974 Paket, das benötigt wird, ist zum Zeitpunkt der
7975 Dokumentationserstellung
7976 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
7977 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
7982 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
7983 sind auf allen gängigen Plattformen verfügbar. Beispiel für
7984 Debian/Ubuntu:</para>
7986 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
7988 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
7989 <filename>doc/build</filename> entpackt werden. Beispiel unter der
7990 Annahme, das <productname>Dobudish</productname> in
7991 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
7993 <programlisting>cd doc/build
7994 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
7997 <sect2 id="devel.build-doc.build">
7998 <title>PDFs und HTML-Seiten erstellen</title>
8000 <para>Die eigentliche Konvertierung erfolgt nach Installation der
8001 benötigten Software mit einem einfachen Aufruf direkt aus dem
8002 kivitendo-Installationsverzeichnis heraus:</para>
8004 <programlisting>./scripts/build_doc.sh</programlisting>
8007 <sect2 id="devel.build-doc.repository">
8008 <title>Einchecken in das Git-Repository</title>
8010 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
8011 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
8012 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
8013 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
8015 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
8016 symbolischen Links gehören hingegen nicht in das Repository.</para>