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>
974 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
975 die maximale Größe eines Requests. Diese sollte wie folgt
976 hochgesetzt werden:</para>
978 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
980 <para>Das Ganze sollte dann so aussehen:</para>
982 <programlisting>AddHandler fcgid-script .fpl
983 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
984 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
985 FcgidMaxRequestLen 10485760
987 <Directory /path/to/kivitendo-erp>
989 Options ExecCGI Includes FollowSymlinks
994 <DirectoryMatch /path/to/kivitendo-erp/users>
997 </DirectoryMatch></programlisting>
999 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
1000 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
1001 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
1002 gibt es hier kleine Performance-Einbußen.</para>
1004 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
1005 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
1006 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
1008 <programlisting># Zugriff über CGI
1009 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
1011 # Zugriff mit mod_fcgid:
1012 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1013 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
1015 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
1016 die normale Version erreichbar, und unter
1017 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
1018 FastCGI-Version.</para>
1023 <title>Weitergehende Konfiguration</title>
1025 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
1026 von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1027 weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1028 Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1029 Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1030 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1031 (Stand Sept. 2015)</ulink></para>
1035 <sect1 id="config.task-server">
1036 <title>Der Task-Server</title>
1038 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1039 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1040 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1041 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1042 essenzielle Aufgaben benutzt.</para>
1044 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1045 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1046 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1048 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1049 Servers integriert werden muss, damit er automatisch gestartet wird.
1050 Dies kann kivitendo nicht für Sie erledigen.</para>
1052 <sect2 id="Konfiguration-des-Task-Servers">
1053 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1055 <para>Die Konfiguration erfolgt über den Abschnitt
1056 <literal>[task_server]</literal> in der Datei
1057 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1058 Optionen sind:</para>
1062 <term><varname>run_as</varname></term>
1065 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1066 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1067 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1068 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1070 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1071 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1072 unter dem auch der Webserver läuft.</para>
1077 <term><varname>debug</varname></term>
1080 <para>Schaltet Debug-Informationen an und aus.</para>
1086 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1087 <title>Konfiguration der Mandanten für den Task-Server</title>
1089 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1090 anschließend jeder Mandant, für den der Task-Server laufen soll,
1091 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1092 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1093 ausgewählt werden, unter der der Task-Server seine Arbeit
1096 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1097 wird der Task-Server für diesen Mandanten keine Aufgaben
1101 <sect2 id="Einbinden-in-den-Boot-Prozess">
1102 <title>Automatisches Starten des Task-Servers beim Booten</title>
1104 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1105 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1106 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1108 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1109 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1110 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1111 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1112 anstelle eines symbolischen Links verwendet werden können.</para>
1115 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE,
1116 ältere Fedora)</title>
1118 <para>Kopieren Sie die Datei
1119 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1120 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1121 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1122 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1123 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1127 <para>Debian-basierende Systeme:</para>
1129 <programlisting>update-rc.d kivitendo-task-server defaults
1130 # Nur bei Debian Squeeze und neuer:
1131 insserv kivitendo-task-server</programlisting>
1135 <para>Ältere OpenSUSE und ältere Fedora:</para>
1137 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1141 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1144 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1148 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1150 <para>Kopieren Sie die Datei
1151 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1152 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1153 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1154 <literal>exec ....</literal>).</para>
1156 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1159 <programlisting>service kivitendo-task-server start</programlisting>
1163 <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1164 Fedora, neuere Ubuntu und Debians)</title>
1166 <para>Kopieren Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
1167 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeilen
1168 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>).</para>
1170 <para>Machen Sie anschließend das Script systemd bekannt, und binden Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden
1173 <programlisting>systemctl daemon-reload
1174 systemctl enable kivitendo-task-server.service</programlisting>
1176 <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt den Server neu zu starten, so können Sie das mit dem
1177 folgenden Befehl tun:</para>
1179 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1183 <sect2 id="Prozesskontrolle">
1184 <title>Wie der Task-Server gestartet und beendet wird</title>
1186 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1188 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1190 <para><literal>Befehl</literal> ist dabei eine der folgenden
1195 <para><literal>start</literal> startet eine neue Instanz des
1196 Task-Servers. Die Prozess-ID wird innerhalb des
1197 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1201 <para><literal>stop</literal> beendet einen laufenden
1206 <para><literal>restart</literal> beendet und startet ihn
1211 <para><literal>status</literal> berichtet, ob der Task-Server
1216 <para>Der Task-Server wechselt beim Starten automatisch in das
1217 kivitendo-Installationsverzeichnis.</para>
1219 <para>Dieselben Optionen können auch für die SystemV-basierenden
1220 Runlevel-Scripte benutzt werden (siehe oben).</para>
1224 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1225 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1227 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1228 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1230 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1231 <title>Grundlagen zur Benutzerauthentifizierung</title>
1233 <para>kivitendo verwaltet die Benutzerinformationen in einer
1234 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1235 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1236 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1237 können, müssen aber nicht unterschiedlich sein.</para>
1239 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1240 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1241 abgelegt werden.</para>
1243 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
1244 entweder gegen die Authentifizierungsdatenbank oder gegen einen
1245 LDAP-Server überprüft werden.</para>
1247 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1248 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1249 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1250 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1251 einer Version vor v2.6.0 angelegt werden. Eine
1252 Beispielkonfigurationsdatei
1253 <filename>config/kivitendo.conf.default</filename> existiert, die als
1254 Vorlage benutzt werden kann.</para>
1257 <sect2 id="Administratorpasswort">
1258 <title>Administratorpasswort</title>
1260 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1261 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1262 gespeichert. Es kann auch nur dort und nicht mehr im
1263 Administrationsinterface selber geändert werden. Der Parameter dazu
1264 heißt <varname>admin_password</varname> im Abschnitt
1265 <varname>[authentication]</varname>.</para>
1268 <sect2 id="Authentifizierungsdatenbank">
1269 <title>Authentifizierungsdatenbank</title>
1271 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1272 Parametern in <varname>[authentication/database]</varname>
1273 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1277 <term><literal>host</literal></term>
1280 <para>Der Rechnername oder die IP-Adresse des
1281 Datenbankservers</para>
1286 <term><literal>port</literal></term>
1289 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1294 <term><literal>db</literal></term>
1297 <para>Der Name der Authentifizierungsdatenbank</para>
1302 <term><literal>user</literal></term>
1305 <para>Der Benutzername, mit dem sich kivitendo beim
1306 Datenbankserver anmeldet (z.B.
1307 "<literal>postgres</literal>")</para>
1312 <term><literal>password</literal></term>
1315 <para>Das Passwort für den Datenbankbenutzer</para>
1320 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1321 automatisch anlegen (mehr dazu siehe unten).</para>
1324 <sect2 id="Passwortüberprüfung">
1325 <title>Passwortüberprüfung</title>
1327 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1328 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1329 Active-Directory-Server. Welche davon benutzt wird, regelt der
1330 Parameter <varname>module</varname> im Abschnitt
1331 <varname>[authentication]</varname>.</para>
1333 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1334 gespeichert werden, so muss der Parameter <varname>module</varname>
1335 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1336 der Administrator als auch die Benutzer selber ihre Passwörter in
1337 kivitendo ändern.</para>
1339 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1340 benutzt werden, so muss der Parameter <varname>module</varname> auf
1341 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1342 zusätzliche Informationen über den LDAP-Server im Abschnitt
1343 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1347 <term><literal>host</literal></term>
1350 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1351 Active-Directory-Servers. Diese Angabe ist zwingend
1352 erforderlich.</para>
1357 <term><literal>port</literal></term>
1360 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1365 <term><literal>tls</literal></term>
1368 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1369 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1370 ‘<literal>0</literal>’ belassen</para>
1375 <term><literal>attribute</literal></term>
1378 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1379 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1380 meist ‘<literal>sAMAccountName</literal>’, für andere
1381 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1382 zwingend erforderlich.</para>
1387 <term><literal>base_dn</literal></term>
1390 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1391 Diese Angabe ist zwingend erforderlich.</para>
1396 <term><literal>filter</literal></term>
1399 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1400 <literal><%login%></literal>, so wird dieses durch den vom
1401 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1402 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1403 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1408 <term><literal>bind_dn</literal> und
1409 <literal>bind_password</literal></term>
1412 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1413 durchsucht werden kann (z.B. ist dies bei
1414 Active-Directory-Servern der Fall), so kann diese hier angegeben
1415 werden. Für Active-Directory-Server kann als
1416 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1417 z.B. ‘<literal>cn=Martin
1418 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1419 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1420 also ‘<literal>Martin Mustermann</literal>’.</para>
1426 <sect2 id="Name-des-Session-Cookies">
1427 <title>Name des Session-Cookies</title>
1429 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1430 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1431 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1432 Parameter <varname>cookie_name</varname> im Abschnitt
1433 <varname>[authentication]</varname>gesetzt.</para>
1435 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1436 Server existiert.</para>
1439 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1440 <title>Anlegen der Authentifizierungsdatenbank</title>
1442 <para>Nachdem alle Einstellungen in
1443 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1444 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1445 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1446 der folgenden URL erreichbar sein sollte:</para>
1449 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1453 <sect1 id="Benutzer--und-Gruppenverwaltung">
1454 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1456 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1457 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1458 das Sie unter folgender URL finden:</para>
1461 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1463 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1464 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1466 <sect2 id="Zusammenhänge">
1467 <title>Zusammenhänge</title>
1469 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1470 in einer oder zwei Datenbanken gespeichert werden.</para>
1472 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1473 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1474 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1475 Diese Informationen werden in der Authentifizierungsdatenbank
1476 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1477 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1478 gespeichert werden.</para>
1480 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1481 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1482 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1483 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1484 einer solchen Mandantendatenbank werden im Administrationsbereich
1485 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1486 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1488 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1489 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1490 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1491 mehr als einem Mandanten, wird empfohlen, für die
1492 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1493 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1496 <sect2 id="Mandanten-Benutzer-Gruppen">
1497 <title>Mandanten, Benutzer und Gruppen</title>
1499 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1500 die sich frei zueinander zuordnen lassen.</para>
1502 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1503 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1504 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1505 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1506 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1507 Diese sollte über die <link
1508 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1511 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1512 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1513 der Administrator fest, an welchen Mandanten sich ein Benutzer
1514 anmelden kann, was beim Login verifiziert wird.</para>
1516 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1517 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1518 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1519 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1520 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1521 dann an einem Mandanten an, so erhält er alle Rechte von allen
1522 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1523 denen der Benutzer zum Anderen Mitglied ist,</para>
1525 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1526 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1527 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1529 <orderedlist numeration="arabic">
1531 <para>Datenbank anlegen</para>
1535 <para>Gruppen anlegen</para>
1539 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1543 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1548 <sect2 id="Datenbanken-anlegen">
1549 <title>Datenbanken anlegen</title>
1551 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1552 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1553 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1556 <sect2 id="Gruppen-anlegen">
1557 <title>Gruppen anlegen</title>
1559 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1560 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1561 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1562 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1564 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1565 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1566 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1567 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1568 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1569 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1570 A, B und C gültig").</para>
1572 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1573 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1574 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1575 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1576 Gruppen A, B und C").</para>
1579 <sect2 id="Benutzer-anlegen">
1580 <title>Benutzer anlegen</title>
1582 <para>Beim Anlegen von Benutzern werden für viele Parameter
1583 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1584 deutschen Raumes entsprechen.</para>
1586 <para>Zwingend anzugeben ist der Loginname. Wenn die
1587 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
1588 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
1589 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1592 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
1593 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
1594 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
1595 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
1596 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
1597 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
1598 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
1599 sind Benutzer A, B und C Mitglieder").</para>
1602 <sect2 id="Mandanten-anlegen">
1603 <title>Mandanten anlegen</title>
1605 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
1606 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
1607 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
1608 einer der eben angelegten Datenbanken eingetragen werden.</para>
1610 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
1611 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
1612 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
1613 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
1614 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
1615 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
1616 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
1617 Gruppe ist für Mandanten A, B und C gültig").</para>
1621 <sect1 id="Drucker--Systemverwaltung">
1622 <title>Drucker- und Systemverwaltung</title>
1624 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
1625 Druckeradministration und System.</para>
1627 <sect2 id="Druckeradministration">
1628 <title>Druckeradministration</title>
1630 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
1631 viele "Druckbefehle" im System verwalten. Diese Befehle werden
1632 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
1633 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
1634 angezeigt wird.</para>
1636 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
1637 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
1638 meinDrucker' oder ein kompletter Pfad zu einem Skript
1639 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
1640 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
1641 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
1642 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
1643 Ausdruck eines Angebots folgende Vorlage geparst:
1644 sales_quotation_epson_drucker.tex.</para>
1648 <title>System sperren / entsperren</title>
1650 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
1651 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
1652 gesamten kivitendo Installation gesperrt.</para>
1654 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
1655 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
1656 Wartungsarbeiten nicht zugänglich.'.</para>
1658 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
1659 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
1660 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
1661 inkonsistenten Datenbestand weitergearbeitet werden.</para>
1665 <sect1 id="config.sending-email"
1666 xreflabel="E-Mail-Versand aus kivitendo heraus">
1667 <title>E-Mail-Versand aus kivitendo heraus</title>
1669 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
1670 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
1671 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
1672 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
1673 Versand über einen lokalen E-Mail-Server (z.B. mit
1674 <productname>Postfix</productname> oder <productname>Exim</productname>,
1675 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
1676 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
1678 <para>Welche Methode und welcher Server verwendet werden, wird über die
1679 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1680 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
1681 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1683 <sect2 id="config.sending-email.sendmail"
1684 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1685 <title>Versand über lokalen E-Mail-Server</title>
1687 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
1688 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
1689 <productname>Postfix</productname>, <productname>Exim</productname>
1690 oder <productname>Sendmail</productname> läuft.</para>
1692 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1693 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1694 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1696 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
1697 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
1698 Standardwert verweist auf das Programm
1699 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1700 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1702 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
1703 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
1707 <sect2 id="config.sending-email.smtp"
1708 xreflabel="E-Mail-Versand über einen SMTP-Server">
1709 <title>Versand über einen SMTP-Server</title>
1711 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
1712 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
1715 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1716 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1717 Parameter dienen dabei der weiteren Konfiguration:</para>
1721 <term><varname>hostname</varname></term>
1724 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
1725 '<literal>localhost</literal>'</para>
1730 <term><varname>port</varname></term>
1733 <para>Portnummer. Der Standardwert hängt von der verwendeten
1734 Verschlüsselungsmethode ab. Gilt '<literal>security =
1735 none</literal>' oder '<literal>security = tls</literal>', so ist
1736 25 die Standardportnummer. Für '<literal>security =
1737 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
1738 geändert werden.</para>
1743 <term><varname>security</varname></term>
1746 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
1747 mit dem Server. Standardwert ist '<literal>none</literal>',
1748 wodurch keine Verschlüsselung verwendet wird. Mit
1749 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
1750 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
1751 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
1752 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
1753 (siehe unten).</para>
1758 <term><varname>login</varname> und
1759 <varname>password</varname></term>
1762 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
1763 so können mit diesen zwei Parametern der Benutzername und das
1764 Passwort angegeben werden. Wird Authentifizierung verwendet, so
1765 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
1766 aktiviert werden.</para>
1773 <sect1 id="Drucken-mit-kivitendo">
1774 <title>Drucken mit kivitendo</title>
1776 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
1777 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1778 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1779 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
1781 <para><programlisting>apt-get install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1782 exlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1784 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
1786 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
1787 texlive-collection-latexrecommended texlive-collection-langgerman \
1788 texlive-collection-langenglish</programlisting></para>
1790 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
1792 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
1793 texlive-collection-latexrecommended texlive-collection-langgerman \
1794 texlive-collection-langenglish</programlisting></para>
1796 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1808 <para>rev-odt</para>
1812 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version
1813 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
1815 <sect2 id="Vorlagenverzeichnis-anlegen"
1816 xreflabel="Vorlagenverzeichnis anlegen">
1817 <title>Vorlagenverzeichnis anlegen</title>
1819 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
1820 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1822 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1824 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
1825 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
1826 <xref linkend="Gruppen-anlegen"/>.</para>
1828 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
1829 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
1830 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
1831 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1835 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
1836 Vorlagensatz aus, der kopiert werden soll
1837 (<filename>RB</filename>, <filename>f-tex</filename> oder
1838 <filename>odt-rev</filename>.)</para>
1842 <para><option>Neuer Name</option>: Der Verzeichnisname für den
1843 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
1844 für Verzeichnisnamen frei gewählt werden.</para>
1848 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
1849 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
1850 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1851 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
1852 vorgenommen werden. Den Ordner findet man im Dateisystem unter
1853 <filename>./templates/[Neuer Name]</filename></para>
1856 <sect2 id="Vorlagen-RB">
1857 <title>Der Druckvorlagensatz RB</title>
1859 <para>Hierbei handelt es sich um einen vollständigen LaTeX
1860 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
1861 sind nicht gepflegt.</para>
1863 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
1864 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1865 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
1866 eigenen Firmendaten finden sich in der Datei Readme.tex im
1867 Vorlagenverzeichnis.</para>
1869 <para>Eine kurze Übersicht der Features:</para>
1873 <para>Mehrsprachenfähig, mit Deutscher und Englischer
1878 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
1879 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
1884 <para>mehrere vordefinierte Varianten für
1885 Logos/Hintergrundbilder</para>
1889 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
1890 "Außerhalb EU"</para>
1896 <title>f-tex</title>
1898 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur
1899 Verfügung stellt.</para>
1901 <sect3 id="f-tex-Feature-Übersicht">
1902 <title>Feature-Übersicht</title>
1906 <para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage
1907 für alle briefartigen Dokumente verwendet. Also Angebot,
1908 Rechnung, Proformarechnung, Lieferschein, aber eben nicht für
1909 Paketaufkleber etc.</para>
1913 <para>Leichte Anpassung an das Firmen-Layout durch Verwendung
1914 eines Hintergrund-PDFs. Dieses kann leicht mit dem eigenen
1915 Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp,
1920 <para>Hintergrund-PDF umschaltbar auf "nur erste Seite"
1921 (Standard) oder "alle Seiten" (Option
1922 "<option>bgPdfFirstPageOnly</option>" in Datei
1923 <filename>letter.lco</filename>)</para>
1927 <para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem
1928 Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1929 versendeten Dokumenten eingebunden (Option
1930 "<option>bgPdfEmailOnly</option>" in Datei
1931 <filename>letter.lco</filename>).</para>
1935 <para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch,
1936 Wiederholung von Kopfzeilen, Zwischensummen etc. (danke an
1937 Kai-Martin Knaak für die Vorarbeit)</para>
1941 <para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom
1942 Land des eigenen Unternehmens abweicht (also die Rechnung das
1943 Land verlässt).</para>
1947 <para>Multisprachfähig leicht um weitere Sprachen zu erweitern,
1948 alle Übersetzungen in der Datei
1949 <filename>translatinos.tex</filename>.</para>
1953 <para>Auflistung von Bruttopreisen für Endverbraucher.</para>
1958 <sect3 id="f-tex-Installation">
1959 <title>Die Installation</title>
1963 <para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref
1964 linkend="Vorlagenverzeichnis-anlegen"/>. Das Vorlagensystem
1965 funktioniert jetzt schon, hat allerdings noch einen
1966 Beispiel-Briefkopf.</para>
1970 <para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
1971 <filename>./letter_head.pdf</filename>.</para>
1975 <para>Editiere den Bereich "<option>settings</option>" in der
1976 datei <filename>letter.lco</filename>.</para>
1980 <para>oder etwas detaillierter:</para>
1982 <para>Es wird eine Datei <filename>sample.lco</filename> erstellt
1983 und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
1984 ist dies die Datei die für die firmenspezifischen Anpassungen
1985 gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist,
1986 wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle
1987 über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und
1988 <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung
1989 über eine <filename>*.lco</filename>-Datei, die letztlich auf
1990 <filename>letter.lco</filename> verlinkt ist ist aber auch
1993 <para>Es wird eine Datei <filename>sample_head.pdf</filename> mit
1994 ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
1995 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage.
1996 Schau Dir nach Abschluss der Installation die Datei
1997 <filename>sample_head.pdf</filename> an und erstelle ein
1998 entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
1999 Template Verzeichniss ablegen und statt
2000 <filename>sample_head.pdf</filename> nach
2001 <filename>letter_head.pdf</filename> verlinken.</para>
2003 <para>Letzlich muss <filename>letter_head.pdf</filename> auf das
2004 passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
2007 <para>Es wird eine Datei <filename>mydata.tex.example</filename>
2008 ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
2009 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das
2010 Land verwendet. Die Datei muss also nicht angefasst werden. Die
2011 anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit
2012 nicht im öffentlichen Zweig).</para>
2014 <para>Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
2015 sollten über die Hintergrund-PDF-Datei oder die
2016 <filename>*.lco</filename>-Datei erfolgen.</para>
2019 <sect3 id="f-tex-Funktionsübersicht">
2020 <title>f-tex Funktionsübersicht</title>
2022 <para>Das Konzept von kivitendo sieht vor, für jedes Dokument
2023 (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
2024 LaTeX-Vorlage vorzuhalten, dies ist sehr wartungsunfreundlich. Auch
2025 das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
2026 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen
2027 aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
2028 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
2029 LaTeX-Vorlage verwendet, welche über Codeweichen die Besonderheiten
2030 der jeweiligen Dokumente berücksichtigt:</para>
2034 <para>Tabellen mit oder ohne Preis</para>
2038 <para>Sprache der Tabellenüberschriften etc.</para>
2042 <para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
2043 Angebotsnummer)</para>
2047 <para>Darstellung von Brutto oder Netto-Preisen in der
2048 Auflistung (Endverbraucher versus gewerblicher Kunde)</para>
2052 <para>Nachteil:</para>
2054 <para>LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei
2055 <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
2056 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder
2057 geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch
2058 innerhalb der Tabellendarstellung gut persönliche Anpassungen
2059 vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell
2060 heftig in den Fuss schiessen.</para>
2062 <para>Wer nicht so tief in die Materie einsteigen will oder leicht
2063 zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
2064 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen,
2065 und sich an der Form der dargestellten Tabellen, wie sie
2066 ausgeliefert werden, erfreuen.</para>
2068 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine,
2069 kontinuierliche Schritte gehen.</para>
2072 <sect3 id="f-tex-Bruttopreise">
2073 <title>Bruttopreise für Endverbraucher</title>
2075 <para>Der auszuweisende Bruttopreis wird innerhalb der
2076 LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen
2077 "alle Preise Brutto" auszuwählen, aber:</para>
2081 <para>hierfür müssen die Preise auch in Brutto in der Datenbank
2082 stehen (ja - das lässt sich über die Preisgruppen und die
2083 Zuordung einer Default-Preisgruppe handhaben)</para>
2087 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses
2088 Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
2089 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche
2094 <para>Es gibt mit f-tex eine weitere Alternative. Die Information ob
2095 Brutto oder Nettorechnung wird mit den Zahlarten verknüpft.
2096 Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben
2097 werden sollen, enden mit "_E" (für Endverbraucher). Falls identische
2098 Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt
2099 man diese einfach doppelt an (einmal mit der Namensendung "_E").
2104 <para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist
2105 nicht mehr fix mit einer Preisliste verbunden.</para>
2109 <para>Die Default-Zahlart kann im Kundendatensatz hinterlegt
2110 werden, und man muss nicht mehr daran denken, "alle Preise
2111 Netto" auszuwählen.</para>
2115 <para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen
2116 werden, kann direkt beim Drucken revidiert werden, ohne dass
2117 sich der Auftragswert ändert.</para>
2122 <sect3 id="f-tex-lieferadressen">
2123 <title>Lieferadressen</title>
2125 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen
2126 im Adressfeld zum Einsatz. Wenn die
2127 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende
2128 Adressvariable eingesetzt. Wenn also die Lieferadresse in Straße,
2129 Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
2130 Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert
2131 der Hauptadresse angezeigt.</para>
2135 <sect2 id="Vorlagen-rev-odt">
2136 <title>Der Druckvorlagensatz rev-odt</title>
2138 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2139 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2140 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2141 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2142 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2143 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2144 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2146 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2147 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2148 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2149 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2150 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2151 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2153 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2154 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2155 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2156 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2157 die vom Parser nicht korrekt gelesen werden kann.</para>
2159 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2160 odt-Vorlagen bei Mahnungen, Briefen und Pflichtenheften einzusetzen.
2161 Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2163 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2164 empfang@revamp-it.ch</para>
2167 <sect2 id="allgemeine-hinweise-zu-latex">
2168 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2170 <para>In den allermeisten Installationen sollte das Drucken jetzt
2171 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2172 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2173 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2174 sind zum Beispiel:</para>
2178 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2179 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2180 allem bei Vorlagen aus der Community auf. Installieren Sie die
2181 entsprechenden Pakete.</para>
2185 <para>! Package inputenc Error: Unicode char \u8:... set up for
2186 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2187 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2188 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2189 diversen Tricks dazu gebracht werden andere Zeichen zu
2190 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2195 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2196 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2197 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2198 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2199 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2202 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2203 verifizieren lässt:</para>
2207 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2208 "keep_temp_files" auf 1</para>
2210 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2214 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2218 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2222 <para>wechsel in das users Verzeichnis von kivitendo</para>
2224 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2228 <para>LaTeX Suchpfad anpassen:</para>
2230 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2234 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2237 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2239 <para>Es sollte die letzte Datei ganz unten sein</para>
2243 <para>für besseren Hinweis auf Fehler texdatei nochmals
2246 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2248 <para>in der *.tex datei nach dem Fehler suchen.</para>
2254 <sect1 id="OpenDocument-Vorlagen">
2255 <title>OpenDocument-Vorlagen</title>
2257 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2258 OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2) erzeugen.
2259 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
2260 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2261 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2262 <filename>config/kivitendo.conf</filename> die Variable
2263 <literal>opendocument</literal> im Abschnitt
2264 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2265 Dieses ist die Standardeinstellung.</para>
2267 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2268 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2269 LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt werden, so muss
2270 neben LibreOffice oder OpenOffice auch der “X virtual frame buffer”
2271 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
2272 Andere Distributionen enthalten ihn in anderen Paketen.</para>
2274 <para>Nach der Installation müssen in der Datei
2275 <filename>config/kivitendo.conf</filename> im Abschnitt
2276 <literal>applications</literal> zwei weitere Variablen
2277 angepasst werden:</para>
2278 <para><literal>openofficeorg_writer</literal> muss den
2279 vollständigen Pfad zu LibreOffice oder OpenOffice enthalten.
2280 Dabei dürfen keine Anführungszeichen eingesetzt werden.</para>
2281 <para>Beispiel für Debian oder Ubuntu:</para>
2282 <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2283 <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2286 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2287 LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die benutzt
2288 wird, wenn die Variable <literal>$openofficeorg_daemon</literal> gesetzt
2289 ist, startet ein LibreOffice oder OpenOffice, das auch nach der Umwandlung
2290 des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen wird dann diese
2291 laufende Instanz benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung
2292 deutlich reduziert wird, weil nicht für jedes Dokument ein LibreOffice bzw.
2293 OpenOffice gestartet werden muss. Der Nachteil ist, dass diese Methode
2294 Python und die Python-UNO-Bindings benötigt, die Bestandteil von LibreOffice
2295 bzw. OpenOffice sind.</para>
2298 <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2299 normalerweise der Python-Interpreter
2300 <filename>/usr/bin/python</filename> benutzt.
2301 Sollte dies nicht der richtige sein, so kann man mit zwei
2302 Konfigurationsvariablen entscheiden, welcher Python-Interpreter
2303 genutzt wird. Mit der Option <literal>python_uno</literal> aus dem
2304 Abschnitt <literal>applications</literal> wird der Interpreter selber
2305 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2306 <literal>/usr/bin/python</literal>.</para>
2308 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2309 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2310 z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2311 OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2312 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2313 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2314 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2315 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2316 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2320 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2321 wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet
2322 und die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses
2323 Makro muss in der Dokumentenvorlage enthalten sein und
2324 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2325 ‘<literal>templates/print/rev-odt/invoice.odt</literal>’
2326 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
2327 ebenfalls enthalten sein muss.</para>
2329 <para>Als letztes muss herausgefunden werden, welchen Namen
2330 OpenOffice bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen
2331 gibt. Unter Debian ist dies momentan
2332 <literal>~/.config/libreoffice</literal>. kivitendo verwendet das
2333 Verzeichnis <literal>users/.openoffice.org2</literal>.
2334 Eventuell muss dieses Verzeichnis umbenannt werden.</para>
2336 <para>Dieses Verzeichnis, wie auch das komplette
2337 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2338 sein. Dieses wurde bereits erledigt (siehe <xref
2339 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber
2340 erneut überprüft werden, wenn die Konvertierung nach PDF
2344 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2346 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2347 Aufgaben erfüllen.</para>
2349 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2350 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2351 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2352 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2353 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2354 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2355 Anpassungen aufgeführt</emphasis>):</para>
2358 <title>Bezeichnung der Vorlagen</title>
2360 <para>Rechnung: invoice_besr.odt, Auftrag:
2361 sales_order_besr.odt</para>
2365 <title>Vorbereitungen im Adminbereich</title>
2367 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2368 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2369 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2370 ein Drucker eingerichtet werden:</para>
2374 <para>Druckeradministration → Drucker hinzufügen</para>
2378 <para>Mandant wählen</para>
2382 <para>Druckerbeschreibung → aussagekräftiger Text: wird in
2383 der Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B.
2384 mit Einzahlungsschein Bank xy)</para>
2388 <para>Druckbefehl → beliebiger Text (hat für das Erzeugen
2389 von Aufträgen oder Rechnungen als odt-Datei keine Bedeutung,
2390 darf aber nicht leer sein)</para>
2394 <para>Vorlagenkürzel → besr bzw. selbst gewähltes
2395 Vorlagensuffix (muss genau der Zeichenfolge entsprechen, die
2396 zwischen "invoice_" bzw. "sales_order_" und ".odt"
2401 <para>speichern</para>
2407 <title>Benutzereinstellungen</title>
2409 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2410 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2411 dies persönlich für sich bei den Benutzereinstellungen
2412 konfigurieren:</para>
2416 <para>Programm → Benutzereinstellungen →
2417 Druckoptionen</para>
2421 <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2425 <para>Standardausgabekanal → Bildschirm</para>
2429 <para>Standarddrucker → gewünschte Druckerbeschreibung
2430 auswählen (z.B. mit Einzahlungsschein Bank xy)</para>
2434 <para>Anzahl Kopien → leer</para>
2438 <para>speichern</para>
2444 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2446 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2447 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2448 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2449 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2454 <para>Für den Einzahlungsschein ist die letzte Seite des
2455 Dokuments reserviert</para>
2459 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2460 Zeile mit folgenden Angaben (<emphasis
2461 role="bold">Bank-Konto-Identifikationsnummer und
2462 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2463 Bank angepasst werden</emphasis>):<itemizedlist>
2465 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2466 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2468 <para>erster Wert: <emphasis
2469 role="bold">Bank-Konto-Identifikation</emphasis>
2470 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2471 angepasst werden</emphasis>.</para>
2475 <para>zweiter Wert: <%customernumber%>
2476 (Kundennummer: nur Ziffern, maximal 6)</para>
2480 <para>dritter Wert: <%ordnumber%>
2481 (Auftragsnummer bei Auftragsvorlage
2482 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2483 führende Buchstaben werden vom Makro entfernt</para>
2487 <para>vierter Wert: <%invnumber%>
2488 (Rechnungsnummer bei Rechnungsvorlage
2489 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2490 führende Buchstaben werden vom Makro entfernt</para>
2492 </itemizedlist></para>
2496 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2497 Bank, muss angepasst werden</emphasis>.</para>
2501 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2502 falls Einzahlungsschein ohne Betrag</para>
2506 <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2508 </itemizedlist></para>
2512 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2513 der Name und die Adresse der Bank, die Postkonto-Nummer der
2514 Bank, sowie der eigene Firmenname und die Firmenadresse
2515 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2516 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2517 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2523 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2524 ändernde Einträge in rot</screeninfo>
2528 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2535 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2536 odt-Rechnung (analog bei Auftrag)</title>
2538 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2539 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2540 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2541 den Benutzereinstellungen als persönlicher Standard gewählt
2546 <title>Makroeinstellungen in LibreOffice anpassen</title>
2548 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2549 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2550 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2551 angepasst werden:</para>
2555 <para>Extras → Optionen → Sicherheit →
2556 Makrosicherheit</para>
2560 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2561 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2562 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2567 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2568 der entsprechenden Nachfrage "Makros ausführen" auswählen.
2571 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2572 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2573 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2574 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2582 <sect1 id="config.eur">
2583 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
2586 <sect2 id="config.eur.introduction"
2587 xreflabel="Einführung in die Konfiguration zur EUR">
2588 <title>Einführung</title>
2590 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
2591 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
2592 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
2593 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
2594 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
2596 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
2597 die Mandantendatenbank verschoben und dabei auch gleich in drei
2598 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
2599 steuern lässt.</para>
2602 <sect2 id="config.eur.parameters"
2603 xreflabel="Konfigurationsparameter für EUR">
2604 <title>Konfigurationsparameter</title>
2606 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
2607 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
2611 <term><varname>profit_determination</varname></term>
2614 <para>Dieser Parameter legt die Berechnungsmethode für die
2615 Gewinnermittlung fest. Er enthält entweder
2616 <literal>balance</literal> für
2617 Betriebsvermögensvergleich/Bilanzierung oder
2618 <literal>income</literal> für die
2619 Einnahmen-Überschuss-Rechnung.</para>
2624 <term><varname>accounting_method</varname></term>
2627 <para>Dieser Parameter steuert die Buchungs- und
2628 Berechnungsmethoden für die Versteuerungsart. Er enthält
2629 entweder <literal>accrual</literal> für die Soll-Versteuerung
2630 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
2635 <term><varname>inventory_system</varname></term>
2638 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
2639 enthält entweder <literal>perpetual</literal> für die
2640 Bestandsmethode oder <literal>periodic</literal> für die
2641 Aufwandsmethode.</para>
2646 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
2647 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
2648 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
2649 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
2650 Bestandsmethode.</para>
2652 <para>Die Konfiguration "<varname>eur</varname>" unter
2653 <varname>[system]</varname> in der <link
2654 linkend="config.config-file">Konfigurationsdatei</link>
2655 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
2656 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
2659 <sect2 id="config.eur.setting-parameters">
2660 <title>Festlegen der Parameter</title>
2662 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
2663 der Admininstration können diese Optionen nun unabhängig voneinander
2664 eingestellt werden.</para>
2666 <para>Für die Schweiz sind folgende Einstellungen üblich:
2669 <para>Sollversteuerung</para>
2672 <para>Aufwandsmethode</para>
2675 <para>Bilanzierung</para>
2678 Diese Einstellungen werden automatisch beim Erstellen einer neuen
2679 Datenbank vorausgewählt, wenn in <filename>config/kivitendo.conf</filename> unter
2680 <varname>[system]</varname> <literal>default_manager = swiss</literal> eingestellt ist.
2683 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
2684 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
2687 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
2688 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
2689 angezeigt. Unter <guimenu>System</guimenu> →
2690 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
2691 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
2692 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
2693 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
2694 auch <link linkend="config.eur.inventory-system-perpetual">
2695 Bemerkungen zur Bestandsmethode</link>).</para>
2698 <sect2 id="config.eur.inventory-system-perpetual">
2699 <title>Bemerkungen zur Bestandsmethode</title>
2701 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
2702 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
2703 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
2704 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
2705 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
2706 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
2707 Einkaufsrechnungen berechnet wird.</para>
2709 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
2710 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
2711 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
2715 <sect2 id="config.eur.knonw-issues">
2716 <title>Bekannte Probleme</title>
2718 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
2719 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
2720 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
2721 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
2722 die Konfigurationsvariable
2723 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
2726 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
2727 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
2731 <sect1 id="config.skr04-update-3804">
2732 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
2734 <sect2 id="config.skr04-update-3804.introduction">
2735 <title>Einführung</title>
2737 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
2738 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
2739 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
2740 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
2741 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
2742 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
2743 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
2744 vielleicht schon selbst geholfen hat und mit seinen Änderungen
2745 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
2746 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
2747 Screenshots dargestellt.</para>
2749 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
2750 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
2751 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
2752 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
2755 <sect2 id="config.skr04-update-3804.create-chart">
2756 <title>Konto 3804 manuell anlegen</title>
2758 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
2759 anzulegen und zu konfigurieren. Zuerst wird in
2760 <guimenu>System</guimenu> →
2761 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konto
2762 erfassen</guimenuitem> das Konto angelegt.</para>
2765 <screeninfo>Konto 3804 erfassen</screeninfo>
2769 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
2774 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
2775 werden. Dazu unter <guimenu>System</guimenu> →
2776 <guisubmenu>Steuern</guisubmenu> →
2777 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
2778 13 auswählen und ihn wie im folgenden Screenshot angezeigt
2782 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
2786 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
2791 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
2792 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
2793 <guisubmenu>Steuern</guisubmenu> →
2794 <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem
2795 Screenshot übernehmen.</para>
2798 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
2802 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
2807 <para>Als Nächstes sind alle Konten anzupassen, die als
2808 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
2809 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
2810 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
2811 müssen Sie dazu unter <guimenu>System</guimenu> →
2812 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
2813 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
2814 wie im Screenshot gezeigt vornehmen.</para>
2817 <screeninfo>Konto 4315 anpassen</screeninfo>
2821 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
2826 <para>Als Letztes sollte die Steuerliste unter
2827 <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
2828 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
2829 Vergleich der Screenshot.</para>
2832 <screeninfo>Steuerliste vergleichen</screeninfo>
2836 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
2843 <sect1 id="config.bilanz">
2844 <title>Verhalten des Bilanzberichts</title>
2846 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
2847 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
2848 monatsweise führt dies zu falschen Werten.</para>
2850 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
2851 einstellen indem man:</para>
2855 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
2860 <para>immer den Jahresanfang nimmt (1.1. relativ zum
2865 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
2867 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
2870 <para>- oder mit "alle Buchungen" als Alternative"</para>
2874 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
2879 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
2883 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
2884 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
2885 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
2886 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
2887 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
2888 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
2889 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
2890 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
2891 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
2892 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
2893 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
2894 Erfolgsrechnung.</para>
2897 <sect1 id="config.erfolgsrechnung">
2898 <title>Erfolgsrechnung</title>
2900 <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht <emphasis role="bold">
2901 Erfolgsrechnung</emphasis>.</para>
2903 <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter Features
2904 an- oder abgeschaltet werden. Mit der Einstellung <varname>default_manager = swiss
2905 </varname> in der <filename>config/kivitendo.conf</filename> wird beim neu Erstellen
2906 einer Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü <guimenu>Berichte
2907 </guimenu> ausgewählt und ersetzt dort die GUV.</para>
2909 <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche Aufwands- und
2910 Erlöskonten einzeln aufgelistet (analog zur Bilanz), sortiert nach ERTRAG und AUFWAND.</para>
2912 <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der Erfolgsrechnung
2913 erscheinen soll, unter <varname>Sonstige Einstellungen/Erfolgsrechnung</varname>
2914 entweder <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal> ausgewählt
2917 <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal> ausgewählt,
2918 so wird dieses Konto als Aufwandsminderung unter AUFWAND aufgelistet.</para>
2920 <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal> ausgewählt,
2921 so wird dieses Konto als Ertragsminderung unter ERTRAG aufgelistet.</para>
2923 <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft zusätzlich
2924 die Erfolgsrechnung als Bericht verwendet werden, so müssen die Einstellungen
2925 zu allen Erlös- und Aufwandskonten unter <varname>Sonstige
2926 Einstellungen/Erfolgsrechnung</varname> überprüft und allenfalls neu gesetzt werden.</para>
2929 <sect1 id="config.rounding">
2930 <title>Rundung in Verkaufsbelegen</title>
2932 <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert von 5 Rappen (0.05 CHF).</para>
2934 <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer Genauigkeit
2935 von 0.01 CHF verwendet werden können, ist es trotzdem nach wie vor üblich,
2936 Rechnungen mit auf 0.05 CHF gerundeten Beträgen auszustellen.</para>
2938 <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine solche
2939 Rundung pro Mandant / Datenbank festgelegt werden.</para>
2941 <para>Die Einstellung wird beim Erstellen der Datenbank bei <literal>Genauigkeit</literal>
2942 festgelegt. Sie kann anschliessend über das Webinterface von kivitendo nicht mehr
2943 verändert werden.</para>
2945 <para>Abhängig vom Wert für <varname>default_manager</varname> in
2946 <filename>config/kivitendo.conf</filename> werden dabei folgende
2947 Werte voreingestellt:</para>
2950 <para>0.05 (default_manager = swiss)</para>
2953 <para>0.01 (default_manager = german)</para>
2956 <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
2957 </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
2959 <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
2960 und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet,
2961 wenn dieser nicht der eingestellten Genauigkeit entspricht.</para>
2963 <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
2964 automatisch auf die in der Mandantenkonfiguration festgelegten
2965 Standardkonten für Rundungserträge bzw. Rundungsaufwendungen gebucht.</para>
2967 <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr verändert.)</para>
2969 <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
2970 <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
2971 <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
2973 <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege
2974 in anderen Währungen als der Standardwährung erstellt, so muss in
2975 kivitendo 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
2976 <para>Das heisst, Firmen in der Schweiz, die teilweise Verkaufsrechnungen
2977 in Euro oder anderen Währungen erstellen wollen, müssen beim Erstellen
2978 der Datenbank als Genauigkeit 0.01 wählen und können zur Zeit die
2979 5er Rundung noch nicht nutzen.</para>
2982 <sect1 id="config.client">
2983 <title>Einstellungen pro Mandant</title>
2985 <para>Einige Einstellungen können von einem Benutzer mit dem <link
2986 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
2987 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
2988 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
2989 Die Einstellungen sind unter <guimenu>System</guimenu> →
2990 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
2992 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
2993 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
2994 geändert werden (siehe auch <link
2995 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
2996 Bestandsmethode</link>).</para>
2998 <para>Die Einstellungen <literal>show_bestbefore</literal> und
2999 <literal>payments_changeable</literal> aus dem Abschnitt
3000 <literal>features</literal> und die Einstellungen im Abschnitt
3001 <literal>datev_check</literal> (sofern schon vorhanden) der <link
3002 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3003 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3004 Diese Einträge können danach aus der Konfigurationsdatei entfernt
3008 <sect1 id="kivitendo-ERP-verwenden">
3009 <title>kivitendo ERP verwenden</title>
3011 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3012 folgender URL erreichbar:</para>
3015 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3017 <para>Die Administrationsseite erreichen Sie unter:</para>
3020 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3024 <chapter id="features" xreflabel="Features und Funktionen">
3025 <title>Features und Funktionen</title>
3027 <sect1 id="features.periodic-invoices"
3028 xreflabel="Wiederkehrende Rechnungen">
3029 <title>Wiederkehrende Rechnungen</title>
3031 <sect2 id="features.periodic-invoices.introduction"
3032 xreflabel="Einführung in wiederkehrende Rechnungen">
3033 <title>Einführung</title>
3035 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3036 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3037 Die konfigurierten Aufträge werden später automatisch in Rechnungen
3038 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3039 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3040 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3041 wiederzufinden sind.</para>
3044 <sect2 id="features.periodic-invoices.configuration"
3045 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3046 <title>Konfiguration</title>
3048 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3049 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3050 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3051 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3052 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3055 <para>Folgende Parameter kann man konfigurieren:</para>
3062 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3063 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3064 eines neuen Monats).</para>
3066 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3067 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3068 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3069 nächsten Periodenwechsel für alle Perioden, seit der letzten
3070 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3071 verhindern, muss man vorher das Startdatum neu setzen.</para>
3073 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3074 erstellt. Man kann sich diese Aufträge aber gesondert in den
3075 Berichten anzeigen lassen.</para>
3080 <term>Periodizität</term>
3083 <para>Ob monatlich, quartalsweise oder jährlich auf neue
3084 Rechnungen überprüft werden soll. Für jede Periode seit dem
3085 Startdatum wird überprüft, ob für die Periode (beginnend immer
3086 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3087 wurde. Unter Umständen können bei einem Startdatum in der
3088 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3093 <term>Buchen auf</term>
3096 <para>Das Forderungskonto, in der Regel "Forderungen aus
3097 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3098 Buchungsgruppen der betreffenden Waren.</para>
3103 <term>Startdatum</term>
3106 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3112 <term>Enddatum</term>
3115 <para>ab wann keine Rechnungen mehr erstellt werden
3121 <term>Automatische Verlängerung um x Monate</term>
3124 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3125 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3126 hier die Anzahl der Monate eingeben, um die das Enddatum
3127 automatisch nach hinten geschoben wird.</para>
3132 <term>Drucken</term>
3135 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3136 Rechnungen auch gleich ausdrucken lassen.</para>
3141 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3142 Informationen zu den erstellten Rechnungen verschickt werden.
3143 Konfiguriert wird dies in der <link
3144 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3145 <filename>config/kivitendo.conf</filename> im Abschnitt
3146 <varname>[periodic_invoices]</varname>.</para>
3149 <sect2 id="features.periodic-invoices.variables">
3150 <title>Spezielle Variablen</title>
3152 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3153 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3154 formatierte Variablen durch für die jeweils aktuelle
3155 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3156 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3157 die Syntax <literal><%variablenname%></literal>.</para>
3159 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3160 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3161 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3162 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3163 Die zur verfügung stehenden Formatinformationen werden unten genauer
3166 <para>Diese Variablen können auch beim automatischen Versand der
3167 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3168 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3170 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3175 <para>Bemerkungen</para>
3179 <para>Interne Bemerkungen</para>
3183 <para>Vorgangsbezeichnung</para>
3187 <para>In den Beschreibungs- und Langtextfeldern aller
3192 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3196 <term><varname><%current_quarter%></varname>,
3197 <varname><%previous_quarter%></varname>,
3198 <varname><%next_quarter%></varname></term>
3201 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3202 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3207 <term><varname><%current_month%></varname>,
3208 <varname><%previous_month%></varname>,
3209 <varname><%next_month%></varname></term>
3212 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3213 <literal>1</literal> und <literal>12</literal>.</para>
3218 <term><varname><%current_month_long%></varname>,
3219 <varname><%previous_month_long%></varname>,
3220 <varname><%next_month_long%></varname></term>
3223 <para>Aktueller, vorheriger und nächster Monat als Name
3224 (<literal>Januar</literal>, <literal>Februar</literal>
3230 <term><varname><%current_year%></varname>,
3231 <varname><%previous_year%></varname>,
3232 <varname><%next_year%></varname></term>
3235 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3236 Jahreszahl (<literal>2013</literal> etc.).</para>
3241 <term><varname><%period_start_date%></varname>,
3242 <varname><%period_end_date%></varname></term>
3245 <para>Formatiertes Datum des ersten und letzten Tages im
3246 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3247 ersten Quartal von 2013 wären dies der
3248 <literal>01.01.2013</literal> und
3249 <literal>31.03.2013</literal>).</para>
3254 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3255 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3256 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3257 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3262 <term><varname>%a</varname></term>
3265 <para>Der abgekürzte Wochentagsname.</para>
3270 <term><varname>%A</varname></term>
3273 <para>Der ausgeschriebene Wochentagsname.</para>
3278 <term><varname>%b</varname></term>
3281 <para>Der abgekürzte Monatsname.</para>
3286 <term><varname>%B</varname></term>
3289 <para>Der ausgeschriebene Monatsname.</para>
3294 <term><varname>%C</varname></term>
3297 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3303 <term><varname>%d</varname></term>
3306 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3311 <term><varname>%D</varname></term>
3314 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3319 <term><varname>%e</varname></term>
3322 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3323 werden führende Nullen durch Leerzeichen ersetzt.</para>
3328 <term><varname>%F</varname></term>
3331 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3336 <term><varname>%j</varname></term>
3339 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3345 <term><varname>%m</varname></term>
3348 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3353 <term><varname>%u</varname></term>
3356 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3357 die 1 dem Montag entspricht.</para>
3362 <term><varname>%U</varname></term>
3365 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3366 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3372 <term><varname>%V</varname></term>
3375 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3376 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3377 vier Tage im Jahr liegen; Montag ist erster Tag der
3383 <term><varname>%w</varname></term>
3386 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3387 die 0 dem Sonntag entspricht.</para>
3392 <term><varname>%W</varname></term>
3395 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3396 wobei der erste Montag im Jahr das Startdatum von Woche 01
3402 <term><varname>%y</varname></term>
3405 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3411 <term><varname>%Y</varname></term>
3414 <para>Das Jahr als vierstellige Zahl.</para>
3419 <term><varname>%%</varname></term>
3422 <para>Das Prozentzeichen selber.</para>
3427 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3428 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3429 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3430 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3433 <sect2 id="features.periodic-invoices.reports">
3434 <title>Auflisten</title>
3436 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3437 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3438 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3439 wiederkehrenden Rechnungen verschaffen kann.</para>
3442 <sect2 id="features.periodic-invoices.task-server">
3443 <title>Erzeugung der eigentlichen Rechnungen</title>
3445 <para>Die zeitliche und periodische Überprüfung, ob eine
3446 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3447 durch den <link linkend="config.task-server">Taskserver</link>, einen
3448 externen Dienst, der automatisch beim Start des Servers gestartet
3449 werden sollte.</para>
3452 <sect2 id="features.periodic-invoices.create-for-current-month">
3453 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3455 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3456 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3457 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
3458 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3459 generiert hat. Alternativ setzt man das Startdatum auf den
3460 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3461 manuell über den Workflow.</para>
3465 <sect1 id="features.bank" xreflabel="bankerweiterung">
3466 <title>Bankerweiterung</title>
3468 <sect2 id="features.bank.introduction"
3469 xreflabel="Einführung in die Bankerweiterung">
3470 <title>Einführung</title>
3472 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3473 im Wiki und soll von dort später hierhin übernommen werden:</para>
3476 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3480 <sect1 id="dokumentenvorlagen-und-variablen">
3481 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3483 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3484 <title>Einführung</title>
3486 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3487 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3488 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3489 <function><%variablenname%></function> verwendet wird. Für
3490 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3492 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3494 <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3495 Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im
3496 Folgenden gesagte für alle Vorlagenarten.</para>
3498 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3499 verfügbar als hier aufgelistet werden. Die meisten davon können
3500 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3501 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3502 diese wie folgt erhalten werden:</para>
3506 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3507 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3511 <para>In <filename>Form.pm</filename> die Funktion
3512 <function>parse_template</function> suchen und hier die Zeile
3513 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3517 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3518 ein PDF für eine Rechnung erzeugen.</para>
3522 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3523 der Variablen <varname>$self</varname> in der Form <varname>'key'
3524 => 'value',</varname>. Alle <varname>key</varname>s sind
3530 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3531 <title>Variablen ausgeben</title>
3533 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3534 Tags geschrieben werden, also z.B.
3535 <varname><%variablenname%></varname>.</para>
3537 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3538 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3539 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
3540 werden die folgenden Flags unterstützt:</para>
3544 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3545 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3546 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3547 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3551 <para><option>NOESCAPE</option> unterdrückt das Escapen von
3552 Sonderzeichen für die Vorlagensprache. Wenn also in einer
3553 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
3554 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
3555 ist dieses Flag sinnvoll.</para>
3559 <para>Beispiel:</para>
3561 <programlisting><%quototal NOFORMAT%></programlisting>
3564 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
3565 <title>Verwendung in Druckbefehlen</title>
3567 <para>In der Admininstration können Drucker definiert werden. Auch im
3568 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
3569 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
3570 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
3571 <function>`...`</function> nicht zu unerwünschtem Verhalten
3574 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
3575 für das die Telefonnummer eines Ansprechpartners als Teil der
3576 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
3577 z.B. wie folgt aussehen:</para>
3579 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
3582 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
3583 xreflabel="Anfang und Ende der Tags verändern">
3584 <title>Anfang und Ende der Tags verändern</title>
3586 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
3587 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
3588 Prozentzeichen und dem Größerzeichen endet, beispielsweise
3589 <function><%customer%></function>. Da diese Form aber z.B. in
3590 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
3591 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
3592 Stil umgestellt werden.</para>
3594 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
3595 Format gültigen Kommentarzeichen anfangen, dann
3596 <function>config:</function> enthalten, die entsprechende Option
3597 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
3598 enden. Beispiel für LaTeX:</para>
3600 <programlisting>% config: tag-style=($ $)</programlisting>
3602 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
3603 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
3604 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
3606 <programlisting><!-- config: tag-style=($ $) --></programlisting>
3609 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
3610 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
3612 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
3613 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
3614 "<filename>.ext</filename>" geeignet zu ersetzen:
3615 "<filename>.tex</filename>" für LaTeX-Vorlagen und
3616 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
3620 <term><filename>bin_list.ext</filename></term>
3623 <para>Lagerliste</para>
3628 <term><filename>check.ext</filename></term>
3636 <term><filename>invoice.ext</filename></term>
3639 <para>Rechnung</para>
3644 <term><filename>packing_list.ext</filename></term>
3647 <para>Packliste</para>
3652 <term><filename>pick_list.ext</filename></term>
3655 <para>Sammelliste</para>
3660 <term><filename>purchase_delivery_order.ext</filename></term>
3663 <para>Lieferschein (Einkauf)</para>
3668 <term><filename>purcharse_order.ext</filename></term>
3671 <para>Bestellung an Lieferanten</para>
3676 <term><filename>request_quotation.ext</filename></term>
3679 <para>Anfrage an Lieferanten</para>
3684 <term><filename>sales_delivery_order.ext</filename></term>
3687 <para>Lieferschein (Verkauf)</para>
3692 <term><filename>sales_order.ext</filename></term>
3695 <para>Bestellung</para>
3700 <term><filename>sales_quotation.ext</filename></term>
3703 <para>Angebot an Kunden</para>
3708 <term><filename>zahlungserinnerung.ext</filename></term>
3711 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
3716 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
3719 <para>Rechnung über Mahngebühren (Dateiname im Programm
3720 konfigurierbar)</para>
3726 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
3727 <title>Sprache, Drucker und E-Mail</title>
3729 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
3730 eingearbeitet. So wird aus der Vorlage
3731 <filename>sales_order.ext</filename> bei Sprache
3732 <function>de</function> und Druckerkürzel <function>lpr2</function>
3733 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
3734 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
3735 bekommen dann noch das Kürzel <filename>_email</filename>, der
3736 vollständige Vorlagenname wäre dann
3737 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
3738 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
3739 werden. Diese wird verwendet, wenn keine der anderen Varianten
3740 gefunden wird.</para>
3742 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
3743 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
3744 verschickt wird, ist:</para>
3748 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
3752 <para><filename>sales_order_de_lpr2.tex</filename></para>
3756 <para><filename>sales_order.tex</filename></para>
3760 <para><filename>default.tex</filename></para>
3764 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
3765 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
3767 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
3770 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
3771 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
3774 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
3775 xreflabel="Metainformationen zur angeforderten Vorlage">
3776 <title>Metainformationen zur angeforderten Vorlage</title>
3778 <para>Diese Variablen liefern Informationen darüber welche Variante
3779 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
3780 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
3781 Formulare einbinden möchten.</para>
3785 <term><varname>template_meta.formname</varname></term>
3788 <para>Basisname der Vorlage. Identisch mit der <link
3789 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
3790 zu den Dateinamen</link> ohne die Erweiterung. Ein
3791 Verkaufsauftrag enthält hier
3792 <constant>sales_order</constant>.</para>
3797 <term><varname>template_meta.language.description</varname></term>
3800 <para>Beschreibung der verwendeten Sprache</para>
3805 <term><varname>template_meta.language.template_code</varname></term>
3808 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
3809 dem Kürzel das im Dateinamen verwendetet wird.</para>
3814 <term><varname>template_meta.language.output_numberformat</varname></term>
3817 <para>Zahlenformat der verwendeten Sprache in der Form
3818 "<constant>1.000,00</constant>". Experimentell! Nur
3819 interessant für Vorlagen die mit unformatierten Werten
3825 <term><varname>template_meta.language.output_dateformat</varname></term>
3828 <para>Datumsformat der verwendeten Sprache in der Form
3829 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
3830 interessant für Vorlagen die mit unformatierten Werten
3836 <term><varname>template_meta.format</varname></term>
3839 <para>Das angeforderte Format. Kann im Moment die Werte
3840 <constant>pdf</constant>, <constant>postscript</constant>,
3841 <constant>html</constant>, <constant>opendocument</constant>,
3842 <constant>opendocument_pdf</constant> und
3843 <constant>excel</constant> enthalten.</para>
3848 <term><varname>template_meta.extension</varname></term>
3851 <para>Dateierweiterung, wie im Dateinamen. Wird aus
3852 <constant>format</constant> entschieden.</para>
3857 <term><varname>template_meta.media</varname></term>
3860 <para>Ausgabemedium. Kann zur Zeit die Werte
3861 <constant>screen</constant> für Bildschirm,
3862 <constant>email</constant> für E-Mail (triggert das
3863 <constant>_email</constant> Kürzel im Dateinamen),
3864 <constant>printer</constant> für Drucker, und
3865 <constant>queue</constant> für Warteschlange enthalten.</para>
3870 <term><varname>template_meta.printer.description</varname></term>
3873 <para>Beschreibung des ausgewählten Druckers</para>
3878 <term><varname>template_meta.printer.template_code</varname></term>
3881 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
3882 dem Kürzel das im Dateinamen verwendetet wird.</para>
3887 <term><varname>template_meta.tmpfile</varname></term>
3890 <para>Datei-Prefix für temporäre Dateien.</para>
3896 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
3897 <title>Stammdaten von Kunden und Lieferanten</title>
3901 <term><varname>account_number</varname></term>
3904 <para>Kontonummer</para>
3909 <term><varname>bank</varname></term>
3912 <para>Name der Bank</para>
3917 <term><varname>bank_code</varname></term>
3920 <para>Bankleitzahl</para>
3925 <term><varname>bic</varname></term>
3928 <para>Bank-Identifikations-Code (Bank Identifier Code,
3934 <term><varname>business</varname></term>
3937 <para>Kunden-/Lieferantentyp</para>
3942 <term><varname>city</varname></term>
3950 <term><varname>contact</varname></term>
3953 <para>Kontakt</para>
3958 <term><varname>country</varname></term>
3966 <term><varname>c_vendor_id</varname></term>
3969 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
3974 <term><varname>v_customer_id</varname></term>
3977 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
3982 <term><varname>cp_email</varname></term>
3985 <para>Email des Ansprechpartners</para>
3990 <term><varname>cp_givenname</varname></term>
3993 <para>Vorname des Ansprechpartners</para>
3998 <term><varname>cp_greeting</varname></term>
4001 <para>Anrede des Ansprechpartners</para>
4006 <term><varname>cp_name</varname></term>
4009 <para>Name des Ansprechpartners</para>
4014 <term><varname>cp_phone1</varname></term>
4017 <para>Telefonnummer 1 des Ansprechpartners</para>
4022 <term><varname>cp_phone2</varname></term>
4025 <para>Telefonnummer 2 des Ansprechpartners</para>
4030 <term><varname>cp_title</varname></term>
4033 <para>Titel des Ansprechpartners</para>
4038 <term><varname>creditlimit</varname></term>
4041 <para>Kreditlimit</para>
4046 <term><varname>customeremail</varname></term>
4049 <para>Email des Kunden; nur für Kunden</para>
4054 <term><varname>customerfax</varname></term>
4057 <para>Faxnummer des Kunden; nur für Kunden</para>
4062 <term><varname>customernotes</varname></term>
4065 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4070 <term><varname>customernumber</varname></term>
4073 <para>Kundennummer; nur für Kunden</para>
4078 <term><varname>customerphone</varname></term>
4081 <para>Telefonnummer des Kunden; nur für Kunden</para>
4086 <term><varname>discount</varname></term>
4094 <term><varname>email</varname></term>
4097 <para>Emailadresse</para>
4102 <term><varname>fax</varname></term>
4105 <para>Faxnummer</para>
4110 <term><varname>gln</varname></term>
4113 <para>GLN (Globale Lokationsnummer)</para>
4118 <term><varname>greeting</varname></term>
4126 <term><varname>homepage</varname></term>
4129 <para>Homepage</para>
4134 <term><varname>iban</varname></term>
4137 <para>Internationale Kontonummer (International Bank Account
4138 Number, IBAN)</para>
4143 <term><varname>language</varname></term>
4146 <para>Sprache</para>
4151 <term><varname>name</varname></term>
4154 <para>Firmenname</para>
4159 <term><varname>payment_description</varname></term>
4162 <para>Name der Zahlart</para>
4167 <term><varname>payment_terms</varname></term>
4170 <para>Zahlungskonditionen</para>
4175 <term><varname>phone</varname></term>
4178 <para>Telefonnummer</para>
4183 <term><varname>shiptocity</varname></term>
4186 <para>Stadt (Lieferadresse) <link
4187 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4192 <term><varname>shiptocontact</varname></term>
4195 <para>Kontakt (Lieferadresse) <link
4196 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4201 <term><varname>shiptocountry</varname></term>
4204 <para>Land (Lieferadresse) <link
4205 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4210 <term><varname>shiptodepartment_1</varname></term>
4213 <para>Abteilung 1 (Lieferadresse) <link
4214 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4219 <term><varname>shiptodepartment_2</varname></term>
4222 <para>Abteilung 2 (Lieferadresse) <link
4223 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4228 <term><varname>shiptoemail</varname></term>
4231 <para>Email (Lieferadresse) <link
4232 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4237 <term><varname>shiptofax</varname></term>
4240 <para>Fax (Lieferadresse) <link
4241 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4246 <term><varname>shiptogln</varname></term>
4249 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4250 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4255 <term><varname>shiptoname</varname></term>
4258 <para>Firmenname (Lieferadresse) <link
4259 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4264 <term><varname>shiptophone</varname></term>
4267 <para>Telefonnummer (Lieferadresse) <link
4268 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4273 <term><varname>shiptostreet</varname></term>
4276 <para>Straße und Hausnummer (Lieferadresse) <link
4277 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4282 <term><varname>shiptozipcode</varname></term>
4285 <para>Postleitzahl (Lieferadresse) <link
4286 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4291 <term><varname>street</varname></term>
4294 <para>Straße und Hausnummer</para>
4299 <term><varname>taxnumber</varname></term>
4302 <para>Steuernummer</para>
4307 <term><varname>ustid</varname></term>
4310 <para>Umsatzsteuer-Identifikationsnummer</para>
4315 <term><varname>vendoremail</varname></term>
4318 <para>Email des Lieferanten; nur für Lieferanten</para>
4323 <term><varname>vendorfax</varname></term>
4326 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4331 <term><varname>vendornotes</varname></term>
4334 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4339 <term><varname>vendornumber</varname></term>
4342 <para>Lieferantennummer; nur für Lieferanten</para>
4347 <term><varname>vendorphone</varname></term>
4350 <para>Telefonnummer des Lieferanten; nur für
4356 <term><varname>zipcode</varname></term>
4359 <para>Postleitzahl</para>
4364 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4365 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4366 Stammdaten nicht eingetragen, so haben die Variablen
4367 <varname>shipto*</varname> den gleichen Wert wie die die
4368 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4369 einige <varname>shipto*</varname>-Variablen so nicht in den
4370 Stammdaten wiederfinden sondern schlicht Kopien der
4371 Lieferdatenvariablen sind (z.B.
4372 <varname>shiptocontact</varname>).</para>
4376 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4377 <title>Informationen über den Bearbeiter</title>
4381 <term><varname>employee_address</varname></term>
4384 <para>Adressfeld</para>
4389 <term><varname>employee_businessnumber</varname></term>
4392 <para>Firmennummer</para>
4397 <term><varname>employee_company</varname></term>
4400 <para>Firmenname</para>
4405 <term><varname>employee_co_ustid</varname></term>
4408 <para>Usatzsteuer-Identifikationsnummer</para>
4413 <term><varname>employee_duns</varname></term>
4416 <para>DUNS-Nummer</para>
4421 <term><varname>employee_email</varname></term>
4429 <term><varname>employee_fax</varname></term>
4437 <term><varname>employee_name</varname></term>
4440 <para>voller Name</para>
4445 <term><varname>employee_signature</varname></term>
4448 <para>Signatur</para>
4453 <term><varname>employee_taxnumber</varname></term>
4456 <para>Steuernummer</para>
4461 <term><varname>employee_tel</varname></term>
4464 <para>Telefonnummer</para>
4470 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4471 <title>Informationen über den Verkäufer</title>
4475 <term><varname>salesman_address</varname></term>
4478 <para>Adressfeld</para>
4483 <term><varname>salesman_businessnumber</varname></term>
4486 <para>Firmennummer</para>
4491 <term><varname>salesman_company</varname></term>
4494 <para>Firmenname</para>
4499 <term><varname>salesman_co_ustid</varname></term>
4502 <para>Usatzsteuer-Identifikationsnummer</para>
4507 <term><varname>salesman_duns</varname></term>
4510 <para>DUNS-Nummer</para>
4515 <term><varname>salesman_email</varname></term>
4523 <term><varname>salesman_fax</varname></term>
4531 <term><varname>salesman_name</varname></term>
4534 <para>voller Name</para>
4539 <term><varname>salesman_signature</varname></term>
4542 <para>Signatur</para>
4547 <term><varname>salesman_taxnumber</varname></term>
4550 <para>Steuernummer</para>
4555 <term><varname>salesman_tel</varname></term>
4558 <para>Telefonnummer</para>
4564 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
4565 <title>Variablen für die einzelnen Steuern</title>
4569 <term><varname>tax</varname></term>
4577 <term><varname>taxbase</varname></term>
4580 <para>zu versteuernder Betrag</para>
4585 <term><varname>taxdescription</varname></term>
4588 <para>Name der Steuer</para>
4593 <term><varname>taxrate</varname></term>
4596 <para>Steuersatz</para>
4602 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
4603 <title>Variablen für Lieferbedingungen</title>
4607 <term><varname>delivery_term</varname></term>
4610 <para>Datenbank-Objekt der Lieferbedingung</para>
4615 <term><varname>delivery_term.description</varname></term>
4618 <para>Beschreibung der Lieferbedingung</para>
4623 <term><varname>delivery_term.description_long</varname></term>
4626 <para>Langtext bzw. übersetzter Langtext der
4627 Lieferbedingung</para>
4634 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
4635 <title>Variablen in Rechnungen</title>
4637 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
4638 <title>Allgemeine Variablen</title>
4642 <term><varname>creditremaining</varname></term>
4645 <para>Verbleibender Kredit</para>
4650 <term><varname>currency</varname></term>
4653 <para>Währung</para>
4658 <term><varname>cusordnumber</varname></term>
4661 <para>Bestellnummer beim Kunden</para>
4666 <term><varname>deliverydate</varname></term>
4669 <para>Lieferdatum</para>
4674 <term><varname>duedate</varname></term>
4677 <para>Fälligkeitsdatum</para>
4682 <term><varname>globalprojectnumber</varname></term>
4685 <para>Projektnummer des ganzen Beleges</para>
4690 <term><varname>globalprojectdescription</varname></term>
4693 <para>Projekbeschreibung des ganzen Beleges</para>
4698 <term><varname>intnotes</varname></term>
4701 <para>Interne Bemerkungen</para>
4706 <term><varname>invdate</varname></term>
4709 <para>Rechnungsdatum</para>
4714 <term><varname>invnumber</varname></term>
4717 <para>Rechnungsnummer</para>
4722 <term><varname>invtotal</varname></term>
4725 <para>gesamter Rechnungsbetrag</para>
4730 <term><varname>notes</varname></term>
4733 <para>Bemerkungen der Rechnung</para>
4738 <term><varname>orddate</varname></term>
4741 <para>Auftragsdatum</para>
4746 <term><varname>ordnumber</varname></term>
4749 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
4750 erstellt wurde</para>
4755 <term><varname>payment_description</varname></term>
4758 <para>Name der Zahlart</para>
4763 <term><varname>payment_terms</varname></term>
4766 <para>Zahlungskonditionen</para>
4771 <term><varname>quodate</varname></term>
4774 <para>Angebotsdatum</para>
4779 <term><varname>quonumber</varname></term>
4782 <para>Angebotsnummer</para>
4787 <term><varname>rounding</varname></term>
4790 <para>Betrag, um den <varname>invtotal</varname> gerundet wurde
4791 (kann positiv oder negativ sein)</para>
4796 <term><varname>shippingpoint</varname></term>
4799 <para>Versandort</para>
4804 <term><varname>shipvia</varname></term>
4807 <para>Transportmittel</para>
4812 <term><varname>subtotal</varname></term>
4815 <para>Zwischensumme aller Posten ohne Steuern</para>
4820 <term><varname>total</varname></term>
4823 <para>Restsumme der Rechnung (Summe abzüglich bereits
4824 bezahlter Posten)</para>
4829 <term><varname>transaction_description</varname></term>
4832 <para>Vorgangsbezeichnung</para>
4837 <term><varname>transdate</varname></term>
4840 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
4841 erstellt wurde</para>
4847 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
4848 <title>Variablen für jeden Posten auf der Rechnung</title>
4852 <term><varname>bin</varname></term>
4855 <para>Stellage</para>
4860 <term><varname>description</varname></term>
4863 <para>Artikelbeschreibung</para>
4868 <term><varname>cusordnumber_oe</varname></term>
4871 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
4872 Posten ursprünglich stammt (nur Verkauf)</para>
4877 <term><varname>discount</varname></term>
4880 <para>Rabatt als Betrag</para>
4885 <term><varname>discount_sub</varname></term>
4888 <para>Zwischensumme mit Rabatt</para>
4893 <term><varname>donumber_do</varname></term>
4896 <para>Lieferscheinnummer des Lieferscheins, aus dem die
4897 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
4898 Workflows aus einem Lieferschein erstellt wurde.</para>
4903 <term><varname>drawing</varname></term>
4906 <para>Zeichnung</para>
4911 <term><varname>ean</varname></term>
4914 <para>EAN-Code</para>
4919 <term><varname>image</varname></term>
4927 <term><varname>linetotal</varname></term>
4930 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
4935 <term><varname>longdescription</varname></term>
4938 <para>Langtext</para>
4943 <term><varname>microfiche</varname></term>
4946 <para>Mikrofilm</para>
4951 <term><varname>netprice</varname></term>
4954 <para>Alternative zu <varname>sellprice</varname>, aber
4955 <varname>netprice</varname> entspricht dem effektiven
4956 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
4957 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
4958 / Menge. Diese Variable ist nützlich, wenn man den gewährten
4959 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
4960 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
4961 <varname>netprice</varname> hat nichts mit Netto/Brutto im
4962 Sinne von Steuern zu tun.</para>
4967 <term><varname>nodiscount_linetotal</varname></term>
4970 <para>Zeilensumme ohne Rabatt</para>
4975 <term><varname>nodiscount_sub</varname></term>
4978 <para>Zwischensumme ohne Rabatt</para>
4983 <term><varname>number</varname></term>
4986 <para>Artikelnummer</para>
4991 <term><varname>ordnumber_oe</varname></term>
4994 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
4995 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
4996 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
4997 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
4998 letzterem Fall wird die unsprüngliche Auftragsnummer
5004 <term><varname>p_discount</varname></term>
5007 <para>Rabatt in Prozent</para>
5012 <term><varname>partnotes</varname></term>
5015 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5020 <term><varname>partsgroup</varname></term>
5023 <para>Warengruppe</para>
5028 <term><varname>price_factor</varname></term>
5031 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5037 <term><varname>price_factor_name</varname></term>
5040 <para>Der Name des Preisfaktors, sofern einer eingestellt
5046 <term><varname>projectnumber</varname></term>
5049 <para>Projektnummer</para>
5054 <term><varname>projectdescription</varname></term>
5057 <para>Projektbeschreibung</para>
5062 <term><varname>qty</varname></term>
5070 <term><varname>reqdate</varname></term>
5073 <para>Lieferdatum</para>
5078 <term><varname>runningnumber</varname></term>
5081 <para>Position auf der Rechnung (1, 2, 3...)</para>
5086 <term><varname>sellprice</varname></term>
5089 <para>Verkaufspreis</para>
5094 <term><varname>serialnumber</varname></term>
5097 <para>Seriennummer</para>
5102 <term><varname>tax_rate</varname></term>
5105 <para>Steuersatz</para>
5110 <term><varname>transdate_do</varname></term>
5113 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5114 Workflows aus einem Lieferschein stammte.</para>
5119 <term><varname>transdate_oe</varname></term>
5122 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5123 Workflows aus einem Auftrag erstellt wurde. Wenn es
5124 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5130 <term><varname>transdate_quo</varname></term>
5133 <para>Datum des Angebots, wenn die Position im Rahmen des
5134 Workflows aus einem Angebot stammte.</para>
5139 <term><varname>unit</varname></term>
5142 <para>Einheit</para>
5147 <term><varname>weight</varname></term>
5150 <para>Gewicht</para>
5155 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5156 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5157 einer <function>foreach</function>-Schleife ausgegeben werden, da
5158 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5159 können. Die Variablen dafür lauten:</para>
5163 <term><varname>make</varname></term>
5166 <para>Lieferant</para>
5171 <term><varname>model</varname></term>
5174 <para>Lieferantenartikelnummer</para>
5180 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5181 <title>Variablen für die einzelnen Zahlungseingänge</title>
5185 <term><varname>payment</varname></term>
5193 <term><varname>paymentaccount</varname></term>
5201 <term><varname>paymentdate</varname></term>
5209 <term><varname>paymentmemo</varname></term>
5217 <term><varname>paymentsource</varname></term>
5226 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5227 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5229 <para>Die vom Benutzer definierten Variablen für Kunden und
5230 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5231 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5232 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5233 Variablennamen zusammen.</para>
5235 <para>Beispiel: Der Benutzer hat eine Variable namens
5236 <varname>number_of_employees</varname> definiert, die die Anzahl der
5237 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5238 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5241 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5242 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5243 Präfix <varname>shiptocvar_</varname>.</para>
5247 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5248 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5250 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5251 <title>Namen der Vorlagen</title>
5253 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5254 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5255 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5256 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5257 Vorlagenname für diese Mahnstufe mit dem Zusatz
5258 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5259 für die ausgewählte Sprache und den ausgewählten Drucker
5263 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5264 <title>Allgemeine Variablen in Mahnungen</title>
5266 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5267 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5268 Kunden stehen als Variablen <varname>name</varname>,
5269 <varname>street</varname>, <varname>zipcode</varname>,
5270 <varname>city</varname>, <varname>country</varname>,
5271 <varname>department_1</varname>, <varname>department_2</varname>,
5272 und <varname>email</varname> zur Verfügung.</para>
5274 <para>Weitere Variablen beinhalten:</para>
5278 <term><varname>dunning_date</varname></term>
5281 <para>Datum der Mahnung</para>
5286 <term><varname>dunning_duedate</varname></term>
5289 <para>Fälligkeitsdatum für diese Mahhnung</para>
5294 <term><varname>dunning_id</varname></term>
5297 <para>Mahnungsnummer</para>
5302 <term><varname>fee</varname></term>
5305 <para>Kumulative Mahngebühren</para>
5310 <term><varname>interest_rate</varname></term>
5313 <para>Zinssatz per anno in Prozent</para>
5318 <term><varname>total_amount</varname></term>
5321 <para>Gesamter noch zu zahlender Betrag als
5322 <function>fee</function> + <function>total_interest</function>
5323 + <function>total_open_amount</function></para>
5328 <term><varname>total_interest</varname></term>
5331 <para>Zinsen per anno über alle Rechnungen</para>
5336 <term><varname>total_open_amount</varname></term>
5339 <para>Summe über alle offene Beträge der Rechnungen</para>
5345 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5346 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5350 <term><varname>dn_amount</varname></term>
5353 <para>Rechnungssumme (brutto)</para>
5358 <term><varname>dn_duedate</varname></term>
5361 <para>Originales Fälligkeitsdatum der Rechnung</para>
5366 <term><varname>dn_dunning_date</varname></term>
5369 <para>Datum der Mahnung</para>
5374 <term><varname>dn_dunning_duedate</varname></term>
5377 <para>Fälligkeitsdatum der Mahnung</para>
5382 <term><varname>dn_fee</varname></term>
5385 <para>Kummulative Mahngebühr</para>
5390 <term><varname>dn_interest</varname></term>
5393 <para>Zinsen per anno für diese Rechnung</para>
5398 <term><varname>dn_invnumber</varname></term>
5401 <para>Rechnungsnummer</para>
5406 <term><varname>dn_linetotal</varname></term>
5409 <para>Noch zu zahlender Betrag (ergibt sich aus
5410 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5411 + <varname>dn_interest</varname>)</para>
5416 <term><varname>dn_netamount</varname></term>
5419 <para>Rechnungssumme (netto)</para>
5424 <term><varname>dn_open_amount</varname></term>
5427 <para>Offener Rechnungsbetrag</para>
5432 <term><varname>dn_ordnumber</varname></term>
5435 <para>Bestellnummer</para>
5440 <term><varname>dn_transdate</varname></term>
5443 <para>Rechnungsdatum</para>
5448 <term><varname>dn_curr</varname></term>
5451 <para>Währung, in der die Rechnung erstellt wurde. (Die
5452 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5458 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5459 <title>Variablen in automatisch erzeugten Rechnungen über
5460 Mahngebühren</title>
5462 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5463 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5464 Kunden stehen als Variablen <varname>name</varname>,
5465 <varname>street</varname>, <varname>zipcode</varname>,
5466 <varname>city</varname>, <varname>country</varname>,
5467 <varname>department_1</varname>, <varname>department_2</varname>,
5468 und <varname>email</varname> zur Verfügung.</para>
5470 <para>Weitere Variablen beinhalten:</para>
5474 <term><varname>duedate</varname></term>
5477 <para>Fälligkeitsdatum der Rechnung</para>
5482 <term><varname>dunning_id</varname></term>
5485 <para>Mahnungsnummer</para>
5490 <term><varname>fee</varname></term>
5493 <para>Mahngebühren</para>
5498 <term><varname>interest</varname></term>
5506 <term><varname>invamount</varname></term>
5509 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
5510 <varname>interest</varname>)</para>
5515 <term><varname>invdate</varname></term>
5518 <para>Rechnungsdatum</para>
5523 <term><varname>invnumber</varname></term>
5526 <para>Rechnungsnummer</para>
5533 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
5534 <title>Variablen in anderen Vorlagen</title>
5537 <title>Einführung</title>
5539 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
5540 Rechnung. Allerdings heißen die Variablen, die mit
5541 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
5542 fangen sie mit <varname>quo</varname> für "quotation" an:
5543 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
5544 wiederum fangen sie mit <varname>ord</varname> für "order" an:
5545 <varname>ordnumber</varname> für Bestellnummer etc.</para>
5547 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
5548 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
5549 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
5550 Vorlage keine Bedeutung haben oder noch nicht belegt sein
5553 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
5554 in Rechnungen aufgeführt.</para>
5557 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
5558 <title>Angebote und Preisanfragen</title>
5562 <term><varname>quonumber</varname></term>
5565 <para>Angebots- bzw. Anfragenummer</para>
5570 <term><varname>reqdate</varname></term>
5573 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
5574 Preisanfragen)</para>
5579 <term><varname>transdate</varname></term>
5582 <para>Angebots- bzw. Anfragedatum</para>
5588 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
5589 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
5593 <term><varname>ordnumber</varname></term>
5596 <para>Auftragsnummer</para>
5601 <term><varname>reqdate</varname></term>
5604 <para>Lieferdatum</para>
5609 <term><varname>transdate</varname></term>
5612 <para>Auftragsdatum</para>
5618 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
5619 <title>Lieferscheine (Verkauf und Einkauf)</title>
5623 <term><varname>cusordnumber</varname></term>
5626 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
5627 des Lieferanten (im Einkauf)</para>
5632 <term><varname>donumber</varname></term>
5635 <para>Lieferscheinnummer</para>
5640 <term><varname>transdate</varname></term>
5643 <para>Lieferscheindatum</para>
5648 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
5649 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
5650 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
5651 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
5652 <function>foreach</function>-Schleife ausgegeben werden. Diese
5653 Variablen sind:</para>
5657 <term><varname>si_bin</varname></term>
5660 <para>Lagerplatz</para>
5665 <term><varname>si_chargenumber</varname></term>
5668 <para>Chargennummer</para>
5673 <term><varname>si_bestbefore</varname></term>
5676 <para>Mindesthaltbarkeit</para>
5681 <term><varname>si_number</varname></term>
5684 <para>Artikelnummer</para>
5689 <term><varname>si_qty</varname></term>
5692 <para>Anzahl bzw. Menge</para>
5697 <term><varname>si_runningnumber</varname></term>
5700 <para>Positionsnummer (1, 2, 3 etc)</para>
5705 <term><varname>si_unit</varname></term>
5708 <para>Einheit</para>
5713 <term><varname>si_warehouse</varname></term>
5722 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
5723 <title>Variablen für Sammelrechnung</title>
5727 <term><varname>c0total</varname></term>
5730 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
5736 <term><varname>c30total</varname></term>
5739 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
5740 und < 60 Tage</para>
5745 <term><varname>c60total</varname></term>
5748 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
5749 und < 90 Tage</para>
5754 <term><varname>c90total</varname></term>
5757 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
5763 <term><varname>total</varname></term>
5766 <para>Gesamtbetrag aller Rechnungen</para>
5771 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
5775 <term><varname>invnumber</varname></term>
5778 <para>Rechnungsnummer</para>
5783 <term><varname>invdate</varname></term>
5786 <para>Rechnungsdatum</para>
5791 <term><varname>duedate</varname></term>
5794 <para>Fälligkeitsdatum</para>
5799 <term><varname>amount</varname></term>
5802 <para>Summe der Rechnung</para>
5807 <term><varname>open</varname></term>
5810 <para>Noch offener Betrag der Rechnung</para>
5815 <term><varname>c0</varname></term>
5818 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
5824 <term><varname>c30</varname></term>
5827 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
5833 <term><varname>c60</varname></term>
5836 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
5842 <term><varname>c90</varname></term>
5845 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
5853 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
5854 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
5856 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
5857 <title>Einführung</title>
5859 <para>Der Parser kennt neben den Variablen einige weitere
5860 Konstrukte, die gesondert behandelt werden. Diese sind wie
5861 Variablennamen in spezieller Weise markiert:
5862 <command><%anweisung%> ... <%end%></command></para>
5864 <para>Anmerkung zum <command><%end%></command>: Der besseren
5865 Verständlichkeit halber kann man nach dem <command>end</command>
5866 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
5867 Anweisung (z.B. <command>if</command> oder
5868 <command>foreach</command>) damit abgeschlossen wird.</para>
5870 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
5871 <command><%if type == "sales_quotation"%></command>, so könnte
5872 er mit <command><%end%></command> genauso abgeschlossen werden
5873 wie mit <command><%end if%></command> oder auch
5874 <command><%end type == "sales_quotation"%></command>.</para>
5877 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
5878 <title>Der if-Block</title>
5880 <programlisting><%if variablenname%>
5882 <%end%></programlisting>
5884 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
5885 und dem "end" werden nur ausgegeben, wenn die Variable
5886 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
5888 <para>Handelt es sich bei der benannten Variable um ein Array, also
5889 um einen Variablennamen, über den man mit <command><%foreach
5890 variablenname%></command> iteriert, so wird mit diesem Konstrukt
5891 darauf getestet, ob das Array Elemente enthält. Somit würde im
5892 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
5893 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
5894 welche getätigt wurden:</para>
5896 <programlisting><%if payment%>
5898 <%foreach payment%>
5899 Am <%paymentdate%>: <%payment%> €
5900 <%end foreach%>
5901 <%end if%></programlisting>
5903 <para>Die Bedingung kann auch negiert werden, indem das Wort
5904 <function>not</function> nach dem <filename>if</filename> verwendet
5905 wird. Beispiel:</para>
5907 <programlisting><%if not cp_greeting%>
5909 <%end%></programlisting>
5911 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
5912 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
5913 einer Variablen mit einer festen Zeichenkette oder einer anderen
5914 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
5915 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
5916 die rechte Seite des Vergleichsoperators in Anführungszeichen
5917 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
5918 anderer Variablen). Zwei Beispiele, die beide Vergleiche
5921 <programlisting><%if var1 == "Wert"%></programlisting>
5923 <para>Testet die Variable <varname>var1</varname> auf
5924 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
5925 Mittels <function>!=</function> anstelle von <function>==</function>
5926 würde auf Ungleichheit getestet.</para>
5928 <programlisting><%if var1 == var2%></programlisting>
5930 <para>Testet die Variable <varname>var1</varname> auf
5931 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
5932 <function>!=</function> anstelle von <function>==</function> würde
5933 auf Ungleichheit getestet.</para>
5935 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
5936 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
5937 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
5938 dieselbe Syntax wie oben nur mit <function>=~</function> und
5939 <function>!~</function> als Vergleichsoperatoren.</para>
5941 <para>Beispiel für einen Test, ob die Variable
5942 <varname>intnotes</varname> (interne Bemerkungen) das Wort
5943 <constant>schwierig</constant> enthält:</para>
5945 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
5948 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
5949 <title>Der foreach-Block</title>
5951 <programlisting><%foreach variablenname%>
5953 <%end%></programlisting>
5955 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
5956 wie das Perl-Array der Variablen <varname>variablenname</varname>
5957 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
5958 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
5959 benutzt. In jedem Durchlauf werden die <link
5960 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
5961 Variablen</link> jeweils auf den Wert für die aktuelle Position
5964 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
5966 <programlisting><%foreach number%>
5967 Position: <%runningnumber%>
5968 Anzahl: <%qty%>
5969 Artikelnummer: <%number%>
5970 Beschreibung: <%description%>
5972 <%end%></programlisting>
5974 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
5975 <function><%foreach%></function>-Block innerhalb einer
5976 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
5977 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
5978 Inhalt zwischen <function><%foreach%></function> und
5979 <function><%end%></function> wiederholt, nicht aber die
5980 komplette Zeile, in der er steht.</para>
5984 <sect2 id="dokumentenvorlagen-und-variablen.markup">
5985 <title>Markup-Code zur Textformatierung innerhalb von
5988 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
5989 anders formatiert haben möchte, so ist dies begrenzt möglich.
5990 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
5991 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
5992 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
5993 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
5994 (HTML oder PDF über LaTeX) umgesetzt.</para>
5996 <para>Die unterstützen Formatierungen sind:</para>
6000 <term><b>Text</b></term>
6003 <para>Text wird in Fettdruck gesetzt.</para>
6008 <term><i>Text</i></term>
6011 <para>Text wird kursiv gesetzt.</para>
6016 <term><u>Text</u></term>
6019 <para>Text wird unterstrichen.</para>
6024 <term><s>Text</s></term>
6027 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6028 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6033 <term><bullet></term>
6036 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6042 <para>Der Befehl <command><bullet></command> funktioniert
6043 momentan auch nur in Latex-Vorlagen.</para>
6047 <sect1 id="excel-templates">
6048 <title>Excel-Vorlagen</title>
6050 <sect2 id="excel-templates.summary">
6051 <title>Zusammenfassung</title>
6053 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6054 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6058 <sect2 id="excel-templates.usage">
6059 <title>Bedienung</title>
6061 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6062 werden. Die Konfigurationsoption heißt <varname>excel_templates =
6063 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6065 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6066 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6067 werden. In den normalen Verkaufsmasken taucht nun
6068 <constant>Excel</constant> als auswählbares Format auf und kann von da
6069 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6071 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6072 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6073 <filename>sales_quotation.xls</filename> gespeichert.</para>
6076 <sect2 id="excel-templates.syntax">
6077 <title>Variablensyntax</title>
6079 <para>Einfache Syntax:
6080 <command><<varname>></command></para>
6082 <para>Dabei sind <constant><<</constant> und
6083 <constant>>></constant> die Delimiter. Da Excel auf festen
6084 Breiten besteht, kann der Tag künstlich verlängert werden, indem
6085 weitere <constant><</constant> oder <constant>></constant>
6086 eingefügt werden. Der Tag muss nicht symmetrisch sein.
6089 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6091 <para>Um die Limitierung der festen Breite zu reduzieren, können
6092 weitere Variablen in einem Block interpoliert werden. Whitespace wird
6093 dazwishen dann erhalten. Beispiel:</para>
6095 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6097 <para>Die Variablen werden interpoliert, und linksbündig mit
6098 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6099 lang, werden überzählige Zeichen abgeschnitten.</para>
6101 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6102 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6104 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6106 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6107 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6111 <sect2 id="excel-templates.limitations">
6112 <title>Einschränkungen</title>
6114 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6115 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6116 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6117 Text zu ersetzen.</para>
6119 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6120 <command><%if%></command> und
6121 <command><%foreach%></command> nicht vorhanden. Der Delimiter
6122 <constant><% %></constant> kommt in den Headerinformationen
6123 evtl. vor. Deshalb wurde auf den sichereren Delimiter
6124 <constant><<</constant> und <constant>>></constant>
6129 <sect1 id="features.warehouse">
6132 <title>Mandantenkonfiguration Lager</title>
6134 Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt:
6135 Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die Möglichkeit
6136 hier über den Menüpunkt Lager entsprechende Warenbewegungen durchzuführen.
6137 Ferner kann jede Position eines Lieferscheins ein-, bzw. ausgelagert werden
6138 (Einkauf-, bzw. Verkauf). Es können beliebig viele Lager mit beliebig vielen
6139 Lagerplätzen abgebildet werden. Die Lagerbewegungen über einen Lieferschein
6140 erfolgt durch Anklicken jeder Einzelposition und das Auswählen dieser Position
6141 zu einem Lager mit Lagerplatz. Dieses Verfahren lässt sich schrittweise
6142 vereinfachen, je nachdem wie die Einstellungen in der Mandatenkonfiguration
6147 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6148 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6149 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6150 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6154 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6155 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6156 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6157 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6158 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6159 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6163 Zusätzliche Funktionshinweise:
6167 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6168 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6169 Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6173 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6174 Stammdaten definiert</option> Wird beim 'Auslagern über
6175 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6176 so wird mit dieser Option einfach der Standardlagerplatz
6184 <sect1 id="features.swiss-charts-of-accounts">
6185 <title>Schweizer Kontenpläne</title>
6187 <para>Seit der Version 3.4.1 stehen in kivitendo 2 Kontenpläne für
6188 den Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6189 Organisationen, die nicht mehrwertsteuerpflichtig sind, und einer
6190 für Firmen, die mehrwertsteuerpflichtig sind.</para>
6192 <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6193 verwendeten KMU-Kontenrahmen und sind mit der Revision des Schweizerischen
6194 Obligationenrechts (OR) vom 1.1.2013 kompatibel, insbesondere
6195 <literal>Art.957a Abs.2</literal>.</para>
6197 <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der aktuellen
6198 Version von kivitendo noch nicht integriert.</para>
6200 <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6201 Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6202 Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen
6203 alle Aufwandskonten editiert werden und dort der Steuersatz auf 0%
6204 gesetzt werden.</para>
6206 <para>So werden bei Kreditorenbuchungen keine Vorsteuern verbucht.</para>
6208 <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6209 Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne
6210 bitte an <literal>empfang@revamp-it.ch</literal> senden.</para>
6215 <title>Entwicklerdokumentation</title>
6217 <sect1 id="devel.globals" xreflabel="Globale Variablen">
6218 <title>Globale Variablen</title>
6221 <title>Wie sehen globale Variablen in Perl aus?</title>
6223 <para>Globale Variablen liegen in einem speziellen namespace namens
6224 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
6225 globs global und die meisten speziellen Variablen sind...
6228 <para>Daraus ergeben sich folgende Formen:</para>
6232 <term><literal>$main::form</literal></term>
6235 <para>expliziter Namespace "main"</para>
6240 <term><literal>$::form</literal></term>
6243 <para>impliziter Namespace "main"</para>
6248 <term><literal>open FILE, "file.txt"</literal></term>
6251 <para><varname>FILE</varname> ist global</para>
6256 <term><literal>$_</literal></term>
6259 <para>speziell</para>
6264 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
6265 Schlüsselwort wie "<function>global</function>", mit dem man
6266 importieren kann. <function>my</function>, <function>our</function>
6267 und <function>local</function> machen was anderes.</para>
6271 <term><literal>my $form</literal></term>
6274 <para>lexikalische Variable, gültig bis zum Ende des
6280 <term><literal>our $form</literal></term>
6283 <para><varname>$form</varname> referenziert ab hier
6284 <varname>$PACKAGE::form</varname>.</para>
6289 <term><literal>local $form</literal></term>
6292 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
6293 des scopes zurückgesetzt</para>
6300 <title>Warum sind globale Variablen ein Problem?</title>
6302 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
6304 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
6305 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
6306 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
6307 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
6308 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
6309 Datenbankverbindungen, weil die sehr lange zum Initialisieren
6312 <para>Das zweite Problem ist <function>strict</function>. Unter
6313 <function>strict</function> werden alle Variablen die nicht explizit
6314 mit <function>Package</function>, <function>my</function> oder
6315 <function>our</function> angegeben werden als Tippfehler angemarkert,
6316 dies hat, seit der Einführung, u.a. schon so manche langwierige
6317 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
6318 angegeben werden, werden die nicht geprüft, und somit kann sich
6319 schnell ein Tippfehler einschleichen.</para>
6323 <title>Kanonische globale Variablen</title>
6325 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
6326 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
6327 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
6328 umhergereicht werden.</para>
6330 <para>Diese Variablen sind im Moment die folgenden neun:</para>
6334 <para><varname>$::form</varname></para>
6338 <para><varname>%::myconfig</varname></para>
6342 <para><varname>$::locale</varname></para>
6346 <para><varname>$::lxdebug</varname></para>
6350 <para><varname>$::auth</varname></para>
6354 <para><varname>$::lx_office_conf</varname></para>
6358 <para><varname>$::instance_conf</varname></para>
6362 <para><varname>$::dispatcher</varname></para>
6366 <para><varname>$::request</varname></para>
6370 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
6371 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
6372 Eigenschaften (Konventionen):</para>
6375 <title>$::form</title>
6379 <para>Ist ein Objekt der Klasse
6380 "<classname>Form</classname>"</para>
6384 <para>Wird nach jedem Request gelöscht</para>
6388 <para>Muss auch in Tests und Konsolenscripts vorhanden
6393 <para>Enthält am Anfang eines Requests die Requestparameter vom
6398 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
6399 cachen, das wird aber momentan absichtlich zerstört</para>
6403 <para><varname>$::form</varname> wurde unter <productname>SQL
6404 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
6405 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
6406 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
6407 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
6408 <function>IS->retrieve_customer()</function> in Sicherheit
6411 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
6412 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
6413 3552, Stand version 2.7beta), um dies hinterher wieder auf den
6414 richtigen Wert zu setzen:</para>
6416 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
6417 $::myconfig{numberformat} = $numberformat;
6418 # (...) div Berechnungen
6419 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
6421 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
6422 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
6423 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
6424 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
6425 Es geht ziemlich sicher etwas kaputt.</para>
6427 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
6428 in den <productname>Template::Toolkit</productname> Templates
6429 außerhalb der Controller: der Ausdruck <function>[% var
6430 %]</function> greift auf <varname>$::form->{var}</varname> zu.
6431 Unter Controllern ist der Standard Scope anders, da lautet der
6432 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
6433 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
6434 <function><%var%></function> zeigt auf
6435 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
6436 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
6439 <programlisting>[%- IF business %]
6440 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
6441 [%- END %]</programlisting>
6443 <para>Entweder wird hier dann $::form->{business} ausgewertet
6444 oder aber der Funktion
6445 <function>$form->parse_html_template</function> wird explizit
6446 noch ein zusätzlicher Hash übergeben, der dann auch in den
6447 (Web-)Templates zu Verfügung steht, bspw. so:</para>
6449 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
6451 <para>Innerhalb von Schleifen wird
6452 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
6453 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
6454 welches über alle Positionen eines Lieferscheins in Schleife
6457 <programlisting>for $i (1 .. $form->{rowcount}) {
6459 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
6460 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
6461 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
6467 <title>%::myconfig</title>
6471 <para>Das einzige Hash unter den globalen Variablen</para>
6475 <para>Wird spätestens benötigt wenn auf die Datenbank
6476 zugegriffen wird</para>
6480 <para>Wird bei jedem Request neu erstellt.</para>
6484 <para>Enthält die Userdaten des aktuellen Logins</para>
6488 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
6489 extern serialisiert werden, weil da auch der Datenbankzugriff
6490 für diesen user drinsteht.</para>
6494 <para>Enthält unter anderem Listenbegrenzung vclimit,
6495 Datumsformat dateformat und Nummernformat numberformat</para>
6499 <para>Enthält Datenbankzugriffinformationen</para>
6503 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
6504 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
6505 aktuellen Users entscheiden müssen, befragen
6506 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
6507 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
6508 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
6509 Informationen über den Benutzer die über die
6510 Administrator-Schnittstelle eingegeben wurden.</para>
6514 <title>$::locale</title>
6518 <para>Objekt der Klasse "Locale"</para>
6522 <para>Wird pro Request erstellt</para>
6526 <para>Muss auch für Tests und Scripte immer verfügbar
6531 <para>Cached intern über Requestgrenzen hinweg benutzte
6536 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
6537 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
6541 <title>$::lxdebug</title>
6545 <para>Objekt der Klasse "LXDebug"</para>
6549 <para>Wird global gecached</para>
6553 <para>Muss immer verfügbar sein, in nahezu allen
6558 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
6559 bereit, wie "<function>enter_sub</function>" und
6560 "<function>leave_sub</function>", mit denen in den alten Modulen ein
6561 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
6562 der man die Wallclockzeit seit Requeststart loggen kann, sowie
6563 "<function>message</function>" und "<function>dump</function>" mit
6564 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
6567 <para>Beispielsweise so:</para>
6569 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
6570 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
6574 <title>$::auth</title>
6578 <para>Objekt der Klasse "SL::Auth"</para>
6582 <para>Wird global gecached</para>
6586 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
6590 <para>Wird nach jedem Request resettet.</para>
6594 <para><varname>$::auth</varname> stellt Funktionen bereit um die
6595 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
6596 vom aktuellen User abhängen wird das Objekt aus
6597 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
6598 Request kurz resettet.</para>
6600 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
6601 Dessen Einstellungen können über
6602 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
6603 ist ein Hash mit den Werten aus der Tabelle
6604 <literal>auth.clients</literal>.</para>
6608 <title>$::lx_office_conf</title>
6612 <para>Objekt der Klasse
6613 "<classname>SL::LxOfficeConf</classname>"</para>
6617 <para>Global gecached</para>
6621 <para>Repräsentation der
6622 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
6626 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
6627 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
6628 das Programm die Konfiguration ändern kann oder sollte.</para>
6630 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
6631 Debug- und Trace-Log-Datei wie folgt konfiguriert und
6634 <programlisting>[debug]
6635 file_name = /tmp/kivitendo-debug.log</programlisting>
6637 <para>ist der Key <varname>file</varname> im Programm als
6638 <varname>$::lx_office_conf->{debug}{file}</varname>
6642 <para>Zugriff auf die Konfiguration erfolgt im Moment über
6643 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
6648 <title>$::instance_conf</title>
6652 <para>Objekt der Klasse
6653 "<classname>SL::InstanceConfiguration</classname>"</para>
6657 <para>wird pro Request neu erstellt</para>
6661 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
6662 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
6663 ist hier eine Mandantendatenbank. Beispielsweise überprüft
6664 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
6665 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
6669 <title>$::dispatcher</title>
6673 <para>Objekt der Klasse
6674 "<varname>SL::Dispatcher</varname>"</para>
6678 <para>wird pro Serverprozess erstellt.</para>
6682 <para>enthält Informationen über die technische Verbindung zum
6687 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
6688 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
6689 Objekt untergebracht.</para>
6693 <title>$::request</title>
6697 <para>Hashref (evtl später Objekt)</para>
6701 <para>Wird pro Request neu initialisiert.</para>
6705 <para>Keine Unterstruktur garantiert.</para>
6709 <para><varname>$::request</varname> ist ein generischer Platz um
6710 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
6711 at a distance benutzt werden, sondern um lokales memoizing zu
6712 ermöglichen, das garantiert am Ende des Requests zerstört
6715 <para>Vieles von dem, was im moment in <varname>$::form</varname>
6716 liegt, sollte eigentlich hier liegen. Die groben
6717 Differentialkriterien sind:</para>
6721 <para>Kommt es vom User, und soll unverändert wieder an den
6722 User? Dann <varname>$::form</varname>, steht da eh schon</para>
6726 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
6727 Requests gebraucht werden? Dann
6728 <varname>$::request</varname></para>
6732 <para>Muss ich von anderen Teilen des Programms lesend drauf
6733 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
6734 Wrappermethode</para>
6741 <title>Ehemalige globale Variablen</title>
6743 <para>Die folgenden Variablen waren einmal im Programm, und wurden
6747 <title>$::cgi</title>
6751 <para>war nötig, weil cookie Methoden nicht als
6752 Klassenfunktionen funktionieren</para>
6756 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
6757 Klassennamespace gehalten wird und über Requestgrenzen
6762 <para>liegt jetzt unter
6763 <varname>$::request->{cgi}</varname></para>
6769 <title>$::all_units</title>
6773 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
6774 ein paar hundert mal pro Request eine Liste der Einheiten
6775 brauchen, und de als Parameter durch einen Riesenstack von
6776 Funktionen geschleift werden müssten.</para>
6780 <para>Liegt jetzt unter
6781 <varname>$::request->{cache}{all_units}</varname></para>
6786 <function>AM->retrieve_all_units()</function> gesetzt oder
6793 <title>%::called_subs</title>
6797 <para>wurde benutzt um callsub deep recursions
6802 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
6803 möglichen Rekursioenen darstellt, und da nie welche
6808 <para>komplette recursion protection wurde entfernt.</para>
6815 <sect1 id="devel.fcgi">
6816 <title>Entwicklung unter FastCGI</title>
6818 <sect2 id="devel.fcgi.general">
6819 <title>Allgemeines</title>
6821 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
6822 werden, muss der Webserver neu gestartet werden.</para>
6824 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
6825 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
6826 müssen folgende Aspekte beachtet werden.</para>
6829 <sect2 id="devel.fcgi.exiting">
6830 <title>Programmende und Ausnahmen</title>
6832 <para>Betrifft die Funktionen <function>warn</function>,
6833 <function>die</function>, <function>exit</function>,
6834 <function>carp</function> und <function>confess</function>.</para>
6836 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
6837 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
6838 am Laufen zu halten. Man kann mit <function>die</function>,
6839 <function>confess</function> oder <function>carp</function> Fehler
6840 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
6841 eigene <function>$::form-</function>error()> tut im Prinzip das
6842 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
6843 <function>exit</function> hingegen werden nicht abgefangen.
6844 <function>warn</function> wird direkt nach STDERR, also in Server Log
6845 eine Nachricht schreiben (sofern in der Konfiguration nicht die
6846 Warnungen in das kivitendo Log umgeleitet wurden), und
6847 <function>exit</function> wird die Ausführung beenden.</para>
6849 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
6850 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
6851 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
6852 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
6855 <sect2 id="devel.fcgi.globals">
6856 <title>Globale Variablen</title>
6858 <para>Um zu vermeiden, dass Informationen von einem Request in einen
6859 anderen gelangen, müssen alle globalen Variablen vor einem Request
6860 sauber initialisiert werden. Das ist besonders wichtig im
6861 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
6862 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
6865 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
6866 abgetrennten Block, der alle kanonischen globalen Variablen listet und
6867 erklärt. Bitte keine anderen einführen ohne das sauber zu
6868 dokumentieren.</para>
6870 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
6871 man sicher geht, dass man die richtige erwischt.</para>
6874 <sect2 id="devel.fcgi.performance">
6875 <title>Performance und Statistiken</title>
6877 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
6878 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
6879 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
6880 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
6881 sind es je nach Menge der definierten Variablen 1-2s. Ab der
6882 Moose/Rose::DB Version sind es 5-6s.</para>
6884 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
6885 den kritischen Pfaden, unter 0,15 sonst.</para>
6889 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
6890 <title>SQL-Upgradedateien</title>
6892 <sect2 id="db-upgrade-files.introduction"
6893 xreflabel="Einführung in die Datenbank-Upgradedateien">
6894 <title>Einführung</title>
6896 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
6897 gesteuert, die sich im Verzeichnis
6898 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
6899 muss pro Datenbankupgrade eine Datei existieren, die neben den
6900 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
6901 Kontrollinformationen enthält.</para>
6903 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
6904 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
6905 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
6906 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
6907 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
6908 Versionsnummern braucht.</para>
6910 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
6911 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
6912 führt diese nicht erneut aus. Dazu dient die Tabelle
6913 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
6914 angelegt wird.</para>
6917 <sect2 id="db-upgrade-files.format"
6918 xreflabel="Format der Upgradedateien">
6919 <title>Format der Kontrollinformationen</title>
6921 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
6922 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
6923 hat dabei das folgende Format:</para>
6925 <para>Für SQL-Upgradedateien:</para>
6927 <programlisting>-- @key: value</programlisting>
6929 <para>Für Perl-Upgradedateien:</para>
6931 <programlisting># @key: value</programlisting>
6933 <para>Leerzeichen vor "<varname>value</varname>" werden
6936 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
6940 <term><varname>tag</varname></term>
6943 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
6944 Dieser "tag" kann von anderen Kontrolldateien in ihren
6945 Abhängigkeiten verwendet werden (Schlüsselwort
6946 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
6947 in der Datenbank eingetragen wird.</para>
6949 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
6950 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
6952 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
6953 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
6954 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
6960 <term><varname>charset</varname></term>
6963 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
6964 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
6965 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
6966 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
6967 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
6968 hingegen müssen immer in UTF-8 encodiert sein und sollten
6969 demnach auch ein "<literal>use utf8;</literal>"
6975 <term><varname>description</varname></term>
6978 <para>Benötigt. Eine Beschreibung, was in diesem Update
6979 passiert. Diese wird dem Benutzer beim eigentlichen
6980 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
6981 sein sollte, sollte die Beschreibung auf Deutsch
6987 <term><varname>depends</varname></term>
6990 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
6991 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
6992 dass die in dieser Liste aufgeführten Scripte bereits
6993 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
6995 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
6996 Script "b" existiert, das von Änderungen in "a" abhängt, und
6997 eine neue Kontrolldatei für "c" erstellt wird, die von
6998 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
6999 Tag "b" als Abhängigkeit zu definieren.</para>
7001 <para>Es ist nicht erlaubt, sich selbst referenzierende
7002 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
7003 und "c" -> "a").</para>
7008 <term><varname>priority</varname></term>
7011 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
7012 der Scripte ausgeführt werden, die die gleichen
7013 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
7014 der Wert 1000 benutzt.</para>
7016 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
7017 "depends" benutzt werden. kivitendo sortiert die auszuführenden
7018 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
7019 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
7020 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
7021 dann "y", dann "z"), dann nach der Priorität und bei gleicher
7022 Priorität alphabetisch nach dem "tag".</para>
7027 <term><varname>ignore</varname></term>
7030 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
7031 Skript bei der Anmeldung ignoriert und entsprechend nicht
7038 <sect2 id="db-upgrade-files.format-perl-files"
7039 xreflabel="Format von Perl-Upgradedateien">
7040 <title>Format von in Perl geschriebenen
7041 Datenbankupgradescripten</title>
7043 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
7044 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
7045 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
7047 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
7048 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
7049 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
7050 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
7051 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
7052 aufgerufen wird.</para>
7054 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
7055 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
7056 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
7057 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
7058 "<literal>SL::DBUpgrade2::tag</literal>".</para>
7060 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
7061 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
7062 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
7064 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
7067 <programlisting># @tag: beispiel-upgrade-file42
7068 # @description: Ein schönes Beispielscript
7069 # @depends: release_3_1_0
7070 package SL::DBUpgrade2::beispiel_upgrade_file42;
7075 use parent qw(SL::DBUpgrade2::Base);
7080 # hier Aktionen ausführen
7089 <sect2 id="db-upgrade-files.dbupgrade-tool"
7090 xreflabel="Hilfsscript dbupgrade2_tool.pl">
7091 <title>Hilfsscript dbupgrade2_tool.pl</title>
7093 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
7094 existiert ein Hilfsscript namens
7095 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
7096 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
7097 liest alle Datenbankupgradescripte aus dem Verzeichnis
7098 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
7099 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
7100 von der Kommandozeile überprüft werden können.</para>
7102 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
7103 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
7104 sich aber auch Informationen auf verschiedene Art ausgeben
7109 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
7110 --list</command>"</para>
7112 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
7113 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
7114 würde. Es werden neben der Listenposition der Tag, die
7115 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
7119 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
7120 --tree</command>"</para>
7122 <para>Listet alle Tags in Baumform basierend auf den
7123 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
7124 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
7125 beim übergeordneten Script als Abhängigkeit eingetragen
7129 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
7130 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
7131 --rtree</command>"</para>
7133 <para>Listet alle Tags in Baumform basierend auf den
7134 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
7135 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
7136 die das übergeordnete Script als Abhängigkeit eingetragen
7141 <para>Baumform mit Postscriptausgabe:
7142 "<command>./scripts/dbupgrade2_tool.pl
7143 --graphviz</command>"</para>
7145 <para>Benötigt das Tool "<command>graphviz</command>", um mit
7146 seiner Hilfe die <link
7147 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
7148 Baumform</link> in eine Postscriptdatei namens
7149 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
7150 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
7151 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
7152 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
7157 <para>Scripte, von denen kein anderes Script abhängt:
7158 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
7160 <para>Listet die Tags aller Scripte auf, von denen keine anderen
7161 Scripte abhängen.</para>
7167 <sect1 id="translations-languages" xreflabel="Translations and languages">
7168 <title>Translations and languages</title>
7170 <sect2 id="translations-languages.introduction"
7171 xreflabel="Introduction to translations and languages">
7172 <title>Introduction</title>
7175 <para>Dieser Abschnitt ist in Englisch geschrieben, um
7176 internationalen Übersetzern die Arbeit zu erleichtern.</para>
7179 <para>This section describes how localization packages in kivitendo
7180 are built. Currently the only language fully supported is German, and
7181 since most of the internal messages are held in English the English
7182 version is usable too.</para>
7185 <sect2 id="translations-languages.character-set"
7186 xreflabel="Character set">
7187 <title>Character set</title>
7189 <para>All files included in a language pack must use UTF-8 as their
7193 <sect2 id="translations-languages.file-structure"
7194 xreflabel="File structure">
7195 <title>File structure</title>
7197 <para>The structure of locales in kivitendo is:</para>
7199 <programlisting>kivitendo/locale/<langcode>/</programlisting>
7201 <para>where <langcode> stands for an abbreviation of the
7202 language package. The builtin packages use two letter <ulink
7203 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
7204 but the actual name is not relevant for the program and can easily be
7206 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
7207 tags</ulink> (i.e. "en_GB"). In fact the original language packages
7208 from SQL Ledger are named in this way.</para>
7210 <para>In such a language directory the following files are
7215 <term>LANGUAGE</term>
7218 <para>This file is mandatory.</para>
7220 <para>The <filename>LANGUAGE</filename> file contains the self
7221 descripted name of the language. It should contain a native
7222 representation first, and in parenthesis an english translation
7223 after that. Example:</para>
7225 <programlisting>Deutsch (German)</programlisting>
7233 <para>This file is mandatory.</para>
7235 <para>The central translation file. It is essentially an inline
7236 Perl script autogenerated by <command>locales.pl</command>. To
7237 generate it, generate the directory and the two files mentioned
7238 above, and execute the following command:</para>
7240 <programlisting>scripts/locales.pl <langcode></programlisting>
7242 <para>Otherwise you can simply copy one of the other languages.
7243 You will be told how many are missing like this:</para>
7245 <programlisting>$ scripts/locales.pl en
7246 English - 0.6% - 2015/2028 missing</programlisting>
7248 <para>A file named "<filename>missing</filename>" will be
7249 generated and can be edited. You can also edit the
7250 "<filename>all</filename>" file directly. Edit everything you
7251 like to fit the target language and execute
7252 <command>locales.pl</command> again. See how the missing words
7258 <term>Num2text</term>
7261 <para>Legacy code from SQL Ledger. It provides a means for
7262 numbers to be converted into natural language, like
7263 <literal>1523 => one thousand five hundred twenty
7264 three</literal>. If you want to provide it, it must be inlinable
7265 Perl code which provides a <function>num2text</function> sub. If
7266 an <function>init</function> sub exists it will be executed
7269 <para>Only used in the check and receipt printing module.</para>
7274 <term>special_chars</term>
7277 <para>kivitendo comes with a lot of interfaces to different
7278 formats, some of which are rather picky with their accepted
7279 charset. The <filename>special_chars</filename> file contains a
7280 listing of chars not suited for different file format and
7281 provides substitutions. It is written in "Simple Ini" style,
7282 containing a block for every file format.</para>
7284 <para>First entry should be the order of substitution for
7285 entries as a whitespace separated list. All entries are
7286 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
7287 and <literal>\\</literal> all work.</para>
7289 <para>After that every entry is a special char that should be
7290 translated when writing text into such a file.</para>
7292 <para>Example:</para>
7294 <programlisting>[Template/XML]
7295 order=& < > \n
7299 \n=<br></programlisting>
7301 <para>Note the importance of the order in this example.
7302 Substituting < and > befor & would lead to $gt; become
7305 <para>For a list of valid formats, see the German
7306 <filename>special_chars</filename> entry. As of this writing the
7307 following are recognized:</para>
7309 <programlisting>HTML
7314 Template/OpenDocument
7315 filenames</programlisting>
7317 <para>The last of which is very machine dependant. Remember that
7318 a lot of characters are forbidden by some filesystems, for
7319 example MS Windows doesn't like ':' in its files where Linux
7320 doesn't mind that. If you want the files created with your
7321 language pack to be portable, find all chars that could cause
7327 <term>missing</term>
7330 <para>This file is not a part of the language package
7333 <para>This is a file generated by
7334 <command>scripts/locales.pl</command> while processing your
7335 locales. It's only to have the missing entries singled out and
7336 does not belong to a language package.</para>
7344 <para>This file is not a part of the language package
7347 <para>Another file generated by
7348 <command>scripts/locales.pl</command>. If for any reason a
7349 translation does not appear anymore and can be deleted, it gets
7350 moved here. The last 50 or so entries deleted are saved here in
7351 case you made a typo, so that you don't have to translate
7352 everything again. If a tranlsation is missing, the lost file is
7353 checked first. If you maintain a language package, you might
7354 want to keep this safe somewhere.</para>
7359 <term>more/all</term>
7362 <para>This subdir and file is not a part of the language package
7365 <para>If the directory more exists and contains a file called
7366 all it will be parsed in addition to the mandatory all (see
7367 above). The file is useful if you want to change some
7368 translations for the current installation without conflicting
7369 further upgrades. The file is not autogenerated and has the same
7370 format as the all, but needs another key (more_texts). See the
7371 german translation for an example or copy the following code:
7374 # -*- coding: utf-8; -*-
7379 # These are additional texts for custom translations.
7380 # The format is the same as for the normal file all, only
7381 # with another key (more_texts instead of texts).
7382 # The file has the form of 'english text' => 'foreign text',
7384 $self->{more_texts} = {
7386 'Ship via' => 'Terms of delivery',
7387 'Shipping Point' => 'Delivery time',
7389 </programlisting></para>
7396 <sect1 id="devel.testsuite">
7397 <title>Die kivitendo-Test-Suite</title>
7399 <sect2 id="devel.testsuite.intro">
7400 <title>Einführung</title>
7402 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
7403 basiert auf dem Standard-Perl-Modul
7404 <literal>Test::More</literal>.</para>
7406 <para>Die grundlegenden Fakten sind:</para>
7410 <para>Alle Tests liegen im Unterverzeichnis
7411 <filename>t/</filename>.</para>
7415 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
7416 enthält einen oder mehrere Testfälle.</para>
7420 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
7421 Es sind selbstständig ausführbare Perl-Scripte.</para>
7425 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
7426 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
7427 auf <literal>.t</literal> endet.</para>
7432 <sect2 id="devel.testsuite.prerequisites">
7433 <title>Voraussetzungen</title>
7435 <para>Für die Ausführung werden neben den für kivitendo eh schon
7436 benötigten Module noch weitere Perl-Module benötigt. Diese
7441 <para><literal>Test::Deep</literal> (Debian-Paketname:
7442 <literal>libtest-deep-perl</literal>; Fedora:
7443 <literal>perl-Test-Deep</literal>; openSUSE:
7444 <literal>perl-Test-Deep</literal>)</para>
7448 <para><literal>Test::Exception</literal> (Debian-Paketname:
7449 <literal>libtest-exception-perl</literal>; Fedora:
7450 <literal>perl-Test-Exception</literal>; openSUSE:
7451 <literal>perl-Test-Exception</literal>)</para>
7455 <para><literal>Test::Output</literal> (Debian-Paketname:
7456 <literal>libtest-output-perl</literal>; Fedora:
7457 <literal>perl-Test-Output</literal>; openSUSE:
7458 <literal>perl-Test-Output</literal>)</para>
7462 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
7463 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
7464 kann für frühere Versionen aus dem <ulink
7465 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
7469 <para><literal>LWP::Simple</literal> aus dem Paket
7470 <literal>libwww-perl</literal> (Debian-Panetname:
7471 <literal>libwww-perl</literal>; Fedora:
7472 <literal>perl-libwww-perl</literal>; openSUSE:
7473 <literal>perl-libwww-perl</literal>)</para>
7477 <para><literal>URI::Find</literal> (Debian-Panetname:
7478 <literal>liburi-find-perl</literal>; Fedora:
7479 <literal>perl-URI-Find</literal>; openSUSE:
7480 <literal>perl-URI-Find</literal>)</para>
7484 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
7485 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
7486 müssen in der Konfigurationsdatei im Abschnit
7487 <literal>testing/database</literal> Datenbankverbindungsparameter
7488 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
7489 Recht haben, Datenbanken anzulegen und zu löschen.</para>
7492 <sect2 id="devel.testsuite.execution">
7493 <title>Existierende Tests ausführen</title>
7495 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
7496 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
7497 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
7498 <filename>t/test.pl</filename>.</para>
7500 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
7501 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
7502 kivitendo-Basisverzeichnis heraus ausführen.</para>
7504 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
7505 an <filename>t/test.pl</filename>. Beispielsweise:</para>
7507 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
7510 <sect2 id="devel.testsuite.meaning_of_scripts">
7511 <title>Bedeutung der verschiedenen Test-Scripte</title>
7513 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
7514 Programmierstil. Einige besonders zu erwähnende, weil auch während der
7515 Entwicklung nützliche Tests sind:</para>
7519 <para><filename>t/001compile.t</filename> -- compiliert alle
7520 Quelldateien und bricht bei Fehlern sofort ab</para>
7524 <para><filename>t/002goodperl.t</filename> -- überprüft alle
7525 Perl-Dateien auf Anwesenheit von '<literal>use
7526 strict</literal>'-Anweisungen</para>
7530 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
7531 <function>system()</function> und <function>exec()</function> auf
7536 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
7537 Tab-Zeichen enthalten</para>
7541 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
7542 Rechtschreibfehlern</para>
7546 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
7547 Dokumentation im POD-Format auf Gültigkeit</para>
7551 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
7552 einzelner Funktionen und Module.</para>
7555 <sect2 id="devel.testsuite.create_new">
7556 <title>Neue Test-Scripte erstellen</title>
7558 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
7559 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
7560 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
7563 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
7564 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
7567 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
7572 <para>Überprüfung auf fehlende symbolische Links</para>
7576 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
7577 gewissen Einschränkungen wie das Erlauben von deutschen
7582 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
7586 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
7590 <para>Test, ob alle zu übersetzenden Strings in
7591 <filename>locale/de/all</filename> vorhanden sind</para>
7595 <para>Test, ob alle Webseiten-Templates in
7596 <filename>templates/webpages</filename> mit vom Perl-Modul
7597 <literal>Template</literal> compiliert werden können</para>
7602 <sect3 id="devel.testsuite.directory_and_test_names">
7603 <title>Konvention für Verzeichnis- und Dateinamen</title>
7605 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
7606 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
7607 und ihnen soweit es geht folgen:</para>
7611 <para>Die Dateiendung muss <filename>.t</filename>
7616 <para>Namen sind englisch, komplett klein geschrieben und
7617 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
7618 <filename>bad_function_params.t</filename>).</para>
7622 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
7623 benannt sein, mit dem sich die Scripte darin befassen
7624 (beispielsweise <filename>background_jobs</filename> für Tests
7625 rund um Hintergrund-Jobs).</para>
7629 <para>Test-Scripte sollten einen überschaubaren Bereich von
7630 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
7631 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
7632 Test-Scripte schreiben.</para>
7637 <sect3 id="devel.testsuite.minimal_example">
7638 <title>Minimales Skelett für eigene Scripte</title>
7640 <para>Der folgenden Programmcode enthält das kleinstmögliche
7641 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
7644 <programlisting>use Test::More tests => 0;
7648 use Support::TestSetup;
7650 Support::TestSetup::login();</programlisting>
7652 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
7653 benötigt (Stichwort: alle globalen Variablen wie
7654 <varname>$::auth</varname>, <varname>$::form</varname> oder
7655 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
7656 <filename>config/kivitendo.conf</filename> im Abschnitt
7657 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
7658 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
7660 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
7661 kann die letzte Zeile <code>Support::TestSetup::login();</code>
7662 weggelassen werden, was die Ausführungszeit des Scripts leicht
7668 <sect1 id="devel.style-guide">
7669 <title>Stil-Richtlinien</title>
7671 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
7672 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
7673 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
7674 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
7676 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
7679 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
7680 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
7685 <para>Es werden keine echten Tabs sondern Leerzeichen
7690 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
7692 <programlisting>foreach my $row (@data) {
7694 # do something with $row
7698 $row->{modules} = MODULE->retrieve(
7699 id => $row->{id},
7700 date => $use_now ? localtime() : $row->{time},
7704 $report->add($row);
7709 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
7710 Zeile wie der letzte Befehl. Beispiele:</para>
7712 <programlisting>sub debug {
7718 <programlisting>if ($form->{item_rows} > 0) {
7724 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
7725 der Befehl / die öffnende schließende Klammer, die den Block
7726 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
7727 Beispiele wie bei 3. gelten.</para>
7731 <para>Die Wörter "<function>else</function>",
7732 "<function>elsif</function>", "<function>while</function>" befinden
7733 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
7736 <programlisting>if ($form->{sum} > 1000) {
7738 } elsif ($form->{sum} > 0) {
7746 } until ($a > 0);</programlisting>
7750 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
7751 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
7752 und grep-ähnliche Operatoren. Beispiel:</para>
7754 <programlisting>$main::lxdebug->message("Could not find file.");
7755 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
7759 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
7761 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
7762 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
7763 Blöcke schon. Beispiel:</para>
7765 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
7770 $form->{sum} += $form->{"row_$i"};
7771 $form->{ $form->{index} } += 1;
7773 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
7777 <para>Mehrzeilige Befehle</para>
7781 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
7782 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
7783 werden, in der die ersten Funktionsparameter in der ersten Zeile
7784 stehen. Beispiel:</para>
7786 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
7787 $form->{some_col_value});</programlisting>
7791 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
7792 besten in einer übersichtlichen Tabellenstruktur organisiert
7793 wird. Beispiel:</para>
7795 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
7796 : $form->{oldcount} ? $form->{oldcount} + 1
7797 : $form->{rowcount} - $form->{rowbase};</programlisting>
7803 <para>Kommentare</para>
7807 <para>Kommentare, die alleine in einer Zeile stehen, sollten
7808 soweit wie der Code eingerückt sein.</para>
7812 <para>Seitliche hängende Kommentare sollten einheitlich
7813 formatiert werden.</para>
7817 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
7818 auf Englisch zu verfassen. So wie ich keine Lust habe,
7819 französischen Quelltext zu lesen, sollte auch der kivitendo
7820 Quelltext für nicht-Deutschsprachige lesbar sein.
7823 <programlisting>my $found = 0;
7831 $i = 0 # initialize $i
7833 $i *= $const; # do something crazy
7834 $i = $n; # recover $i</programlisting>
7840 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
7841 Interpolation gewünscht ist. Beispiel:</para>
7843 <programlisting>$form->{sum} = 0;
7844 $form->{"row_$i"} = $form->{"row_$i"} - 5;
7845 $some_hash{42} = 54;</programlisting>
7849 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
7850 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
7851 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
7852 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
7854 <para>Als Beispiel sei die Funktion
7855 <function>print_options</function> aus
7856 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
7860 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
7861 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
7864 <para>Emacs und vim haben beide recht einfache Methoden zur
7865 Entfernung von trailing whitespace. Emacs kennt das Kommande
7866 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
7867 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
7868 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
7873 <para>Es wird kein <command>perltidy</command> verwendet.</para>
7875 <para>In der Vergangenheit wurde versucht,
7876 <command>perltidy</command> zu verwenden, um einen einheitlichen
7877 Stil zu erlangen. Es hat sich aber gezeigt, dass
7878 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
7879 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
7880 den Interessierten sind hier die
7881 <command>perltidy</command>-Optionen, die grob den beschriebenen
7882 Richtlinien entsprechen:</para>
7884 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
7885 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
7886 -lp -vt=1 -vtc=1</programlisting>
7890 <para><varname>STDERR</varname> ist tabu. Unkonditionale
7891 Debugmeldungen auch.</para>
7893 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
7894 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
7895 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
7897 <para>Die <classname>LXDebug</classname>-Methode
7898 "<function>message</function>" nimmt als ersten Paramter außerdem
7899 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
7900 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
7901 und werden in den meisten Fällen auch vom Repository
7902 zurückgewiesen.</para>
7906 <para>Alle neuen Module müssen use strict verwenden.</para>
7908 <para><varname>$form</varname>, <varname>$auth</varname>,
7909 <varname>$locale</varname>, <varname>$lxdebug</varname> und
7910 <varname>%myconfig</varname> werden derzeit aus dem main package
7911 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
7912 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
7917 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
7918 <title>Dokumentation erstellen</title>
7920 <sect2 id="devel.build-doc.introduction">
7921 <title>Einführung</title>
7923 <para>Diese Dokumentation ist in <productname>DocBook</productname>
7924 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
7925 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
7926 Editor nutzt, der spezielle Unterstützung für
7927 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
7928 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
7929 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
7933 <sect2 id="devel.build-doc.required-software">
7934 <title>Benötigte Software</title>
7936 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
7937 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
7938 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
7939 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
7940 <command>scripts/build_doc.sh</command>.</para>
7942 <para>Das Script benötigt zur Konvertierung verschiedene
7943 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
7949 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
7950 in einer halbwegs aktuellen Version</para>
7954 <para>Das Java-Build-System <ulink
7955 url="http://ant.apache.org/">Apache Ant</ulink></para>
7959 <para>Das Dokumentations-System Dobudish für
7960 <productname>DocBook</productname> 4.5, eine Zusammenstellung
7961 diverser Stylesheets und Grafiken zur Konvertierung von
7962 <productname>DocBook</productname> XML in andere Formate. Das
7963 Paket, das benötigt wird, ist zum Zeitpunkt der
7964 Dokumentationserstellung
7965 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
7966 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
7971 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
7972 sind auf allen gängigen Plattformen verfügbar. Beispiel für
7973 Debian/Ubuntu:</para>
7975 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
7977 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
7978 <filename>doc/build</filename> entpackt werden. Beispiel unter der
7979 Annahme, das <productname>Dobudish</productname> in
7980 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
7982 <programlisting>cd doc/build
7983 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
7986 <sect2 id="devel.build-doc.build">
7987 <title>PDFs und HTML-Seiten erstellen</title>
7989 <para>Die eigentliche Konvertierung erfolgt nach Installation der
7990 benötigten Software mit einem einfachen Aufruf direkt aus dem
7991 kivitendo-Installationsverzeichnis heraus:</para>
7993 <programlisting>./scripts/build_doc.sh</programlisting>
7996 <sect2 id="devel.build-doc.repository">
7997 <title>Einchecken in das Git-Repository</title>
7999 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
8000 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
8001 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
8002 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
8004 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
8005 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob