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.0: Installation, Konfiguration, Entwicklung</title>
7 <chapter id="Aktuelle-Hinweise">
8 <title>Aktuelle Hinweise</title>
10 <para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>
14 <para>im Community-Forum: <ulink
15 url="https://forum.kivitendo.de:32443">https://forum.kivitendo.de:32443</ulink></para>
19 <para>im Kunden-Forum: <ulink
20 url="http://redmine.kivitendo-premium.de/projects/forum/boards/">http://redmine.kivitendo-premium.de/projects/forum/boards/</ulink></para>
24 <para>in der doc/UPGRADE Datei im doc-Verzeichnis der
29 <para>Im Schulungs- und Dienstleistungsangebot der entsprechenden
30 kivitendo-Partner: <ulink
31 url="http://www.kivitendo.de/partner.html">http://www.kivitendo.de/partner.html</ulink></para>
37 <title>Installation und Grundkonfiguration</title>
39 <sect1 id="Installation-Übersicht">
40 <title>Übersicht</title>
42 <para>Die Installation von kivitendo umfasst mehrere Schritte. Die
43 folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
44 Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit
45 minimalen Features möglichst schnell zum Laufen zu kriegen.</para>
49 <para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo
50 benötigt gewisse Ressourcen und benutzt weitere Programme. Das
51 Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert
52 diese. Auch die Liste der benötigten Perl-Module befindet sich
57 <para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst
58 die "<xref linkend="Manuelle-Installation-des-Programmpaketes"/>"
59 sowie grundlegende Einstellungen, die der "<xref
60 linkend="config.config-file"/>" erläutert.</para>
64 <para><emphasis>Konfiguration externer Programme</emphasis>: hierzu
65 gehören die Datenbank ("<xref
66 linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der
67 Webserver ("<xref linkend="Apache-Konfiguration"/>").</para>
71 <para><emphasis>Benutzerinformationen speichern können</emphasis>:
72 man benötigt mindestens eine Datenbank, in der Informationen zur
73 Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man
74 das als Administrator macht, verrät "<xref
75 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para>
79 <para><emphasis>Benutzer, Gruppen und Datenbanken
80 anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
81 linkend="Benutzer--und-Gruppenverwaltung"/>".</para>
85 <para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann
86 kann es losgehen: "<xref linkend="kivitendo-ERP-verwenden"/>"</para>
90 <para>Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls
91 wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen
95 <sect1 id="Benötigte-Software-und-Pakete">
96 <title>Benötigte Software und Pakete</title>
98 <sect2 id="Betriebssystem">
99 <title>Betriebssystem</title>
101 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
102 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
103 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
104 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
105 ohne große Probleme auf den derzeit aktuellen verbreiteten
106 Distributionen läuft.</para>
108 <para>Anfang 2016 sind das folgende Systeme, von denen bekannt ist,
109 dass kivitendo auf ihnen läuft:</para>
117 <para>7.0 "Wheezy"</para>
121 <para>8.0 "Jessie"</para>
127 <para>Ubuntu 12.04 LTS "Precise Pangolin", 14.04 "Trusty Tahr"
128 LTS, 15.10 "Wily Werewolf" und 16.04 "Xenial Xerus" LTS
133 <para>openSUSE LEAP 42.1</para>
137 <para>Fedora 22</para>
142 <sect2 id="Pakete" xreflabel="Pakete">
143 <title>Benötigte Perl-Pakete installieren</title>
145 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
146 Apache) und ein Datenbankserver (PostgreSQL) in einer aktuellen 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.0.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.0.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]
620 password =</programlisting>
622 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
623 <varname>[periodic_invoices]</varname> den Login eines Benutzers
624 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
625 mit Informationen über die erstellten Rechnungen bekommt.</para>
627 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
628 Ausführung bestimmter Aufgaben mit, den <link
629 linkend="config.task-server">Taskserver</link>. Er wird u.a. für
630 Features wie die <link
631 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
632 benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
633 daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
634 <link linkend="config.task-server">Task-Server</link> genauer
637 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
638 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
641 <sect2 id="config.config-file.prior-versions">
642 <title>Versionen vor 2.6.3</title>
644 <para>In älteren kivitendo Versionen gab es im Verzeichnis
645 <filename>config</filename> die Dateien
646 <filename>authentication.pl</filename> und
647 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
648 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
649 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
650 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
652 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
653 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
654 manuell übertragen und die alten Konfigurationsdateien anschließend
655 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
656 entsprechende Fehlermeldung an.</para>
660 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
661 <title>Anpassung der PostgreSQL-Konfiguration</title>
663 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
665 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
666 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
668 <para>kivitendo setzt zwingend voraus, dass die Datenbank
669 Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
670 Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
672 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
673 Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
674 man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
676 <programlisting>su postgres
678 exit </programlisting>
680 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
681 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
682 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
685 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
687 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
688 Versionsnummer angepasst werden.</para>
690 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
692 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
693 <literal>\l</literal> geprüft werden.</para>
696 <sect2 id="Änderungen-an-Konfigurationsdateien">
697 <title>Änderungen an Konfigurationsdateien</title>
699 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
700 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
701 <filename>/var/lib/pgsql/data/</filename> oder
702 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
703 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
704 Parameter <varname>listen_address</varname> gesteuert. Laufen
705 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
706 <literal>localhost</literal> verwendet werden. Andernfalls müssen
707 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
708 was mit dem Wert <literal>*</literal> geschieht.</para>
710 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
711 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
712 sein sollte, müssen die Berechtigungen für den Zugriff geändert
713 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
714 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
715 Datenbank zum Beispiel:</para>
717 <programlisting>local all kivitendo password
718 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
721 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
722 <title>Erweiterung für servergespeicherte Prozeduren</title>
724 <para>In der Datenbank <literal>template1</literal> muss die
725 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
726 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
727 <programlisting>su - postgres
728 psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
730 <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
734 <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
735 bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
736 anzulegen. In diesen Versionen ist die Extension meist auch schon
737 vorhanden. Sollten Sie eine ältere Version von Postgres haben,
738 benutzen Sie stattdessen den folgenden Befehl.</para>
740 <programlisting>CREATE LANGUAGE 'plpgsql';
745 <sect2 id="Datenbankbenutzer-anlegen">
746 <title>Datenbankbenutzer anlegen</title>
748 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
749 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
750 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
753 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
754 nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
755 generieren nicht nötig.</para>
757 <programlisting>su - postgres
758 createuser -d -P kivitendo
759 exit</programlisting>
761 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
762 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
763 bzw. den hier gewählten Benutzernamen.</para>
767 <sect1 id="Apache-Konfiguration">
768 <title>Webserver-Konfiguration</title>
771 <title>Grundkonfiguration mittels CGI</title>
774 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
775 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
776 <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
779 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
780 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
781 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
782 anderen Datei hinzu, die beim Starten des Webservers eingelesen
785 <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
786 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
788 <Directory /var/www/kivitendo-erp>
789 AddHandler cgi-script .pl
790 Options ExecCGI Includes FollowSymlinks
793 <Directory /var/www/kivitendo-erp/users>
796 </Directory></programlisting>
798 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
799 das kivitendo-Archiv entpacket haben.</para>
802 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
803 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
805 <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
806 noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
807 aktiviert werden.</para>
810 <para>Auf einigen Webservern werden manchmal die Grafiken und
811 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
812 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
814 <programlisting>EnableSendfile Off</programlisting>
817 <sect2 id="Apache-Konfiguration.FCGI"
818 xreflabel="Konfiguration für FastCGI/FCGI">
819 <title>Konfiguration für FastCGI/FCGI</title>
821 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
822 <title>Was ist FastCGI?</title>
824 <para>Direkt aus <ulink
825 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
828 <para><citation> FastCGI ist ein Standard für die Einbindung
829 externer Software zur Generierung dynamischer Webseiten in einem
830 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
831 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
832 umgehen. </citation></para>
835 <sect3 id="Apache-Konfiguration.FCGI.Warum">
836 <title>Warum FastCGI?</title>
838 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
839 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
840 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
841 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
842 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
843 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
844 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
845 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
846 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
847 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
848 deutlich länger dauert als früher, und dass davon 90% für das Laden
849 der Module verwendet wird.</para>
851 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
852 wird nur die eigentliche Programmlogik ausgeführt.</para>
855 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
856 <title>Getestete Kombinationen aus Webservern und Plugin</title>
858 <para>Folgende Kombinationen sind getestet:</para>
862 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
866 <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
870 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
874 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
875 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
876 mod_fastcgi nicht mehr explizit eingegangen.</para>
878 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
882 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
883 strict in der Behandlung von Unicode, und verweigern bestimmte
884 Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
885 Installation gibt, muss zwingend Version 0.68 oder aber Version
886 0.72 und neuer eingesetzt werden.</para>
888 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
889 sich die Vorgängerversion wie folgt installieren:</para>
891 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
895 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
896 <title>Konfiguration des Webservers</title>
898 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
899 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
900 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
901 debuggen die beim ersten aufsetzen auftreten können. Sollte die
902 Installation schon funktionieren, lesen Sie weiter.</para>
904 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
905 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
907 <programlisting>a2enmod fcgid</programlisting>
909 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
910 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
911 und <function>Directory</function>-Direktiven. Dabei wird zwischen
912 dem Installationspfad von kivitendo im Dateisystem
913 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
914 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
915 ("<filename>/url/for/kivitendo-erp</filename>").</para>
917 <para>Folgender Konfigurationsschnipsel funktioniert mit
920 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
921 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
923 <Directory /path/to/kivitendo-erp>
925 Options ExecCGI Includes FollowSymlinks
929 <DirectoryMatch /path/to/kivitendo-erp/users>
931 </DirectoryMatch></programlisting>
934 <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
935 muss entsprechend die Syntax der Directorydirektiven verändert.
938 <programlisting>Require all granted</programlisting>
940 <para>muß man Folgendes einstellen:</para>
944 Allow from All </programlisting>
947 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
948 die maximale Größe eines Requests. Diese sollte wie folgt
949 hochgesetzt werden:</para>
951 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
953 <para>Das Ganze sollte dann so aussehen:</para>
955 <programlisting>AddHandler fcgid-script .fpl
956 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
957 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
958 FcgidMaxRequestLen 10485760
960 <Directory /path/to/kivitendo-erp>
962 Options ExecCGI Includes FollowSymlinks
967 <DirectoryMatch /path/to/kivitendo-erp/users>
970 </DirectoryMatch></programlisting>
972 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
973 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
974 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
975 gibt es hier kleine Performance-Einbußen.</para>
977 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
978 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
979 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
981 <programlisting># Zugriff über CGI
982 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
984 # Zugriff mit mod_fcgid:
985 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
986 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
988 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
989 die normale Version erreichbar, und unter
990 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
991 FastCGI-Version.</para>
996 <title>Weitergehende Konfiguration</title>
998 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
999 von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1000 weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1001 Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1002 Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1003 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1004 (Stand Sept. 2015)</ulink></para>
1008 <sect1 id="config.task-server">
1009 <title>Der Task-Server</title>
1011 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1012 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1013 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1014 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1015 essenzielle Aufgaben benutzt.</para>
1017 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1018 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1019 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1021 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1022 Servers integriert werden muss, damit er automatisch gestartet wird.
1023 Dies kann kivitendo nicht für Sie erledigen.</para>
1025 <sect2 id="Konfiguration-des-Task-Servers">
1026 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1028 <para>Die Konfiguration erfolgt über den Abschnitt
1029 <literal>[task_server]</literal> in der Datei
1030 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1031 Optionen sind:</para>
1035 <term><varname>run_as</varname></term>
1038 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1039 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1040 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1041 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1043 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1044 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1045 unter dem auch der Webserver läuft.</para>
1050 <term><varname>debug</varname></term>
1053 <para>Schaltet Debug-Informationen an und aus.</para>
1059 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1060 <title>Konfiguration der Mandanten für den Task-Server</title>
1062 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1063 anschließend jeder Mandant, für den der Task-Server laufen soll,
1064 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1065 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1066 ausgewählt werden, unter der der Task-Server seine Arbeit
1069 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1070 wird der Task-Server für diesen Mandanten keine Aufgaben
1074 <sect2 id="Einbinden-in-den-Boot-Prozess">
1075 <title>Automatisches Starten des Task-Servers beim Booten</title>
1077 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1078 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1079 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1081 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1082 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1083 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1084 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1085 anstelle eines symbolischen Links verwendet werden können.</para>
1088 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE,
1089 ältere Fedora)</title>
1091 <para>Kopieren Sie die Datei
1092 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1093 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1094 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1095 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1096 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1100 <para>Debian-basierende Systeme:</para>
1102 <programlisting>update-rc.d kivitendo-task-server defaults
1103 # Nur bei Debian Squeeze und neuer:
1104 insserv kivitendo-task-server</programlisting>
1108 <para>Ältere OpenSUSE und ältere Fedora:</para>
1110 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1114 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1117 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1121 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1123 <para>Kopieren Sie die Datei
1124 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1125 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1126 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1127 <literal>exec ....</literal>).</para>
1129 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1132 <programlisting>service kivitendo-task-server start</programlisting>
1136 <title>systemd-basierende Systeme (z.B. neure OpenSUSE, neuere
1137 Fedora, neuere Ubuntu)</title>
1139 <para>Verlinken Sie die Datei
1140 <filename>scripts/boot/systemd/kivitendo-task-server.service</filename>
1141 nach <filename>/etc/systemd/system/</filename>. Passen Sie in der
1142 kopierten Datei den Pfad zum Task-Server an (Zeile
1143 <literal>ExecStart=....</literal> und
1144 <literal>ExecStop=...</literal>). Binden Sie das Script in den
1145 Boot-Prozess ein.</para>
1147 <para>Alle hierzu benötigten Befehle sehen so aus:</para>
1149 <programlisting>cd /var/www/kivitendo-erp/scripts/boot/systemd
1150 ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
1152 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1155 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1159 <sect2 id="Prozesskontrolle">
1160 <title>Wie der Task-Server gestartet und beendet wird</title>
1162 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1164 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1166 <para><literal>Befehl</literal> ist dabei eine der folgenden
1171 <para><literal>start</literal> startet eine neue Instanz des
1172 Task-Servers. Die Prozess-ID wird innerhalb des
1173 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1177 <para><literal>stop</literal> beendet einen laufenden
1182 <para><literal>restart</literal> beendet und startet ihn
1187 <para><literal>status</literal> berichtet, ob der Task-Server
1192 <para>Der Task-Server wechselt beim Starten automatisch in das
1193 kivitendo-Installationsverzeichnis.</para>
1195 <para>Dieselben Optionen können auch für die SystemV-basierenden
1196 Runlevel-Scripte benutzt werden (siehe oben).</para>
1200 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1201 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1203 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1204 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1206 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1207 <title>Grundlagen zur Benutzerauthentifizierung</title>
1209 <para>kivitendo verwaltet die Benutzerinformationen in einer
1210 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1211 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1212 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1213 können, müssen aber nicht unterschiedlich sein.</para>
1215 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1216 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1217 abgelegt werden.</para>
1219 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
1220 entweder gegen die Authentifizierungsdatenbank oder gegen einen
1221 LDAP-Server überprüft werden.</para>
1223 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1224 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1225 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1226 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1227 einer Version vor v2.6.0 angelegt werden. Eine
1228 Beispielkonfigurationsdatei
1229 <filename>config/kivitendo.conf.default</filename> existiert, die als
1230 Vorlage benutzt werden kann.</para>
1233 <sect2 id="Administratorpasswort">
1234 <title>Administratorpasswort</title>
1236 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1237 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1238 gespeichert. Es kann auch nur dort und nicht mehr im
1239 Administrationsinterface selber geändert werden. Der Parameter dazu
1240 heißt <varname>admin_password</varname> im Abschnitt
1241 <varname>[authentication]</varname>.</para>
1244 <sect2 id="Authentifizierungsdatenbank">
1245 <title>Authentifizierungsdatenbank</title>
1247 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1248 Parametern in <varname>[authentication/database]</varname>
1249 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1253 <term><literal>host</literal></term>
1256 <para>Der Rechnername oder die IP-Adresse des
1257 Datenbankservers</para>
1262 <term><literal>port</literal></term>
1265 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1270 <term><literal>db</literal></term>
1273 <para>Der Name der Authentifizierungsdatenbank</para>
1278 <term><literal>user</literal></term>
1281 <para>Der Benutzername, mit dem sich kivitendo beim
1282 Datenbankserver anmeldet (z.B.
1283 "<literal>postgres</literal>")</para>
1288 <term><literal>password</literal></term>
1291 <para>Das Passwort für den Datenbankbenutzer</para>
1296 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1297 automatisch anlegen (mehr dazu siehe unten).</para>
1300 <sect2 id="Passwortüberprüfung">
1301 <title>Passwortüberprüfung</title>
1303 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1304 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1305 Active-Directory-Server. Welche davon benutzt wird, regelt der
1306 Parameter <varname>module</varname> im Abschnitt
1307 <varname>[authentication]</varname>.</para>
1309 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1310 gespeichert werden, so muss der Parameter <varname>module</varname>
1311 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1312 der Administrator als auch die Benutzer selber ihre Passwörter in
1313 kivitendo ändern.</para>
1315 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1316 benutzt werden, so muss der Parameter <varname>module</varname> auf
1317 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1318 zusätzliche Informationen über den LDAP-Server im Abschnitt
1319 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1323 <term><literal>host</literal></term>
1326 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1327 Active-Directory-Servers. Diese Angabe ist zwingend
1328 erforderlich.</para>
1333 <term><literal>port</literal></term>
1336 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1341 <term><literal>tls</literal></term>
1344 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1345 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1346 ‘<literal>0</literal>’ belassen</para>
1351 <term><literal>attribute</literal></term>
1354 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1355 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1356 meist ‘<literal>sAMAccountName</literal>’, für andere
1357 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1358 zwingend erforderlich.</para>
1363 <term><literal>base_dn</literal></term>
1366 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1367 Diese Angabe ist zwingend erforderlich.</para>
1372 <term><literal>filter</literal></term>
1375 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1376 <literal><%login%></literal>, so wird dieses durch den vom
1377 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1378 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1379 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1384 <term><literal>bind_dn</literal> und
1385 <literal>bind_password</literal></term>
1388 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1389 durchsucht werden kann (z.B. ist dies bei
1390 Active-Directory-Servern der Fall), so kann diese hier angegeben
1391 werden. Für Active-Directory-Server kann als
1392 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1393 z.B. ‘<literal>cn=Martin
1394 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1395 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1396 also ‘<literal>Martin Mustermann</literal>’.</para>
1402 <sect2 id="Name-des-Session-Cookies">
1403 <title>Name des Session-Cookies</title>
1405 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1406 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1407 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1408 Parameter <varname>cookie_name</varname> im Abschnitt
1409 <varname>[authentication]</varname>gesetzt.</para>
1411 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1412 Server existiert.</para>
1415 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1416 <title>Anlegen der Authentifizierungsdatenbank</title>
1418 <para>Nachdem alle Einstellungen in
1419 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1420 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1421 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1422 der folgenden URL erreichbar sein sollte:</para>
1425 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1429 <sect1 id="Benutzer--und-Gruppenverwaltung">
1430 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1432 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1433 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1434 das Sie unter folgender URL finden:</para>
1437 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1439 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1440 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1442 <sect2 id="Zusammenhänge">
1443 <title>Zusammenhänge</title>
1445 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1446 in einer oder zwei Datenbanken gespeichert werden.</para>
1448 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1449 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1450 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1451 Diese Informationen werden in der Authentifizierungsdatenbank
1452 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1453 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1454 gespeichert werden.</para>
1456 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1457 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1458 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1459 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1460 einer solchen Mandantendatenbank werden im Administrationsbereich
1461 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1462 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1464 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1465 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1466 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1467 mehr als einem Mandanten, wird empfohlen, für die
1468 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1469 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1472 <sect2 id="Mandanten-Benutzer-Gruppen">
1473 <title>Mandanten, Benutzer und Gruppen</title>
1475 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1476 die sich frei zueinander zuordnen lassen.</para>
1478 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1479 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1480 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1481 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1482 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1483 Diese sollte über die <link
1484 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1487 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1488 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1489 der Administrator fest, an welchen Mandanten sich ein Benutzer
1490 anmelden kann, was beim Login verifiziert wird.</para>
1492 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1493 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1494 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1495 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1496 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1497 dann an einem Mandanten an, so erhält er alle Rechte von allen
1498 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1499 denen der Benutzer zum Anderen Mitglied ist,</para>
1501 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1502 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1503 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1505 <orderedlist numeration="arabic">
1507 <para>Datenbank anlegen</para>
1511 <para>Gruppen anlegen</para>
1515 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1519 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1524 <sect2 id="Datenbanken-anlegen">
1525 <title>Datenbanken anlegen</title>
1527 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1528 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1529 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1532 <sect2 id="Gruppen-anlegen">
1533 <title>Gruppen anlegen</title>
1535 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1536 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1537 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1538 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1540 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1541 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1542 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1543 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1544 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1545 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1546 A, B und C gültig").</para>
1548 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1549 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1550 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1551 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1552 Gruppen A, B und C").</para>
1555 <sect2 id="Benutzer-anlegen">
1556 <title>Benutzer anlegen</title>
1558 <para>Beim Anlegen von Benutzern werden für viele Parameter
1559 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1560 deutschen Raumes entsprechen.</para>
1562 <para>Zwingend anzugeben ist der Loginname. Wenn die
1563 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
1564 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
1565 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1568 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
1569 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
1570 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
1571 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
1572 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
1573 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
1574 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
1575 sind Benutzer A, B und C Mitglieder").</para>
1578 <sect2 id="Mandanten-anlegen">
1579 <title>Mandanten anlegen</title>
1581 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
1582 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
1583 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
1584 einer der eben angelegten Datenbanken eingetragen werden.</para>
1586 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
1587 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
1588 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
1589 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
1590 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
1591 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
1592 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
1593 Gruppe ist für Mandanten A, B und C gültig").</para>
1597 <sect1 id="Drucker--Systemverwaltung">
1598 <title>Drucker- und Systemverwaltung</title>
1600 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
1601 Druckeradministration und System.</para>
1603 <sect2 id="Druckeradministration">
1604 <title>Druckeradministration</title>
1606 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
1607 viele "Druckbefehle" im System verwalten. Diese Befehle werden
1608 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
1609 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
1610 angezeigt wird.</para>
1612 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
1613 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
1614 meinDrucker' oder ein kompletter Pfad zu einem Skript
1615 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
1616 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
1617 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
1618 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
1619 Ausdruck eines Angebots folgende Vorlage geparst:
1620 sales_quotation_epson_drucker.tex.</para>
1624 <title>System sperren / entsperren</title>
1626 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
1627 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
1628 gesamten kivitendo Installation gesperrt.</para>
1630 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
1631 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
1632 Wartungsarbeiten nicht zugänglich.'.</para>
1634 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
1635 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
1636 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
1637 inkonsistenten Datenbestand weitergearbeitet werden.</para>
1641 <sect1 id="config.sending-email"
1642 xreflabel="E-Mail-Versand aus kivitendo heraus">
1643 <title>E-Mail-Versand aus kivitendo heraus</title>
1645 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
1646 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
1647 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
1648 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
1649 Versand über einen lokalen E-Mail-Server (z.B. mit
1650 <productname>Postfix</productname> oder <productname>Exim</productname>,
1651 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
1652 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
1654 <para>Welche Methode und welcher Server verwendet werden, wird über die
1655 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1656 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
1657 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1659 <sect2 id="config.sending-email.sendmail"
1660 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1661 <title>Versand über lokalen E-Mail-Server</title>
1663 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
1664 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
1665 <productname>Postfix</productname>, <productname>Exim</productname>
1666 oder <productname>Sendmail</productname> läuft.</para>
1668 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1669 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1670 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1672 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
1673 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
1674 Standardwert verweist auf das Programm
1675 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1676 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1678 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
1679 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
1683 <sect2 id="config.sending-email.smtp"
1684 xreflabel="E-Mail-Versand über einen SMTP-Server">
1685 <title>Versand über einen SMTP-Server</title>
1687 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
1688 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
1691 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1692 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1693 Parameter dienen dabei der weiteren Konfiguration:</para>
1697 <term><varname>hostname</varname></term>
1700 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
1701 '<literal>localhost</literal>'</para>
1706 <term><varname>port</varname></term>
1709 <para>Portnummer. Der Standardwert hängt von der verwendeten
1710 Verschlüsselungsmethode ab. Gilt '<literal>security =
1711 none</literal>' oder '<literal>security = tls</literal>', so ist
1712 25 die Standardportnummer. Für '<literal>security =
1713 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
1714 geändert werden.</para>
1719 <term><varname>security</varname></term>
1722 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
1723 mit dem Server. Standardwert ist '<literal>none</literal>',
1724 wodurch keine Verschlüsselung verwendet wird. Mit
1725 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
1726 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
1727 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
1728 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
1729 (siehe unten).</para>
1734 <term><varname>login</varname> und
1735 <varname>password</varname></term>
1738 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
1739 so können mit diesen zwei Parametern der Benutzername und das
1740 Passwort angegeben werden. Wird Authentifizierung verwendet, so
1741 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
1742 aktiviert werden.</para>
1749 <sect1 id="Drucken-mit-kivitendo">
1750 <title>Drucken mit kivitendo</title>
1752 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
1753 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1754 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1755 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
1757 <para><programlisting>apt-get install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1758 exlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1760 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
1762 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
1763 texlive-collection-latexrecommended texlive-collection-langgerman \
1764 texlive-collection-langenglish</programlisting></para>
1766 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
1768 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
1769 texlive-collection-latexrecommended texlive-collection-langgerman \
1770 texlive-collection-langenglish</programlisting></para>
1772 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1784 <para>rev-odt</para>
1788 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version
1789 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
1791 <sect2 id="Vorlagenverzeichnis-anlegen"
1792 xreflabel="Vorlagenverzeichnis anlegen">
1793 <title>Vorlagenverzeichnis anlegen</title>
1795 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
1796 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1798 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1800 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
1801 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
1802 <xref linkend="Gruppen-anlegen"/>.</para>
1804 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
1805 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
1806 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
1807 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1811 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
1812 Vorlagensatz aus, der kopiert werden soll
1813 (<filename>RB</filename>, <filename>f-tex</filename> oder
1814 <filename>odt-rev</filename>.)</para>
1818 <para><option>Neuer Name</option>: Der Verzeichnisname für den
1819 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
1820 für Verzeichnisnamen frei gewählt werden.</para>
1824 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
1825 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
1826 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1827 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
1828 vorgenommen werden. Den Ordner findet man im Dateisystem unter
1829 <filename>./templates/[Neuer Name]</filename></para>
1832 <sect2 id="Vorlagen-RB">
1833 <title>Der Druckvorlagensatz RB</title>
1835 <para>Hierbei handelt es sich um einen vollständigen LaTeX
1836 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
1837 sind nicht gepflegt.</para>
1839 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
1840 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1841 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
1842 eigenen Firmendaten finden sich in der Datei Readme.tex im
1843 Vorlagenverzeichnis.</para>
1845 <para>Eine kurze Übersicht der Features:</para>
1849 <para>Mehrsprachenfähig, mit Deutscher und Englischer
1854 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
1855 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
1860 <para>mehrere vordefinierte Varianten für
1861 Logos/Hintergrundbilder</para>
1865 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
1866 "Außerhalb EU"</para>
1872 <title>f-tex</title>
1874 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur
1875 Verfügung stellt.</para>
1877 <sect3 id="f-tex-Feature-Übersicht">
1878 <title>Feature-Übersicht</title>
1882 <para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage
1883 für alle briefartigen Dokumente verwendet. Also Angebot,
1884 Rechnung, Proformarechnung, Lieferschein, aber eben nicht für
1885 Paketaufkleber etc.</para>
1889 <para>Leichte Anpassung an das Firmen-Layout durch Verwendung
1890 eines Hintergrund-PDFs. Dieses kann leicht mit dem eigenen
1891 Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp,
1896 <para>Hintergrund-PDF umschaltbar auf "nur erste Seite"
1897 (Standard) oder "alle Seiten" (Option
1898 "<option>bgPdfFirstPageOnly</option>" in Datei
1899 <filename>letter.lco</filename>)</para>
1903 <para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem
1904 Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1905 versendeten Dokumenten eingebunden (Option
1906 "<option>bgPdfEmailOnly</option>" in Datei
1907 <filename>letter.lco</filename>).</para>
1911 <para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch,
1912 Wiederholung von Kopfzeilen, Zwischensummen etc. (danke an
1913 Kai-Martin Knaak für die Vorarbeit)</para>
1917 <para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom
1918 Land des eigenen Unternehmens abweicht (also die Rechnung das
1919 Land verlässt).</para>
1923 <para>Multisprachfähig leicht um weitere Sprachen zu erweitern,
1924 alle Übersetzungen in der Datei
1925 <filename>translatinos.tex</filename>.</para>
1929 <para>Auflistung von Bruttopreisen für Endverbraucher.</para>
1934 <sect3 id="f-tex-Installation">
1935 <title>Die Installation</title>
1939 <para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref
1940 linkend="Vorlagenverzeichnis-anlegen"/>. Das Vorlagensystem
1941 funktioniert jetzt schon, hat allerdings noch einen
1942 Beispiel-Briefkopf.</para>
1946 <para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
1947 <filename>./letter_head.pdf</filename>.</para>
1951 <para>Editiere den Bereich "<option>settings</option>" in der
1952 datei <filename>letter.lco</filename>.</para>
1956 <para>oder etwas detaillierter:</para>
1958 <para>Es wird eine Datei <filename>sample.lco</filename> erstellt
1959 und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
1960 ist dies die Datei die für die firmenspezifischen Anpassungen
1961 gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist,
1962 wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle
1963 über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und
1964 <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung
1965 über eine <filename>*.lco</filename>-Datei, die letztlich auf
1966 <filename>letter.lco</filename> verlinkt ist ist aber auch
1969 <para>Es wird eine Datei <filename>sample_head.pdf</filename> mit
1970 ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
1971 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage.
1972 Schau Dir nach Abschluss der Installation die Datei
1973 <filename>sample_head.pdf</filename> an und erstelle ein
1974 entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
1975 Template Verzeichniss ablegen und statt
1976 <filename>sample_head.pdf</filename> nach
1977 <filename>letter_head.pdf</filename> verlinken.</para>
1979 <para>Letzlich muss <filename>letter_head.pdf</filename> auf das
1980 passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
1983 <para>Es wird eine Datei <filename>mydata.tex.example</filename>
1984 ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
1985 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das
1986 Land verwendet. Die Datei muss also nicht angefasst werden. Die
1987 anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit
1988 nicht im öffentlichen Zweig).</para>
1990 <para>Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
1991 sollten über die Hintergrund-PDF-Datei oder die
1992 <filename>*.lco</filename>-Datei erfolgen.</para>
1995 <sect3 id="f-tex-Funktionsübersicht">
1996 <title>f-tex Funktionsübersicht</title>
1998 <para>Das Konzept von kivitendo sieht vor, für jedes Dokument
1999 (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
2000 LaTeX-Vorlage vorzuhalten, dies ist sehr wartungsunfreundlich. Auch
2001 das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
2002 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen
2003 aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
2004 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
2005 LaTeX-Vorlage verwendet, welche über Codeweichen die Besonderheiten
2006 der jeweiligen Dokumente berücksichtigt:</para>
2010 <para>Tabellen mit oder ohne Preis</para>
2014 <para>Sprache der Tabellenüberschriften etc.</para>
2018 <para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
2019 Angebotsnummer)</para>
2023 <para>Darstellung von Brutto oder Netto-Preisen in der
2024 Auflistung (Endverbraucher versus gewerblicher Kunde)</para>
2028 <para>Nachteil:</para>
2030 <para>LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei
2031 <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
2032 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder
2033 geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch
2034 innerhalb der Tabellendarstellung gut persönliche Anpassungen
2035 vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell
2036 heftig in den Fuss schiessen.</para>
2038 <para>Wer nicht so tief in die Materie einsteigen will oder leicht
2039 zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
2040 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen,
2041 und sich an der Form der dargestellten Tabellen, wie sie
2042 ausgeliefert werden, erfreuen.</para>
2044 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine,
2045 kontinuierliche Schritte gehen.</para>
2048 <sect3 id="f-tex-Bruttopreise">
2049 <title>Bruttopreise für Endverbraucher</title>
2051 <para>Der auszuweisende Bruttopreis wird innerhalb der
2052 LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen
2053 "alle Preise Brutto" auszuwählen, aber:</para>
2057 <para>hierfür müssen die Preise auch in Brutto in der Datenbank
2058 stehen (ja - das lässt sich über die Preisgruppen und die
2059 Zuordung einer Default-Preisgruppe handhaben)</para>
2063 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses
2064 Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
2065 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche
2070 <para>Es gibt mit f-tex eine weitere Alternative. Die Information ob
2071 Brutto oder Nettorechnung wird mit den Zahlarten verknüpft.
2072 Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben
2073 werden sollen, enden mit "_E" (für Endverbraucher). Falls identische
2074 Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt
2075 man diese einfach doppelt an (einmal mit der Namensendung "_E").
2080 <para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist
2081 nicht mehr fix mit einer Preisliste verbunden.</para>
2085 <para>Die Default-Zahlart kann im Kundendatensatz hinterlegt
2086 werden, und man muss nicht mehr daran denken, "alle Preise
2087 Netto" auszuwählen.</para>
2091 <para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen
2092 werden, kann direkt beim Drucken revidiert werden, ohne dass
2093 sich der Auftragswert ändert.</para>
2098 <sect3 id="f-tex-lieferadressen">
2099 <title>Lieferadressen</title>
2101 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen
2102 im Adressfeld zum Einsatz. Wenn die
2103 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende
2104 Adressvariable eingesetzt. Wenn also die Lieferadresse in Straße,
2105 Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
2106 Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert
2107 der Hauptadresse angezeigt.</para>
2111 <sect2 id="Vorlagen-rev-odt">
2112 <title>Der Druckvorlagensatz rev-odt</title>
2114 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2115 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2116 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2117 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2118 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2119 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2120 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2122 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2123 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2124 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2125 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2126 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2127 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2129 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2130 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2131 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2132 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2133 die vom Parser nicht korrekt gelesen werden kann.</para>
2135 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2136 odt-Vorlagen bei Mahnungen einzusetzen. Entsprechende Vorlagen sind
2137 deshalb nicht vorhanden.</para>
2139 <para>Inwieweit es möglich ist, für die in Version 3.2.0 neu
2140 eingeführten Pflichtenhefte odt-Vorlagen zu erstellen, sind wir am
2141 abklären. Wenn dies möglich ist, werden wir in Zukunft auch eine
2142 odt-Vorlage für Pflichtenhefte in diesem Vorlagensatz zur Verfügung
2145 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2146 empfang@revamp-it.ch</para>
2149 <sect2 id="allgemeine-hinweise-zu-latex">
2150 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2152 <para>In den allermeisten Installationen sollte das Drucken jetzt
2153 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2154 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2155 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2156 sind zum Beispiel:</para>
2160 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2161 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2162 allem bei Vorlagen aus der Community auf. Installieren Sie die
2163 entsprechenden Pakete.</para>
2167 <para>! Package inputenc Error: Unicode char \u8:... set up for
2168 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2169 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2170 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2171 diversen Tricks dazu gebracht werden andere Zeichen zu
2172 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2177 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2178 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2179 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2180 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2181 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2184 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2185 verifizieren lässt:</para>
2189 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2190 "keep_temp_files" auf 1</para>
2192 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2196 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2200 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2204 <para>wechsel in das users Verzeichnis von kivitendo</para>
2206 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2210 <para>LaTeX Suchpfad anpassen:</para>
2212 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2216 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2219 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2221 <para>Es sollte die letzte Datei ganz unten sein</para>
2225 <para>für besseren Hinweis auf Fehler texdatei nochmals
2228 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2230 <para>in der *.tex datei nach dem Fehler suchen.</para>
2236 <sect1 id="OpenDocument-Vorlagen">
2237 <title>OpenDocument-Vorlagen</title>
2239 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2240 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
2241 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
2242 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2243 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2244 <filename>config/kivitendo.conf</filename> die Variable
2245 <literal>opendocument</literal> im Abschnitt
2246 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2247 Dieses ist die Standardeinstellung.</para>
2249 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2250 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2251 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
2252 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
2253 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
2254 Andere Distributionen enthalten ihn in anderen Paketen.</para>
2256 <para>Nach der Installation müssen in der Datei
2257 <filename>config/kivitendo.conf</filename> zwei weitere Variablen
2258 angepasst werden: <literal>openofficeorg_writer</literal> muss den
2259 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
2260 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2261 enthalten. Beide stehen im Abschnitt
2262 <literal>applications</literal>.</para>
2264 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2265 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
2266 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
2267 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
2268 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
2269 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
2270 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
2271 werden muss. Der Nachteil ist, dass diese Methode Python und die
2272 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
2276 <para>Für die Verbindung zu OpenOffice wird normalerweise der
2277 Python-Interpreter <filename>/usr/bin/python</filename> benutzt.
2278 Sollte dies nicht der richtige sein, so kann man mit zwei
2279 Konfigurationsvariablen entscheiden, welcher Python-Interpreter
2280 genutzt wird. Mit der Option <literal>python_uno</literal> aus dem
2281 Abschnitt <literal>applications</literal> wird der Interpreter selber
2282 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2283 <literal>/usr/bin/python</literal>.</para>
2285 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2286 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2287 z.B. falls sich diese in einem gesonderten OpenOffice-Verzeichnis
2288 befinden. Diese zweite Variable heißt
2289 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2290 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2291 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2292 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2293 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2297 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2298 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
2299 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
2300 Dokumentenvorlage enthalten sein und
2301 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2302 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
2303 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
2304 ebenfalls enthalten sein muss.</para>
2306 <para>Als letztes muss herausgefunden werden, welchen Namen
2307 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
2308 gibt. Unter Debian ist dies momentan
2309 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
2310 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
2311 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
2312 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
2313 folgender Befehl auszuführen:</para>
2315 <para><literal>mv users/.openoffice.org2
2316 users/.openoffice</literal></para>
2318 <para>Dieses Verzeichnis, wie auch das komplette
2319 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2320 sein. Dieses wurde bereits erledigt (siehe <xref
2321 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber erneut
2322 überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.</para>
2325 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2327 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2328 Aufgaben erfüllen.</para>
2330 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2331 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2332 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2333 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2334 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2335 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2336 Anpassungen aufgeführt</emphasis>):</para>
2339 <title>Bezeichnung der Vorlagen</title>
2341 <para>Rechnung: invoice_besr.odt, Auftrag:
2342 sales_order_besr.odt</para>
2346 <title>Vorbereitungen im Adminbereich</title>
2348 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2349 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2350 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2351 ein Drucker eingerichtet werden:</para>
2355 <para>Druckeradministration -> Drucker hinzufügen</para>
2359 <para>Mandant wählen</para>
2363 <para>Druckerbeschreibung -> aussagekräftiger Text: wird in
2364 der Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B.
2365 mit Einzahlungsschein Bank xy)</para>
2369 <para>Druckbefehl -> beliebiger Text (hat für das Erzeugen
2370 von Aufträgen oder Rechnungen als odt-Datei keine Bedeutung,
2371 darf aber nicht leer sein)</para>
2375 <para>Vorlagenkürzel -> besr bzw. selbst gewähltes
2376 Vorlagensuffix (muss genau der Zeichenfolge entsprechen, die
2377 zwischen "invoice_" bzw. "sales_order_" und ".odt"
2382 <para>speichern</para>
2388 <title>Benutzereinstellungen</title>
2390 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2391 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2392 dies persönlich für sich bei den Benutzereinstellungen
2393 konfigurieren:</para>
2397 <para>Programm -> Benutzereinstellungen ->
2398 Druckoptionen</para>
2402 <para>Standardvorlagenformat -> OpenDocument/OASIS</para>
2406 <para>Standardausgabekanal -> Bildschirm</para>
2410 <para>Standarddrucker -> gewünschte Druckerbeschreibung
2411 auswählen (z.B. mit Einzahlungsschein Bank xy)</para>
2415 <para>Anzahl Kopien -> leer</para>
2419 <para>speichern</para>
2425 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2427 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2428 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2429 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2430 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2435 <para>Für den Einzahlungsschein ist die letzte Seite des
2436 Dokuments reserviert</para>
2440 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2441 Zeile mit folgenden Angaben (<emphasis
2442 role="bold">Bank-Konto-Identifikationsnummer und
2443 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2444 Bank angepasst werden</emphasis>):<itemizedlist>
2446 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2447 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2449 <para>erster Wert: <emphasis
2450 role="bold">Bank-Konto-Identifikation</emphasis>
2451 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2452 angepasst werden</emphasis>.</para>
2456 <para>zweiter Wert: <%customernumber%>
2457 (Kundennummer: nur Ziffern, maximal 6)</para>
2461 <para>dritter Wert: <%ordnumber%>
2462 (Auftragsnummer bei Auftragsvorlage
2463 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2464 führende Buchstaben werden vom Makro entfernt</para>
2468 <para>vierter Wert: <%invnumber%>
2469 (Rechnungsnummer bei Rechnungsvorlage
2470 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2471 führende Buchstaben werden vom Makro entfernt</para>
2473 </itemizedlist></para>
2477 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2478 Bank, muss angepasst werden</emphasis>.</para>
2482 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2483 falls Einzahlungsschein ohne Betrag</para>
2485 </itemizedlist></para>
2489 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2490 der Name und die Adresse der Bank, die Postkonto-Nummer der
2491 Bank, sowie der eigene Firmenname und die Firmenadresse
2492 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2493 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2494 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2500 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2501 ändernde Einträge in rot</screeninfo>
2505 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2512 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2513 odt-Rechnung (analog bei Auftrag)</title>
2515 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2516 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2517 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2518 den Benutzereinstellungen als persönlicher Standard gewählt
2523 <title>Makroeinstellungen in LibreOffice anpassen</title>
2525 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2526 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2527 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2528 angepasst werden:</para>
2532 <para>Extras -> Optionen -> Sicherheit ->
2533 Makrosicherheit</para>
2537 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2538 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2539 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2544 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2545 der entsprechenden Nachfrage "Makros ausführen" auswählen.
2548 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2549 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2550 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2551 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2559 <sect1 id="config.eur">
2560 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
2563 <sect2 id="config.eur.introduction"
2564 xreflabel="Einführung in die Konfiguration zur EUR">
2565 <title>Einführung</title>
2567 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
2568 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
2569 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
2570 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
2571 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
2573 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
2574 die Mandantendatenbank verschoben und dabei auch gleich in drei
2575 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
2576 steuern lässt.</para>
2579 <sect2 id="config.eur.parameters"
2580 xreflabel="Konfigurationsparameter für EUR">
2581 <title>Konfigurationsparameter</title>
2583 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
2584 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
2588 <term><varname>profit_determination</varname></term>
2591 <para>Dieser Parameter legt die Berechnungsmethode für die
2592 Gewinnermittlung fest. Er enthält entweder
2593 <literal>balance</literal> für
2594 Betriebsvermögensvergleich/Bilanzierung oder
2595 <literal>income</literal> für die
2596 Einnahmen-Überschuss-Rechnung.</para>
2601 <term><varname>accounting_method</varname></term>
2604 <para>Dieser Parameter steuert die Buchungs- und
2605 Berechnungsmethoden für die Versteuerungsart. Er enthält
2606 entweder <literal>accrual</literal> für die Soll-Versteuerung
2607 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
2612 <term><varname>inventory_system</varname></term>
2615 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
2616 enthält entweder <literal>perpetual</literal> für die
2617 Bestandsmethode oder <literal>periodic</literal> für die
2618 Aufwandsmethode.</para>
2623 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
2624 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
2625 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
2626 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
2627 Bestandsmethode.</para>
2629 <para>Die Konfiguration "<varname>eur</varname>" unter
2630 <varname>[system]</varname> in der <link
2631 linkend="config.config-file">Konfigurationsdatei</link>
2632 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
2633 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
2636 <sect2 id="config.eur.setting-parameters">
2637 <title>Festlegen der Parameter</title>
2639 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
2640 der Admininstration können diese Optionen nun unabhängig voneinander
2641 eingestellt werden.</para>
2643 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
2644 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
2647 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
2648 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
2649 angezeigt. Unter <guimenu>System</guimenu> ->
2650 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
2651 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
2652 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
2653 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
2654 auch <link linkend="config.eur.inventory-system-perpetual">
2655 Bemerkungen zur Bestandsmethode</link>).</para>
2658 <sect2 id="config.eur.inventory-system-perpetual">
2659 <title>Bemerkungen zur Bestandsmethode</title>
2661 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
2662 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
2663 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
2664 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
2665 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
2666 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
2667 Einkaufsrechnungen berechnet wird.</para>
2669 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
2670 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
2671 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
2675 <sect2 id="config.eur.knonw-issues">
2676 <title>Bekannte Probleme</title>
2678 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
2679 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
2680 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
2681 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
2682 die Konfigurationsvariable
2683 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
2686 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
2687 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
2691 <sect1 id="config.skr04-update-3804">
2692 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
2694 <sect2 id="config.skr04-update-3804.introduction">
2695 <title>Einführung</title>
2697 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
2698 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
2699 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
2700 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
2701 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
2702 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
2703 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
2704 vielleicht schon selbst geholfen hat und mit seinen Änderungen
2705 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
2706 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
2707 Screenshots dargestellt.</para>
2709 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
2710 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
2711 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
2712 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
2715 <sect2 id="config.skr04-update-3804.create-chart">
2716 <title>Konto 3804 manuell anlegen</title>
2718 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
2719 anzulegen und zu konfigurieren. Zuerst wird in
2720 <guimenu>System</guimenu> ->
2721 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
2722 erfassen</guimenuitem> das Konto angelegt.</para>
2725 <screeninfo>Konto 3804 erfassen</screeninfo>
2729 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
2734 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
2735 werden. Dazu unter <guimenu>System</guimenu> ->
2736 <guisubmenu>Steuern</guisubmenu> ->
2737 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
2738 13 auswählen und ihn wie im folgenden Screenshot angezeigt
2742 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
2746 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
2751 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
2752 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
2753 <guisubmenu>Steuern</guisubmenu> ->
2754 <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem
2755 Screenshot übernehmen.</para>
2758 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
2762 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
2767 <para>Als Nächstes sind alle Konten anzupassen, die als
2768 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
2769 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
2770 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
2771 müssen Sie dazu unter <guimenu>System</guimenu> ->
2772 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
2773 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
2774 wie im Screenshot gezeigt vornehmen.</para>
2777 <screeninfo>Konto 4315 anpassen</screeninfo>
2781 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
2786 <para>Als Letztes sollte die Steuerliste unter
2787 <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
2788 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
2789 Vergleich der Screenshot.</para>
2792 <screeninfo>Steuerliste vergleichen</screeninfo>
2796 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
2804 <title>Verhalten des Bilanzberichts</title>
2806 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
2807 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
2808 monatsweise führt dies zu falschen Werten.</para>
2810 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
2811 einstellen indem man:</para>
2815 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
2820 <para>immer den Jahresanfang nimmt (1.1. relativ zum
2825 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
2827 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
2830 <para>- oder mit "alle Buchungen" als Alternative"</para>
2834 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
2839 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
2843 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
2844 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
2845 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
2846 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
2847 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
2848 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
2849 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
2850 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
2851 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
2852 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
2853 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV.</para>
2856 <sect1 id="config.client">
2857 <title>Einstellungen pro Mandant</title>
2859 <para>Einige Einstellungen können von einem Benutzer mit dem <link
2860 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
2861 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
2862 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
2863 Die Einstellungen sind unter <guimenu>System</guimenu> ->
2864 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
2866 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
2867 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
2868 geändert werden (siehe auch <link
2869 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
2870 Bestandsmethode</link>).</para>
2872 <para>Die Einstellungen <literal>show_bestbefore</literal> und
2873 <literal>payments_changeable</literal> aus dem Abschnitt
2874 <literal>features</literal> und die Einstellungen im Abschnitt
2875 <literal>datev_check</literal> (sofern schon vorhanden) der <link
2876 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
2877 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
2878 Diese Einträge können danach aus der Konfigurationsdatei entfernt
2882 <sect1 id="kivitendo-ERP-verwenden">
2883 <title>kivitendo ERP verwenden</title>
2885 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
2886 folgender URL erreichbar:</para>
2889 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
2891 <para>Die Administrationsseite erreichen Sie unter:</para>
2894 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
2898 <chapter id="features" xreflabel="Features und Funktionen">
2899 <title>Features und Funktionen</title>
2901 <sect1 id="features.periodic-invoices"
2902 xreflabel="Wiederkehrende Rechnungen">
2903 <title>Wiederkehrende Rechnungen</title>
2905 <sect2 id="features.periodic-invoices.introduction"
2906 xreflabel="Einführung in wiederkehrende Rechnungen">
2907 <title>Einführung</title>
2909 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
2910 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
2911 Die konfigurierten Aufträge werden später automatisch in Rechnungen
2912 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
2913 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
2914 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
2915 wiederzufinden sind.</para>
2918 <sect2 id="features.periodic-invoices.configuration"
2919 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
2920 <title>Konfiguration</title>
2922 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
2923 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
2924 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
2925 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
2926 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
2929 <para>Folgende Parameter kann man konfigurieren:</para>
2936 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
2937 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
2938 eines neuen Monats).</para>
2940 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
2941 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
2942 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
2943 nächsten Periodenwechsel für alle Perioden, seit der letzten
2944 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
2945 verhindern, muss man vorher das Startdatum neu setzen.</para>
2947 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
2948 erstellt. Man kann sich diese Aufträge aber gesondert in den
2949 Berichten anzeigen lassen.</para>
2954 <term>Periodizität</term>
2957 <para>Ob monatlich, quartalsweise oder jährlich auf neue
2958 Rechnungen überprüft werden soll. Für jede Periode seit dem
2959 Startdatum wird überprüft, ob für die Periode (beginnend immer
2960 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
2961 wurde. Unter Umständen können bei einem Startdatum in der
2962 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
2967 <term>Buchen auf</term>
2970 <para>Das Forderungskonto, in der Regel "Forderungen aus
2971 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
2972 Buchungsgruppen der betreffenden Waren.</para>
2977 <term>Startdatum</term>
2980 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
2986 <term>Enddatum</term>
2989 <para>ab wann keine Rechnungen mehr erstellt werden
2995 <term>Automatische Verlängerung um x Monate</term>
2998 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
2999 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3000 hier die Anzahl der Monate eingeben, um die das Enddatum
3001 automatisch nach hinten geschoben wird.</para>
3006 <term>Drucken</term>
3009 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3010 Rechnungen auch gleich ausdrucken lassen.</para>
3015 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3016 Informationen zu den erstellten Rechnungen verschickt werden.
3017 Konfiguriert wird dies in der <link
3018 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3019 <filename>config/kivitendo.conf</filename> im Abschnitt
3020 <varname>[periodic_invoices]</varname>.</para>
3023 <sect2 id="features.periodic-invoices.variables">
3024 <title>Spezielle Variablen</title>
3026 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3027 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3028 formatierte Variablen durch für die jeweils aktuelle
3029 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3030 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3031 die Syntax <literal><%variablenname%></literal>.</para>
3033 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3034 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3035 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3036 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3037 Die zur verfügung stehenden Formatinformationen werden unten genauer
3040 <para>Diese Variablen können auch beim automatischen Versand der
3041 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3042 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3044 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3049 <para>Bemerkungen</para>
3053 <para>Interne Bemerkungen</para>
3057 <para>Vorgangsbezeichnung</para>
3061 <para>In den Beschreibungs- und Langtextfeldern aller
3066 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3070 <term><varname><%current_quarter%></varname>,
3071 <varname><%previous_quarter%></varname>,
3072 <varname><%next_quarter%></varname></term>
3075 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3076 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3081 <term><varname><%current_month%></varname>,
3082 <varname><%previous_month%></varname>,
3083 <varname><%next_month%></varname></term>
3086 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3087 <literal>1</literal> und <literal>12</literal>.</para>
3092 <term><varname><%current_month_long%></varname>,
3093 <varname><%previous_month_long%></varname>,
3094 <varname><%next_month_long%></varname></term>
3097 <para>Aktueller, vorheriger und nächster Monat als Name
3098 (<literal>Januar</literal>, <literal>Februar</literal>
3104 <term><varname><%current_year%></varname>,
3105 <varname><%previous_year%></varname>,
3106 <varname><%next_year%></varname></term>
3109 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3110 Jahreszahl (<literal>2013</literal> etc.).</para>
3115 <term><varname><%period_start_date%></varname>,
3116 <varname><%period_end_date%></varname></term>
3119 <para>Formatiertes Datum des ersten und letzten Tages im
3120 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3121 ersten Quartal von 2013 wären dies der
3122 <literal>01.01.2013</literal> und
3123 <literal>31.03.2013</literal>).</para>
3128 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3129 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3130 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3131 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3136 <term><varname>%a</varname></term>
3139 <para>Der abgekürzte Wochentagsname.</para>
3144 <term><varname>%A</varname></term>
3147 <para>Der ausgeschriebene Wochentagsname.</para>
3152 <term><varname>%b</varname></term>
3155 <para>Der abgekürzte Monatsname.</para>
3160 <term><varname>%B</varname></term>
3163 <para>Der ausgeschriebene Monatsname.</para>
3168 <term><varname>%C</varname></term>
3171 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3177 <term><varname>%d</varname></term>
3180 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3185 <term><varname>%D</varname></term>
3188 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3193 <term><varname>%e</varname></term>
3196 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3197 werden führende Nullen durch Leerzeichen ersetzt.</para>
3202 <term><varname>%F</varname></term>
3205 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3210 <term><varname>%j</varname></term>
3213 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3219 <term><varname>%m</varname></term>
3222 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3227 <term><varname>%u</varname></term>
3230 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3231 die 1 dem Montag entspricht.</para>
3236 <term><varname>%U</varname></term>
3239 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3240 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3246 <term><varname>%V</varname></term>
3249 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3250 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3251 vier Tage im Jahr liegen; Montag ist erster Tag der
3257 <term><varname>%w</varname></term>
3260 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3261 die 0 dem Sonntag entspricht.</para>
3266 <term><varname>%W</varname></term>
3269 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3270 wobei der erste Montag im Jahr das Startdatum von Woche 01
3276 <term><varname>%y</varname></term>
3279 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3285 <term><varname>%Y</varname></term>
3288 <para>Das Jahr als vierstellige Zahl.</para>
3293 <term><varname>%%</varname></term>
3296 <para>Das Prozentzeichen selber.</para>
3301 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3302 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3303 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3304 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3307 <sect2 id="features.periodic-invoices.reports">
3308 <title>Auflisten</title>
3310 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3311 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3312 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3313 wiederkehrenden Rechnungen verschaffen kann.</para>
3316 <sect2 id="features.periodic-invoices.task-server">
3317 <title>Erzeugung der eigentlichen Rechnungen</title>
3319 <para>Die zeitliche und periodische Überprüfung, ob eine
3320 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3321 durch den <link linkend="config.task-server">Taskserver</link>, einen
3322 externen Dienst, der automatisch beim Start des Servers gestartet
3323 werden sollte.</para>
3326 <sect2 id="features.periodic-invoices.create-for-current-month">
3327 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3329 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3330 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3331 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
3332 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3333 generiert hat. Alternativ setzt man das Startdatum auf den
3334 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3335 manuell über den Workflow.</para>
3339 <sect1 id="features.bank" xreflabel="bankerweiterung">
3340 <title>Bankerweiterung</title>
3342 <sect2 id="features.bank.introduction"
3343 xreflabel="Einführung in die Bankerweiterung">
3344 <title>Einführung</title>
3346 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3347 im Wiki und soll von dort später hierhin übernommen werden:</para>
3350 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3354 <sect1 id="dokumentenvorlagen-und-variablen">
3355 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3357 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3358 <title>Einführung</title>
3360 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3361 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3362 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3363 <function><%variablenname%></function> verwendet wird. Für
3364 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3366 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3368 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
3369 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
3370 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
3371 alle Vorlagenarten.</para>
3373 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3374 verfügbar als hier aufgelistet werden. Die meisten davon können
3375 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3376 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3377 diese wie folgt erhalten werden:</para>
3381 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3382 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3386 <para>In <filename>Form.pm</filename> die Funktion
3387 <function>parse_template</function> suchen und hier die Zeile
3388 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3392 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3393 ein PDF für eine Rechnung erzeugen.</para>
3397 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3398 der Variablen <varname>$self</varname> in der Form <varname>'key'
3399 => 'value',</varname>. Alle <varname>key</varname>s sind
3405 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3406 <title>Variablen ausgeben</title>
3408 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3409 Tags geschrieben werden, also z.B.
3410 <varname><%variablenname%></varname>.</para>
3412 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3413 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3414 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
3415 werden die folgenden Flags unterstützt:</para>
3419 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3420 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3421 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3422 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3426 <para><option>NOESCAPE</option> unterdrückt das Escapen von
3427 Sonderzeichen für die Vorlagensprache. Wenn also in einer
3428 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
3429 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
3430 ist dieses Flag sinnvoll.</para>
3434 <para>Beispiel:</para>
3436 <programlisting><%quototal NOFORMAT%></programlisting>
3439 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
3440 <title>Verwendung in Druckbefehlen</title>
3442 <para>In der Admininstration können Drucker definiert werden. Auch im
3443 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
3444 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
3445 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
3446 <function>`...`</function> nicht zu unerwünschtem Verhalten
3449 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
3450 für das die Telefonnummer eines Ansprechpartners als Teil der
3451 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
3452 z.B. wie folgt aussehen:</para>
3454 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
3457 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
3458 xreflabel="Anfang und Ende der Tags verändern">
3459 <title>Anfang und Ende der Tags verändern</title>
3461 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
3462 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
3463 Prozentzeichen und dem Größerzeichen endet, beispielsweise
3464 <function><%customer%></function>. Da diese Form aber z.B. in
3465 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
3466 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
3467 Stil umgestellt werden.</para>
3469 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
3470 Format gültigen Kommentarzeichen anfangen, dann
3471 <function>config:</function> enthalten, die entsprechende Option
3472 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
3473 enden. Beispiel für LaTeX:</para>
3475 <programlisting>% config: tag-style=($ $)</programlisting>
3477 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
3478 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
3479 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
3481 <programlisting><!-- config: tag-style=($ $) --></programlisting>
3484 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
3485 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
3487 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
3488 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
3489 "<filename>.ext</filename>" geeignet zu ersetzen:
3490 "<filename>.tex</filename>" für LaTeX-Vorlagen und
3491 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
3495 <term><filename>bin_list.ext</filename></term>
3498 <para>Lagerliste</para>
3503 <term><filename>check.ext</filename></term>
3511 <term><filename>invoice.ext</filename></term>
3514 <para>Rechnung</para>
3519 <term><filename>packing_list.ext</filename></term>
3522 <para>Packliste</para>
3527 <term><filename>pick_list.ext</filename></term>
3530 <para>Sammelliste</para>
3535 <term><filename>purchase_delivery_order.ext</filename></term>
3538 <para>Lieferschein (Einkauf)</para>
3543 <term><filename>purcharse_order.ext</filename></term>
3546 <para>Bestellung an Lieferanten</para>
3551 <term><filename>request_quotation.ext</filename></term>
3554 <para>Anfrage an Lieferanten</para>
3559 <term><filename>sales_delivery_order.ext</filename></term>
3562 <para>Lieferschein (Verkauf)</para>
3567 <term><filename>sales_order.ext</filename></term>
3570 <para>Bestellung</para>
3575 <term><filename>sales_quotation.ext</filename></term>
3578 <para>Angebot an Kunden</para>
3583 <term><filename>zahlungserinnerung.ext</filename></term>
3586 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
3591 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
3594 <para>Rechnung über Mahngebühren (Dateiname im Programm
3595 konfigurierbar)</para>
3601 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
3602 <title>Sprache, Drucker und E-Mail</title>
3604 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
3605 eingearbeitet. So wird aus der Vorlage
3606 <filename>sales_order.ext</filename> bei Sprache
3607 <function>de</function> und Druckerkürzel <function>lpr2</function>
3608 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
3609 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
3610 bekommen dann noch das Kürzel <filename>_email</filename>, der
3611 vollständige Vorlagenname wäre dann
3612 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
3613 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
3614 werden. Diese wird verwendet, wenn keine der anderen Varianten
3615 gefunden wird.</para>
3617 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
3618 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
3619 verschickt wird, ist:</para>
3623 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
3627 <para><filename>sales_order_de_lpr2.tex</filename></para>
3631 <para><filename>sales_order.tex</filename></para>
3635 <para><filename>default.tex</filename></para>
3639 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
3640 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
3642 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
3645 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
3646 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
3649 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
3650 xreflabel="Metainformationen zur angeforderten Vorlage">
3651 <title>Metainformationen zur angeforderten Vorlage</title>
3653 <para>Diese Variablen liefern Informationen darüber welche Variante
3654 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
3655 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
3656 Formulare einbinden möchten.</para>
3660 <term><varname>template_meta.formname</varname></term>
3663 <para>Basisname der Vorlage. Identisch mit der <link
3664 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
3665 zu den Dateinamen</link> ohne die Erweiterung. Ein
3666 Verkaufsauftrag enthält hier
3667 <constant>sales_order</constant>.</para>
3672 <term><varname>template_meta.language.description</varname></term>
3675 <para>Beschreibung der verwendeten Sprache</para>
3680 <term><varname>template_meta.language.template_code</varname></term>
3683 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
3684 dem Kürzel das im Dateinamen verwendetet wird.</para>
3689 <term><varname>template_meta.language.output_numberformat</varname></term>
3692 <para>Zahlenformat der verwendeten Sprache in der Form
3693 "<constant>1.000,00</constant>". Experimentell! Nur
3694 interessant für Vorlagen die mit unformatierten Werten
3700 <term><varname>template_meta.language.output_dateformat</varname></term>
3703 <para>Datumsformat der verwendeten Sprache in der Form
3704 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
3705 interessant für Vorlagen die mit unformatierten Werten
3711 <term><varname>template_meta.format</varname></term>
3714 <para>Das angeforderte Format. Kann im Moment die Werte
3715 <constant>pdf</constant>, <constant>postscript</constant>,
3716 <constant>html</constant>, <constant>opendocument</constant>,
3717 <constant>opendocument_pdf</constant> und
3718 <constant>excel</constant> enthalten.</para>
3723 <term><varname>template_meta.extension</varname></term>
3726 <para>Dateierweiterung, wie im Dateinamen. Wird aus
3727 <constant>format</constant> entschieden.</para>
3732 <term><varname>template_meta.media</varname></term>
3735 <para>Ausgabemedium. Kann zur Zeit die Werte
3736 <constant>screen</constant> für Bildschirm,
3737 <constant>email</constant> für E-Mail (triggert das
3738 <constant>_email</constant> Kürzel im Dateinamen),
3739 <constant>printer</constant> für Drucker, und
3740 <constant>queue</constant> für Warteschlange enthalten.</para>
3745 <term><varname>template_meta.printer.description</varname></term>
3748 <para>Beschreibung des ausgewählten Druckers</para>
3753 <term><varname>template_meta.printer.template_code</varname></term>
3756 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
3757 dem Kürzel das im Dateinamen verwendetet wird.</para>
3762 <term><varname>template_meta.tmpfile</varname></term>
3765 <para>Datei-Prefix für temporäre Dateien.</para>
3771 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
3772 <title>Stammdaten von Kunden und Lieferanten</title>
3776 <term><varname>account_number</varname></term>
3779 <para>Kontonummer</para>
3784 <term><varname>bank</varname></term>
3787 <para>Name der Bank</para>
3792 <term><varname>bank_code</varname></term>
3795 <para>Bankleitzahl</para>
3800 <term><varname>bic</varname></term>
3803 <para>Bank-Identifikations-Code (Bank Identifier Code,
3809 <term><varname>business</varname></term>
3812 <para>Kunden-/Lieferantentyp</para>
3817 <term><varname>city</varname></term>
3825 <term><varname>contact</varname></term>
3828 <para>Kontakt</para>
3833 <term><varname>country</varname></term>
3841 <term><varname>c_vendor_id</varname></term>
3844 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
3849 <term><varname>v_customer_id</varname></term>
3852 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
3857 <term><varname>cp_email</varname></term>
3860 <para>Email des Ansprechpartners</para>
3865 <term><varname>cp_givenname</varname></term>
3868 <para>Vorname des Ansprechpartners</para>
3873 <term><varname>cp_greeting</varname></term>
3876 <para>Anrede des Ansprechpartners</para>
3881 <term><varname>cp_name</varname></term>
3884 <para>Name des Ansprechpartners</para>
3889 <term><varname>cp_phone1</varname></term>
3892 <para>Telefonnummer 1 des Ansprechpartners</para>
3897 <term><varname>cp_phone2</varname></term>
3900 <para>Telefonnummer 2 des Ansprechpartners</para>
3905 <term><varname>cp_title</varname></term>
3908 <para>Titel des Ansprechpartners</para>
3913 <term><varname>creditlimit</varname></term>
3916 <para>Kreditlimit</para>
3921 <term><varname>customeremail</varname></term>
3924 <para>Email des Kunden; nur für Kunden</para>
3929 <term><varname>customerfax</varname></term>
3932 <para>Faxnummer des Kunden; nur für Kunden</para>
3937 <term><varname>customernotes</varname></term>
3940 <para>Bemerkungen beim Kunden; nur für Kunden</para>
3945 <term><varname>customernumber</varname></term>
3948 <para>Kundennummer; nur für Kunden</para>
3953 <term><varname>customerphone</varname></term>
3956 <para>Telefonnummer des Kunden; nur für Kunden</para>
3961 <term><varname>discount</varname></term>
3969 <term><varname>email</varname></term>
3972 <para>Emailadresse</para>
3977 <term><varname>fax</varname></term>
3980 <para>Faxnummer</para>
3985 <term><varname>gln</varname></term>
3988 <para>GLN (Globale Lokationsnummer)</para>
3993 <term><varname>greeting</varname></term>
4001 <term><varname>homepage</varname></term>
4004 <para>Homepage</para>
4009 <term><varname>iban</varname></term>
4012 <para>Internationale Kontonummer (International Bank Account
4013 Number, IBAN)</para>
4018 <term><varname>language</varname></term>
4021 <para>Sprache</para>
4026 <term><varname>name</varname></term>
4029 <para>Firmenname</para>
4034 <term><varname>payment_description</varname></term>
4037 <para>Name der Zahlart</para>
4042 <term><varname>payment_terms</varname></term>
4045 <para>Zahlungskonditionen</para>
4050 <term><varname>phone</varname></term>
4053 <para>Telefonnummer</para>
4058 <term><varname>shiptocity</varname></term>
4061 <para>Stadt (Lieferadresse) <link
4062 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4067 <term><varname>shiptocontact</varname></term>
4070 <para>Kontakt (Lieferadresse) <link
4071 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4076 <term><varname>shiptocountry</varname></term>
4079 <para>Land (Lieferadresse) <link
4080 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4085 <term><varname>shiptodepartment_1</varname></term>
4088 <para>Abteilung 1 (Lieferadresse) <link
4089 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4094 <term><varname>shiptodepartment_2</varname></term>
4097 <para>Abteilung 2 (Lieferadresse) <link
4098 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4103 <term><varname>shiptoemail</varname></term>
4106 <para>Email (Lieferadresse) <link
4107 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4112 <term><varname>shiptofax</varname></term>
4115 <para>Fax (Lieferadresse) <link
4116 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4121 <term><varname>shiptogln</varname></term>
4124 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4125 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4130 <term><varname>shiptoname</varname></term>
4133 <para>Firmenname (Lieferadresse) <link
4134 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4139 <term><varname>shiptophone</varname></term>
4142 <para>Telefonnummer (Lieferadresse) <link
4143 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4148 <term><varname>shiptostreet</varname></term>
4151 <para>Straße und Hausnummer (Lieferadresse) <link
4152 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4157 <term><varname>shiptozipcode</varname></term>
4160 <para>Postleitzahl (Lieferadresse) <link
4161 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4166 <term><varname>street</varname></term>
4169 <para>Straße und Hausnummer</para>
4174 <term><varname>taxnumber</varname></term>
4177 <para>Steuernummer</para>
4182 <term><varname>ustid</varname></term>
4185 <para>Umsatzsteuer-Identifikationsnummer</para>
4190 <term><varname>vendoremail</varname></term>
4193 <para>Email des Lieferanten; nur für Lieferanten</para>
4198 <term><varname>vendorfax</varname></term>
4201 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4206 <term><varname>vendornotes</varname></term>
4209 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4214 <term><varname>vendornumber</varname></term>
4217 <para>Lieferantennummer; nur für Lieferanten</para>
4222 <term><varname>vendorphone</varname></term>
4225 <para>Telefonnummer des Lieferanten; nur für
4231 <term><varname>zipcode</varname></term>
4234 <para>Postleitzahl</para>
4239 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4240 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4241 Stammdaten nicht eingetragen, so haben die Variablen
4242 <varname>shipto*</varname> den gleichen Wert wie die die
4243 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4244 einige <varname>shipto*</varname>-Variablen so nicht in den
4245 Stammdaten wiederfinden sondern schlicht Kopien der
4246 Lieferdatenvariablen sind (z.B.
4247 <varname>shiptocontact</varname>).</para>
4251 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4252 <title>Informationen über den Bearbeiter</title>
4256 <term><varname>employee_address</varname></term>
4259 <para>Adressfeld</para>
4264 <term><varname>employee_businessnumber</varname></term>
4267 <para>Firmennummer</para>
4272 <term><varname>employee_company</varname></term>
4275 <para>Firmenname</para>
4280 <term><varname>employee_co_ustid</varname></term>
4283 <para>Usatzsteuer-Identifikationsnummer</para>
4288 <term><varname>employee_duns</varname></term>
4291 <para>DUNS-Nummer</para>
4296 <term><varname>employee_email</varname></term>
4304 <term><varname>employee_fax</varname></term>
4312 <term><varname>employee_name</varname></term>
4315 <para>voller Name</para>
4320 <term><varname>employee_signature</varname></term>
4323 <para>Signatur</para>
4328 <term><varname>employee_taxnumber</varname></term>
4331 <para>Steuernummer</para>
4336 <term><varname>employee_tel</varname></term>
4339 <para>Telefonnummer</para>
4345 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4346 <title>Informationen über den Verkäufer</title>
4350 <term><varname>salesman_address</varname></term>
4353 <para>Adressfeld</para>
4358 <term><varname>salesman_businessnumber</varname></term>
4361 <para>Firmennummer</para>
4366 <term><varname>salesman_company</varname></term>
4369 <para>Firmenname</para>
4374 <term><varname>salesman_co_ustid</varname></term>
4377 <para>Usatzsteuer-Identifikationsnummer</para>
4382 <term><varname>salesman_duns</varname></term>
4385 <para>DUNS-Nummer</para>
4390 <term><varname>salesman_email</varname></term>
4398 <term><varname>salesman_fax</varname></term>
4406 <term><varname>salesman_name</varname></term>
4409 <para>voller Name</para>
4414 <term><varname>salesman_signature</varname></term>
4417 <para>Signatur</para>
4422 <term><varname>salesman_taxnumber</varname></term>
4425 <para>Steuernummer</para>
4430 <term><varname>salesman_tel</varname></term>
4433 <para>Telefonnummer</para>
4439 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
4440 <title>Variablen für die einzelnen Steuern</title>
4444 <term><varname>tax</varname></term>
4452 <term><varname>taxbase</varname></term>
4455 <para>zu versteuernder Betrag</para>
4460 <term><varname>taxdescription</varname></term>
4463 <para>Name der Steuer</para>
4468 <term><varname>taxrate</varname></term>
4471 <para>Steuersatz</para>
4477 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
4478 <title>Variablen für Lieferbedingungen</title>
4482 <term><varname>delivery_term</varname></term>
4485 <para>Datenbank-Objekt der Lieferbedingung</para>
4490 <term><varname>delivery_term.description</varname></term>
4493 <para>Beschreibung der Lieferbedingung</para>
4498 <term><varname>delivery_term.description_long</varname></term>
4501 <para>Langtext bzw. übersetzter Langtext der
4502 Lieferbedingung</para>
4509 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
4510 <title>Variablen in Rechnungen</title>
4512 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
4513 <title>Allgemeine Variablen</title>
4517 <term><varname>creditremaining</varname></term>
4520 <para>Verbleibender Kredit</para>
4525 <term><varname>currency</varname></term>
4528 <para>Währung</para>
4533 <term><varname>cusordnumber</varname></term>
4536 <para>Bestellnummer beim Kunden</para>
4541 <term><varname>deliverydate</varname></term>
4544 <para>Lieferdatum</para>
4549 <term><varname>duedate</varname></term>
4552 <para>Fälligkeitsdatum</para>
4557 <term><varname>globalprojectnumber</varname></term>
4560 <para>Projektnummer des ganzen Beleges</para>
4565 <term><varname>globalprojectdescription</varname></term>
4568 <para>Projekbeschreibung des ganzen Beleges</para>
4573 <term><varname>intnotes</varname></term>
4576 <para>Interne Bemerkungen</para>
4581 <term><varname>invdate</varname></term>
4584 <para>Rechnungsdatum</para>
4589 <term><varname>invnumber</varname></term>
4592 <para>Rechnungsnummer</para>
4597 <term><varname>invtotal</varname></term>
4600 <para>gesamter Rechnungsbetrag</para>
4605 <term><varname>notes</varname></term>
4608 <para>Bemerkungen der Rechnung</para>
4613 <term><varname>orddate</varname></term>
4616 <para>Auftragsdatum</para>
4621 <term><varname>ordnumber</varname></term>
4624 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
4625 erstellt wurde</para>
4630 <term><varname>payment_description</varname></term>
4633 <para>Name der Zahlart</para>
4638 <term><varname>payment_terms</varname></term>
4641 <para>Zahlungskonditionen</para>
4646 <term><varname>quodate</varname></term>
4649 <para>Angebotsdatum</para>
4654 <term><varname>quonumber</varname></term>
4657 <para>Angebotsnummer</para>
4662 <term><varname>shippingpoint</varname></term>
4665 <para>Versandort</para>
4670 <term><varname>shipvia</varname></term>
4673 <para>Transportmittel</para>
4678 <term><varname>subtotal</varname></term>
4681 <para>Zwischensumme aller Posten ohne Steuern</para>
4686 <term><varname>total</varname></term>
4689 <para>Restsumme der Rechnung (Summe abzüglich bereits
4690 bezahlter Posten)</para>
4695 <term><varname>transaction_description</varname></term>
4698 <para>Vorgangsbezeichnung</para>
4703 <term><varname>transdate</varname></term>
4706 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
4707 erstellt wurde</para>
4713 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
4714 <title>Variablen für jeden Posten auf der Rechnung</title>
4718 <term><varname>bin</varname></term>
4721 <para>Stellage</para>
4726 <term><varname>description</varname></term>
4729 <para>Artikelbeschreibung</para>
4734 <term><varname>cusordnumber_oe</varname></term>
4737 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
4738 Posten ursprünglich stammt (nur Verkauf)</para>
4743 <term><varname>discount</varname></term>
4746 <para>Rabatt als Betrag</para>
4751 <term><varname>discount_sub</varname></term>
4754 <para>Zwischensumme mit Rabatt</para>
4759 <term><varname>donumber_do</varname></term>
4762 <para>Lieferscheinnummer des Lieferscheins, aus dem die
4763 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
4764 Workflows aus einem Lieferschein erstellt wurde.</para>
4769 <term><varname>drawing</varname></term>
4772 <para>Zeichnung</para>
4777 <term><varname>ean</varname></term>
4780 <para>EAN-Code</para>
4785 <term><varname>image</varname></term>
4793 <term><varname>linetotal</varname></term>
4796 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
4801 <term><varname>longdescription</varname></term>
4804 <para>Langtext</para>
4809 <term><varname>microfiche</varname></term>
4812 <para>Mikrofilm</para>
4817 <term><varname>netprice</varname></term>
4820 <para>Alternative zu <varname>sellprice</varname>, aber
4821 <varname>netprice</varname> entspricht dem effektiven
4822 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
4823 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
4824 / Menge. Diese Variable ist nützlich, wenn man den gewährten
4825 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
4826 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
4827 <varname>netprice</varname> hat nichts mit Netto/Brutto im
4828 Sinne von Steuern zu tun.</para>
4833 <term><varname>nodiscount_linetotal</varname></term>
4836 <para>Zeilensumme ohne Rabatt</para>
4841 <term><varname>nodiscount_sub</varname></term>
4844 <para>Zwischensumme ohne Rabatt</para>
4849 <term><varname>number</varname></term>
4852 <para>Artikelnummer</para>
4857 <term><varname>ordnumber_oe</varname></term>
4860 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
4861 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
4862 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
4863 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
4864 letzterem Fall wird die unsprüngliche Auftragsnummer
4870 <term><varname>p_discount</varname></term>
4873 <para>Rabatt in Prozent</para>
4878 <term><varname>partnotes</varname></term>
4881 <para>Die beim Artikel gespeicherten Bemerkungen</para>
4886 <term><varname>partsgroup</varname></term>
4889 <para>Warengruppe</para>
4894 <term><varname>price_factor</varname></term>
4897 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
4903 <term><varname>price_factor_name</varname></term>
4906 <para>Der Name des Preisfaktors, sofern einer eingestellt
4912 <term><varname>projectnumber</varname></term>
4915 <para>Projektnummer</para>
4920 <term><varname>projectdescription</varname></term>
4923 <para>Projektbeschreibung</para>
4928 <term><varname>qty</varname></term>
4936 <term><varname>reqdate</varname></term>
4939 <para>Lieferdatum</para>
4944 <term><varname>runningnumber</varname></term>
4947 <para>Position auf der Rechnung (1, 2, 3...)</para>
4952 <term><varname>sellprice</varname></term>
4955 <para>Verkaufspreis</para>
4960 <term><varname>serialnumber</varname></term>
4963 <para>Seriennummer</para>
4968 <term><varname>tax_rate</varname></term>
4971 <para>Steuersatz</para>
4976 <term><varname>transdate_do</varname></term>
4979 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
4980 Workflows aus einem Lieferschein stammte.</para>
4985 <term><varname>transdate_oe</varname></term>
4988 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
4989 Workflows aus einem Auftrag erstellt wurde. Wenn es
4990 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
4996 <term><varname>transdate_quo</varname></term>
4999 <para>Datum des Angebots, wenn die Position im Rahmen des
5000 Workflows aus einem Angebot stammte.</para>
5005 <term><varname>unit</varname></term>
5008 <para>Einheit</para>
5013 <term><varname>weight</varname></term>
5016 <para>Gewicht</para>
5021 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5022 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5023 einer <function>foreach</function>-Schleife ausgegeben werden, da
5024 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5025 können. Die Variablen dafür lauten:</para>
5029 <term><varname>make</varname></term>
5032 <para>Lieferant</para>
5037 <term><varname>model</varname></term>
5040 <para>Lieferantenartikelnummer</para>
5046 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5047 <title>Variablen für die einzelnen Zahlungseingänge</title>
5051 <term><varname>payment</varname></term>
5059 <term><varname>paymentaccount</varname></term>
5067 <term><varname>paymentdate</varname></term>
5075 <term><varname>paymentmemo</varname></term>
5083 <term><varname>paymentsource</varname></term>
5092 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5093 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5095 <para>Die vom Benutzer definierten Variablen für Kunden und
5096 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5097 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5098 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5099 Variablennamen zusammen.</para>
5101 <para>Beispiel: Der Benutzer hat eine Variable namens
5102 <varname>number_of_employees</varname> definiert, die die Anzahl der
5103 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5104 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5107 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5108 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5109 Präfix <varname>shiptocvar_</varname>.</para>
5113 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5114 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5116 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5117 <title>Namen der Vorlagen</title>
5119 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5120 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5121 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5122 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5123 Vorlagenname für diese Mahnstufe mit dem Zusatz
5124 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5125 für die ausgewählte Sprache und den ausgewählten Drucker
5129 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5130 <title>Allgemeine Variablen in Mahnungen</title>
5132 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5133 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5134 Kunden stehen als Variablen <varname>name</varname>,
5135 <varname>street</varname>, <varname>zipcode</varname>,
5136 <varname>city</varname>, <varname>country</varname>,
5137 <varname>department_1</varname>, <varname>department_2</varname>,
5138 und <varname>email</varname> zur Verfügung.</para>
5140 <para>Weitere Variablen beinhalten:</para>
5144 <term><varname>dunning_date</varname></term>
5147 <para>Datum der Mahnung</para>
5152 <term><varname>dunning_duedate</varname></term>
5155 <para>Fälligkeitsdatum für diese Mahhnung</para>
5160 <term><varname>dunning_id</varname></term>
5163 <para>Mahnungsnummer</para>
5168 <term><varname>fee</varname></term>
5171 <para>Kumulative Mahngebühren</para>
5176 <term><varname>interest_rate</varname></term>
5179 <para>Zinssatz per anno in Prozent</para>
5184 <term><varname>total_amount</varname></term>
5187 <para>Gesamter noch zu zahlender Betrag als
5188 <function>fee</function> + <function>total_interest</function>
5189 + <function>total_open_amount</function></para>
5194 <term><varname>total_interest</varname></term>
5197 <para>Zinsen per anno über alle Rechnungen</para>
5202 <term><varname>total_open_amount</varname></term>
5205 <para>Summe über alle offene Beträge der Rechnungen</para>
5211 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5212 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5216 <term><varname>dn_amount</varname></term>
5219 <para>Rechnungssumme (brutto)</para>
5224 <term><varname>dn_duedate</varname></term>
5227 <para>Originales Fälligkeitsdatum der Rechnung</para>
5232 <term><varname>dn_dunning_date</varname></term>
5235 <para>Datum der Mahnung</para>
5240 <term><varname>dn_dunning_duedate</varname></term>
5243 <para>Fälligkeitsdatum der Mahnung</para>
5248 <term><varname>dn_fee</varname></term>
5251 <para>Kummulative Mahngebühr</para>
5256 <term><varname>dn_interest</varname></term>
5259 <para>Zinsen per anno für diese Rechnung</para>
5264 <term><varname>dn_invnumber</varname></term>
5267 <para>Rechnungsnummer</para>
5272 <term><varname>dn_linetotal</varname></term>
5275 <para>Noch zu zahlender Betrag (ergibt sich aus
5276 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5277 + <varname>dn_interest</varname>)</para>
5282 <term><varname>dn_netamount</varname></term>
5285 <para>Rechnungssumme (netto)</para>
5290 <term><varname>dn_open_amount</varname></term>
5293 <para>Offener Rechnungsbetrag</para>
5298 <term><varname>dn_ordnumber</varname></term>
5301 <para>Bestellnummer</para>
5306 <term><varname>dn_transdate</varname></term>
5309 <para>Rechnungsdatum</para>
5314 <term><varname>dn_curr</varname></term>
5317 <para>Währung, in der die Rechnung erstellt wurde. (Die
5318 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5324 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5325 <title>Variablen in automatisch erzeugten Rechnungen über
5326 Mahngebühren</title>
5328 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5329 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5330 Kunden stehen als Variablen <varname>name</varname>,
5331 <varname>street</varname>, <varname>zipcode</varname>,
5332 <varname>city</varname>, <varname>country</varname>,
5333 <varname>department_1</varname>, <varname>department_2</varname>,
5334 und <varname>email</varname> zur Verfügung.</para>
5336 <para>Weitere Variablen beinhalten:</para>
5340 <term><varname>duedate</varname></term>
5343 <para>Fälligkeitsdatum der Rechnung</para>
5348 <term><varname>dunning_id</varname></term>
5351 <para>Mahnungsnummer</para>
5356 <term><varname>fee</varname></term>
5359 <para>Mahngebühren</para>
5364 <term><varname>interest</varname></term>
5372 <term><varname>invamount</varname></term>
5375 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
5376 <varname>interest</varname>)</para>
5381 <term><varname>invdate</varname></term>
5384 <para>Rechnungsdatum</para>
5389 <term><varname>invnumber</varname></term>
5392 <para>Rechnungsnummer</para>
5399 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
5400 <title>Variablen in anderen Vorlagen</title>
5403 <title>Einführung</title>
5405 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
5406 Rechnung. Allerdings heißen die Variablen, die mit
5407 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
5408 fangen sie mit <varname>quo</varname> für "quotation" an:
5409 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
5410 wiederum fangen sie mit <varname>ord</varname> für "order" an:
5411 <varname>ordnumber</varname> für Bestellnummer etc.</para>
5413 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
5414 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
5415 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
5416 Vorlage keine Bedeutung haben oder noch nicht belegt sein
5419 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
5420 in Rechnungen aufgeführt.</para>
5423 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
5424 <title>Angebote und Preisanfragen</title>
5428 <term><varname>quonumber</varname></term>
5431 <para>Angebots- bzw. Anfragenummer</para>
5436 <term><varname>reqdate</varname></term>
5439 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
5440 Preisanfragen)</para>
5445 <term><varname>transdate</varname></term>
5448 <para>Angebots- bzw. Anfragedatum</para>
5454 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
5455 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
5459 <term><varname>ordnumber</varname></term>
5462 <para>Auftragsnummer</para>
5467 <term><varname>reqdate</varname></term>
5470 <para>Lieferdatum</para>
5475 <term><varname>transdate</varname></term>
5478 <para>Auftragsdatum</para>
5484 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
5485 <title>Lieferscheine (Verkauf und Einkauf)</title>
5489 <term><varname>cusordnumber</varname></term>
5492 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
5493 des Lieferanten (im Einkauf)</para>
5498 <term><varname>donumber</varname></term>
5501 <para>Lieferscheinnummer</para>
5506 <term><varname>transdate</varname></term>
5509 <para>Lieferscheindatum</para>
5514 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
5515 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
5516 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
5517 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
5518 <function>foreach</function>-Schleife ausgegeben werden. Diese
5519 Variablen sind:</para>
5523 <term><varname>si_bin</varname></term>
5526 <para>Lagerplatz</para>
5531 <term><varname>si_chargenumber</varname></term>
5534 <para>Chargennummer</para>
5539 <term><varname>si_bestbefore</varname></term>
5542 <para>Mindesthaltbarkeit</para>
5547 <term><varname>si_number</varname></term>
5550 <para>Artikelnummer</para>
5555 <term><varname>si_qty</varname></term>
5558 <para>Anzahl bzw. Menge</para>
5563 <term><varname>si_runningnumber</varname></term>
5566 <para>Positionsnummer (1, 2, 3 etc)</para>
5571 <term><varname>si_unit</varname></term>
5574 <para>Einheit</para>
5579 <term><varname>si_warehouse</varname></term>
5588 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
5589 <title>Variablen für Sammelrechnung</title>
5593 <term><varname>c0total</varname></term>
5596 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
5602 <term><varname>c30total</varname></term>
5605 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
5606 und < 60 Tage</para>
5611 <term><varname>c60total</varname></term>
5614 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
5615 und < 90 Tage</para>
5620 <term><varname>c90total</varname></term>
5623 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
5629 <term><varname>total</varname></term>
5632 <para>Gesamtbetrag aller Rechnungen</para>
5637 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
5641 <term><varname>invnumber</varname></term>
5644 <para>Rechnungsnummer</para>
5649 <term><varname>invdate</varname></term>
5652 <para>Rechnungsdatum</para>
5657 <term><varname>duedate</varname></term>
5660 <para>Fälligkeitsdatum</para>
5665 <term><varname>amount</varname></term>
5668 <para>Summe der Rechnung</para>
5673 <term><varname>open</varname></term>
5676 <para>Noch offener Betrag der Rechnung</para>
5681 <term><varname>c0</varname></term>
5684 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
5690 <term><varname>c30</varname></term>
5693 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
5699 <term><varname>c60</varname></term>
5702 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
5708 <term><varname>c90</varname></term>
5711 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
5719 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
5720 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
5722 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
5723 <title>Einführung</title>
5725 <para>Der Parser kennt neben den Variablen einige weitere
5726 Konstrukte, die gesondert behandelt werden. Diese sind wie
5727 Variablennamen in spezieller Weise markiert:
5728 <command><%anweisung%> ... <%end%></command></para>
5730 <para>Anmerkung zum <command><%end%></command>: Der besseren
5731 Verständlichkeit halber kann man nach dem <command>end</command>
5732 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
5733 Anweisung (z.B. <command>if</command> oder
5734 <command>foreach</command>) damit abgeschlossen wird.</para>
5736 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
5737 <command><%if type == "sales_quotation"%></command>, so könnte
5738 er mit <command><%end%></command> genauso abgeschlossen werden
5739 wie mit <command><%end if%></command> oder auch
5740 <command><%end type == "sales_quotation"%></command>.</para>
5743 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
5744 <title>Der if-Block</title>
5746 <programlisting><%if variablenname%>
5748 <%end%></programlisting>
5750 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
5751 und dem "end" werden nur ausgegeben, wenn die Variable
5752 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
5754 <para>Handelt es sich bei der benannten Variable um ein Array, also
5755 um einen Variablennamen, über den man mit <command><%foreach
5756 variablenname%></command> iteriert, so wird mit diesem Konstrukt
5757 darauf getestet, ob das Array Elemente enthält. Somit würde im
5758 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
5759 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
5760 welche getätigt wurden:</para>
5762 <programlisting><%if payment%>
5764 <%foreach payment%>
5765 Am <%paymentdate%>: <%payment%> €
5766 <%end foreach%>
5767 <%end if%></programlisting>
5769 <para>Die Bedingung kann auch negiert werden, indem das Wort
5770 <function>not</function> nach dem <filename>if</filename> verwendet
5771 wird. Beispiel:</para>
5773 <programlisting><%if not cp_greeting%>
5775 <%end%></programlisting>
5777 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
5778 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
5779 einer Variablen mit einer festen Zeichenkette oder einer anderen
5780 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
5781 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
5782 die rechte Seite des Vergleichsoperators in Anführungszeichen
5783 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
5784 anderer Variablen). Zwei Beispiele, die beide Vergleiche
5787 <programlisting><%if var1 == "Wert"%></programlisting>
5789 <para>Testet die Variable <varname>var1</varname> auf
5790 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
5791 Mittels <function>!=</function> anstelle von <function>==</function>
5792 würde auf Ungleichheit getestet.</para>
5794 <programlisting><%if var1 == var2%></programlisting>
5796 <para>Testet die Variable <varname>var1</varname> auf
5797 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
5798 <function>!=</function> anstelle von <function>==</function> würde
5799 auf Ungleichheit getestet.</para>
5801 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
5802 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
5803 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
5804 dieselbe Syntax wie oben nur mit <function>=~</function> und
5805 <function>!~</function> als Vergleichsoperatoren.</para>
5807 <para>Beispiel für einen Test, ob die Variable
5808 <varname>intnotes</varname> (interne Bemerkungen) das Wort
5809 <constant>schwierig</constant> enthält:</para>
5811 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
5814 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
5815 <title>Der foreach-Block</title>
5817 <programlisting><%foreach variablenname%>
5819 <%end%></programlisting>
5821 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
5822 wie das Perl-Array der Variablen <varname>variablenname</varname>
5823 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
5824 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
5825 benutzt. In jedem Durchlauf werden die <link
5826 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
5827 Variablen</link> jeweils auf den Wert für die aktuelle Position
5830 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
5832 <programlisting><%foreach number%>
5833 Position: <%runningnumber%>
5834 Anzahl: <%qty%>
5835 Artikelnummer: <%number%>
5836 Beschreibung: <%description%>
5838 <%end%></programlisting>
5840 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
5841 <function><%foreach%></function>-Block innerhalb einer
5842 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
5843 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
5844 Inhalt zwischen <function><%foreach%></function> und
5845 <function><%end%></function> wiederholt, nicht aber die
5846 komplette Zeile, in der er steht.</para>
5850 <sect2 id="dokumentenvorlagen-und-variablen.markup">
5851 <title>Markup-Code zur Textformatierung innerhalb von
5854 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
5855 anders formatiert haben möchte, so ist dies begrenzt möglich.
5856 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
5857 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
5858 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
5859 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
5860 (HTML oder PDF über LaTeX) umgesetzt.</para>
5862 <para>Die unterstützen Formatierungen sind:</para>
5866 <term><b>Text</b></term>
5869 <para>Text wird in Fettdruck gesetzt.</para>
5874 <term><i>Text</i></term>
5877 <para>Text wird kursiv gesetzt.</para>
5882 <term><u>Text</u></term>
5885 <para>Text wird unterstrichen.</para>
5890 <term><s>Text</s></term>
5893 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
5894 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
5899 <term><bullet></term>
5902 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
5908 <para>Der Befehl <command><bullet></command> funktioniert
5909 momentan auch nur in Latex-Vorlagen.</para>
5913 <sect1 id="excel-templates">
5914 <title>Excel-Vorlagen</title>
5916 <sect2 id="excel-templates.summary">
5917 <title>Zusammenfassung</title>
5919 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
5920 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
5924 <sect2 id="excel-templates.usage">
5925 <title>Bedienung</title>
5927 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
5928 werden. Die Konfigurationsoption heißt <varname>excel_templates =
5929 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
5931 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
5932 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
5933 werden. In den normalen Verkaufsmasken taucht nun
5934 <constant>Excel</constant> als auswählbares Format auf und kann von da
5935 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
5937 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
5938 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
5939 <filename>sales_quotation.xls</filename> gespeichert.</para>
5942 <sect2 id="excel-templates.syntax">
5943 <title>Variablensyntax</title>
5945 <para>Einfache Syntax:
5946 <command><<varname>></command></para>
5948 <para>Dabei sind <constant><<</constant> und
5949 <constant>>></constant> die Delimiter. Da Excel auf festen
5950 Breiten besteht, kann der Tag künstlich verlängert werden, indem
5951 weitere <constant><</constant> oder <constant>></constant>
5952 eingefügt werden. Der Tag muss nicht symmetrisch sein.
5955 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
5957 <para>Um die Limitierung der festen Breite zu reduzieren, können
5958 weitere Variablen in einem Block interpoliert werden. Whitespace wird
5959 dazwishen dann erhalten. Beispiel:</para>
5961 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
5963 <para>Die Variablen werden interpoliert, und linksbündig mit
5964 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
5965 lang, werden überzählige Zeichen abgeschnitten.</para>
5967 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
5968 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
5970 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
5972 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
5973 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
5977 <sect2 id="excel-templates.limitations">
5978 <title>Einschränkungen</title>
5980 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
5981 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
5982 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
5983 Text zu ersetzen.</para>
5985 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
5986 <command><%if%></command> und
5987 <command><%foreach%></command> nicht vorhanden. Der Delimiter
5988 <constant><% %></constant> kommt in den Headerinformationen
5989 evtl. vor. Deshalb wurde auf den sichereren Delimiter
5990 <constant><<</constant> und <constant>>></constant>
5995 <sect1 id="features.warehouse">
5998 <title>Mandantenkonfiguration Lager</title>
6000 Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. Ferner kann jede Position eines Lieferscheins ein-, bzw. ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele Lager mit beliebig vielen Lagerplätzen abgebildet werden. Die Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder Einzelposition und das Auswählen dieser Position zu einem Lager mit Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je nachdem wie die Einstellungen in der Mandatenkonfiguration gesetzt werden.
6004 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6005 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6006 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6007 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6011 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6012 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6013 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6014 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6015 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6016 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6020 Zusätzliche Funktionshinweise:
6024 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6025 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6026 Stammdaten-> Waren / Dienstleistung / Erzeugnis verwendet.</para>
6030 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6031 Stammdaten definiert</option> Wird beim 'Auslagern über
6032 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6033 so wird mit dieser Option einfach der Standardlagerplatz
6043 <title>Entwicklerdokumentation</title>
6045 <sect1 id="devel.globals" xreflabel="Globale Variablen">
6046 <title>Globale Variablen</title>
6049 <title>Wie sehen globale Variablen in Perl aus?</title>
6051 <para>Globale Variablen liegen in einem speziellen namespace namens
6052 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
6053 globs global und die meisten speziellen Variablen sind...
6056 <para>Daraus ergeben sich folgende Formen:</para>
6060 <term><literal>$main::form</literal></term>
6063 <para>expliziter Namespace "main"</para>
6068 <term><literal>$::form</literal></term>
6071 <para>impliziter Namespace "main"</para>
6076 <term><literal>open FILE, "file.txt"</literal></term>
6079 <para><varname>FILE</varname> ist global</para>
6084 <term><literal>$_</literal></term>
6087 <para>speziell</para>
6092 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
6093 Schlüsselwort wie "<function>global</function>", mit dem man
6094 importieren kann. <function>my</function>, <function>our</function>
6095 und <function>local</function> machen was anderes.</para>
6099 <term><literal>my $form</literal></term>
6102 <para>lexikalische Variable, gültig bis zum Ende des
6108 <term><literal>our $form</literal></term>
6111 <para><varname>$form</varname> referenziert ab hier
6112 <varname>$PACKAGE::form</varname>.</para>
6117 <term><literal>local $form</literal></term>
6120 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
6121 des scopes zurückgesetzt</para>
6128 <title>Warum sind globale Variablen ein Problem?</title>
6130 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
6132 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
6133 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
6134 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
6135 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
6136 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
6137 Datenbankverbindungen, weil die sehr lange zum Initialisieren
6140 <para>Das zweite Problem ist <function>strict</function>. Unter
6141 <function>strict</function> werden alle Variablen die nicht explizit
6142 mit <function>Package</function>, <function>my</function> oder
6143 <function>our</function> angegeben werden als Tippfehler angemarkert,
6144 dies hat, seit der Einführung, u.a. schon so manche langwierige
6145 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
6146 angegeben werden, werden die nicht geprüft, und somit kann sich
6147 schnell ein Tippfehler einschleichen.</para>
6151 <title>Kanonische globale Variablen</title>
6153 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
6154 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
6155 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
6156 umhergereicht werden.</para>
6158 <para>Diese Variablen sind im Moment die folgenden neun:</para>
6162 <para><varname>$::form</varname></para>
6166 <para><varname>%::myconfig</varname></para>
6170 <para><varname>$::locale</varname></para>
6174 <para><varname>$::lxdebug</varname></para>
6178 <para><varname>$::auth</varname></para>
6182 <para><varname>$::lx_office_conf</varname></para>
6186 <para><varname>$::instance_conf</varname></para>
6190 <para><varname>$::dispatcher</varname></para>
6194 <para><varname>$::request</varname></para>
6198 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
6199 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
6200 Eigenschaften (Konventionen):</para>
6203 <title>$::form</title>
6207 <para>Ist ein Objekt der Klasse
6208 "<classname>Form</classname>"</para>
6212 <para>Wird nach jedem Request gelöscht</para>
6216 <para>Muss auch in Tests und Konsolenscripts vorhanden
6221 <para>Enthält am Anfang eines Requests die Requestparameter vom
6226 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
6227 cachen, das wird aber momentan absichtlich zerstört</para>
6231 <para><varname>$::form</varname> wurde unter <productname>SQL
6232 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
6233 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
6234 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
6235 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
6236 <function>IS->retrieve_customer()</function> in Sicherheit
6239 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
6240 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
6241 3552, Stand version 2.7beta), um dies hinterher wieder auf den
6242 richtigen Wert zu setzen:</para>
6244 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
6245 $::myconfig{numberformat} = $numberformat;
6246 # (...) div Berechnungen
6247 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
6249 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
6250 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
6251 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
6252 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
6253 Es geht ziemlich sicher etwas kaputt.</para>
6255 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
6256 in den <productname>Template::Toolkit</productname> Templates
6257 außerhalb der Controller: der Ausdruck <function>[% var
6258 %]</function> greift auf <varname>$::form->{var}</varname> zu.
6259 Unter Controllern ist der Standard Scope anders, da lautet der
6260 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
6261 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
6262 <function><%var%></function> zeigt auf
6263 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
6264 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
6267 <programlisting>[%- IF business %]
6268 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
6269 [%- END %]</programlisting>
6271 <para>Entweder wird hier dann $::form->{business} ausgewertet
6272 oder aber der Funktion
6273 <function>$form->parse_html_template</function> wird explizit
6274 noch ein zusätzlicher Hash übergeben, der dann auch in den
6275 (Web-)Templates zu Verfügung steht, bspw. so:</para>
6277 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
6279 <para>Innerhalb von Schleifen wird
6280 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
6281 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
6282 welches über alle Positionen eines Lieferscheins in Schleife
6285 <programlisting>for $i (1 .. $form->{rowcount}) {
6287 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
6288 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
6289 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
6295 <title>%::myconfig</title>
6299 <para>Das einzige Hash unter den globalen Variablen</para>
6303 <para>Wird spätestens benötigt wenn auf die Datenbank
6304 zugegriffen wird</para>
6308 <para>Wird bei jedem Request neu erstellt.</para>
6312 <para>Enthält die Userdaten des aktuellen Logins</para>
6316 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
6317 extern serialisiert werden, weil da auch der Datenbankzugriff
6318 für diesen user drinsteht.</para>
6322 <para>Enthält unter anderem Listenbegrenzung vclimit,
6323 Datumsformat dateformat und Nummernformat numberformat</para>
6327 <para>Enthält Datenbankzugriffinformationen</para>
6331 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
6332 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
6333 aktuellen Users entscheiden müssen, befragen
6334 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
6335 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
6336 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
6337 Informationen über den Benutzer die über die
6338 Administrator-Schnittstelle eingegeben wurden.</para>
6342 <title>$::locale</title>
6346 <para>Objekt der Klasse "Locale"</para>
6350 <para>Wird pro Request erstellt</para>
6354 <para>Muss auch für Tests und Scripte immer verfügbar
6359 <para>Cached intern über Requestgrenzen hinweg benutzte
6364 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
6365 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
6369 <title>$::lxdebug</title>
6373 <para>Objekt der Klasse "LXDebug"</para>
6377 <para>Wird global gecached</para>
6381 <para>Muss immer verfügbar sein, in nahezu allen
6386 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
6387 bereit, wie "<function>enter_sub</function>" und
6388 "<function>leave_sub</function>", mit denen in den alten Modulen ein
6389 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
6390 der man die Wallclockzeit seit Requeststart loggen kann, sowie
6391 "<function>message</function>" und "<function>dump</function>" mit
6392 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
6395 <para>Beispielsweise so:</para>
6397 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
6398 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
6402 <title>$::auth</title>
6406 <para>Objekt der Klasse "SL::Auth"</para>
6410 <para>Wird global gecached</para>
6414 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
6418 <para>Wird nach jedem Request resettet.</para>
6422 <para><varname>$::auth</varname> stellt Funktionen bereit um die
6423 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
6424 vom aktuellen User abhängen wird das Objekt aus
6425 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
6426 Request kurz resettet.</para>
6428 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
6429 Dessen Einstellungen können über
6430 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
6431 ist ein Hash mit den Werten aus der Tabelle
6432 <literal>auth.clients</literal>.</para>
6436 <title>$::lx_office_conf</title>
6440 <para>Objekt der Klasse
6441 "<classname>SL::LxOfficeConf</classname>"</para>
6445 <para>Global gecached</para>
6449 <para>Repräsentation der
6450 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
6454 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
6455 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
6456 das Programm die Konfiguration ändern kann oder sollte.</para>
6458 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
6459 Debug- und Trace-Log-Datei wie folgt konfiguriert und
6462 <programlisting>[debug]
6463 file_name = /tmp/kivitendo-debug.log</programlisting>
6465 <para>ist der Key <varname>file</varname> im Programm als
6466 <varname>$::lx_office_conf->{debug}{file}</varname>
6470 <para>Zugriff auf die Konfiguration erfolgt im Moment über
6471 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
6476 <title>$::instance_conf</title>
6480 <para>Objekt der Klasse
6481 "<classname>SL::InstanceConfiguration</classname>"</para>
6485 <para>wird pro Request neu erstellt</para>
6489 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
6490 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
6491 ist hier eine Mandantendatenbank. Beispielsweise überprüft
6492 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
6493 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
6497 <title>$::dispatcher</title>
6501 <para>Objekt der Klasse
6502 "<varname>SL::Dispatcher</varname>"</para>
6506 <para>wird pro Serverprozess erstellt.</para>
6510 <para>enthält Informationen über die technische Verbindung zum
6515 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
6516 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
6517 Objekt untergebracht.</para>
6521 <title>$::request</title>
6525 <para>Hashref (evtl später Objekt)</para>
6529 <para>Wird pro Request neu initialisiert.</para>
6533 <para>Keine Unterstruktur garantiert.</para>
6537 <para><varname>$::request</varname> ist ein generischer Platz um
6538 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
6539 at a distance benutzt werden, sondern um lokales memoizing zu
6540 ermöglichen, das garantiert am Ende des Requests zerstört
6543 <para>Vieles von dem, was im moment in <varname>$::form</varname>
6544 liegt, sollte eigentlich hier liegen. Die groben
6545 Differentialkriterien sind:</para>
6549 <para>Kommt es vom User, und soll unverändert wieder an den
6550 User? Dann <varname>$::form</varname>, steht da eh schon</para>
6554 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
6555 Requests gebraucht werden? Dann
6556 <varname>$::request</varname></para>
6560 <para>Muss ich von anderen Teilen des Programms lesend drauf
6561 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
6562 Wrappermethode</para>
6569 <title>Ehemalige globale Variablen</title>
6571 <para>Die folgenden Variablen waren einmal im Programm, und wurden
6575 <title>$::cgi</title>
6579 <para>war nötig, weil cookie Methoden nicht als
6580 Klassenfunktionen funktionieren</para>
6584 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
6585 Klassennamespace gehalten wird und über Requestgrenzen
6590 <para>liegt jetzt unter
6591 <varname>$::request->{cgi}</varname></para>
6597 <title>$::all_units</title>
6601 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
6602 ein paar hundert mal pro Request eine Liste der Einheiten
6603 brauchen, und de als Parameter durch einen Riesenstack von
6604 Funktionen geschleift werden müssten.</para>
6608 <para>Liegt jetzt unter
6609 <varname>$::request->{cache}{all_units}</varname></para>
6614 <function>AM->retrieve_all_units()</function> gesetzt oder
6621 <title>%::called_subs</title>
6625 <para>wurde benutzt um callsub deep recursions
6630 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
6631 möglichen Rekursioenen darstellt, und da nie welche
6636 <para>komplette recursion protection wurde entfernt.</para>
6643 <sect1 id="devel.fcgi">
6644 <title>Entwicklung unter FastCGI</title>
6646 <sect2 id="devel.fcgi.general">
6647 <title>Allgemeines</title>
6649 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
6650 werden, muss der Webserver neu gestartet werden.</para>
6652 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
6653 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
6654 müssen folgende Aspekte beachtet werden.</para>
6657 <sect2 id="devel.fcgi.exiting">
6658 <title>Programmende und Ausnahmen</title>
6660 <para>Betrifft die Funktionen <function>warn</function>,
6661 <function>die</function>, <function>exit</function>,
6662 <function>carp</function> und <function>confess</function>.</para>
6664 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
6665 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
6666 am Laufen zu halten. Man kann mit <function>die</function>,
6667 <function>confess</function> oder <function>carp</function> Fehler
6668 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
6669 eigene <function>$::form-</function>error()> tut im Prinzip das
6670 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
6671 <function>exit</function> hingegen werden nicht abgefangen.
6672 <function>warn</function> wird direkt nach STDERR, also in Server Log
6673 eine Nachricht schreiben (sofern in der Konfiguration nicht die
6674 Warnungen in das kivitendo Log umgeleitet wurden), und
6675 <function>exit</function> wird die Ausführung beenden.</para>
6677 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
6678 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
6679 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
6680 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
6683 <sect2 id="devel.fcgi.globals">
6684 <title>Globale Variablen</title>
6686 <para>Um zu vermeiden, dass Informationen von einem Request in einen
6687 anderen gelangen, müssen alle globalen Variablen vor einem Request
6688 sauber initialisiert werden. Das ist besonders wichtig im
6689 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
6690 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
6693 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
6694 abgetrennten Block, der alle kanonischen globalen Variablen listet und
6695 erklärt. Bitte keine anderen einführen ohne das sauber zu
6696 dokumentieren.</para>
6698 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
6699 man sicher geht, dass man die richtige erwischt.</para>
6702 <sect2 id="devel.fcgi.performance">
6703 <title>Performance und Statistiken</title>
6705 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
6706 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
6707 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
6708 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
6709 sind es je nach Menge der definierten Variablen 1-2s. Ab der
6710 Moose/Rose::DB Version sind es 5-6s.</para>
6712 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
6713 den kritischen Pfaden, unter 0,15 sonst.</para>
6717 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
6718 <title>SQL-Upgradedateien</title>
6720 <sect2 id="db-upgrade-files.introduction"
6721 xreflabel="Einführung in die Datenbank-Upgradedateien">
6722 <title>Einführung</title>
6724 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
6725 gesteuert, die sich im Verzeichnis
6726 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
6727 muss pro Datenbankupgrade eine Datei existieren, die neben den
6728 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
6729 Kontrollinformationen enthält.</para>
6731 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
6732 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
6733 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
6734 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
6735 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
6736 Versionsnummern braucht.</para>
6738 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
6739 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
6740 führt diese nicht erneut aus. Dazu dient die Tabelle
6741 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
6742 angelegt wird.</para>
6745 <sect2 id="db-upgrade-files.format"
6746 xreflabel="Format der Upgradedateien">
6747 <title>Format der Kontrollinformationen</title>
6749 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
6750 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
6751 hat dabei das folgende Format:</para>
6753 <para>Für SQL-Upgradedateien:</para>
6755 <programlisting>-- @key: value</programlisting>
6757 <para>Für Perl-Upgradedateien:</para>
6759 <programlisting># @key: value</programlisting>
6761 <para>Leerzeichen vor "<varname>value</varname>" werden
6764 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
6768 <term><varname>tag</varname></term>
6771 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
6772 Dieser "tag" kann von anderen Kontrolldateien in ihren
6773 Abhängigkeiten verwendet werden (Schlüsselwort
6774 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
6775 in der Datenbank eingetragen wird.</para>
6777 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
6778 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
6780 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
6781 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
6782 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
6788 <term><varname>charset</varname></term>
6791 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
6792 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
6793 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
6794 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
6795 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
6796 hingegen müssen immer in UTF-8 encodiert sein und sollten
6797 demnach auch ein "<literal>use utf8;</literal>"
6803 <term><varname>description</varname></term>
6806 <para>Benötigt. Eine Beschreibung, was in diesem Update
6807 passiert. Diese wird dem Benutzer beim eigentlichen
6808 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
6809 sein sollte, sollte die Beschreibung auf Deutsch
6815 <term><varname>depends</varname></term>
6818 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
6819 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
6820 dass die in dieser Liste aufgeführten Scripte bereits
6821 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
6823 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
6824 Script "b" existiert, das von Änderungen in "a" abhängt, und
6825 eine neue Kontrolldatei für "c" erstellt wird, die von
6826 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
6827 Tag "b" als Abhängigkeit zu definieren.</para>
6829 <para>Es ist nicht erlaubt, sich selbst referenzierende
6830 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
6831 und "c" -> "a").</para>
6836 <term><varname>priority</varname></term>
6839 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
6840 der Scripte ausgeführt werden, die die gleichen
6841 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
6842 der Wert 1000 benutzt.</para>
6844 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
6845 "depends" benutzt werden. kivitendo sortiert die auszuführenden
6846 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
6847 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
6848 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
6849 dann "y", dann "z"), dann nach der Priorität und bei gleicher
6850 Priorität alphabetisch nach dem "tag".</para>
6855 <term><varname>ignore</varname></term>
6858 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
6859 Skript bei der Anmeldung ignoriert und entsprechend nicht
6866 <sect2 id="db-upgrade-files.format-perl-files"
6867 xreflabel="Format von Perl-Upgradedateien">
6868 <title>Format von in Perl geschriebenen
6869 Datenbankupgradescripten</title>
6871 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
6872 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
6873 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
6875 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
6876 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
6877 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
6878 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
6879 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
6880 aufgerufen wird.</para>
6882 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
6883 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
6884 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
6885 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
6886 "<literal>SL::DBUpgrade2::tag</literal>".</para>
6888 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
6889 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
6890 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
6892 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
6895 <programlisting># @tag: beispiel-upgrade-file42
6896 # @description: Ein schönes Beispielscript
6897 # @depends: release_3_1_0
6898 package SL::DBUpgrade2::beispiel_upgrade_file42;
6903 use parent qw(SL::DBUpgrade2::Base);
6908 # hier Aktionen ausführen
6917 <sect2 id="db-upgrade-files.dbupgrade-tool"
6918 xreflabel="Hilfsscript dbupgrade2_tool.pl">
6919 <title>Hilfsscript dbupgrade2_tool.pl</title>
6921 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
6922 existiert ein Hilfsscript namens
6923 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
6924 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
6925 liest alle Datenbankupgradescripte aus dem Verzeichnis
6926 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
6927 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
6928 von der Kommandozeile überprüft werden können.</para>
6930 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
6931 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
6932 sich aber auch Informationen auf verschiedene Art ausgeben
6937 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
6938 --list</command>"</para>
6940 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
6941 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
6942 würde. Es werden neben der Listenposition der Tag, die
6943 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
6947 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
6948 --tree</command>"</para>
6950 <para>Listet alle Tags in Baumform basierend auf den
6951 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
6952 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
6953 beim übergeordneten Script als Abhängigkeit eingetragen
6957 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
6958 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
6959 --rtree</command>"</para>
6961 <para>Listet alle Tags in Baumform basierend auf den
6962 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
6963 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
6964 die das übergeordnete Script als Abhängigkeit eingetragen
6969 <para>Baumform mit Postscriptausgabe:
6970 "<command>./scripts/dbupgrade2_tool.pl
6971 --graphviz</command>"</para>
6973 <para>Benötigt das Tool "<command>graphviz</command>", um mit
6974 seiner Hilfe die <link
6975 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
6976 Baumform</link> in eine Postscriptdatei namens
6977 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
6978 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
6979 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
6980 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
6985 <para>Scripte, von denen kein anderes Script abhängt:
6986 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
6988 <para>Listet die Tags aller Scripte auf, von denen keine anderen
6989 Scripte abhängen.</para>
6995 <sect1 id="translations-languages" xreflabel="Translations and languages">
6996 <title>Translations and languages</title>
6998 <sect2 id="translations-languages.introduction"
6999 xreflabel="Introduction to translations and languages">
7000 <title>Introduction</title>
7003 <para>Dieser Abschnitt ist in Englisch geschrieben, um
7004 internationalen Übersetzern die Arbeit zu erleichtern.</para>
7007 <para>This section describes how localization packages in kivitendo
7008 are built. Currently the only language fully supported is German, and
7009 since most of the internal messages are held in English the English
7010 version is usable too.</para>
7013 <sect2 id="translations-languages.character-set"
7014 xreflabel="Character set">
7015 <title>Character set</title>
7017 <para>All files included in a language pack must use UTF-8 as their
7021 <sect2 id="translations-languages.file-structure"
7022 xreflabel="File structure">
7023 <title>File structure</title>
7025 <para>The structure of locales in kivitendo is:</para>
7027 <programlisting>kivitendo/locale/<langcode>/</programlisting>
7029 <para>where <langcode> stands for an abbreviation of the
7030 language package. The builtin packages use two letter <ulink
7031 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
7032 but the actual name is not relevant for the program and can easily be
7034 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
7035 tags</ulink> (i.e. "en_GB"). In fact the original language packages
7036 from SQL Ledger are named in this way.</para>
7038 <para>In such a language directory the following files are
7043 <term>LANGUAGE</term>
7046 <para>This file is mandatory.</para>
7048 <para>The <filename>LANGUAGE</filename> file contains the self
7049 descripted name of the language. It should contain a native
7050 representation first, and in parenthesis an english translation
7051 after that. Example:</para>
7053 <programlisting>Deutsch (German)</programlisting>
7061 <para>This file is mandatory.</para>
7063 <para>The central translation file. It is essentially an inline
7064 Perl script autogenerated by <command>locales.pl</command>. To
7065 generate it, generate the directory and the two files mentioned
7066 above, and execute the following command:</para>
7068 <programlisting>scripts/locales.pl <langcode></programlisting>
7070 <para>Otherwise you can simply copy one of the other languages.
7071 You will be told how many are missing like this:</para>
7073 <programlisting>$ scripts/locales.pl en
7074 English - 0.6% - 2015/2028 missing</programlisting>
7076 <para>A file named "<filename>missing</filename>" will be
7077 generated and can be edited. You can also edit the
7078 "<filename>all</filename>" file directly. Edit everything you
7079 like to fit the target language and execute
7080 <command>locales.pl</command> again. See how the missing words
7086 <term>Num2text</term>
7089 <para>Legacy code from SQL Ledger. It provides a means for
7090 numbers to be converted into natural language, like
7091 <literal>1523 => one thousand five hundred twenty
7092 three</literal>. If you want to provide it, it must be inlinable
7093 Perl code which provides a <function>num2text</function> sub. If
7094 an <function>init</function> sub exists it will be executed
7097 <para>Only used in the check and receipt printing module.</para>
7102 <term>special_chars</term>
7105 <para>kivitendo comes with a lot of interfaces to different
7106 formats, some of which are rather picky with their accepted
7107 charset. The <filename>special_chars</filename> file contains a
7108 listing of chars not suited for different file format and
7109 provides substitutions. It is written in "Simple Ini" style,
7110 containing a block for every file format.</para>
7112 <para>First entry should be the order of substitution for
7113 entries as a whitespace separated list. All entries are
7114 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
7115 and <literal>\\</literal> all work.</para>
7117 <para>After that every entry is a special char that should be
7118 translated when writing text into such a file.</para>
7120 <para>Example:</para>
7122 <programlisting>[Template/XML]
7123 order=& < > \n
7127 \n=<br></programlisting>
7129 <para>Note the importance of the order in this example.
7130 Substituting < and > befor & would lead to $gt; become
7133 <para>For a list of valid formats, see the German
7134 <filename>special_chars</filename> entry. As of this writing the
7135 following are recognized:</para>
7137 <programlisting>HTML
7142 Template/OpenDocument
7143 filenames</programlisting>
7145 <para>The last of which is very machine dependant. Remember that
7146 a lot of characters are forbidden by some filesystems, for
7147 example MS Windows doesn't like ':' in its files where Linux
7148 doesn't mind that. If you want the files created with your
7149 language pack to be portable, find all chars that could cause
7155 <term>missing</term>
7158 <para>This file is not a part of the language package
7161 <para>This is a file generated by
7162 <command>scripts/locales.pl</command> while processing your
7163 locales. It's only to have the missing entries singled out and
7164 does not belong to a language package.</para>
7172 <para>This file is not a part of the language package
7175 <para>Another file generated by
7176 <command>scripts/locales.pl</command>. If for any reason a
7177 translation does not appear anymore and can be deleted, it gets
7178 moved here. The last 50 or so entries deleted are saved here in
7179 case you made a typo, so that you don't have to translate
7180 everything again. If a tranlsation is missing, the lost file is
7181 checked first. If you maintain a language package, you might
7182 want to keep this safe somewhere.</para>
7187 <term>more/all</term>
7190 <para>This subdir and file is not a part of the language package
7193 <para>If the directory more exists and contains a file called
7194 all it will be parsed in addition to the mandatory all (see
7195 above). The file is useful if you want to change some
7196 translations for the current installation without conflicting
7197 further upgrades. The file is not autogenerated and has the same
7198 format as the all, but needs another key (more_texts). See the
7199 german translation for an example or copy the following code:
7202 # -*- coding: utf-8; -*-
7207 # These are additional texts for custom translations.
7208 # The format is the same as for the normal file all, only
7209 # with another key (more_texts instead of texts).
7210 # The file has the form of 'english text' => 'foreign text',
7212 $self->{more_texts} = {
7214 'Ship via' => 'Terms of delivery',
7215 'Shipping Point' => 'Delivery time',
7217 </programlisting></para>
7224 <sect1 id="devel.testsuite">
7225 <title>Die kivitendo-Test-Suite</title>
7227 <sect2 id="devel.testsuite.intro">
7228 <title>Einführung</title>
7230 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
7231 basiert auf dem Standard-Perl-Modul
7232 <literal>Test::More</literal>.</para>
7234 <para>Die grundlegenden Fakten sind:</para>
7238 <para>Alle Tests liegen im Unterverzeichnis
7239 <filename>t/</filename>.</para>
7243 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
7244 enthält einen oder mehrere Testfälle.</para>
7248 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
7249 Es sind selbstständig ausführbare Perl-Scripte.</para>
7253 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
7254 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
7255 auf <literal>.t</literal> endet.</para>
7260 <sect2 id="devel.testsuite.prerequisites">
7261 <title>Voraussetzungen</title>
7263 <para>Für die Ausführung werden neben den für kivitendo eh schon
7264 benötigten Module noch weitere Perl-Module benötigt. Diese
7269 <para><literal>Test::Deep</literal> (Debian-Paketname:
7270 <literal>libtest-deep-perl</literal>; Fedora:
7271 <literal>perl-Test-Deep</literal>; openSUSE:
7272 <literal>perl-Test-Deep</literal>)</para>
7276 <para><literal>Test::Exception</literal> (Debian-Paketname:
7277 <literal>libtest-exception-perl</literal>; Fedora:
7278 <literal>perl-Test-Exception</literal>; openSUSE:
7279 <literal>perl-Test-Exception</literal>)</para>
7283 <para><literal>Test::Output</literal> (Debian-Paketname:
7284 <literal>libtest-output-perl</literal>; Fedora:
7285 <literal>perl-Test-Output</literal>; openSUSE:
7286 <literal>perl-Test-Output</literal>)</para>
7290 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
7291 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
7292 kann für frühere Versionen aus dem <ulink
7293 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
7297 <para><literal>LWP::Simple</literal> aus dem Paket
7298 <literal>libwww-perl</literal> (Debian-Panetname:
7299 <literal>libwww-perl</literal>; Fedora:
7300 <literal>perl-libwww-perl</literal>; openSUSE:
7301 <literal>perl-libwww-perl</literal>)</para>
7305 <para><literal>URI::Find</literal> (Debian-Panetname:
7306 <literal>liburi-find-perl</literal>; Fedora:
7307 <literal>perl-URI-Find</literal>; openSUSE:
7308 <literal>perl-URI-Find</literal>)</para>
7312 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
7313 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
7314 müssen in der Konfigurationsdatei im Abschnit
7315 <literal>testing/database</literal> Datenbankverbindungsparameter
7316 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
7317 Recht haben, Datenbanken anzulegen und zu löschen.</para>
7320 <sect2 id="devel.testsuite.execution">
7321 <title>Existierende Tests ausführen</title>
7323 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
7324 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
7325 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
7326 <filename>t/test.pl</filename>.</para>
7328 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
7329 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
7330 kivitendo-Basisverzeichnis heraus ausführen.</para>
7332 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
7333 an <filename>t/test.pl</filename>. Beispielsweise:</para>
7335 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
7338 <sect2 id="devel.testsuite.meaning_of_scripts">
7339 <title>Bedeutung der verschiedenen Test-Scripte</title>
7341 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
7342 Programmierstil. Einige besonders zu erwähnende, weil auch während der
7343 Entwicklung nützliche Tests sind:</para>
7347 <para><filename>t/001compile.t</filename> -- compiliert alle
7348 Quelldateien und bricht bei Fehlern sofort ab</para>
7352 <para><filename>t/002goodperl.t</filename> -- überprüft alle
7353 Perl-Dateien auf Anwesenheit von '<literal>use
7354 strict</literal>'-Anweisungen</para>
7358 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
7359 <function>system()</function> und <function>exec()</function> auf
7364 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
7365 Tab-Zeichen enthalten</para>
7369 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
7370 Rechtschreibfehlern</para>
7374 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
7375 Dokumentation im POD-Format auf Gültigkeit</para>
7379 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
7380 einzelner Funktionen und Module.</para>
7383 <sect2 id="devel.testsuite.create_new">
7384 <title>Neue Test-Scripte erstellen</title>
7386 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
7387 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
7388 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
7391 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
7392 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
7395 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
7400 <para>Überprüfung auf fehlende symbolische Links</para>
7404 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
7405 gewissen Einschränkungen wie das Erlauben von deutschen
7410 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
7414 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
7418 <para>Test, ob alle zu übersetzenden Strings in
7419 <filename>locale/de/all</filename> vorhanden sind</para>
7423 <para>Test, ob alle Webseiten-Templates in
7424 <filename>templates/webpages</filename> mit vom Perl-Modul
7425 <literal>Template</literal> compiliert werden können</para>
7430 <sect3 id="devel.testsuite.directory_and_test_names">
7431 <title>Konvention für Verzeichnis- und Dateinamen</title>
7433 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
7434 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
7435 und ihnen soweit es geht folgen:</para>
7439 <para>Die Dateiendung muss <filename>.t</filename>
7444 <para>Namen sind englisch, komplett klein geschrieben und
7445 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
7446 <filename>bad_function_params.t</filename>).</para>
7450 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
7451 benannt sein, mit dem sich die Scripte darin befassen
7452 (beispielsweise <filename>background_jobs</filename> für Tests
7453 rund um Hintergrund-Jobs).</para>
7457 <para>Test-Scripte sollten einen überschaubaren Bereich von
7458 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
7459 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
7460 Test-Scripte schreiben.</para>
7465 <sect3 id="devel.testsuite.minimal_example">
7466 <title>Minimales Skelett für eigene Scripte</title>
7468 <para>Der folgenden Programmcode enthält das kleinstmögliche
7469 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
7472 <programlisting>use Test::More tests => 0;
7476 use Support::TestSetup;
7478 Support::TestSetup::login();</programlisting>
7480 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
7481 benötigt (Stichwort: alle globalen Variablen wie
7482 <varname>$::auth</varname>, <varname>$::form</varname> oder
7483 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
7484 <filename>config/kivitendo.conf</filename> im Abschnitt
7485 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
7486 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
7488 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
7489 kann die letzte Zeile <code>Support::TestSetup::login();</code>
7490 weggelassen werden, was die Ausführungszeit des Scripts leicht
7496 <sect1 id="devel.style-guide">
7497 <title>Stil-Richtlinien</title>
7499 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
7500 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
7501 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
7502 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
7504 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
7507 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
7508 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
7513 <para>Es werden keine echten Tabs sondern Leerzeichen
7518 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
7520 <programlisting>foreach my $row (@data) {
7522 # do something with $row
7526 $row->{modules} = MODULE->retrieve(
7527 id => $row->{id},
7528 date => $use_now ? localtime() : $row->{time},
7532 $report->add($row);
7537 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
7538 Zeile wie der letzte Befehl. Beispiele:</para>
7540 <programlisting>sub debug {
7546 <programlisting>if ($form->{item_rows} > 0) {
7552 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
7553 der Befehl / die öffnende schließende Klammer, die den Block
7554 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
7555 Beispiele wie bei 3. gelten.</para>
7559 <para>Die Wörter "<function>else</function>",
7560 "<function>elsif</function>", "<function>while</function>" befinden
7561 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
7564 <programlisting>if ($form->{sum} > 1000) {
7566 } elsif ($form->{sum} > 0) {
7574 } until ($a > 0);</programlisting>
7578 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
7579 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
7580 und grep-ähnliche Operatoren. Beispiel:</para>
7582 <programlisting>$main::lxdebug->message("Could not find file.");
7583 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
7587 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
7589 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
7590 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
7591 Blöcke schon. Beispiel:</para>
7593 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
7598 $form->{sum} += $form->{"row_$i"};
7599 $form->{ $form->{index} } += 1;
7601 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
7605 <para>Mehrzeilige Befehle</para>
7609 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
7610 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
7611 werden, in der die ersten Funktionsparameter in der ersten Zeile
7612 stehen. Beispiel:</para>
7614 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
7615 $form->{some_col_value});</programlisting>
7619 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
7620 besten in einer übersichtlichen Tabellenstruktur organisiert
7621 wird. Beispiel:</para>
7623 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
7624 : $form->{oldcount} ? $form->{oldcount} + 1
7625 : $form->{rowcount} - $form->{rowbase};</programlisting>
7631 <para>Kommentare</para>
7635 <para>Kommentare, die alleine in einer Zeile stehen, sollten
7636 soweit wie der Code eingerückt sein.</para>
7640 <para>Seitliche hängende Kommentare sollten einheitlich
7641 formatiert werden.</para>
7645 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
7646 auf Englisch zu verfassen. So wie ich keine Lust habe,
7647 französischen Quelltext zu lesen, sollte auch der kivitendo
7648 Quelltext für nicht-Deutschsprachige lesbar sein.
7651 <programlisting>my $found = 0;
7659 $i = 0 # initialize $i
7661 $i *= $const; # do something crazy
7662 $i = $n; # recover $i</programlisting>
7668 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
7669 Interpolation gewünscht ist. Beispiel:</para>
7671 <programlisting>$form->{sum} = 0;
7672 $form->{"row_$i"} = $form->{"row_$i"} - 5;
7673 $some_hash{42} = 54;</programlisting>
7677 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
7678 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
7679 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
7680 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
7682 <para>Als Beispiel sei die Funktion
7683 <function>print_options</function> aus
7684 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
7688 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
7689 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
7692 <para>Emacs und vim haben beide recht einfache Methoden zur
7693 Entfernung von trailing whitespace. Emacs kennt das Kommande
7694 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
7695 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
7696 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
7701 <para>Es wird kein <command>perltidy</command> verwendet.</para>
7703 <para>In der Vergangenheit wurde versucht,
7704 <command>perltidy</command> zu verwenden, um einen einheitlichen
7705 Stil zu erlangen. Es hat sich aber gezeigt, dass
7706 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
7707 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
7708 den Interessierten sind hier die
7709 <command>perltidy</command>-Optionen, die grob den beschriebenen
7710 Richtlinien entsprechen:</para>
7712 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
7713 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
7714 -lp -vt=1 -vtc=1</programlisting>
7718 <para><varname>STDERR</varname> ist tabu. Unkonditionale
7719 Debugmeldungen auch.</para>
7721 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
7722 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
7723 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
7725 <para>Die <classname>LXDebug</classname>-Methode
7726 "<function>message</function>" nimmt als ersten Paramter außerdem
7727 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
7728 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
7729 und werden in den meisten Fällen auch vom Repository
7730 zurückgewiesen.</para>
7734 <para>Alle neuen Module müssen use strict verwenden.</para>
7736 <para><varname>$form</varname>, <varname>$auth</varname>,
7737 <varname>$locale</varname>, <varname>$lxdebug</varname> und
7738 <varname>%myconfig</varname> werden derzeit aus dem main package
7739 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
7740 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
7745 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
7746 <title>Dokumentation erstellen</title>
7748 <sect2 id="devel.build-doc.introduction">
7749 <title>Einführung</title>
7751 <para>Diese Dokumentation ist in <productname>DocBook</productname>
7752 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
7753 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
7754 Editor nutzt, der spezielle Unterstützung für
7755 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
7756 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
7757 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
7761 <sect2 id="devel.build-doc.required-software">
7762 <title>Benötigte Software</title>
7764 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
7765 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
7766 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
7767 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
7768 <command>scripts/build_doc.sh</command>.</para>
7770 <para>Das Script benötigt zur Konvertierung verschiedene
7771 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
7777 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
7778 in einer halbwegs aktuellen Version</para>
7782 <para>Das Java-Build-System <ulink
7783 url="http://ant.apache.org/">Apache Ant</ulink></para>
7787 <para>Das Dokumentations-System Dobudish für
7788 <productname>DocBook</productname> 4.5, eine Zusammenstellung
7789 diverser Stylesheets und Grafiken zur Konvertierung von
7790 <productname>DocBook</productname> XML in andere Formate. Das
7791 Paket, das benötigt wird, ist zum Zeitpunkt der
7792 Dokumentationserstellung
7793 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
7794 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
7799 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
7800 sind auf allen gängigen Plattformen verfügbar. Beispiel für
7801 Debian/Ubuntu:</para>
7803 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
7805 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
7806 <filename>doc/build</filename> entpackt werden. Beispiel unter der
7807 Annahme, das <productname>Dobudish</productname> in
7808 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
7810 <programlisting>cd doc/build
7811 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
7814 <sect2 id="devel.build-doc.build">
7815 <title>PDFs und HTML-Seiten erstellen</title>
7817 <para>Die eigentliche Konvertierung erfolgt nach Installation der
7818 benötigten Software mit einem einfachen Aufruf direkt aus dem
7819 kivitendo-Installationsverzeichnis heraus:</para>
7821 <programlisting>./scripts/build_doc.sh</programlisting>
7824 <sect2 id="devel.build-doc.repository">
7825 <title>Einchecken in das Git-Repository</title>
7827 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
7828 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
7829 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
7830 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
7832 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
7833 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob