1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <book id="kivitendo-documentation" lang="de">
5 <title>kivitendo 3.5.0: Installation, Konfiguration, Entwicklung</title>
7 <chapter id="Aktuelle-Hinweise">
8 <title>Aktuelle Hinweise</title>
10 <para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>
14 <para>im Community-Forum: <ulink
15 url="https://forum.kivitendo.de:32443">https://forum.kivitendo.de:32443</ulink></para>
19 <para>im Kunden-Forum: <ulink
20 url="http://redmine.kivitendo-premium.de/projects/forum/boards/">http://redmine.kivitendo-premium.de/projects/forum/boards/</ulink></para>
24 <para>in der doc/UPGRADE Datei im doc-Verzeichnis der
29 <para>Im Schulungs- und Dienstleistungsangebot der entsprechenden
30 kivitendo-Partner: <ulink
31 url="http://www.kivitendo.de/partner.html">http://www.kivitendo.de/partner.html</ulink></para>
37 <title>Installation und Grundkonfiguration</title>
39 <sect1 id="Installation-Übersicht">
40 <title>Übersicht</title>
42 <para>Die Installation von kivitendo umfasst mehrere Schritte. Die
43 folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
44 Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit
45 minimalen Features möglichst schnell zum Laufen zu kriegen.</para>
49 <para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo
50 benötigt gewisse Ressourcen und benutzt weitere Programme. Das
51 Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert
52 diese. Auch die Liste der benötigten Perl-Module befindet sich
57 <para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst
58 die "<xref linkend="Manuelle-Installation-des-Programmpaketes"/>"
59 sowie grundlegende Einstellungen, die der "<xref
60 linkend="config.config-file"/>" erläutert.</para>
64 <para><emphasis>Konfiguration externer Programme</emphasis>: hierzu
65 gehören die Datenbank ("<xref
66 linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der
67 Webserver ("<xref linkend="Apache-Konfiguration"/>").</para>
71 <para><emphasis>Benutzerinformationen speichern können</emphasis>:
72 man benötigt mindestens eine Datenbank, in der Informationen zur
73 Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man
74 das als Administrator macht, verrät "<xref
75 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para>
79 <para><emphasis>Benutzer, Gruppen und Datenbanken
80 anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
81 linkend="Benutzer--und-Gruppenverwaltung"/>".</para>
85 <para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann
86 kann es losgehen: "<xref linkend="kivitendo-ERP-verwenden"/>"</para>
90 <para>Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls
91 wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen
95 <sect1 id="Benötigte-Software-und-Pakete">
96 <title>Benötigte Software und Pakete</title>
98 <sect2 id="Betriebssystem">
99 <title>Betriebssystem</title>
101 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
102 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
103 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
104 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
105 ohne große Probleme auf den derzeit aktuellen verbreiteten
106 Distributionen läuft.</para>
108 <para>Anfang 2016 sind das folgende Systeme, von denen bekannt ist,
109 dass kivitendo auf ihnen läuft:</para>
117 <para>7.0 "Wheezy"</para>
121 <para>8.0 "Jessie"</para>
127 <para>Ubuntu 12.04 LTS "Precise Pangolin", 14.04 "Trusty Tahr"
128 LTS, 15.10 "Wily Werewolf" und 16.04 "Xenial Xerus" LTS
133 <para>openSUSE LEAP 42.1</para>
137 <para>Fedora 22</para>
142 <sect2 id="Pakete" xreflabel="Pakete">
143 <title>Benötigte Perl-Pakete installieren</title>
145 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
146 Apache) und ein Datenbankserver (PostgreSQL) in einer aktuellen 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>File::MimeInfo</literal></para>
222 <para><literal>GD</literal></para>
226 <para><literal>HTML::Parser</literal></para>
230 <para><literal>HTML::Restrict</literal></para>
234 <para><literal>Image::Info</literal></para>
238 <para><literal>JSON</literal></para>
242 <para><literal>List::MoreUtils</literal></para>
246 <para><literal>List::UtilsBy</literal></para>
250 <para><literal>Net::SMTP::SSL</literal> (optional, bei
251 E-Mail-Versand über SSL; siehe Abschnitt "<xref
252 linkend="config.sending-email.smtp"/>")</para>
256 <para><literal>Net::SSLGlue</literal> (optional, bei
257 E-Mail-Versand über TLS; siehe Abschnitt "<xref
258 linkend="config.sending-email.smtp"/>")</para>
262 <para><literal>Params::Validate</literal></para>
266 <para><literal>PBKDF2::Tiny</literal></para>
270 <para><literal>PDF::API2</literal></para>
274 <para><literal>Rose::Object</literal></para>
278 <para><literal>Rose::DB</literal></para>
282 <para><literal>Rose::DB::Object</literal> Version 0.788 oder
287 <para><literal>String::ShellQuote</literal></para>
291 <para><literal>Sort::Naturally</literal></para>
295 <para><literal>Template</literal></para>
299 <para><literal>Text::CSV_XS</literal></para>
303 <para><literal>Text::Iconv</literal></para>
307 <para><literal>Text::Unidecode</literal></para>
311 <para><literal>URI</literal></para>
315 <para><literal>XML::Writer</literal></para>
319 <para><literal>YAML</literal></para>
322 <para>Seit Version größer v3.5.0 sind die folgenden Pakete hinzugekommen:
323 <literal>Text::Unidecode</literal></para>
325 <para>Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen:
326 <literal>Algorithm::CheckDigits</literal><literal>PBKDF2::Tiny</literal></para>
328 <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen:
329 <literal>GD</literal>, <literal>HTML::Restrict</literal>,
330 <literal>Image::Info</literal></para>
332 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen:
333 <literal>File::Copy::Recursive</literal>.</para>
335 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen:
336 <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
337 <literal>Net::SSLGlue</literal>.</para>
339 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
340 hinzugekommen, <literal>URI</literal> und
341 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
344 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
345 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
346 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
347 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
349 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
350 hinzugekommen.</para>
352 <para><literal>Email::Address</literal> und
353 <literal>List::MoreUtils</literal> sind schon länger feste
354 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
355 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
356 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
357 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
361 <title>Debian und Ubuntu</title>
363 <para>Für Debian und Ubuntu stehen die meisten der benötigten
364 Perl-Pakete als Debian-Pakete zur Verfügung. Sie können mit
365 folgendem Befehl installiert werden:</para>
367 <programlisting>apt install apache2 libarchive-zip-perl libclone-perl \
368 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
369 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
370 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
371 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
372 librose-db-perl librose-object-perl libsort-naturally-perl \
373 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
374 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
375 libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \
376 libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \
377 libcrypt-pbkdf2-perl git libcgi-pm-perl libtext-unidecode-perl
380 <para>Für das Paket HTML::Restrict gibt es kein Debian-Paket, dies
381 muß per CPAN installiert werden. Unter Ubuntu funktioniert das
384 <programlisting>apt-get install build-essential
385 cpan HTML::Restrict</programlisting>
389 <title>Fedora</title>
391 <para>Für Fedora stehen die meisten der benötigten Perl-Pakete als
392 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
393 installiert werden:</para>
395 <programlisting>dnf install httpd mod_fcgid perl-Archive-Zip perl-Clone perl-DBD-Pg \
396 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
397 perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
398 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
399 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
400 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
401 perl-XML-Writer perl-YAML perl-parent postgresql-server perl-CPAN \
402 perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor perl-Text-Balanced</programlisting>
404 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
405 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
407 <programlisting>cpan Config::Std HTML::Restrict</programlisting>
411 <title>openSUSE</title>
413 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als
414 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
415 installiert werden:</para>
417 <programlisting>zypper install apache2 apache2-mod_fcgid perl-Archive-Zip perl-Clone \
418 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
419 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
420 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
421 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
422 perl-URI perl-XML-Writer perl-YAML perl-CPAN \
423 perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor postgresql-server</programlisting>
425 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
426 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
428 <programlisting>cpan Rose::Db::Object</programlisting>
432 <title>Andere Pakete installieren</title>
434 <para>Seit Version v3.4.0 wird für den Bankimport optional das Paket
435 'aqbanking-tools' benötigt.</para>
437 <para>Debian und Ubuntu: <programlisting>apt install aqbanking-tools
438 </programlisting></para>
440 <para>OpenSuSE: <programlisting>zypper install aqbanking-tools</programlisting></para>
442 <para>Seit Version v3.4.1 wird generell zum Feststellen der
443 Seitenanzahl von PDF_Dokumenten 'pdfinfo' benötigt was im Paket
444 'poppler-utils' enthalten ist.</para>
446 <para>Debian und Ubuntu: <programlisting>apt install poppler-utils
447 </programlisting></para>
449 <para>OpenSuSE: <programlisting>zypper install poppler-tools</programlisting></para>
454 <sect1 id="Manuelle-Installation-des-Programmpaketes"
455 xreflabel="Manuelle Installation des Programmpaketes">
456 <title>Manuelle Installation des Programmpaketes</title>
458 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github
459 gehostet und kann <ulink
460 url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
461 heruntergeladen werden.</para>
463 <para>Die kivitendo ERP Installationsdatei
464 (<filename>kivitendo-erp-3.4.1.tgz</filename>) wird im
465 Dokumentenverzeichnis des Webservers (z.B.
466 <filename>/var/www/html/</filename>,
467 <filename>/srv/www/htdocs</filename> oder
468 <filename>/var/www/</filename>) entpackt:</para>
470 <programlisting>cd /var/www
471 tar xvzf kivitendo-erp-3.4.1.tgz</programlisting>
473 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
475 <programlisting>cd kivitendo-erp</programlisting>
477 <para>Alternativ können Sie auch einen Alias in der
478 Webserverkonfiguration benutzen, um auf das tatsächliche
479 Installationsverzeichnis zu verweisen.</para>
481 <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
482 WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
484 <programlisting>mkdir webdav</programlisting>
486 <para>Die Verzeichnisse <filename>users</filename>,
487 <filename>spool</filename> und <filename>webdav</filename> müssen für
488 den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
489 restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer-
490 und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich
491 (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
492 <constant>apache</constant> oder bei OpenSUSE
493 <constant>wwwrun</constant>).</para>
495 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
496 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
498 <programlisting>chown -R www-data users spool webdav</programlisting>
500 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen
501 <filename>templates</filename> und <filename>users</filename>
502 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in
503 kivitendo angelegt wird:</para>
505 <programlisting>chown www-data templates users</programlisting>
508 <para>Wir empfehlen eine Installation mittels des Versionsmanagager
509 git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr
510 viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte
511 die Pfade anpassen) bspw. wie folgt: <programlisting>cd /var/www/
512 git clone https://github.com/kivitendo/kivitendo-erp.git
514 git checkout `git tag -l | egrep -ve "(beta|rc)" | tail -1`</programlisting>
515 Erläuterung: Der Befehl wechselt zur letzten Stable-Version (git tag -l listet
516 alle Tags auf, das egrep schmeisst alle Einträge mit beta oder rc raus und
517 das tail gibt davon den obersten Treffer zurück).
519 Sehr sinnvoll ist es, direkt im Anschluss einen eigenen Branch zu
520 erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen damit zu
521 verwalten. Hierfür reicht ein simples <programlisting> git checkout -b meine_eigenen_änderungen</programlisting>
522 nach dem letzten Kommando (weiterführende Informationen <ulink
523 url="http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html">
524 Git Magic</ulink>).</para>
527 Ein beispielhafter Workflow für Druckvorlagen-Anpassungen von 3.4.1 nach 3.5:
529 $ git clone https://github.com/kivitendo/kivitendo-erp.git
531 $ git checkout release-3.4.1 # das ist der aktuelle release, den wir wollen
532 $ git add templates/fullhouse # das sind unsere druckvorlagen inkl. produktbilder
533 $ git commit -m "juhu tolle ändernungen"
534 [meine_aenderungen 1d89e41] juhu tolle ändernungen
535 4 files changed, 380 insertions(+)
536 create mode 100644 templates/fullhouse/img/webdav/tesla.png
537 create mode 100644 templates/fullhouse/mahnung.tex
538 create mode 100644 templates/fullhouse/zahlungserinnerung_zwei.tex
539 create mode 100644 templates/fullhouse/zahlungserinnerung_zwei_invoice.tex
544 $ git rebase --onto release-3.5.0 release-3.4.1 meine_aenderungen
545 Zunächst wird der Branch zurückgespult, um Ihre Änderungen
546 darauf neu anzuwenden ...
547 Wende an: juhu tolle ändernungen
548 $ service apache2 restart
549 </programlisting></para>
553 <sect1 id="config.config-file">
554 <title>kivitendo-Konfigurationsdatei</title>
556 <sect2 id="config.config-file.introduction"
557 xreflabel="Einführung in die Konfigurationsdatei">
558 <title>Einführung</title>
560 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
561 benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die
562 Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von
563 kivitendo bzw. der Migration von älteren Versionen angelegt
566 <para>Als Vorlage dient die Datei
567 <filename>config/kivitendo.conf.default</filename> (kurz: "die
568 Default-Datei"):</para>
570 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
572 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
573 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
574 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
575 Abschnitte und Werte enthalten, die von denen der Default-Datei
579 <para>Vor der Umbenennung in kivitendo hieß diese Datei noch
580 <filename>config/lx_office.conf</filename>. Aus Gründen der
581 Kompatibilität wird diese Datei eingelesen, sofern die Datei
582 <filename>config/kivitendo.conf</filename> nicht existiert.</para>
585 <para>Diese Hauptkonfigurationsdatei ist dann eine
586 installationsspezifische Datei, d.h. sie enthält bspw. lokale
587 Passwörter und wird auch nicht im Versionsmanagement (git)
590 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
591 Mandaten, bzw. Datenbanken gleich.</para>
594 <sect2 id="config.config-file.sections-parameters">
595 <title>Abschnitte und Parameter</title>
597 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
598 entsprechend kommentiert sind:</para>
602 <para><literal>authentication</literal> (siehe Abschnitt "<xref
603 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
604 in diesem Kapitel)</para>
608 <para><literal>authentication/database</literal></para>
612 <para><literal>authentication/ldap</literal></para>
616 <para><literal>system</literal></para>
620 <para><literal>paths</literal></para>
624 <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
625 linkend="config.sending-email.smtp"/>)</para>
629 <para><literal>applications</literal></para>
633 <para><literal>environment</literal></para>
637 <para><literal>print_templates</literal></para>
641 <para><literal>task_server</literal></para>
645 <para><literal>periodic_invoices</literal></para>
649 <para><literal>self_tests</literal></para>
653 <para><literal>console</literal></para>
657 <para><literal>testing</literal></para>
661 <para><literal>testing/database</literal></para>
665 <para><literal>debug</literal></para>
669 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
670 einzustellen oder zu kontrollieren sind, sind:</para>
672 <programlisting>[authentication]
673 admin_password = geheim
675 [authentication/database]
683 default_manager = german</programlisting>
685 <para>Für kivitendo Installationen in der Schweiz sollte hier <varname>german</varname>
686 durch <varname>swiss</varname> ersetzt werden.</para>
687 <para>Die Einstellung <varname>default_manager = swiss</varname> bewirkt:</para>
690 <para>Beim Erstellen einer neuen Datenbank in der kivitendo Administration
691 werden automatisch die Standard-Werte für die Schweiz voreingestellt:
692 Währung CHF, 5er-Rundung, Schweizer KMU-Kontenplan, Sollversteuerung,
693 Aufwandsmethode, Bilanzierung (die Werte können aber manuell angepasst werden).</para>
696 <para>Einstellen der Standardkonten für Rundungserträge und -aufwendungen
697 (unter Mandantenkonfiguration → Standardkonten veränderbar)</para>
700 <para>das verwendete Zahlenformat wird auf <varname>1'000.00</varname> eingestellt
701 (unter Programm → Benutzereinstellungen veränderbar)</para>
704 <para>DATEV-Automatik und UStVA werden nicht angezeigt, Erfolgsrechnung
705 ersetzt GUV ( unter Mandantenkonfiguration → Features veränderbar)</para>
709 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
710 <varname>[periodic_invoices]</varname> den Login eines Benutzers
711 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
712 mit Informationen über die erstellten Rechnungen bekommt.</para>
714 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
715 Ausführung bestimmter Aufgaben mit, den <link
716 linkend="config.task-server">Taskserver</link>. Er wird u.a. für
717 Features wie die <link
718 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
719 benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
720 daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
721 <link linkend="config.task-server">Task-Server</link> genauer
724 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
725 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
728 <sect2 id="config.config-file.prior-versions">
729 <title>Versionen vor 2.6.3</title>
731 <para>In älteren kivitendo Versionen gab es im Verzeichnis
732 <filename>config</filename> die Dateien
733 <filename>authentication.pl</filename> und
734 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
735 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
736 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
737 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
739 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
740 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
741 manuell übertragen und die alten Konfigurationsdateien anschließend
742 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
743 entsprechende Fehlermeldung an.</para>
747 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
748 <title>Anpassung der PostgreSQL-Konfiguration</title>
750 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
752 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
753 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
755 <para>kivitendo setzt zwingend voraus, dass die Datenbank
756 Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
757 Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
759 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
760 Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
761 man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
763 <programlisting>su postgres
765 exit </programlisting>
767 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
768 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
769 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
772 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
774 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
775 Versionsnummer angepasst werden.</para>
777 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
779 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
780 <literal>\l</literal> geprüft werden.</para>
783 <sect2 id="Änderungen-an-Konfigurationsdateien">
784 <title>Änderungen an Konfigurationsdateien</title>
786 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
787 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
788 <filename>/var/lib/pgsql/data/</filename> oder
789 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
790 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
791 Parameter <varname>listen_address</varname> gesteuert. Laufen
792 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
793 <literal>localhost</literal> verwendet werden. Andernfalls müssen
794 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
795 was mit dem Wert <literal>*</literal> geschieht.</para>
797 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
798 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
799 sein sollte, müssen die Berechtigungen für den Zugriff geändert
800 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
801 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
802 Datenbank zum Beispiel:</para>
804 <programlisting>local all kivitendo password
805 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
808 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
809 <title>Erweiterung für servergespeicherte Prozeduren</title>
811 <para>In der Datenbank <literal>template1</literal> muss die
812 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
813 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
814 <programlisting>su - postgres
815 psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
817 <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
821 <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
822 bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
823 anzulegen. In diesen Versionen ist die Extension meist auch schon
824 vorhanden. Sollten Sie eine ältere Version von Postgres haben,
825 benutzen Sie stattdessen den folgenden Befehl.</para>
827 <programlisting>CREATE LANGUAGE 'plpgsql';
832 <sect2 id="Datenbankbenutzer-anlegen">
833 <title>Datenbankbenutzer anlegen</title>
835 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
836 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
837 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
840 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
841 nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
842 generieren nicht nötig.</para>
844 <programlisting>su - postgres
845 createuser -d -P kivitendo
846 exit</programlisting>
848 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
849 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
850 bzw. den hier gewählten Benutzernamen.</para>
854 <sect1 id="Apache-Konfiguration">
855 <title>Webserver-Konfiguration</title>
858 <title>Grundkonfiguration mittels CGI</title>
861 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
862 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
863 <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
866 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
867 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
868 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
869 anderen Datei hinzu, die beim Starten des Webservers eingelesen
872 <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
873 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
875 <Directory /var/www/kivitendo-erp>
876 AddHandler cgi-script .pl
877 Options ExecCGI Includes FollowSymlinks
880 <Directory /var/www/kivitendo-erp/users>
882 </Directory></programlisting>
884 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
885 das kivitendo-Archiv entpacket haben.</para>
888 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
889 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
891 <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
892 noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
893 aktiviert werden.</para>
896 <para>Auf einigen Webservern werden manchmal die Grafiken und
897 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
898 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
900 <programlisting>EnableSendfile Off</programlisting>
903 <sect2 id="Apache-Konfiguration.FCGI"
904 xreflabel="Konfiguration für FastCGI/FCGI">
905 <title>Konfiguration für FastCGI/FCGI</title>
907 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
908 <title>Was ist FastCGI?</title>
910 <para>Direkt aus <ulink
911 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
914 <para><citation> FastCGI ist ein Standard für die Einbindung
915 externer Software zur Generierung dynamischer Webseiten in einem
916 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
917 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
918 umgehen. </citation></para>
921 <sect3 id="Apache-Konfiguration.FCGI.Warum">
922 <title>Warum FastCGI?</title>
924 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
925 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
926 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
927 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
928 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
929 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
930 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
931 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
932 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
933 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
934 deutlich länger dauert als früher, und dass davon 90% für das Laden
935 der Module verwendet wird.</para>
937 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
938 wird nur die eigentliche Programmlogik ausgeführt.</para>
941 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
942 <title>Getestete Kombinationen aus Webservern und Plugin</title>
944 <para>Folgende Kombinationen sind getestet:</para>
948 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
952 <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
956 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
960 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
961 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
962 mod_fastcgi nicht mehr explizit eingegangen.</para>
964 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
968 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
969 strict in der Behandlung von Unicode, und verweigern bestimmte
970 Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
971 Installation gibt, muss zwingend Version 0.68 oder aber Version
972 0.72 und neuer eingesetzt werden.</para>
974 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
975 sich die Vorgängerversion wie folgt installieren:</para>
977 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
981 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
982 <title>Konfiguration des Webservers</title>
984 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
985 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
986 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
987 debuggen die beim ersten aufsetzen auftreten können. Sollte die
988 Installation schon funktionieren, lesen Sie weiter.</para>
990 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
991 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
993 <programlisting>a2enmod fcgid</programlisting>
995 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
996 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
997 und <function>Directory</function>-Direktiven. Dabei wird zwischen
998 dem Installationspfad von kivitendo im Dateisystem
999 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
1000 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
1001 ("<filename>/url/for/kivitendo-erp</filename>").</para>
1003 <para>Folgender Konfigurationsschnipsel funktioniert mit
1006 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
1007 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1009 <Directory /path/to/kivitendo-erp>
1011 Options ExecCGI Includes FollowSymlinks
1015 <DirectoryMatch /path/to/kivitendo-erp/users>
1017 </DirectoryMatch></programlisting>
1020 <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
1021 muss entsprechend die Syntax der Directorydirektiven verändert.
1024 <programlisting>Require all granted</programlisting>
1026 <para>muß man Folgendes einstellen:</para>
1030 Allow from All </programlisting>
1032 <para>und statt</para>
1034 <programlisting>Require all denied</programlisting>
1036 <para>muss stehen:</para>
1040 Deny from All </programlisting>
1044 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
1045 die maximale Größe eines Requests. Diese sollte wie folgt
1046 hochgesetzt werden:</para>
1048 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
1050 <para>Das Ganze sollte dann so aussehen:</para>
1052 <programlisting>AddHandler fcgid-script .fpl
1053 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1054 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1055 FcgidMaxRequestLen 10485760
1057 <Directory /path/to/kivitendo-erp>
1059 Options ExecCGI Includes FollowSymlinks
1064 <DirectoryMatch /path/to/kivitendo-erp/users>
1067 </DirectoryMatch></programlisting>
1069 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
1070 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
1071 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
1072 gibt es hier kleine Performance-Einbußen.</para>
1074 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
1075 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
1076 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
1078 <programlisting># Zugriff über CGI
1079 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
1081 # Zugriff mit mod_fcgid:
1082 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1083 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
1085 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
1086 die normale Version erreichbar, und unter
1087 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
1088 FastCGI-Version.</para>
1093 <title>Weitergehende Konfiguration</title>
1095 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
1096 von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1097 weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1098 Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1099 Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1100 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1101 (Stand Sept. 2015)</ulink> und einen aktuellen (Stand Mai 2017)
1102 <ulink url="https://mozilla.github.io/server-side-tls/ssl-config-generator/">
1103 SSL-Konfigurations-Generator</ulink>.</para>
1107 <sect1 id="config.task-server">
1108 <title>Der Task-Server</title>
1110 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1111 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1112 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1113 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1114 essenzielle Aufgaben benutzt.</para>
1116 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1117 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1118 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1120 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1121 Servers integriert werden muss, damit er automatisch gestartet wird.
1122 Dies kann kivitendo nicht für Sie erledigen.</para>
1124 <para>Da der Taskserver als Perlscript läuft, wird Arbeitsspeicher,
1125 der einmal benötigt wurde, nicht mehr an das Betriebssystem zurückgegeben,
1126 solange der Taskserver läuft. Dies kann dazu führen, dass ein länger
1127 laufender Taskserver mit der Zeit immer mehr Arbeitsspeicher für sich
1128 beansprucht. Es ist deshalb sinnvoll, dass der Taskserver in regelmässigen
1129 Abständen neu gestartet wird.</para>
1131 <sect2 id="Konfiguration-des-Task-Servers">
1132 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1134 <para>Die Konfiguration erfolgt über den Abschnitt
1135 <literal>[task_server]</literal> in der Datei
1136 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1137 Optionen sind:</para>
1141 <term><varname>run_as</varname></term>
1144 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1145 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1146 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1147 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1149 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1150 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1151 unter dem auch der Webserver läuft.</para>
1156 <term><varname>debug</varname></term>
1159 <para>Schaltet Debug-Informationen an und aus.</para>
1165 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1166 <title>Konfiguration der Mandanten für den Task-Server</title>
1168 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1169 anschließend jeder Mandant, für den der Task-Server laufen soll,
1170 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1171 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1172 ausgewählt werden, unter der der Task-Server seine Arbeit
1175 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1176 wird der Task-Server für diesen Mandanten keine Aufgaben
1180 <sect2 id="Einbinden-in-den-Boot-Prozess">
1181 <title>Automatisches Starten des Task-Servers beim Booten</title>
1183 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1184 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1185 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1187 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1188 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1189 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1190 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1191 anstelle eines symbolischen Links verwendet werden können.</para>
1194 <title>SystemV-basierende Systeme (z.B. ältere Debian, ältere OpenSUSE,
1195 ältere Fedora)</title>
1197 <para>Kopieren Sie die Datei
1198 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1199 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1200 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1201 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1202 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1206 <para>Debian-basierende Systeme:</para>
1208 <programlisting>update-rc.d kivitendo-task-server defaults
1209 insserv kivitendo-task-server</programlisting>
1213 <para>Ältere OpenSUSE und ältere Fedora:</para>
1215 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1219 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1222 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1226 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1228 <para>Kopieren Sie die Datei
1229 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1230 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1231 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1232 <literal>exec ....</literal>).</para>
1234 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1237 <programlisting>service kivitendo-task-server start</programlisting>
1241 <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1242 Fedora, neuere Ubuntu und neuere Debians)</title>
1244 <para>Kopieren Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
1245 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeilen
1246 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>).</para>
1248 <para>Machen Sie anschließend das Script systemd bekannt, und binden Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden
1251 <programlisting>systemctl daemon-reload
1252 systemctl enable kivitendo-task-server.service</programlisting>
1254 <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt den Server neu zu starten, so können Sie das mit dem
1255 folgenden Befehl tun:</para>
1257 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1261 <sect2 id="Prozesskontrolle">
1262 <title>Wie der Task-Server gestartet und beendet wird</title>
1264 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1266 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1268 <para><literal>Befehl</literal> ist dabei eine der folgenden
1273 <para><literal>start</literal> startet eine neue Instanz des
1274 Task-Servers. Die Prozess-ID wird innerhalb des
1275 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1279 <para><literal>stop</literal> beendet einen laufenden
1284 <para><literal>restart</literal> beendet und startet ihn
1289 <para><literal>status</literal> berichtet, ob der Task-Server
1294 <para>Der Task-Server wechselt beim Starten automatisch in das
1295 kivitendo-Installationsverzeichnis.</para>
1297 <para>Dieselben Optionen können auch für die SystemV-basierenden
1298 Runlevel-Scripte benutzt werden (siehe oben).</para>
1302 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1303 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1305 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1306 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1308 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1309 <title>Grundlagen zur Benutzerauthentifizierung</title>
1311 <para>kivitendo verwaltet die Benutzerinformationen in einer
1312 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1313 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1314 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1315 können, müssen aber nicht unterschiedlich sein.</para>
1317 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1318 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1319 abgelegt werden.</para>
1321 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
1322 entweder gegen die Authentifizierungsdatenbank oder gegen einen
1323 LDAP-Server überprüft werden.</para>
1325 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1326 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1327 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1328 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1329 einer Version vor v2.6.0 angelegt werden. Eine
1330 Beispielkonfigurationsdatei
1331 <filename>config/kivitendo.conf.default</filename> existiert, die als
1332 Vorlage benutzt werden kann.</para>
1335 <sect2 id="Administratorpasswort">
1336 <title>Administratorpasswort</title>
1338 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1339 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1340 gespeichert. Es kann auch nur dort und nicht mehr im
1341 Administrationsinterface selber geändert werden. Der Parameter dazu
1342 heißt <varname>admin_password</varname> im Abschnitt
1343 <varname>[authentication]</varname>.</para>
1346 <sect2 id="Authentifizierungsdatenbank">
1347 <title>Authentifizierungsdatenbank</title>
1349 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1350 Parametern in <varname>[authentication/database]</varname>
1351 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1355 <term><literal>host</literal></term>
1358 <para>Der Rechnername oder die IP-Adresse des
1359 Datenbankservers</para>
1364 <term><literal>port</literal></term>
1367 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1372 <term><literal>db</literal></term>
1375 <para>Der Name der Authentifizierungsdatenbank</para>
1380 <term><literal>user</literal></term>
1383 <para>Der Benutzername, mit dem sich kivitendo beim
1384 Datenbankserver anmeldet (z.B.
1385 "<literal>postgres</literal>")</para>
1390 <term><literal>password</literal></term>
1393 <para>Das Passwort für den Datenbankbenutzer</para>
1398 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1399 automatisch anlegen (mehr dazu siehe unten).</para>
1402 <sect2 id="Passwortüberprüfung">
1403 <title>Passwortüberprüfung</title>
1405 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1406 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1407 Active-Directory-Server. Welche davon benutzt wird, regelt der
1408 Parameter <varname>module</varname> im Abschnitt
1409 <varname>[authentication]</varname>.</para>
1411 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1412 gespeichert werden, so muss der Parameter <varname>module</varname>
1413 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1414 der Administrator als auch die Benutzer selber ihre Passwörter in
1415 kivitendo ändern.</para>
1417 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1418 benutzt werden, so muss der Parameter <varname>module</varname> auf
1419 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1420 zusätzliche Informationen über den LDAP-Server im Abschnitt
1421 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1425 <term><literal>host</literal></term>
1428 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1429 Active-Directory-Servers. Diese Angabe ist zwingend
1430 erforderlich.</para>
1435 <term><literal>port</literal></term>
1438 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1443 <term><literal>tls</literal></term>
1446 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1447 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1448 ‘<literal>0</literal>’ belassen</para>
1453 <term><literal>attribute</literal></term>
1456 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1457 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1458 meist ‘<literal>sAMAccountName</literal>’, für andere
1459 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1460 zwingend erforderlich.</para>
1465 <term><literal>base_dn</literal></term>
1468 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1469 Diese Angabe ist zwingend erforderlich.</para>
1474 <term><literal>filter</literal></term>
1477 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1478 <literal><%login%></literal>, so wird dieses durch den vom
1479 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1480 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1481 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1486 <term><literal>bind_dn</literal> und
1487 <literal>bind_password</literal></term>
1490 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1491 durchsucht werden kann (z.B. ist dies bei
1492 Active-Directory-Servern der Fall), so kann diese hier angegeben
1493 werden. Für Active-Directory-Server kann als
1494 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1495 z.B. ‘<literal>cn=Martin
1496 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1497 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1498 also ‘<literal>Martin Mustermann</literal>’.</para>
1504 <sect2 id="Name-des-Session-Cookies">
1505 <title>Name des Session-Cookies</title>
1507 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1508 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1509 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1510 Parameter <varname>cookie_name</varname> im Abschnitt
1511 <varname>[authentication]</varname>gesetzt.</para>
1513 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1514 Server existiert.</para>
1517 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1518 <title>Anlegen der Authentifizierungsdatenbank</title>
1520 <para>Nachdem alle Einstellungen in
1521 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1522 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1523 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1524 der folgenden URL erreichbar sein sollte:</para>
1527 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1531 <sect1 id="Benutzer--und-Gruppenverwaltung">
1532 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1534 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1535 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1536 das Sie unter folgender URL finden:</para>
1539 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1541 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1542 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1544 <sect2 id="Zusammenhänge">
1545 <title>Zusammenhänge</title>
1547 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1548 in einer oder zwei Datenbanken gespeichert werden.</para>
1550 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1551 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1552 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1553 Diese Informationen werden in der Authentifizierungsdatenbank
1554 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1555 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1556 gespeichert werden.</para>
1558 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1559 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1560 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1561 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1562 einer solchen Mandantendatenbank werden im Administrationsbereich
1563 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1564 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1566 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1567 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1568 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1569 mehr als einem Mandanten, wird empfohlen, für die
1570 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1571 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1574 <sect2 id="Mandanten-Benutzer-Gruppen">
1575 <title>Mandanten, Benutzer und Gruppen</title>
1577 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1578 die sich frei zueinander zuordnen lassen.</para>
1580 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1581 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1582 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1583 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1584 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1585 Diese sollte über die <link
1586 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1589 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1590 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1591 der Administrator fest, an welchen Mandanten sich ein Benutzer
1592 anmelden kann, was beim Login verifiziert wird.</para>
1594 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1595 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1596 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1597 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1598 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1599 dann an einem Mandanten an, so erhält er alle Rechte von allen
1600 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1601 denen der Benutzer zum Anderen Mitglied ist,</para>
1603 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1604 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1605 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1607 <orderedlist numeration="arabic">
1609 <para>Datenbank anlegen</para>
1613 <para>Gruppen anlegen</para>
1617 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1621 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1626 <sect2 id="Datenbanken-anlegen">
1627 <title>Datenbanken anlegen</title>
1629 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1630 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1631 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1634 <sect2 id="Gruppen-anlegen">
1635 <title>Gruppen anlegen</title>
1637 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1638 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1639 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1640 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1642 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1643 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1644 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1645 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1646 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1647 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1648 A, B und C gültig").</para>
1650 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1651 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1652 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1653 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1654 Gruppen A, B und C").</para>
1657 <sect2 id="Benutzer-anlegen">
1658 <title>Benutzer anlegen</title>
1660 <para>Beim Anlegen von Benutzern werden für viele Parameter
1661 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1662 deutschen Raumes entsprechen.</para>
1664 <para>Zwingend anzugeben ist der Loginname. Wenn die
1665 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
1666 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
1667 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1670 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
1671 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
1672 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
1673 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
1674 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
1675 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
1676 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
1677 sind Benutzer A, B und C Mitglieder").</para>
1680 <sect2 id="Mandanten-anlegen">
1681 <title>Mandanten anlegen</title>
1683 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
1684 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
1685 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
1686 einer der eben angelegten Datenbanken eingetragen werden.</para>
1688 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
1689 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
1690 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
1691 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
1692 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
1693 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
1694 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
1695 Gruppe ist für Mandanten A, B und C gültig").</para>
1699 <sect1 id="Drucker--Systemverwaltung">
1700 <title>Drucker- und Systemverwaltung</title>
1702 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
1703 Druckeradministration und System.</para>
1705 <sect2 id="Druckeradministration">
1706 <title>Druckeradministration</title>
1708 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
1709 viele "Druckbefehle" im System verwalten. Diese Befehle werden
1710 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
1711 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
1712 angezeigt wird.</para>
1714 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
1715 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
1716 meinDrucker' oder ein kompletter Pfad zu einem Skript
1717 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
1718 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
1719 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
1720 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
1721 Ausdruck eines Angebots folgende Vorlage geparst:
1722 sales_quotation_epson_drucker.tex.</para>
1726 <title>System sperren / entsperren</title>
1728 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
1729 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
1730 gesamten kivitendo Installation gesperrt.</para>
1732 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
1733 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
1734 Wartungsarbeiten nicht zugänglich.'.</para>
1736 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
1737 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
1738 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
1739 inkonsistenten Datenbestand weitergearbeitet werden.</para>
1743 <sect1 id="config.sending-email"
1744 xreflabel="E-Mail-Versand aus kivitendo heraus">
1745 <title>E-Mail-Versand aus kivitendo heraus</title>
1747 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
1748 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
1749 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
1750 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
1751 Versand über einen lokalen E-Mail-Server (z.B. mit
1752 <productname>Postfix</productname> oder <productname>Exim</productname>,
1753 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
1754 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
1756 <para>Welche Methode und welcher Server verwendet werden, wird über die
1757 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1758 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
1759 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1761 <sect2 id="config.sending-email.sendmail"
1762 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1763 <title>Versand über lokalen E-Mail-Server</title>
1765 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
1766 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
1767 <productname>Postfix</productname>, <productname>Exim</productname>
1768 oder <productname>Sendmail</productname> läuft.</para>
1770 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1771 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1772 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1774 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
1775 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
1776 Standardwert verweist auf das Programm
1777 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1778 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1780 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
1781 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
1785 <sect2 id="config.sending-email.smtp"
1786 xreflabel="E-Mail-Versand über einen SMTP-Server">
1787 <title>Versand über einen SMTP-Server</title>
1789 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
1790 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
1793 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1794 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1795 Parameter dienen dabei der weiteren Konfiguration:</para>
1799 <term><varname>hostname</varname></term>
1802 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
1803 '<literal>localhost</literal>'</para>
1808 <term><varname>port</varname></term>
1811 <para>Portnummer. Der Standardwert hängt von der verwendeten
1812 Verschlüsselungsmethode ab. Gilt '<literal>security =
1813 none</literal>' oder '<literal>security = tls</literal>', so ist
1814 25 die Standardportnummer. Für '<literal>security =
1815 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
1816 geändert werden.</para>
1821 <term><varname>security</varname></term>
1824 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
1825 mit dem Server. Standardwert ist '<literal>none</literal>',
1826 wodurch keine Verschlüsselung verwendet wird. Mit
1827 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
1828 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
1829 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
1830 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
1831 (siehe unten).</para>
1836 <term><varname>login</varname> und
1837 <varname>password</varname></term>
1840 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
1841 so können mit diesen zwei Parametern der Benutzername und das
1842 Passwort angegeben werden. Wird Authentifizierung verwendet, so
1843 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
1844 aktiviert werden.</para>
1851 <sect1 id="Drucken-mit-kivitendo">
1852 <title>Drucken mit kivitendo</title>
1854 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
1855 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1856 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1857 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
1859 <para><programlisting>apt-get install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1860 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1862 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
1864 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
1865 texlive-collection-latexrecommended texlive-collection-langgerman \
1866 texlive-collection-langenglish</programlisting></para>
1868 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
1870 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
1871 texlive-collection-latexrecommended texlive-collection-langgerman \
1872 texlive-collection-langenglish</programlisting></para>
1874 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1886 <para>rev-odt</para>
1890 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version
1891 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
1893 <sect2 id="Vorlagenverzeichnis-anlegen"
1894 xreflabel="Vorlagenverzeichnis anlegen">
1895 <title>Vorlagenverzeichnis anlegen</title>
1897 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
1898 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1900 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1902 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
1903 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
1904 <xref linkend="Gruppen-anlegen"/>.</para>
1906 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
1907 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
1908 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
1909 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1913 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
1914 Vorlagensatz aus, der kopiert werden soll
1915 (<filename>RB</filename>, <filename>f-tex</filename> oder
1916 <filename>odt-rev</filename>.)</para>
1920 <para><option>Neuer Name</option>: Der Verzeichnisname für den
1921 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
1922 für Verzeichnisnamen frei gewählt werden.</para>
1926 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
1927 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
1928 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1929 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
1930 vorgenommen werden. Den Ordner findet man im Dateisystem unter
1931 <filename>./templates/[Neuer Name]</filename></para>
1934 <sect2 id="Vorlagen-RB">
1935 <title>Der Druckvorlagensatz RB</title>
1937 <para>Hierbei handelt es sich um einen vollständigen LaTeX
1938 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
1939 sind nicht gepflegt.</para>
1941 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
1942 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1943 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
1944 eigenen Firmendaten finden sich in der Datei Readme.tex im
1945 Vorlagenverzeichnis.</para>
1947 <para>Eine kurze Übersicht der Features:</para>
1951 <para>Mehrsprachenfähig, mit Deutscher und Englischer
1956 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
1957 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
1962 <para>mehrere vordefinierte Varianten für
1963 Logos/Hintergrundbilder</para>
1967 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
1968 "Außerhalb EU"</para>
1974 <title>f-tex</title>
1976 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur
1977 Verfügung stellt.</para>
1979 <sect3 id="f-tex-Feature-Übersicht">
1980 <title>Feature-Übersicht</title>
1984 <para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage
1985 für alle briefartigen Dokumente verwendet. Also Angebot,
1986 Rechnung, Proformarechnung, Lieferschein, aber eben nicht für
1987 Paketaufkleber etc.</para>
1991 <para>Leichte Anpassung an das Firmen-Layout durch Verwendung
1992 eines Hintergrund-PDFs. Dieses kann leicht mit dem eigenen
1993 Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp,
1998 <para>Hintergrund-PDF umschaltbar auf "nur erste Seite"
1999 (Standard) oder "alle Seiten" (Option
2000 "<option>bgPdfFirstPageOnly</option>" in Datei
2001 <filename>letter.lco</filename>)</para>
2005 <para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem
2006 Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
2007 versendeten Dokumenten eingebunden (Option
2008 "<option>bgPdfEmailOnly</option>" in Datei
2009 <filename>letter.lco</filename>).</para>
2013 <para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch,
2014 Wiederholung von Kopfzeilen, Zwischensummen etc. (danke an
2015 Kai-Martin Knaak für die Vorarbeit)</para>
2019 <para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom
2020 Land des eigenen Unternehmens abweicht (also die Rechnung das
2021 Land verlässt).</para>
2025 <para>Multisprachfähig leicht um weitere Sprachen zu erweitern,
2026 alle Übersetzungen in der Datei
2027 <filename>translatinos.tex</filename>.</para>
2031 <para>Auflistung von Bruttopreisen für Endverbraucher.</para>
2036 <sect3 id="f-tex-Installation">
2037 <title>Die Installation</title>
2041 <para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref
2042 linkend="Vorlagenverzeichnis-anlegen"/>. Das Vorlagensystem
2043 funktioniert jetzt schon, hat allerdings noch einen
2044 Beispiel-Briefkopf.</para>
2048 <para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
2049 <filename>./letter_head.pdf</filename>.</para>
2053 <para>Editiere den Bereich "<option>settings</option>" in der
2054 datei <filename>letter.lco</filename>.</para>
2058 <para>oder etwas detaillierter:</para>
2060 <para>Es wird eine Datei <filename>sample.lco</filename> erstellt
2061 und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
2062 ist dies die Datei die für die firmenspezifischen Anpassungen
2063 gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist,
2064 wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle
2065 über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und
2066 <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung
2067 über eine <filename>*.lco</filename>-Datei, die letztlich auf
2068 <filename>letter.lco</filename> verlinkt ist ist aber auch
2071 <para>Es wird eine Datei <filename>sample_head.pdf</filename> mit
2072 ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
2073 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage.
2074 Schau Dir nach Abschluss der Installation die Datei
2075 <filename>sample_head.pdf</filename> an und erstelle ein
2076 entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
2077 Template Verzeichniss ablegen und statt
2078 <filename>sample_head.pdf</filename> nach
2079 <filename>letter_head.pdf</filename> verlinken.</para>
2081 <para>Letzlich muss <filename>letter_head.pdf</filename> auf das
2082 passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
2085 <para>Es wird eine Datei <filename>mydata.tex.example</filename>
2086 ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
2087 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das
2088 Land verwendet. Die Datei muss also nicht angefasst werden. Die
2089 anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit
2090 nicht im öffentlichen Zweig).</para>
2092 <para>Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
2093 sollten über die Hintergrund-PDF-Datei oder die
2094 <filename>*.lco</filename>-Datei erfolgen.</para>
2097 <sect3 id="f-tex-Funktionsübersicht">
2098 <title>f-tex Funktionsübersicht</title>
2100 <para>Das Konzept von kivitendo sieht vor, für jedes Dokument
2101 (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
2102 LaTeX-Vorlage vorzuhalten, dies ist sehr wartungsunfreundlich. Auch
2103 das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
2104 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen
2105 aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
2106 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
2107 LaTeX-Vorlage verwendet, welche über Codeweichen die Besonderheiten
2108 der jeweiligen Dokumente berücksichtigt:</para>
2112 <para>Tabellen mit oder ohne Preis</para>
2116 <para>Sprache der Tabellenüberschriften etc.</para>
2120 <para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
2121 Angebotsnummer)</para>
2125 <para>Darstellung von Brutto oder Netto-Preisen in der
2126 Auflistung (Endverbraucher versus gewerblicher Kunde)</para>
2130 <para>Nachteil:</para>
2132 <para>LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei
2133 <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
2134 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder
2135 geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch
2136 innerhalb der Tabellendarstellung gut persönliche Anpassungen
2137 vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell
2138 heftig in den Fuss schiessen.</para>
2140 <para>Wer nicht so tief in die Materie einsteigen will oder leicht
2141 zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
2142 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen,
2143 und sich an der Form der dargestellten Tabellen, wie sie
2144 ausgeliefert werden, erfreuen.</para>
2146 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine,
2147 kontinuierliche Schritte gehen.</para>
2150 <sect3 id="f-tex-Bruttopreise">
2151 <title>Bruttopreise für Endverbraucher</title>
2153 <para>Der auszuweisende Bruttopreis wird innerhalb der
2154 LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen
2155 "alle Preise Brutto" auszuwählen, aber:</para>
2159 <para>hierfür müssen die Preise auch in Brutto in der Datenbank
2160 stehen (ja - das lässt sich über die Preisgruppen und die
2161 Zuordung einer Default-Preisgruppe handhaben)</para>
2165 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses
2166 Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
2167 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche
2172 <para>Es gibt mit f-tex eine weitere Alternative. Die Information ob
2173 Brutto oder Nettorechnung wird mit den Zahlarten verknüpft.
2174 Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben
2175 werden sollen, enden mit "_E" (für Endverbraucher). Falls identische
2176 Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt
2177 man diese einfach doppelt an (einmal mit der Namensendung "_E").
2182 <para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist
2183 nicht mehr fix mit einer Preisliste verbunden.</para>
2187 <para>Die Default-Zahlart kann im Kundendatensatz hinterlegt
2188 werden, und man muss nicht mehr daran denken, "alle Preise
2189 Netto" auszuwählen.</para>
2193 <para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen
2194 werden, kann direkt beim Drucken revidiert werden, ohne dass
2195 sich der Auftragswert ändert.</para>
2200 <sect3 id="f-tex-lieferadressen">
2201 <title>Lieferadressen</title>
2203 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen
2204 im Adressfeld zum Einsatz. Wenn die
2205 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende
2206 Adressvariable eingesetzt. Wenn also die Lieferadresse in Straße,
2207 Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
2208 Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert
2209 der Hauptadresse angezeigt.</para>
2213 <sect2 id="Vorlagen-rev-odt">
2214 <title>Der Druckvorlagensatz rev-odt</title>
2216 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2217 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2218 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2219 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2220 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2221 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2222 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2224 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2225 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2226 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2227 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2228 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2229 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2231 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2232 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2233 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2234 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2235 die vom Parser nicht korrekt gelesen werden kann.</para>
2237 <para>Mahnungen können unter folgenden Einschränkungen mit den odt-Vorlagen
2238 im Vorlagensatz rev-odt erzeugt werden:</para>
2242 <para>als Druckoption steht nur 'PDF(OpenDocument/OASIS)' zur
2243 Verfügung, das heisst, die Mahnungen werden als PDF-Datei ausgegeben.
2248 <para>für jede Rechnung muss eine eigene Mahnung erzeugt werden
2249 (auch wenn bei einzelnen KundInnen mehrere überfällige Rechnungen
2250 vorhanden sind).</para>
2254 <para>Mehrere Mahnungen für eine Kundin / einen Kunden werden zu einer
2255 PDF-Datei zusammengefasst</para>
2257 <para>Die Vorlagen zahlungserinnerung.odt sowie mahnung.odt sind für das
2258 Erstellen einer Zahlungserinnerung bzw. Mahnung selbst vorgesehen, die
2259 Vorlage mahnung_invoice.odt für das Erstellen einer Rechnung über die
2260 verrechneten Mahngebühren und Verzugszinsen.</para>
2262 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2263 odt-Vorlagen bei Briefen und Pflichtenheften einzusetzen.
2264 Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2266 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2267 empfang@revamp-it.ch</para>
2270 <sect2 id="allgemeine-hinweise-zu-latex">
2271 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2273 <para>In den allermeisten Installationen sollte das Drucken jetzt
2274 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2275 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2276 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2277 sind zum Beispiel:</para>
2281 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2282 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2283 allem bei Vorlagen aus der Community auf. Installieren Sie die
2284 entsprechenden Pakete.</para>
2288 <para>! Package inputenc Error: Unicode char \u8:... set up for
2289 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2290 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2291 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2292 diversen Tricks dazu gebracht werden andere Zeichen zu
2293 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2298 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2299 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2300 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2301 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2302 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2305 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2306 verifizieren lässt:</para>
2310 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2311 "keep_temp_files" auf 1</para>
2313 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2317 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2321 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2325 <para>wechsel in das users Verzeichnis von kivitendo</para>
2327 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2331 <para>LaTeX Suchpfad anpassen:</para>
2333 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2337 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2340 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2342 <para>Es sollte die letzte Datei ganz unten sein</para>
2346 <para>für besseren Hinweis auf Fehler texdatei nochmals
2349 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2351 <para>in der *.tex datei nach dem Fehler suchen.</para>
2357 <sect1 id="OpenDocument-Vorlagen">
2358 <title>OpenDocument-Vorlagen</title>
2360 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2361 OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2) erzeugen.
2362 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
2363 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2364 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2365 <filename>config/kivitendo.conf</filename> die Variable
2366 <literal>opendocument</literal> im Abschnitt
2367 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2368 Dieses ist die Standardeinstellung.</para>
2370 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2371 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2372 LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt werden, so muss
2373 neben LibreOffice oder OpenOffice auch der “X virtual frame buffer”
2374 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
2375 Andere Distributionen enthalten ihn in anderen Paketen.</para>
2377 <para>Nach der Installation müssen in der Datei
2378 <filename>config/kivitendo.conf</filename> im Abschnitt
2379 <literal>applications</literal> zwei weitere Variablen
2380 angepasst werden:</para>
2381 <para><literal>openofficeorg_writer</literal> muss den
2382 vollständigen Pfad zu LibreOffice oder OpenOffice enthalten.
2383 Dabei dürfen keine Anführungszeichen eingesetzt werden.</para>
2384 <para>Beispiel für Debian oder Ubuntu:</para>
2385 <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2386 <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2389 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2390 LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die benutzt
2391 wird, wenn die Variable <literal>$openofficeorg_daemon</literal> gesetzt
2392 ist, startet ein LibreOffice oder OpenOffice, das auch nach der Umwandlung
2393 des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen wird dann diese
2394 laufende Instanz benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung
2395 deutlich reduziert wird, weil nicht für jedes Dokument ein LibreOffice bzw.
2396 OpenOffice gestartet werden muss. Der Nachteil ist, dass diese Methode
2397 Python und die Python-UNO-Bindings benötigt, die Bestandteil von LibreOffice
2398 bzw. OpenOffice sind.</para>
2401 <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2402 normalerweise der Python-Interpreter
2403 <filename>/usr/bin/python</filename> benutzt.
2404 Sollte dies nicht der richtige sein, so kann man mit zwei
2405 Konfigurationsvariablen entscheiden, welcher Python-Interpreter
2406 genutzt wird. Mit der Option <literal>python_uno</literal> aus dem
2407 Abschnitt <literal>applications</literal> wird der Interpreter selber
2408 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2409 <literal>/usr/bin/python</literal>.</para>
2411 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2412 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2413 z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2414 OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2415 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2416 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2417 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2418 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2419 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2423 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2424 wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet
2425 und die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses
2426 Makro muss in der Dokumentenvorlage enthalten sein und
2427 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2428 ‘<literal>templates/print/rev-odt/invoice.odt</literal>’
2429 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
2430 ebenfalls enthalten sein muss.</para>
2432 <para>Als letztes muss herausgefunden werden, welchen Namen
2433 OpenOffice bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen
2434 gibt. Unter Debian ist dies momentan
2435 <literal>~/.config/libreoffice</literal>. kivitendo verwendet das
2436 Verzeichnis <literal>users/.openoffice.org2</literal>.
2437 Eventuell muss dieses Verzeichnis umbenannt werden.</para>
2439 <para>Dieses Verzeichnis, wie auch das komplette
2440 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2441 sein. Dieses wurde bereits erledigt (siehe <xref
2442 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber
2443 erneut überprüft werden, wenn die Konvertierung nach PDF
2447 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2449 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2450 Aufgaben erfüllen.</para>
2452 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2453 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2454 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2455 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2456 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2457 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2458 Anpassungen aufgeführt</emphasis>):</para>
2461 <title>Bezeichnung der Vorlagen</title>
2463 <para>Rechnung: invoice_besr.odt, Auftrag:
2464 sales_order_besr.odt</para>
2468 <title>Vorbereitungen im Adminbereich</title>
2470 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2471 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2472 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2473 ein Drucker eingerichtet werden:</para>
2477 <para>Druckeradministration → Drucker hinzufügen</para>
2481 <para>Mandant wählen</para>
2485 <para>Druckerbeschreibung → aussagekräftiger Text: wird in
2486 der Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B.
2487 mit Einzahlungsschein Bank xy)</para>
2491 <para>Druckbefehl → beliebiger Text (hat für das Erzeugen
2492 von Aufträgen oder Rechnungen als odt-Datei keine Bedeutung,
2493 darf aber nicht leer sein)</para>
2497 <para>Vorlagenkürzel → besr bzw. selbst gewähltes
2498 Vorlagensuffix (muss genau der Zeichenfolge entsprechen, die
2499 zwischen "invoice_" bzw. "sales_order_" und ".odt"
2504 <para>speichern</para>
2510 <title>Benutzereinstellungen</title>
2512 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2513 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2514 dies persönlich für sich bei den Benutzereinstellungen
2515 konfigurieren:</para>
2519 <para>Programm → Benutzereinstellungen →
2520 Druckoptionen</para>
2524 <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2528 <para>Standardausgabekanal → Bildschirm</para>
2532 <para>Standarddrucker → gewünschte Druckerbeschreibung
2533 auswählen (z.B. mit Einzahlungsschein Bank xy)</para>
2537 <para>Anzahl Kopien → leer</para>
2541 <para>speichern</para>
2547 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2549 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2550 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2551 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2552 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2557 <para>Für den Einzahlungsschein ist die letzte Seite des
2558 Dokuments reserviert</para>
2562 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2563 Zeile mit folgenden Angaben (<emphasis
2564 role="bold">Bank-Konto-Identifikationsnummer und
2565 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2566 Bank angepasst werden</emphasis>):<itemizedlist>
2568 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2569 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2571 <para>erster Wert: <emphasis
2572 role="bold">Bank-Konto-Identifikation</emphasis>
2573 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2574 angepasst werden</emphasis>.</para>
2578 <para>zweiter Wert: <%customernumber%>
2579 (Kundennummer: nur Ziffern, maximal 6)</para>
2583 <para>dritter Wert: <%ordnumber%>
2584 (Auftragsnummer bei Auftragsvorlage
2585 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2586 führende Buchstaben werden vom Makro entfernt</para>
2590 <para>vierter Wert: <%invnumber%>
2591 (Rechnungsnummer bei Rechnungsvorlage
2592 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2593 führende Buchstaben werden vom Makro entfernt</para>
2595 </itemizedlist></para>
2599 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2600 Bank, muss angepasst werden</emphasis>.</para>
2604 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2605 falls Einzahlungsschein ohne Betrag</para>
2609 <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2611 </itemizedlist></para>
2615 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2616 der Name und die Adresse der Bank, die Postkonto-Nummer der
2617 Bank, sowie der eigene Firmenname und die Firmenadresse
2618 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2619 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2620 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2626 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2627 ändernde Einträge in rot</screeninfo>
2631 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2638 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2639 odt-Rechnung (analog bei Auftrag)</title>
2641 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2642 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2643 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2644 den Benutzereinstellungen als persönlicher Standard gewählt
2649 <title>Makroeinstellungen in LibreOffice anpassen</title>
2651 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2652 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2653 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2654 angepasst werden:</para>
2658 <para>Extras → Optionen → Sicherheit →
2659 Makrosicherheit</para>
2663 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2664 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2665 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2670 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2671 der entsprechenden Nachfrage "Makros ausführen" auswählen.
2674 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2675 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2676 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2677 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2685 <sect1 id="nomenclature">
2686 <title>Nomenklatur</title>
2688 <sect2 id="booking.dates">
2689 <title>Datum bei Buchungen</title>
2691 <para>Seit der Version 3.5 werden für Buchungen in kivitendo einheitlich
2692 folgende Bezeichnungen verwendet:</para>
2696 <para><option>Erfassungsdatum</option> (en: <option>Entry Date</option>,
2697 code: <option>Gldate</option>)</para>
2699 <para>bezeichnet das Datum, an dem die Buchung in kivitendo erfasst wurde.
2704 <para><option>Buchungsdatum</option> (en: <option>Booking Date</option>,
2705 code: <option>Transdate</option>)</para>
2707 <para>bezeichnet das buchhaltungstechnisch für eine Buchung relevante
2710 <para>Das <option>Rechnungsdatum</option> bei Verkaufs- und
2711 Einkaufsrechnungen entspricht dem Buchungsdatum. Das heisst, in
2712 Berichten wie dem Buchungsjournal, in denen eine Spalte
2713 <option>Buchungsdatum</option> angezeigt werden kann, erscheint hier
2714 im Fall von Rechnungen das Rechnungsdatum.</para>
2718 <para>Bezieht sich ein verbuchter Beleg auf einen Zeitpunkt, der nicht mit
2719 dem Buchungsdatum übereinstimmt, so kann dieses Datum momentan in kivitendo
2720 nur unter Bemerkungen erfasst werden.</para>
2722 <para>Möglicherweise wird für solche Fälle in einer späteren Version von
2723 kivitendo ein dritter Datumswert für Buchungen erstellt. (Beispiel:
2724 Einkaufsbeleg stammt aus einem früheren Jahr, das bereits
2725 buchhaltungstechnisch abgeschlossen wurde, und muss deshalb später
2726 verbucht werden.)</para>
2732 <sect1 id="config.eur">
2733 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
2736 <sect2 id="config.eur.introduction"
2737 xreflabel="Einführung in die Konfiguration zur EUR">
2738 <title>Einführung</title>
2740 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
2741 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
2742 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
2743 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
2744 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
2746 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
2747 die Mandantendatenbank verschoben und dabei auch gleich in drei
2748 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
2749 steuern lässt.</para>
2752 <sect2 id="config.eur.parameters"
2753 xreflabel="Konfigurationsparameter für EUR">
2754 <title>Konfigurationsparameter</title>
2756 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
2757 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
2761 <term><varname>profit_determination</varname></term>
2764 <para>Dieser Parameter legt die Berechnungsmethode für die
2765 Gewinnermittlung fest. Er enthält entweder
2766 <literal>balance</literal> für
2767 Betriebsvermögensvergleich/Bilanzierung oder
2768 <literal>income</literal> für die
2769 Einnahmen-Überschuss-Rechnung.</para>
2774 <term><varname>accounting_method</varname></term>
2777 <para>Dieser Parameter steuert die Buchungs- und
2778 Berechnungsmethoden für die Versteuerungsart. Er enthält
2779 entweder <literal>accrual</literal> für die Soll-Versteuerung
2780 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
2785 <term><varname>inventory_system</varname></term>
2788 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
2789 enthält entweder <literal>perpetual</literal> für die
2790 Bestandsmethode oder <literal>periodic</literal> für die
2791 Aufwandsmethode.</para>
2796 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
2797 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
2798 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
2799 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
2800 Bestandsmethode.</para>
2802 <para>Die Konfiguration "<varname>eur</varname>" unter
2803 <varname>[system]</varname> in der <link
2804 linkend="config.config-file">Konfigurationsdatei</link>
2805 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
2806 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
2809 <sect2 id="config.eur.setting-parameters">
2810 <title>Festlegen der Parameter</title>
2812 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
2813 der Admininstration können diese Optionen nun unabhängig voneinander
2814 eingestellt werden.</para>
2816 <para>Für die Schweiz sind folgende Einstellungen üblich:
2819 <para>Sollversteuerung</para>
2822 <para>Aufwandsmethode</para>
2825 <para>Bilanzierung</para>
2828 Diese Einstellungen werden automatisch beim Erstellen einer neuen
2829 Datenbank vorausgewählt, wenn in <filename>config/kivitendo.conf</filename> unter
2830 <varname>[system]</varname> <literal>default_manager = swiss</literal> eingestellt ist.
2833 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
2834 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
2837 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
2838 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
2839 angezeigt. Unter <guimenu>System</guimenu> →
2840 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
2841 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
2842 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
2843 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
2844 auch <link linkend="config.eur.inventory-system-perpetual">
2845 Bemerkungen zur Bestandsmethode</link>).</para>
2848 <sect2 id="config.eur.inventory-system-perpetual">
2849 <title>Bemerkungen zur Bestandsmethode</title>
2851 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
2852 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
2853 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
2854 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
2855 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
2856 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
2857 Einkaufsrechnungen berechnet wird.</para>
2859 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
2860 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
2861 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
2865 <sect2 id="config.eur.knonw-issues">
2866 <title>Bekannte Probleme</title>
2868 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
2869 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
2870 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
2871 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
2872 die Konfigurationsvariable
2873 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
2876 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
2877 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
2881 <sect1 id="config.skr04-update-3804">
2882 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
2884 <sect2 id="config.skr04-update-3804.introduction">
2885 <title>Einführung</title>
2887 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
2888 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
2889 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
2890 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
2891 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
2892 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
2893 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
2894 vielleicht schon selbst geholfen hat und mit seinen Änderungen
2895 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
2896 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
2897 Screenshots dargestellt.</para>
2899 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
2900 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
2901 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
2902 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
2905 <sect2 id="config.skr04-update-3804.create-chart">
2906 <title>Konto 3804 manuell anlegen</title>
2908 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
2909 anzulegen und zu konfigurieren. Zuerst wird in
2910 <guimenu>System</guimenu> →
2911 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konto
2912 erfassen</guimenuitem> das Konto angelegt.</para>
2915 <screeninfo>Konto 3804 erfassen</screeninfo>
2919 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
2924 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
2925 werden. Dazu unter <guimenu>System</guimenu> →
2926 <guisubmenu>Steuern</guisubmenu> →
2927 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
2928 13 auswählen und ihn wie im folgenden Screenshot angezeigt
2932 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
2936 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
2941 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
2942 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
2943 <guisubmenu>Steuern</guisubmenu> →
2944 <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem
2945 Screenshot übernehmen.</para>
2948 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
2952 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
2957 <para>Als Nächstes sind alle Konten anzupassen, die als
2958 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
2959 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
2960 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
2961 müssen Sie dazu unter <guimenu>System</guimenu> →
2962 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
2963 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
2964 wie im Screenshot gezeigt vornehmen.</para>
2967 <screeninfo>Konto 4315 anpassen</screeninfo>
2971 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
2976 <para>Als Letztes sollte die Steuerliste unter
2977 <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
2978 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
2979 Vergleich der Screenshot.</para>
2982 <screeninfo>Steuerliste vergleichen</screeninfo>
2986 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
2993 <sect1 id="config.bilanz">
2994 <title>Verhalten des Bilanzberichts</title>
2996 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
2997 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
2998 monatsweise führt dies zu falschen Werten.</para>
3000 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
3001 einstellen indem man:</para>
3005 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
3010 <para>immer den Jahresanfang nimmt (1.1. relativ zum
3015 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
3017 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3020 <para>- oder mit "alle Buchungen" als Alternative"</para>
3024 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3029 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
3033 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
3034 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
3035 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
3036 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
3037 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
3038 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
3039 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
3040 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
3041 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
3042 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
3043 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
3044 Erfolgsrechnung.</para>
3047 <sect1 id="config.erfolgsrechnung">
3048 <title>Erfolgsrechnung</title>
3050 <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht <emphasis role="bold">
3051 Erfolgsrechnung</emphasis>.</para>
3053 <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter Features
3054 an- oder abgeschaltet werden. Mit der Einstellung <varname>default_manager = swiss
3055 </varname> in der <filename>config/kivitendo.conf</filename> wird beim neu Erstellen
3056 einer Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü <guimenu>Berichte
3057 </guimenu> ausgewählt und ersetzt dort die GUV.</para>
3059 <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche Aufwands- und
3060 Erlöskonten einzeln aufgelistet (analog zur Bilanz), sortiert nach ERTRAG und AUFWAND.</para>
3062 <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der Erfolgsrechnung
3063 erscheinen soll, unter <varname>Sonstige Einstellungen/Erfolgsrechnung</varname>
3064 entweder <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal> ausgewählt
3067 <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal> ausgewählt,
3068 so wird dieses Konto als Aufwandsminderung unter AUFWAND aufgelistet.</para>
3070 <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal> ausgewählt,
3071 so wird dieses Konto als Ertragsminderung unter ERTRAG aufgelistet.</para>
3073 <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft zusätzlich
3074 die Erfolgsrechnung als Bericht verwendet werden, so müssen die Einstellungen
3075 zu allen Erlös- und Aufwandskonten unter <varname>Sonstige
3076 Einstellungen/Erfolgsrechnung</varname> überprüft und allenfalls neu gesetzt werden.</para>
3079 <sect1 id="config.rounding">
3080 <title>Rundung in Verkaufsbelegen</title>
3082 <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert von 5 Rappen (0.05 CHF).</para>
3084 <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer Genauigkeit
3085 von 0.01 CHF verwendet werden können, ist es trotzdem nach wie vor üblich,
3086 Rechnungen mit auf 0.05 CHF gerundeten Beträgen auszustellen.</para>
3088 <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine solche
3089 Rundung pro Mandant / Datenbank festgelegt werden.</para>
3091 <para>Die Einstellung wird beim Erstellen der Datenbank bei <literal>Genauigkeit</literal>
3092 festgelegt. Sie kann anschliessend über das Webinterface von kivitendo nicht mehr
3093 verändert werden.</para>
3095 <para>Abhängig vom Wert für <varname>default_manager</varname> in
3096 <filename>config/kivitendo.conf</filename> werden dabei folgende
3097 Werte voreingestellt:</para>
3100 <para>0.05 (default_manager = swiss)</para>
3103 <para>0.01 (default_manager = german)</para>
3106 <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
3107 </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
3109 <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
3110 und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet,
3111 wenn dieser nicht der eingestellten Genauigkeit entspricht.</para>
3113 <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
3114 automatisch auf die in der Mandantenkonfiguration festgelegten
3115 Standardkonten für Rundungserträge bzw. Rundungsaufwendungen gebucht.</para>
3117 <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr verändert.)</para>
3119 <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
3120 <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
3121 <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
3123 <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege
3124 in anderen Währungen als der Standardwährung erstellt, so muss in
3125 kivitendo ab Version 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
3126 <para>Das heisst, Firmen in der Schweiz, die teilweise Verkaufsrechnungen
3127 in Euro oder anderen Währungen erstellen wollen, müssen beim Erstellen
3128 der Datenbank als Genauigkeit 0.01 wählen und können zur Zeit die
3129 5er Rundung noch nicht nutzen.</para>
3132 <sect1 id="config.client">
3133 <title>Einstellungen pro Mandant</title>
3135 <para>Einige Einstellungen können von einem Benutzer mit dem <link
3136 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
3137 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
3138 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3139 Die Einstellungen sind unter <guimenu>System</guimenu> →
3140 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3142 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3143 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3144 geändert werden (siehe auch <link
3145 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3146 Bestandsmethode</link>).</para>
3148 <para>Die Einstellungen <literal>show_bestbefore</literal> und
3149 <literal>payments_changeable</literal> aus dem Abschnitt
3150 <literal>features</literal> und die Einstellungen im Abschnitt
3151 <literal>datev_check</literal> (sofern schon vorhanden) der <link
3152 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3153 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3154 Diese Einträge können danach aus der Konfigurationsdatei entfernt
3158 <sect1 id="kivitendo-ERP-verwenden">
3159 <title>kivitendo ERP verwenden</title>
3161 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3162 folgender URL erreichbar:</para>
3165 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3167 <para>Die Administrationsseite erreichen Sie unter:</para>
3170 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3174 <chapter id="features" xreflabel="Features und Funktionen">
3175 <title>Features und Funktionen</title>
3177 <sect1 id="features.periodic-invoices"
3178 xreflabel="Wiederkehrende Rechnungen">
3179 <title>Wiederkehrende Rechnungen</title>
3181 <sect2 id="features.periodic-invoices.introduction"
3182 xreflabel="Einführung in wiederkehrende Rechnungen">
3183 <title>Einführung</title>
3185 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3186 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3187 Die konfigurierten Aufträge werden später automatisch in Rechnungen
3188 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3189 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3190 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3191 wiederzufinden sind.</para>
3194 <sect2 id="features.periodic-invoices.configuration"
3195 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3196 <title>Konfiguration</title>
3198 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3199 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3200 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3201 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3202 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3205 <para>Folgende Parameter kann man konfigurieren:</para>
3212 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3213 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3214 eines neuen Monats).</para>
3216 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3217 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3218 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3219 nächsten Periodenwechsel für alle Perioden, seit der letzten
3220 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3221 verhindern, muss man vorher das Startdatum neu setzen.</para>
3223 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3224 erstellt. Man kann sich diese Aufträge aber gesondert in den
3225 Berichten anzeigen lassen.</para>
3230 <term>Periodizität</term>
3233 <para>Ob monatlich, quartalsweise oder jährlich auf neue
3234 Rechnungen überprüft werden soll. Für jede Periode seit dem
3235 Startdatum wird überprüft, ob für die Periode (beginnend immer
3236 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3237 wurde. Unter Umständen können bei einem Startdatum in der
3238 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3243 <term>Buchen auf</term>
3246 <para>Das Forderungskonto, in der Regel "Forderungen aus
3247 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3248 Buchungsgruppen der betreffenden Waren.</para>
3253 <term>Startdatum</term>
3256 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3262 <term>Enddatum</term>
3265 <para>ab wann keine Rechnungen mehr erstellt werden
3271 <term>Automatische Verlängerung um x Monate</term>
3274 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3275 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3276 hier die Anzahl der Monate eingeben, um die das Enddatum
3277 automatisch nach hinten geschoben wird.</para>
3282 <term>Drucken</term>
3285 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3286 Rechnungen auch gleich ausdrucken lassen.</para>
3291 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3292 Informationen zu den erstellten Rechnungen verschickt werden.
3293 Konfiguriert wird dies in der <link
3294 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3295 <filename>config/kivitendo.conf</filename> im Abschnitt
3296 <varname>[periodic_invoices]</varname>.</para>
3299 <sect2 id="features.periodic-invoices.variables">
3300 <title>Spezielle Variablen</title>
3302 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3303 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3304 formatierte Variablen durch für die jeweils aktuelle
3305 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3306 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3307 die Syntax <literal><%variablenname%></literal>.</para>
3309 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3310 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3311 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3312 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3313 Die zur verfügung stehenden Formatinformationen werden unten genauer
3316 <para>Diese Variablen können auch beim automatischen Versand der
3317 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3318 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3320 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3325 <para>Bemerkungen</para>
3329 <para>Interne Bemerkungen</para>
3333 <para>Vorgangsbezeichnung</para>
3337 <para>In den Beschreibungs- und Langtextfeldern aller
3342 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3346 <term><varname><%current_quarter%></varname>,
3347 <varname><%previous_quarter%></varname>,
3348 <varname><%next_quarter%></varname></term>
3351 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3352 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3357 <term><varname><%current_month%></varname>,
3358 <varname><%previous_month%></varname>,
3359 <varname><%next_month%></varname></term>
3362 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3363 <literal>1</literal> und <literal>12</literal>.</para>
3368 <term><varname><%current_month_long%></varname>,
3369 <varname><%previous_month_long%></varname>,
3370 <varname><%next_month_long%></varname></term>
3373 <para>Aktueller, vorheriger und nächster Monat als Name
3374 (<literal>Januar</literal>, <literal>Februar</literal>
3380 <term><varname><%current_year%></varname>,
3381 <varname><%previous_year%></varname>,
3382 <varname><%next_year%></varname></term>
3385 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3386 Jahreszahl (<literal>2013</literal> etc.).</para>
3391 <term><varname><%period_start_date%></varname>,
3392 <varname><%period_end_date%></varname></term>
3395 <para>Formatiertes Datum des ersten und letzten Tages im
3396 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3397 ersten Quartal von 2013 wären dies der
3398 <literal>01.01.2013</literal> und
3399 <literal>31.03.2013</literal>).</para>
3404 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3405 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3406 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3407 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3412 <term><varname>%a</varname></term>
3415 <para>Der abgekürzte Wochentagsname.</para>
3420 <term><varname>%A</varname></term>
3423 <para>Der ausgeschriebene Wochentagsname.</para>
3428 <term><varname>%b</varname></term>
3431 <para>Der abgekürzte Monatsname.</para>
3436 <term><varname>%B</varname></term>
3439 <para>Der ausgeschriebene Monatsname.</para>
3444 <term><varname>%C</varname></term>
3447 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3453 <term><varname>%d</varname></term>
3456 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3461 <term><varname>%D</varname></term>
3464 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3469 <term><varname>%e</varname></term>
3472 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3473 werden führende Nullen durch Leerzeichen ersetzt.</para>
3478 <term><varname>%F</varname></term>
3481 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3486 <term><varname>%j</varname></term>
3489 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3495 <term><varname>%m</varname></term>
3498 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3503 <term><varname>%u</varname></term>
3506 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3507 die 1 dem Montag entspricht.</para>
3512 <term><varname>%U</varname></term>
3515 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3516 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3522 <term><varname>%V</varname></term>
3525 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3526 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3527 vier Tage im Jahr liegen; Montag ist erster Tag der
3533 <term><varname>%w</varname></term>
3536 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3537 die 0 dem Sonntag entspricht.</para>
3542 <term><varname>%W</varname></term>
3545 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3546 wobei der erste Montag im Jahr das Startdatum von Woche 01
3552 <term><varname>%y</varname></term>
3555 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3561 <term><varname>%Y</varname></term>
3564 <para>Das Jahr als vierstellige Zahl.</para>
3569 <term><varname>%%</varname></term>
3572 <para>Das Prozentzeichen selber.</para>
3577 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3578 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3579 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3580 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3583 <sect2 id="features.periodic-invoices.reports">
3584 <title>Auflisten</title>
3586 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3587 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3588 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3589 wiederkehrenden Rechnungen verschaffen kann.</para>
3592 <sect2 id="features.periodic-invoices.task-server">
3593 <title>Erzeugung der eigentlichen Rechnungen</title>
3595 <para>Die zeitliche und periodische Überprüfung, ob eine
3596 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3597 durch den <link linkend="config.task-server">Taskserver</link>, einen
3598 externen Dienst, der automatisch beim Start des Servers gestartet
3599 werden sollte.</para>
3602 <sect2 id="features.periodic-invoices.create-for-current-month">
3603 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3605 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3606 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3607 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
3608 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3609 generiert hat. Alternativ setzt man das Startdatum auf den
3610 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3611 manuell über den Workflow.</para>
3615 <sect1 id="features.bank" xreflabel="bankerweiterung">
3616 <title>Bankerweiterung</title>
3618 <sect2 id="features.bank.introduction"
3619 xreflabel="Einführung in die Bankerweiterung">
3620 <title>Einführung</title>
3622 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3623 im Wiki und soll von dort später hierhin übernommen werden:</para>
3626 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3630 <sect1 id="dokumentenvorlagen-und-variablen">
3631 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3633 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3634 <title>Einführung</title>
3636 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3637 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3638 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3639 <function><%variablenname%></function> verwendet wird. Für
3640 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3642 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3644 <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3645 Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im
3646 Folgenden gesagte für alle Vorlagenarten.</para>
3648 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3649 verfügbar als hier aufgelistet werden. Die meisten davon können
3650 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3651 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3652 diese wie folgt erhalten werden:</para>
3656 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3657 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3661 <para>In <filename>Form.pm</filename> die Funktion
3662 <function>parse_template</function> suchen und hier die Zeile
3663 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3667 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3668 ein PDF für eine Rechnung erzeugen.</para>
3672 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3673 der Variablen <varname>$self</varname> in der Form <varname>'key'
3674 => 'value',</varname>. Alle <varname>key</varname>s sind
3680 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3681 <title>Variablen ausgeben</title>
3683 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3684 Tags geschrieben werden, also z.B.
3685 <varname><%variablenname%></varname>.</para>
3687 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3688 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3689 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
3690 werden die folgenden Flags unterstützt:</para>
3694 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3695 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3696 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3697 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3701 <para><option>NOESCAPE</option> unterdrückt das Escapen von
3702 Sonderzeichen für die Vorlagensprache. Wenn also in einer
3703 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
3704 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
3705 ist dieses Flag sinnvoll.</para>
3709 <para>Beispiel:</para>
3711 <programlisting><%quototal NOFORMAT%></programlisting>
3714 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
3715 <title>Verwendung in Druckbefehlen</title>
3717 <para>In der Admininstration können Drucker definiert werden. Auch im
3718 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
3719 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
3720 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
3721 <function>`...`</function> nicht zu unerwünschtem Verhalten
3724 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
3725 für das die Telefonnummer eines Ansprechpartners als Teil der
3726 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
3727 z.B. wie folgt aussehen:</para>
3729 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
3732 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
3733 xreflabel="Anfang und Ende der Tags verändern">
3734 <title>Anfang und Ende der Tags verändern</title>
3736 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
3737 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
3738 Prozentzeichen und dem Größerzeichen endet, beispielsweise
3739 <function><%customer%></function>. Da diese Form aber z.B. in
3740 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
3741 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
3742 Stil umgestellt werden.</para>
3744 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
3745 Format gültigen Kommentarzeichen anfangen, dann
3746 <function>config:</function> enthalten, die entsprechende Option
3747 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
3748 enden. Beispiel für LaTeX:</para>
3750 <programlisting>% config: tag-style=($ $)</programlisting>
3752 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
3753 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
3754 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
3756 <programlisting><!-- config: tag-style=($ $) --></programlisting>
3759 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
3760 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
3762 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
3763 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
3764 "<filename>.ext</filename>" geeignet zu ersetzen:
3765 "<filename>.tex</filename>" für LaTeX-Vorlagen und
3766 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
3770 <term><filename>bin_list.ext</filename></term>
3773 <para>Lagerliste</para>
3778 <term><filename>check.ext</filename></term>
3786 <term><filename>invoice.ext</filename></term>
3789 <para>Rechnung</para>
3794 <term><filename>packing_list.ext</filename></term>
3797 <para>Packliste</para>
3802 <term><filename>pick_list.ext</filename></term>
3805 <para>Sammelliste</para>
3810 <term><filename>purchase_delivery_order.ext</filename></term>
3813 <para>Lieferschein (Einkauf)</para>
3818 <term><filename>purcharse_order.ext</filename></term>
3821 <para>Bestellung an Lieferanten</para>
3826 <term><filename>request_quotation.ext</filename></term>
3829 <para>Anfrage an Lieferanten</para>
3834 <term><filename>sales_delivery_order.ext</filename></term>
3837 <para>Lieferschein (Verkauf)</para>
3842 <term><filename>sales_order.ext</filename></term>
3845 <para>Bestellung</para>
3850 <term><filename>sales_quotation.ext</filename></term>
3853 <para>Angebot an Kunden</para>
3858 <term><filename>zahlungserinnerung.ext</filename></term>
3861 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
3866 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
3869 <para>Rechnung über Mahngebühren (Dateiname im Programm
3870 konfigurierbar)</para>
3876 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
3877 <title>Sprache, Drucker und E-Mail</title>
3879 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
3880 eingearbeitet. So wird aus der Vorlage
3881 <filename>sales_order.ext</filename> bei Sprache
3882 <function>de</function> und Druckerkürzel <function>lpr2</function>
3883 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
3884 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
3885 bekommen dann noch das Kürzel <filename>_email</filename>, der
3886 vollständige Vorlagenname wäre dann
3887 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
3888 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
3889 werden. Diese wird verwendet, wenn keine der anderen Varianten
3890 gefunden wird.</para>
3892 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
3893 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
3894 verschickt wird, ist:</para>
3898 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
3902 <para><filename>sales_order_de_lpr2.tex</filename></para>
3906 <para><filename>sales_order.tex</filename></para>
3910 <para><filename>default.tex</filename></para>
3914 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
3915 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
3917 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
3920 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
3921 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
3924 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
3925 xreflabel="Metainformationen zur angeforderten Vorlage">
3926 <title>Metainformationen zur angeforderten Vorlage</title>
3928 <para>Diese Variablen liefern Informationen darüber welche Variante
3929 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
3930 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
3931 Formulare einbinden möchten.</para>
3935 <term><varname>template_meta.formname</varname></term>
3938 <para>Basisname der Vorlage. Identisch mit der <link
3939 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
3940 zu den Dateinamen</link> ohne die Erweiterung. Ein
3941 Verkaufsauftrag enthält hier
3942 <constant>sales_order</constant>.</para>
3947 <term><varname>template_meta.language.description</varname></term>
3950 <para>Beschreibung der verwendeten Sprache</para>
3955 <term><varname>template_meta.language.template_code</varname></term>
3958 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
3959 dem Kürzel das im Dateinamen verwendetet wird.</para>
3964 <term><varname>template_meta.language.output_numberformat</varname></term>
3967 <para>Zahlenformat der verwendeten Sprache in der Form
3968 "<constant>1.000,00</constant>". Experimentell! Nur
3969 interessant für Vorlagen die mit unformatierten Werten
3975 <term><varname>template_meta.language.output_dateformat</varname></term>
3978 <para>Datumsformat der verwendeten Sprache in der Form
3979 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
3980 interessant für Vorlagen die mit unformatierten Werten
3986 <term><varname>template_meta.format</varname></term>
3989 <para>Das angeforderte Format. Kann im Moment die Werte
3990 <constant>pdf</constant>, <constant>postscript</constant>,
3991 <constant>html</constant>, <constant>opendocument</constant>,
3992 <constant>opendocument_pdf</constant> und
3993 <constant>excel</constant> enthalten.</para>
3998 <term><varname>template_meta.extension</varname></term>
4001 <para>Dateierweiterung, wie im Dateinamen. Wird aus
4002 <constant>format</constant> entschieden.</para>
4007 <term><varname>template_meta.media</varname></term>
4010 <para>Ausgabemedium. Kann zur Zeit die Werte
4011 <constant>screen</constant> für Bildschirm,
4012 <constant>email</constant> für E-Mail (triggert das
4013 <constant>_email</constant> Kürzel im Dateinamen),
4014 <constant>printer</constant> für Drucker, und
4015 <constant>queue</constant> für Warteschlange enthalten.</para>
4020 <term><varname>template_meta.printer.description</varname></term>
4023 <para>Beschreibung des ausgewählten Druckers</para>
4028 <term><varname>template_meta.printer.template_code</varname></term>
4031 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
4032 dem Kürzel das im Dateinamen verwendetet wird.</para>
4037 <term><varname>template_meta.tmpfile</varname></term>
4040 <para>Datei-Prefix für temporäre Dateien.</para>
4046 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
4047 <title>Stammdaten von Kunden und Lieferanten</title>
4051 <term><varname>account_number</varname></term>
4054 <para>Kontonummer</para>
4059 <term><varname>bank</varname></term>
4062 <para>Name der Bank</para>
4067 <term><varname>bank_code</varname></term>
4070 <para>Bankleitzahl</para>
4075 <term><varname>bic</varname></term>
4078 <para>Bank-Identifikations-Code (Bank Identifier Code,
4084 <term><varname>business</varname></term>
4087 <para>Kunden-/Lieferantentyp</para>
4092 <term><varname>city</varname></term>
4100 <term><varname>contact</varname></term>
4103 <para>Kontakt</para>
4108 <term><varname>country</varname></term>
4116 <term><varname>c_vendor_id</varname></term>
4119 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
4124 <term><varname>v_customer_id</varname></term>
4127 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
4132 <term><varname>cp_email</varname></term>
4135 <para>Email des Ansprechpartners</para>
4140 <term><varname>cp_givenname</varname></term>
4143 <para>Vorname des Ansprechpartners</para>
4148 <term><varname>cp_greeting</varname></term>
4151 <para>Anrede des Ansprechpartners</para>
4156 <term><varname>cp_name</varname></term>
4159 <para>Name des Ansprechpartners</para>
4164 <term><varname>cp_phone1</varname></term>
4167 <para>Telefonnummer 1 des Ansprechpartners</para>
4172 <term><varname>cp_phone2</varname></term>
4175 <para>Telefonnummer 2 des Ansprechpartners</para>
4180 <term><varname>cp_title</varname></term>
4183 <para>Titel des Ansprechpartners</para>
4188 <term><varname>creditlimit</varname></term>
4191 <para>Kreditlimit</para>
4196 <term><varname>customeremail</varname></term>
4199 <para>Email des Kunden; nur für Kunden</para>
4204 <term><varname>customerfax</varname></term>
4207 <para>Faxnummer des Kunden; nur für Kunden</para>
4212 <term><varname>customernotes</varname></term>
4215 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4220 <term><varname>customernumber</varname></term>
4223 <para>Kundennummer; nur für Kunden</para>
4228 <term><varname>customerphone</varname></term>
4231 <para>Telefonnummer des Kunden; nur für Kunden</para>
4236 <term><varname>discount</varname></term>
4244 <term><varname>email</varname></term>
4247 <para>Emailadresse</para>
4252 <term><varname>fax</varname></term>
4255 <para>Faxnummer</para>
4260 <term><varname>gln</varname></term>
4263 <para>GLN (Globale Lokationsnummer)</para>
4268 <term><varname>greeting</varname></term>
4276 <term><varname>homepage</varname></term>
4279 <para>Homepage</para>
4284 <term><varname>iban</varname></term>
4287 <para>Internationale Kontonummer (International Bank Account
4288 Number, IBAN)</para>
4293 <term><varname>language</varname></term>
4296 <para>Sprache</para>
4301 <term><varname>name</varname></term>
4304 <para>Firmenname</para>
4309 <term><varname>payment_description</varname></term>
4312 <para>Name der Zahlart</para>
4317 <term><varname>payment_terms</varname></term>
4320 <para>Zahlungskonditionen</para>
4325 <term><varname>phone</varname></term>
4328 <para>Telefonnummer</para>
4333 <term><varname>shiptocity</varname></term>
4336 <para>Stadt (Lieferadresse) <link
4337 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4342 <term><varname>shiptocontact</varname></term>
4345 <para>Kontakt (Lieferadresse) <link
4346 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4351 <term><varname>shiptocountry</varname></term>
4354 <para>Land (Lieferadresse) <link
4355 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4360 <term><varname>shiptodepartment_1</varname></term>
4363 <para>Abteilung 1 (Lieferadresse) <link
4364 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4369 <term><varname>shiptodepartment_2</varname></term>
4372 <para>Abteilung 2 (Lieferadresse) <link
4373 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4378 <term><varname>shiptoemail</varname></term>
4381 <para>Email (Lieferadresse) <link
4382 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4387 <term><varname>shiptofax</varname></term>
4390 <para>Fax (Lieferadresse) <link
4391 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4396 <term><varname>shiptogln</varname></term>
4399 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4400 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4405 <term><varname>shiptoname</varname></term>
4408 <para>Firmenname (Lieferadresse) <link
4409 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4414 <term><varname>shiptophone</varname></term>
4417 <para>Telefonnummer (Lieferadresse) <link
4418 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4423 <term><varname>shiptostreet</varname></term>
4426 <para>Straße und Hausnummer (Lieferadresse) <link
4427 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4432 <term><varname>shiptozipcode</varname></term>
4435 <para>Postleitzahl (Lieferadresse) <link
4436 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4441 <term><varname>street</varname></term>
4444 <para>Straße und Hausnummer</para>
4449 <term><varname>taxnumber</varname></term>
4452 <para>Steuernummer</para>
4457 <term><varname>ustid</varname></term>
4460 <para>Umsatzsteuer-Identifikationsnummer</para>
4465 <term><varname>vendoremail</varname></term>
4468 <para>Email des Lieferanten; nur für Lieferanten</para>
4473 <term><varname>vendorfax</varname></term>
4476 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4481 <term><varname>vendornotes</varname></term>
4484 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4489 <term><varname>vendornumber</varname></term>
4492 <para>Lieferantennummer; nur für Lieferanten</para>
4497 <term><varname>vendorphone</varname></term>
4500 <para>Telefonnummer des Lieferanten; nur für
4506 <term><varname>zipcode</varname></term>
4509 <para>Postleitzahl</para>
4514 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4515 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4516 Stammdaten nicht eingetragen, so haben die Variablen
4517 <varname>shipto*</varname> den gleichen Wert wie die die
4518 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4519 einige <varname>shipto*</varname>-Variablen so nicht in den
4520 Stammdaten wiederfinden sondern schlicht Kopien der
4521 Lieferdatenvariablen sind (z.B.
4522 <varname>shiptocontact</varname>).</para>
4526 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4527 <title>Informationen über den Bearbeiter</title>
4531 <term><varname>employee_address</varname></term>
4534 <para>Adressfeld</para>
4539 <term><varname>employee_businessnumber</varname></term>
4542 <para>Firmennummer</para>
4547 <term><varname>employee_company</varname></term>
4550 <para>Firmenname</para>
4555 <term><varname>employee_co_ustid</varname></term>
4558 <para>Usatzsteuer-Identifikationsnummer</para>
4563 <term><varname>employee_duns</varname></term>
4566 <para>DUNS-Nummer</para>
4571 <term><varname>employee_email</varname></term>
4579 <term><varname>employee_fax</varname></term>
4587 <term><varname>employee_name</varname></term>
4590 <para>voller Name</para>
4595 <term><varname>employee_signature</varname></term>
4598 <para>Signatur</para>
4603 <term><varname>employee_taxnumber</varname></term>
4606 <para>Steuernummer</para>
4611 <term><varname>employee_tel</varname></term>
4614 <para>Telefonnummer</para>
4620 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4621 <title>Informationen über den Verkäufer</title>
4625 <term><varname>salesman_address</varname></term>
4628 <para>Adressfeld</para>
4633 <term><varname>salesman_businessnumber</varname></term>
4636 <para>Firmennummer</para>
4641 <term><varname>salesman_company</varname></term>
4644 <para>Firmenname</para>
4649 <term><varname>salesman_co_ustid</varname></term>
4652 <para>Usatzsteuer-Identifikationsnummer</para>
4657 <term><varname>salesman_duns</varname></term>
4660 <para>DUNS-Nummer</para>
4665 <term><varname>salesman_email</varname></term>
4673 <term><varname>salesman_fax</varname></term>
4681 <term><varname>salesman_name</varname></term>
4684 <para>voller Name</para>
4689 <term><varname>salesman_signature</varname></term>
4692 <para>Signatur</para>
4697 <term><varname>salesman_taxnumber</varname></term>
4700 <para>Steuernummer</para>
4705 <term><varname>salesman_tel</varname></term>
4708 <para>Telefonnummer</para>
4714 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
4715 <title>Variablen für die einzelnen Steuern</title>
4719 <term><varname>tax</varname></term>
4727 <term><varname>taxbase</varname></term>
4730 <para>zu versteuernder Betrag</para>
4735 <term><varname>taxdescription</varname></term>
4738 <para>Name der Steuer</para>
4743 <term><varname>taxrate</varname></term>
4746 <para>Steuersatz</para>
4752 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
4753 <title>Variablen für Lieferbedingungen</title>
4757 <term><varname>delivery_term</varname></term>
4760 <para>Datenbank-Objekt der Lieferbedingung</para>
4765 <term><varname>delivery_term.description</varname></term>
4768 <para>Beschreibung der Lieferbedingung</para>
4773 <term><varname>delivery_term.description_long</varname></term>
4776 <para>Langtext bzw. übersetzter Langtext der
4777 Lieferbedingung</para>
4784 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
4785 <title>Variablen in Rechnungen</title>
4787 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
4788 <title>Allgemeine Variablen</title>
4792 <term><varname>creditremaining</varname></term>
4795 <para>Verbleibender Kredit</para>
4800 <term><varname>currency</varname></term>
4803 <para>Währung</para>
4808 <term><varname>cusordnumber</varname></term>
4811 <para>Bestellnummer beim Kunden</para>
4816 <term><varname>deliverydate</varname></term>
4819 <para>Lieferdatum</para>
4824 <term><varname>duedate</varname></term>
4827 <para>Fälligkeitsdatum</para>
4832 <term><varname>globalprojectnumber</varname></term>
4835 <para>Projektnummer des ganzen Beleges</para>
4840 <term><varname>globalprojectdescription</varname></term>
4843 <para>Projekbeschreibung des ganzen Beleges</para>
4848 <term><varname>intnotes</varname></term>
4851 <para>Interne Bemerkungen</para>
4856 <term><varname>invdate</varname></term>
4859 <para>Rechnungsdatum</para>
4864 <term><varname>invnumber</varname></term>
4867 <para>Rechnungsnummer</para>
4872 <term><varname>invtotal</varname></term>
4875 <para>gesamter Rechnungsbetrag</para>
4880 <term><varname>notes</varname></term>
4883 <para>Bemerkungen der Rechnung</para>
4888 <term><varname>orddate</varname></term>
4891 <para>Auftragsdatum</para>
4896 <term><varname>ordnumber</varname></term>
4899 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
4900 erstellt wurde</para>
4905 <term><varname>payment_description</varname></term>
4908 <para>Name der Zahlart</para>
4913 <term><varname>payment_terms</varname></term>
4916 <para>Zahlungskonditionen</para>
4921 <term><varname>quodate</varname></term>
4924 <para>Angebotsdatum</para>
4929 <term><varname>quonumber</varname></term>
4932 <para>Angebotsnummer</para>
4937 <term><varname>rounding</varname></term>
4940 <para>Betrag, um den <varname>invtotal</varname> gerundet wurde
4941 (kann positiv oder negativ sein)</para>
4946 <term><varname>shippingpoint</varname></term>
4949 <para>Versandort</para>
4954 <term><varname>shipvia</varname></term>
4957 <para>Transportmittel</para>
4962 <term><varname>subtotal</varname></term>
4965 <para>Zwischensumme aller Posten ohne Steuern</para>
4970 <term><varname>total</varname></term>
4973 <para>Restsumme der Rechnung (Summe abzüglich bereits
4974 bezahlter Posten)</para>
4979 <term><varname>transaction_description</varname></term>
4982 <para>Vorgangsbezeichnung</para>
4987 <term><varname>transdate</varname></term>
4990 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
4991 erstellt wurde</para>
4997 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
4998 <title>Variablen für jeden Posten auf der Rechnung</title>
5002 <term><varname>bin</varname></term>
5005 <para>Stellage</para>
5010 <term><varname>description</varname></term>
5013 <para>Artikelbeschreibung</para>
5018 <term><varname>cusordnumber_oe</varname></term>
5021 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
5022 Posten ursprünglich stammt (nur Verkauf)</para>
5027 <term><varname>discount</varname></term>
5030 <para>Rabatt als Betrag</para>
5035 <term><varname>discount_sub</varname></term>
5038 <para>Zwischensumme mit Rabatt</para>
5043 <term><varname>donumber_do</varname></term>
5046 <para>Lieferscheinnummer des Lieferscheins, aus dem die
5047 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
5048 Workflows aus einem Lieferschein erstellt wurde.</para>
5053 <term><varname>drawing</varname></term>
5056 <para>Zeichnung</para>
5061 <term><varname>ean</varname></term>
5064 <para>EAN-Code</para>
5069 <term><varname>image</varname></term>
5077 <term><varname>linetotal</varname></term>
5080 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
5085 <term><varname>longdescription</varname></term>
5088 <para>Langtext</para>
5093 <term><varname>microfiche</varname></term>
5096 <para>Mikrofilm</para>
5101 <term><varname>netprice</varname></term>
5104 <para>Alternative zu <varname>sellprice</varname>, aber
5105 <varname>netprice</varname> entspricht dem effektiven
5106 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
5107 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
5108 / Menge. Diese Variable ist nützlich, wenn man den gewährten
5109 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
5110 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
5111 <varname>netprice</varname> hat nichts mit Netto/Brutto im
5112 Sinne von Steuern zu tun.</para>
5117 <term><varname>nodiscount_linetotal</varname></term>
5120 <para>Zeilensumme ohne Rabatt</para>
5125 <term><varname>nodiscount_sub</varname></term>
5128 <para>Zwischensumme ohne Rabatt</para>
5133 <term><varname>number</varname></term>
5136 <para>Artikelnummer</para>
5141 <term><varname>ordnumber_oe</varname></term>
5144 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5145 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5146 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5147 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5148 letzterem Fall wird die unsprüngliche Auftragsnummer
5154 <term><varname>p_discount</varname></term>
5157 <para>Rabatt in Prozent</para>
5162 <term><varname>partnotes</varname></term>
5165 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5170 <term><varname>partsgroup</varname></term>
5173 <para>Warengruppe</para>
5178 <term><varname>price_factor</varname></term>
5181 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5187 <term><varname>price_factor_name</varname></term>
5190 <para>Der Name des Preisfaktors, sofern einer eingestellt
5196 <term><varname>projectnumber</varname></term>
5199 <para>Projektnummer</para>
5204 <term><varname>projectdescription</varname></term>
5207 <para>Projektbeschreibung</para>
5212 <term><varname>qty</varname></term>
5220 <term><varname>reqdate</varname></term>
5223 <para>Lieferdatum</para>
5228 <term><varname>runningnumber</varname></term>
5231 <para>Position auf der Rechnung (1, 2, 3...)</para>
5236 <term><varname>sellprice</varname></term>
5239 <para>Verkaufspreis</para>
5244 <term><varname>serialnumber</varname></term>
5247 <para>Seriennummer</para>
5252 <term><varname>tax_rate</varname></term>
5255 <para>Steuersatz</para>
5260 <term><varname>transdate_do</varname></term>
5263 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5264 Workflows aus einem Lieferschein stammte.</para>
5269 <term><varname>transdate_oe</varname></term>
5272 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5273 Workflows aus einem Auftrag erstellt wurde. Wenn es
5274 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5280 <term><varname>transdate_quo</varname></term>
5283 <para>Datum des Angebots, wenn die Position im Rahmen des
5284 Workflows aus einem Angebot stammte.</para>
5289 <term><varname>unit</varname></term>
5292 <para>Einheit</para>
5297 <term><varname>weight</varname></term>
5300 <para>Gewicht</para>
5305 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5306 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5307 einer <function>foreach</function>-Schleife ausgegeben werden, da
5308 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5309 können. Die Variablen dafür lauten:</para>
5313 <term><varname>make</varname></term>
5316 <para>Lieferant</para>
5321 <term><varname>model</varname></term>
5324 <para>Lieferantenartikelnummer</para>
5330 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5331 <title>Variablen für die einzelnen Zahlungseingänge</title>
5335 <term><varname>payment</varname></term>
5343 <term><varname>paymentaccount</varname></term>
5351 <term><varname>paymentdate</varname></term>
5359 <term><varname>paymentmemo</varname></term>
5367 <term><varname>paymentsource</varname></term>
5376 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5377 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5379 <para>Die vom Benutzer definierten Variablen für Kunden und
5380 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5381 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5382 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5383 Variablennamen zusammen.</para>
5385 <para>Beispiel: Der Benutzer hat eine Variable namens
5386 <varname>number_of_employees</varname> definiert, die die Anzahl der
5387 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5388 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5391 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5392 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5393 Präfix <varname>shiptocvar_</varname>.</para>
5395 <para>Analog stehen die benutzerdefinierten Variablen für Ansprechpersonen mit dem Namenspräfix <varname>cp_cvar_</varname> zur Verfügung.</para>
5399 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5400 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5402 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5403 <title>Namen der Vorlagen</title>
5405 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5406 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5407 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5408 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5409 Vorlagenname für diese Mahnstufe mit dem Zusatz
5410 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5411 für die ausgewählte Sprache und den ausgewählten Drucker
5415 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5416 <title>Allgemeine Variablen in Mahnungen</title>
5418 <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie gewohnt als
5419 <varname>employee_...</varname> bzw. <varname>salesman_...</varname> zur Verfügung.
5420 Werden mehrere Rechnungen in einer Mahnung zusammengefasst, so werden
5421 die Metadaten (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung
5422 im Ausdruck genommen.</para>
5423 <para>Die Adressdaten des Kunden stehen als Variablen <varname>name</varname>,
5424 <varname>street</varname>, <varname>zipcode</varname>,
5425 <varname>city</varname>, <varname>country</varname>,
5426 <varname>department_1</varname>, <varname>department_2</varname>,
5427 und <varname>email</varname> zur Verfügung. Der Ansprechpartner <varname>cp_...</varname>
5428 steht auch zu Verfügung, wird allerdings auch nur von der ersten angemahnten Rechnung (s.o.)
5431 <para>Weitere Variablen beinhalten:</para>
5435 <term><varname>dunning_date</varname></term>
5438 <para>Datum der Mahnung</para>
5443 <term><varname>dunning_duedate</varname></term>
5446 <para>Fälligkeitsdatum für diese Mahhnung</para>
5451 <term><varname>dunning_id</varname></term>
5454 <para>Mahnungsnummer</para>
5459 <term><varname>fee</varname></term>
5462 <para>Kumulative Mahngebühren</para>
5467 <term><varname>interest_rate</varname></term>
5470 <para>Zinssatz per anno in Prozent</para>
5475 <term><varname>total_amount</varname></term>
5478 <para>Gesamter noch zu zahlender Betrag als
5479 <function>fee</function> + <function>total_interest</function>
5480 + <function>total_open_amount</function></para>
5485 <term><varname>total_interest</varname></term>
5488 <para>Zinsen per anno über alle Rechnungen</para>
5493 <term><varname>total_open_amount</varname></term>
5496 <para>Summe über alle offene Beträge der Rechnungen</para>
5502 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5503 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5507 <term><varname>dn_amount</varname></term>
5510 <para>Rechnungssumme (brutto)</para>
5515 <term><varname>dn_duedate</varname></term>
5518 <para>Originales Fälligkeitsdatum der Rechnung</para>
5523 <term><varname>dn_dunning_date</varname></term>
5526 <para>Datum der Mahnung</para>
5531 <term><varname>dn_dunning_duedate</varname></term>
5534 <para>Fälligkeitsdatum der Mahnung</para>
5539 <term><varname>dn_fee</varname></term>
5542 <para>Kummulative Mahngebühr</para>
5547 <term><varname>dn_interest</varname></term>
5550 <para>Zinsen per anno für diese Rechnung</para>
5555 <term><varname>dn_invnumber</varname></term>
5558 <para>Rechnungsnummer</para>
5563 <term><varname>dn_linetotal</varname></term>
5566 <para>Noch zu zahlender Betrag (ergibt sich aus
5567 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5568 + <varname>dn_interest</varname>)</para>
5573 <term><varname>dn_netamount</varname></term>
5576 <para>Rechnungssumme (netto)</para>
5581 <term><varname>dn_open_amount</varname></term>
5584 <para>Offener Rechnungsbetrag</para>
5589 <term><varname>dn_ordnumber</varname></term>
5592 <para>Bestellnummer</para>
5597 <term><varname>dn_transdate</varname></term>
5600 <para>Rechnungsdatum</para>
5605 <term><varname>dn_curr</varname></term>
5608 <para>Währung, in der die Rechnung erstellt wurde. (Die
5609 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5615 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5616 <title>Variablen in automatisch erzeugten Rechnungen über
5617 Mahngebühren</title>
5619 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5620 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5621 Kunden stehen als Variablen <varname>name</varname>,
5622 <varname>street</varname>, <varname>zipcode</varname>,
5623 <varname>city</varname>, <varname>country</varname>,
5624 <varname>department_1</varname>, <varname>department_2</varname>,
5625 und <varname>email</varname> zur Verfügung.</para>
5627 <para>Weitere Variablen beinhalten:</para>
5631 <term><varname>duedate</varname></term>
5634 <para>Fälligkeitsdatum der Rechnung</para>
5639 <term><varname>dunning_id</varname></term>
5642 <para>Mahnungsnummer</para>
5647 <term><varname>fee</varname></term>
5650 <para>Mahngebühren</para>
5655 <term><varname>interest</varname></term>
5663 <term><varname>invamount</varname></term>
5666 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
5667 <varname>interest</varname>)</para>
5672 <term><varname>invdate</varname></term>
5675 <para>Rechnungsdatum</para>
5680 <term><varname>invnumber</varname></term>
5683 <para>Rechnungsnummer</para>
5690 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
5691 <title>Variablen in anderen Vorlagen</title>
5694 <title>Einführung</title>
5696 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
5697 Rechnung. Allerdings heißen die Variablen, die mit
5698 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
5699 fangen sie mit <varname>quo</varname> für "quotation" an:
5700 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
5701 wiederum fangen sie mit <varname>ord</varname> für "order" an:
5702 <varname>ordnumber</varname> für Bestellnummer etc.</para>
5704 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
5705 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
5706 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
5707 Vorlage keine Bedeutung haben oder noch nicht belegt sein
5710 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
5711 in Rechnungen aufgeführt.</para>
5714 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
5715 <title>Angebote und Preisanfragen</title>
5719 <term><varname>quonumber</varname></term>
5722 <para>Angebots- bzw. Anfragenummer</para>
5727 <term><varname>reqdate</varname></term>
5730 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
5731 Preisanfragen)</para>
5736 <term><varname>transdate</varname></term>
5739 <para>Angebots- bzw. Anfragedatum</para>
5745 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
5746 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
5750 <term><varname>ordnumber</varname></term>
5753 <para>Auftragsnummer</para>
5758 <term><varname>reqdate</varname></term>
5761 <para>Lieferdatum</para>
5766 <term><varname>transdate</varname></term>
5769 <para>Auftragsdatum</para>
5775 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
5776 <title>Lieferscheine (Verkauf und Einkauf)</title>
5780 <term><varname>cusordnumber</varname></term>
5783 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
5784 des Lieferanten (im Einkauf)</para>
5789 <term><varname>donumber</varname></term>
5792 <para>Lieferscheinnummer</para>
5797 <term><varname>transdate</varname></term>
5800 <para>Lieferscheindatum</para>
5805 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
5806 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
5807 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
5808 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
5809 <function>foreach</function>-Schleife ausgegeben werden. Diese
5810 Variablen sind:</para>
5814 <term><varname>si_bin</varname></term>
5817 <para>Lagerplatz</para>
5822 <term><varname>si_chargenumber</varname></term>
5825 <para>Chargennummer</para>
5830 <term><varname>si_bestbefore</varname></term>
5833 <para>Mindesthaltbarkeit</para>
5838 <term><varname>si_number</varname></term>
5841 <para>Artikelnummer</para>
5846 <term><varname>si_qty</varname></term>
5849 <para>Anzahl bzw. Menge</para>
5854 <term><varname>si_runningnumber</varname></term>
5857 <para>Positionsnummer (1, 2, 3 etc)</para>
5862 <term><varname>si_unit</varname></term>
5865 <para>Einheit</para>
5870 <term><varname>si_warehouse</varname></term>
5879 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
5880 <title>Variablen für Sammelrechnung</title>
5884 <term><varname>c0total</varname></term>
5887 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
5893 <term><varname>c30total</varname></term>
5896 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
5897 und < 60 Tage</para>
5902 <term><varname>c60total</varname></term>
5905 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
5906 und < 90 Tage</para>
5911 <term><varname>c90total</varname></term>
5914 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
5920 <term><varname>total</varname></term>
5923 <para>Gesamtbetrag aller Rechnungen</para>
5928 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
5932 <term><varname>invnumber</varname></term>
5935 <para>Rechnungsnummer</para>
5940 <term><varname>invdate</varname></term>
5943 <para>Rechnungsdatum</para>
5948 <term><varname>duedate</varname></term>
5951 <para>Fälligkeitsdatum</para>
5956 <term><varname>amount</varname></term>
5959 <para>Summe der Rechnung</para>
5964 <term><varname>open</varname></term>
5967 <para>Noch offener Betrag der Rechnung</para>
5972 <term><varname>c0</varname></term>
5975 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
5981 <term><varname>c30</varname></term>
5984 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
5990 <term><varname>c60</varname></term>
5993 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
5999 <term><varname>c90</varname></term>
6002 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
6010 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
6011 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
6013 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
6014 <title>Einführung</title>
6016 <para>Der Parser kennt neben den Variablen einige weitere
6017 Konstrukte, die gesondert behandelt werden. Diese sind wie
6018 Variablennamen in spezieller Weise markiert:
6019 <command><%anweisung%> ... <%end%></command></para>
6021 <para>Anmerkung zum <command><%end%></command>: Der besseren
6022 Verständlichkeit halber kann man nach dem <command>end</command>
6023 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
6024 Anweisung (z.B. <command>if</command> oder
6025 <command>foreach</command>) damit abgeschlossen wird.</para>
6027 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
6028 <command><%if type == "sales_quotation"%></command>, so könnte
6029 er mit <command><%end%></command> genauso abgeschlossen werden
6030 wie mit <command><%end if%></command> oder auch
6031 <command><%end type == "sales_quotation"%></command>.</para>
6034 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
6035 <title>Der if-Block</title>
6037 <programlisting><%if variablenname%>
6039 <%end%></programlisting>
6041 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
6042 und dem "end" werden nur ausgegeben, wenn die Variable
6043 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
6045 <para>Handelt es sich bei der benannten Variable um ein Array, also
6046 um einen Variablennamen, über den man mit <command><%foreach
6047 variablenname%></command> iteriert, so wird mit diesem Konstrukt
6048 darauf getestet, ob das Array Elemente enthält. Somit würde im
6049 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
6050 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
6051 welche getätigt wurden:</para>
6053 <programlisting><%if payment%>
6055 <%foreach payment%>
6056 Am <%paymentdate%>: <%payment%> €
6057 <%end foreach%>
6058 <%end if%></programlisting>
6060 <para>Die Bedingung kann auch negiert werden, indem das Wort
6061 <function>not</function> nach dem <filename>if</filename> verwendet
6062 wird. Beispiel:</para>
6064 <programlisting><%if not cp_greeting%>
6066 <%end%></programlisting>
6068 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
6069 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
6070 einer Variablen mit einer festen Zeichenkette oder einer anderen
6071 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
6072 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
6073 die rechte Seite des Vergleichsoperators in Anführungszeichen
6074 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
6075 anderer Variablen). Zwei Beispiele, die beide Vergleiche
6078 <programlisting><%if var1 == "Wert"%></programlisting>
6080 <para>Testet die Variable <varname>var1</varname> auf
6081 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
6082 Mittels <function>!=</function> anstelle von <function>==</function>
6083 würde auf Ungleichheit getestet.</para>
6085 <programlisting><%if var1 == var2%></programlisting>
6087 <para>Testet die Variable <varname>var1</varname> auf
6088 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
6089 <function>!=</function> anstelle von <function>==</function> würde
6090 auf Ungleichheit getestet.</para>
6092 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
6093 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
6094 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
6095 dieselbe Syntax wie oben nur mit <function>=~</function> und
6096 <function>!~</function> als Vergleichsoperatoren.</para>
6098 <para>Beispiel für einen Test, ob die Variable
6099 <varname>intnotes</varname> (interne Bemerkungen) das Wort
6100 <constant>schwierig</constant> enthält:</para>
6102 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
6105 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
6106 <title>Der foreach-Block</title>
6108 <programlisting><%foreach variablenname%>
6110 <%end%></programlisting>
6112 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
6113 wie das Perl-Array der Variablen <varname>variablenname</varname>
6114 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
6115 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
6116 benutzt. In jedem Durchlauf werden die <link
6117 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
6118 Variablen</link> jeweils auf den Wert für die aktuelle Position
6121 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
6123 <programlisting><%foreach number%>
6124 Position: <%runningnumber%>
6125 Anzahl: <%qty%>
6126 Artikelnummer: <%number%>
6127 Beschreibung: <%description%>
6129 <%end%></programlisting>
6131 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
6132 <function><%foreach%></function>-Block innerhalb einer
6133 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
6134 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
6135 Inhalt zwischen <function><%foreach%></function> und
6136 <function><%end%></function> wiederholt, nicht aber die
6137 komplette Zeile, in der er steht.</para>
6141 <sect2 id="dokumentenvorlagen-und-variablen.markup">
6142 <title>Markup-Code zur Textformatierung innerhalb von
6145 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6146 anders formatiert haben möchte, so ist dies begrenzt möglich.
6147 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6148 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6149 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6150 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6151 (HTML oder PDF über LaTeX) umgesetzt.</para>
6153 <para>Die unterstützen Formatierungen sind:</para>
6157 <term><b>Text</b></term>
6160 <para>Text wird in Fettdruck gesetzt.</para>
6165 <term><i>Text</i></term>
6168 <para>Text wird kursiv gesetzt.</para>
6173 <term><u>Text</u></term>
6176 <para>Text wird unterstrichen.</para>
6181 <term><s>Text</s></term>
6184 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6185 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6190 <term><bullet></term>
6193 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6199 <para>Der Befehl <command><bullet></command> funktioniert
6200 momentan auch nur in Latex-Vorlagen.</para>
6204 <sect1 id="excel-templates">
6205 <title>Excel-Vorlagen</title>
6207 <sect2 id="excel-templates.summary">
6208 <title>Zusammenfassung</title>
6210 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6211 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6215 <sect2 id="excel-templates.usage">
6216 <title>Bedienung</title>
6218 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6219 werden. Die Konfigurationsoption heißt <varname>excel_templates =
6220 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6222 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6223 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6224 werden. In den normalen Verkaufsmasken taucht nun
6225 <constant>Excel</constant> als auswählbares Format auf und kann von da
6226 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6228 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6229 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6230 <filename>sales_quotation.xls</filename> gespeichert.</para>
6233 <sect2 id="excel-templates.syntax">
6234 <title>Variablensyntax</title>
6236 <para>Einfache Syntax:
6237 <command><<varname>></command></para>
6239 <para>Dabei sind <constant><<</constant> und
6240 <constant>>></constant> die Delimiter. Da Excel auf festen
6241 Breiten besteht, kann der Tag künstlich verlängert werden, indem
6242 weitere <constant><</constant> oder <constant>></constant>
6243 eingefügt werden. Der Tag muss nicht symmetrisch sein.
6246 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6248 <para>Um die Limitierung der festen Breite zu reduzieren, können
6249 weitere Variablen in einem Block interpoliert werden. Whitespace wird
6250 dazwishen dann erhalten. Beispiel:</para>
6252 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6254 <para>Die Variablen werden interpoliert, und linksbündig mit
6255 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6256 lang, werden überzählige Zeichen abgeschnitten.</para>
6258 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6259 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6261 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6263 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6264 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6268 <sect2 id="excel-templates.limitations">
6269 <title>Einschränkungen</title>
6271 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6272 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6273 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6274 Text zu ersetzen.</para>
6276 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6277 <command><%if%></command> und
6278 <command><%foreach%></command> nicht vorhanden. Der Delimiter
6279 <constant><% %></constant> kommt in den Headerinformationen
6280 evtl. vor. Deshalb wurde auf den sichereren Delimiter
6281 <constant><<</constant> und <constant>>></constant>
6286 <sect1 id="features.warehouse">
6289 <title>Mandantenkonfiguration Lager</title>
6292 Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6293 Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. Ferner kann jede Position eines Lieferscheins
6294 ein-, bzw. ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele Lager mit beliebig vielen Lagerplätzen abgebildet
6295 werden. Die Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder Einzelposition und das Auswählen dieser Position zu
6296 einem Lager mit Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je nachdem wie die Einstellungen in der
6297 Mandatenkonfiguration gesetzt werden.
6302 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6303 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6304 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6305 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6309 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6310 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6311 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6312 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6313 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6314 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6319 Zusätzliche Funktionshinweise:
6324 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6325 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6326 Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6330 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6331 Stammdaten definiert</option> Wird beim 'Auslagern über
6332 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6333 so wird mit dieser Option einfach der Standardlagerplatz
6341 <sect1 id="features.swiss-charts-of-accounts">
6342 <title>Schweizer Kontenpläne</title>
6344 <para>Seit der Version 3.5 stehen in kivitendo 3 Kontenpläne für
6345 den Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6346 Organisationen, die nicht mehrwertsteuerpflichtig sind, einer
6347 für Firmen, die mehrwertsteuerpflichtig sind und einer speziell
6350 <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6351 verwendeten KMU-Kontenrahmen und sind mit der Revision des Schweizerischen
6352 Obligationenrechts (OR) vom 1.1.2013 kompatibel, insbesondere
6353 <literal>Art.957a Abs.2</literal>.</para>
6355 <para>Beim Vereinskontenplan sind standardmässig nur die Konten 1100
6356 (Debitoren CHF) und 1101 (Debitoren EUR) als Buchungskonten im Verkauf
6357 sowie die Konten 2000 (Kreditoren CHF) und 2001 (Kreditoren EUR) als
6358 Buchungskonten im Einkauf vorgesehen. Weitere Konten können bei Bedarf
6359 in den Konto-Detaileinstellungen als Einkaufs- oder Verkaufskonten
6360 konfiguriert werden.</para>
6362 <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der aktuellen
6363 Version von kivitendo noch nicht integriert.</para>
6365 <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6366 Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6367 Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen
6368 alle Aufwandskonten editiert werden und dort der Steuersatz auf 0%
6369 gesetzt werden.</para>
6371 <para>So werden bei Kreditorenbuchungen keine Vorsteuern verbucht.</para>
6373 <para>Bezugssteuern für aus dem Ausland bezogene Dienstleistungen müssen
6374 manuell verbucht werden.</para>
6376 <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6377 Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne
6378 bitte an <literal>empfang@revamp-it.ch</literal> senden.</para>
6381 <sect1 id="features.part_classification">
6382 <title>Artikelklassifizierung</title>
6385 <title>Übersicht</title>
6387 <para>Die Klassifizierung von Artikeln dient einer weiteren Gliederung,
6388 um zum Beispiel den Einkauf vom Verkauf zu trennen, gekennzeichnet
6389 durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel (z.B. "E").
6390 Für jede Klassifizierung besteht eine Beschreibung und eine Abkürzung
6391 die normalerweise aus einem Zeichen besteht, kann aber auf mehrere
6392 Zeichen erweitert werden, falls zur Unterscheidung notwendig. Sinnvoll
6393 sind jedoch nur maximal 2 Zeichen.</para>
6397 <title>Basisklassifizierung</title>
6399 <para>Als Basisklassifizierungen gibt es</para>
6403 <para>Einkauf</para>
6407 <para>Verkauf</para>
6411 <para>Handelsware</para>
6415 <para>Produktion</para>
6419 <para>- keine - (diese wird bei einer Aktualisierung für alle
6420 existierenden Artikel verwendet und ist gültig für Verkauf und
6425 <para>Es können weitere Klassifizierungen angelegt werden. So kann es
6426 z.B. für separat auszuweisende Artikel folgende Klassen geben:</para>
6430 <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
6434 <para>Material (Verpackungsmaterial) mit Kürzel M</para>
6440 <title>Attribute</title>
6442 <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
6443 alle gleichzeitg gültig sein können</para>
6447 <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
6452 <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
6457 <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
6458 (LaTeX) eine zusätzliche Variable</para>
6462 <para>Für das Attribut "separat ausweisen" stehen in den LaTeX-Vorlagen
6463 die Variable <emphasis role="bold"><%non_separate_subtotal%>
6464 </emphasis>zur Verfügung, die alle nicht separat auszuweisenden
6465 Artikelkosten saldiert, sowie pro separat auszuweisenden
6466 Klassifizierungen die Variable<emphasis role="bold"><
6467 %separate_X_subtotal%></emphasis>, wobei X das Kürzel der
6468 Klassifizierung ist.</para>
6470 <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
6471 role="bold"><%separate_L_subtotal%></emphasis> und für
6472 Verpackungsmaterial <emphasis role="bold">
6473 <%separate_M_subtotal%></emphasis>.</para>
6477 <title>Zwei-Zeichen Abkürzung</title>
6479 <para>Der Typ des Artikels und die Klassifizierung werden durch zwei
6480 Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
6481 Artikel-Typs ('P','A','S'), deutsch 'W', 'E', und 'D' für Ware
6482 Erzeugnis oder Dienstleistung und ggf. weiterer Typen.</para>
6484 <para>Der zweite Buchstabe (und ggf. auch ein dritter, falls nötig)
6485 entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
6487 <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
6488 Erleichterung mit dargestellt.</para>
6492 <sect1 id="features.file_managment">
6493 <title>Dateiverwaltung (Mini-DMS)</title>
6496 <title>Übersicht</title>
6497 <para>Parallel zum alten WebDAV gibt es ein Datei-Management-System, das Dateien
6498 verschiedenen Typs verwaltet. Dies können</para>
6501 <para>aus ERP-Daten per LaTeX Template erzeugte PDF-Dokumente,</para>
6504 <para>zu bestimmten ERP-Daten gehörende Anhangdateien unterschiedlichen Formats,</para>
6507 <para>per Scanner eingelesene PDF-Dateien,</para>
6510 <para>per E-Mail empfangene Dateianhänge unterschiedlichen Formats,</para>
6513 <para>sowie speziel für Artikel hochgeladene Bilder sein.</para>
6517 <screeninfo>Übersicht</screeninfo>
6520 <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
6527 <title>Struktur</title>
6529 <para>Über eine vom Speichermedium unabhängige Zwischenschicht werden die Dateien und ihre Versionen in der Datenbank verwaltet. Darunter können verschiedene Implementierungen (Backends) gleichzeitig existieren:
6533 <para>Dateisystem</para>
6539 <para>Schnittstelle zu externen Dokumenten-Management-Systemen</para>
6542 <para>andere Datenbank</para>
6545 <para>etc ...</para>
6548 <para>Es gibt unterschiedliche Typen von Dateien. Jedem Typ läßt sich in der
6549 Mandantenkonfiguration ein bestimmtes Backend zuordnen.
6553 <para>"document": Das sind entweder generierte, eingescannte oder hochgeladene PDF-Dateien,
6554 die zu bestimmten ERP-Daten (ERP-Objekte, wie z.B. Rechnung, Lieferschein) gehören.</para>
6557 <para>"attachment": zusätzlich hochgeladene Dokumente, die an bestimmte ERP-Objekte angehängt werden,
6558 z.B. technische Zeichnungen, Aufmaße. Diese können auch für Artikel,
6559 Lieferanten und Kunden hinterlegt sein.</para>
6562 <para>"image": Bilder für Artikel. Diese können auch verkleinert in einer Vorschau (Thumbnail)
6563 angezeigt werden.</para>
6566 <para>Zusätzlich werden in der Datenbank zu den Dateien neben der Zuordnung zu ERP-Objekten, Dateityp
6567 Dateinamen und Backend, in dem die Datei gespeichert ist, auch die Quelle der Datei notiert:
6571 <para> "created": vom System erzeugte Dokumente"</para>
6574 <para> "uploaded": hochgeladene Dokumente</para>
6577 <para> "email": vom Mail-System empfangene Dateien</para>
6580 <para> "scanner[1]": von einem oder mehreren Scannern erzeugte Dateien. Existieren mehrere Scanner,
6581 so sind diese durch unterschiedliche Quellennamen zu definieren.</para>
6584 <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es für "attachment" und "image" nur
6585 die Quelle "uploaded". Für "document" gibt es auf jeden Fall die Quelle "created".
6586 Die Quellen "scanner" und "email" müssen derzeit in der Datenbank konfiguriert werden
6587 (siehe <xref linkend="file_management.dbconfig"/>).</para>
6591 <title>Anwendung</title>
6592 <para>Die Daten werden bei den ERP-Objekten als extra Reiter dargestellt.
6593 Eine Verkaufsrechnung z.B. hat die
6594 Reiter "Dokumente" und "Dateianhänge".</para>
6596 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6599 <imagedata scale="50" fileref="images/DMS-Anhaenge.png"/>
6603 <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer Datei angezeigt.
6604 Wird eine Datei mit gleichem Namen hochgeladen, so wird eine neue Version der Datei erstellt.
6605 Vorher wird der Anwender durch einen Dialog gefragt, ob er eine neue Version anlegen will oder
6606 ob er die Datei umbenennen will, falls es eine neue Datei sein soll.</para>
6608 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6611 <imagedata width="100" contentwidth="40" fileref="images/DMS-Anhaenge-hochladen.png"/>
6615 <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
6616 solange in Summe die maximale Größe nicht überschritten wird
6617 (siehe <xref linkend="file_management.clientconfig"/>).</para>
6619 <screeninfo>Reiter "Dokumente"</screeninfo>
6622 <imagedata width="500" fileref="images/DMS-Dokumente.png"/>
6626 <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt es nur "erzeugte Dokumente".
6627 Es werden alle Versionen der generierten Datei angezeigt. Für Verkaufsrechnungen kommen keine
6628 anderen Quellen zur Geltung. Werden entsprechend der
6629 <xref linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert, so sind diese z.B. bei
6630 Einkaufsrechnungen sichtbar:</para>
6632 <screeninfo>Reiter "Dokumente"</screeninfo>
6635 <imagedata contentwidth="600" fileref="images/DMS-Dokumente-Scanner.png"/>
6639 <para>Statt des Löschens wird hier die Datei zurück zur Quelle verschoben. Somit kann die Datei anschließend
6640 an ein anderes ERP-Objekt angehängt werden.</para>
6641 <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie sind bisher nur bei Bildern relevant.</para>
6645 <title>Konfigurierung</title>
6646 <sect3 id="file_management.clientconfig" xreflabel="Mandantenkonfigurierung">
6647 <title>Mandantenkonfiguration</title>
6649 <title>Reiter "Features"</title>
6650 <para>Unter dem Reiter <emphasis role="bold">Features</emphasis> im Abschnitt Dateimanagement ist
6651 neben dem "alten" WebDAV das Dateimangement generell zu- und abschaltbar, sowie die Zuordnung der
6652 Dateitypen zu Backends. Die Löschbarkeit von Dateien, sowie die maximale Uploadgröße sind Backend-unabhängig</para>
6654 <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
6657 <imagedata width="500" fileref="images/DMS-ClientConfig.png"/>
6661 <para>Die einzelnen Backends sind einzeln einschaltbar. Spezifische Backend-Konfigurierungen sind hier
6662 noch ergänzbar.</para>
6665 <title>Reiter "Allgemeine Dokumentenanhänge"</title>
6666 <para>Unter dem Reiter <emphasis role="bold">Allgemeine Dokumentenanhänge</emphasis>
6667 kann für alle ERP-Dokumente ( Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und Einkauf )
6668 allgemeingültige Anhänge hochgeladen werden.</para>
6670 <screeninfo>Mandantenkonfig Reiter "Allgemeine Dokumentenanhänge"</screeninfo>
6673 <imagedata width="500" fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"/>
6677 <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die ERP-Dokumente angehängt,
6678 z.B. AGBs oder aktuelle Angebote. Es werden in dem Fall die Daten kopiert, sodass an den ERP-Dokumenten immer
6679 die Anhänge zum Generierungszeitpunkt eingebettet sind.
6683 <sect3 id="file_management.dbconfig" xreflabel="Datenbank-Konfigurierung">
6684 <title>Datenbank-Konfigurierung</title>
6685 <para>Die zusätzlichen Quellen für "email" oder ein oder mehrere Scanner sind derzeit vom Administrator
6686 direkt in der Datenbanktabelle "user_preferences" einzurichten. Die "value" ist im JSON-Format
6687 mit den jeweiligen Werten des Verzeichnisses und der Beschreibung der Quelle.</para>
6689 id | login | namespace | version | key | value
6690 ----+-----------+--------------+---------+----------+---------------------------
6691 1 | #default# | file_sources | 0.00000 | scanner1 |
6692 {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
6693 2 | #default# | file_sources | 0.00000 | scanner2 |
6694 {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
6695 3 | #default# | file_sources | 0.00000 | emails |
6696 {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
6698 <para>Es ist daran gedacht, statt dem Default-Eintrag später für bestimmte Benutzer ('login') bestimmte Quellen zuzulassen.
6699 Dies wird nach Bedarf implementiert.</para>
6701 <sect3 id="file_management.kiviconfig" xreflabel="kivitendo-Konfigurationsdatei">
6702 <title>kivitendo-Konfigurationsdatei</title>
6703 <para>Dort ist im Abschnitt [paths] der relative oder absolute Pfad zum Dokumentenwurzelverzeichnis einzutragen.
6704 Dieser muss für den Webserver schreib- und lesbar sein, jedoch nicht ausführbar.</para>
6707 document_path = /var/local/kivi_documents
6709 <para>Unter diesem Wurzelverzeichnis wird pro Mandant automatisch ein Unterverzeichnis mit der ID des Mandanten angelegt.</para>
6716 <title>Entwicklerdokumentation</title>
6718 <sect1 id="devel.globals" xreflabel="Globale Variablen">
6719 <title>Globale Variablen</title>
6722 <title>Wie sehen globale Variablen in Perl aus?</title>
6724 <para>Globale Variablen liegen in einem speziellen namespace namens
6725 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
6726 globs global und die meisten speziellen Variablen sind...
6729 <para>Daraus ergeben sich folgende Formen:</para>
6733 <term><literal>$main::form</literal></term>
6736 <para>expliziter Namespace "main"</para>
6741 <term><literal>$::form</literal></term>
6744 <para>impliziter Namespace "main"</para>
6749 <term><literal>open FILE, "file.txt"</literal></term>
6752 <para><varname>FILE</varname> ist global</para>
6757 <term><literal>$_</literal></term>
6760 <para>speziell</para>
6765 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
6766 Schlüsselwort wie "<function>global</function>", mit dem man
6767 importieren kann. <function>my</function>, <function>our</function>
6768 und <function>local</function> machen was anderes.</para>
6772 <term><literal>my $form</literal></term>
6775 <para>lexikalische Variable, gültig bis zum Ende des
6781 <term><literal>our $form</literal></term>
6784 <para><varname>$form</varname> referenziert ab hier
6785 <varname>$PACKAGE::form</varname>.</para>
6790 <term><literal>local $form</literal></term>
6793 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
6794 des scopes zurückgesetzt</para>
6801 <title>Warum sind globale Variablen ein Problem?</title>
6803 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
6805 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
6806 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
6807 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
6808 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
6809 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
6810 Datenbankverbindungen, weil die sehr lange zum Initialisieren
6813 <para>Das zweite Problem ist <function>strict</function>. Unter
6814 <function>strict</function> werden alle Variablen die nicht explizit
6815 mit <function>Package</function>, <function>my</function> oder
6816 <function>our</function> angegeben werden als Tippfehler angemarkert,
6817 dies hat, seit der Einführung, u.a. schon so manche langwierige
6818 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
6819 angegeben werden, werden die nicht geprüft, und somit kann sich
6820 schnell ein Tippfehler einschleichen.</para>
6824 <title>Kanonische globale Variablen</title>
6826 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
6827 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
6828 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
6829 umhergereicht werden.</para>
6831 <para>Diese Variablen sind im Moment die folgenden neun:</para>
6835 <para><varname>$::form</varname></para>
6839 <para><varname>%::myconfig</varname></para>
6843 <para><varname>$::locale</varname></para>
6847 <para><varname>$::lxdebug</varname></para>
6851 <para><varname>$::auth</varname></para>
6855 <para><varname>$::lx_office_conf</varname></para>
6859 <para><varname>$::instance_conf</varname></para>
6863 <para><varname>$::dispatcher</varname></para>
6867 <para><varname>$::request</varname></para>
6871 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
6872 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
6873 Eigenschaften (Konventionen):</para>
6876 <title>$::form</title>
6880 <para>Ist ein Objekt der Klasse
6881 "<classname>Form</classname>"</para>
6885 <para>Wird nach jedem Request gelöscht</para>
6889 <para>Muss auch in Tests und Konsolenscripts vorhanden
6894 <para>Enthält am Anfang eines Requests die Requestparameter vom
6899 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
6900 cachen, das wird aber momentan absichtlich zerstört</para>
6904 <para><varname>$::form</varname> wurde unter <productname>SQL
6905 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
6906 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
6907 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
6908 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
6909 <function>IS->retrieve_customer()</function> in Sicherheit
6912 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
6913 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
6914 3552, Stand version 2.7beta), um dies hinterher wieder auf den
6915 richtigen Wert zu setzen:</para>
6917 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
6918 $::myconfig{numberformat} = $numberformat;
6919 # (...) div Berechnungen
6920 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
6922 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
6923 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
6924 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
6925 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
6926 Es geht ziemlich sicher etwas kaputt.</para>
6928 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
6929 in den <productname>Template::Toolkit</productname> Templates
6930 außerhalb der Controller: der Ausdruck <function>[% var
6931 %]</function> greift auf <varname>$::form->{var}</varname> zu.
6932 Unter Controllern ist der Standard Scope anders, da lautet der
6933 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
6934 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
6935 <function><%var%></function> zeigt auf
6936 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
6937 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
6940 <programlisting>[%- IF business %]
6941 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
6942 [%- END %]</programlisting>
6944 <para>Entweder wird hier dann $::form->{business} ausgewertet
6945 oder aber der Funktion
6946 <function>$form->parse_html_template</function> wird explizit
6947 noch ein zusätzlicher Hash übergeben, der dann auch in den
6948 (Web-)Templates zu Verfügung steht, bspw. so:</para>
6950 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
6952 <para>Innerhalb von Schleifen wird
6953 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
6954 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
6955 welches über alle Positionen eines Lieferscheins in Schleife
6958 <programlisting>for $i (1 .. $form->{rowcount}) {
6960 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
6961 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
6962 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
6968 <title>%::myconfig</title>
6972 <para>Das einzige Hash unter den globalen Variablen</para>
6976 <para>Wird spätestens benötigt wenn auf die Datenbank
6977 zugegriffen wird</para>
6981 <para>Wird bei jedem Request neu erstellt.</para>
6985 <para>Enthält die Userdaten des aktuellen Logins</para>
6989 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
6990 extern serialisiert werden, weil da auch der Datenbankzugriff
6991 für diesen user drinsteht.</para>
6995 <para>Enthält unter anderem Datumsformat dateformat und Nummernformat numberformat</para>
6999 <para>Enthält Datenbankzugriffinformationen</para>
7003 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
7004 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
7005 aktuellen Users entscheiden müssen, befragen
7006 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
7007 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
7008 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
7009 Informationen über den Benutzer die über die
7010 Administrator-Schnittstelle eingegeben wurden.</para>
7014 <title>$::locale</title>
7018 <para>Objekt der Klasse "Locale"</para>
7022 <para>Wird pro Request erstellt</para>
7026 <para>Muss auch für Tests und Scripte immer verfügbar
7031 <para>Cached intern über Requestgrenzen hinweg benutzte
7036 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
7037 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
7041 <title>$::lxdebug</title>
7045 <para>Objekt der Klasse "LXDebug"</para>
7049 <para>Wird global gecached</para>
7053 <para>Muss immer verfügbar sein, in nahezu allen
7058 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
7059 bereit, wie "<function>enter_sub</function>" und
7060 "<function>leave_sub</function>", mit denen in den alten Modulen ein
7061 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
7062 der man die Wallclockzeit seit Requeststart loggen kann, sowie
7063 "<function>message</function>" und "<function>dump</function>" mit
7064 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
7067 <para>Beispielsweise so:</para>
7069 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
7070 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
7074 <title>$::auth</title>
7078 <para>Objekt der Klasse "SL::Auth"</para>
7082 <para>Wird global gecached</para>
7086 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
7090 <para>Wird nach jedem Request resettet.</para>
7094 <para><varname>$::auth</varname> stellt Funktionen bereit um die
7095 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
7096 vom aktuellen User abhängen wird das Objekt aus
7097 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
7098 Request kurz resettet.</para>
7100 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
7101 Dessen Einstellungen können über
7102 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
7103 ist ein Hash mit den Werten aus der Tabelle
7104 <literal>auth.clients</literal>.</para>
7108 <title>$::lx_office_conf</title>
7112 <para>Objekt der Klasse
7113 "<classname>SL::LxOfficeConf</classname>"</para>
7117 <para>Global gecached</para>
7121 <para>Repräsentation der
7122 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
7126 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
7127 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
7128 das Programm die Konfiguration ändern kann oder sollte.</para>
7130 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
7131 Debug- und Trace-Log-Datei wie folgt konfiguriert und
7134 <programlisting>[debug]
7135 file_name = /tmp/kivitendo-debug.log</programlisting>
7137 <para>ist der Key <varname>file</varname> im Programm als
7138 <varname>$::lx_office_conf->{debug}{file}</varname>
7142 <para>Zugriff auf die Konfiguration erfolgt im Moment über
7143 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
7148 <title>$::instance_conf</title>
7152 <para>Objekt der Klasse
7153 "<classname>SL::InstanceConfiguration</classname>"</para>
7157 <para>wird pro Request neu erstellt</para>
7161 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
7162 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
7163 ist hier eine Mandantendatenbank. Beispielsweise überprüft
7164 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
7165 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
7169 <title>$::dispatcher</title>
7173 <para>Objekt der Klasse
7174 "<varname>SL::Dispatcher</varname>"</para>
7178 <para>wird pro Serverprozess erstellt.</para>
7182 <para>enthält Informationen über die technische Verbindung zum
7187 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
7188 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
7189 Objekt untergebracht.</para>
7193 <title>$::request</title>
7197 <para>Hashref (evtl später Objekt)</para>
7201 <para>Wird pro Request neu initialisiert.</para>
7205 <para>Keine Unterstruktur garantiert.</para>
7209 <para><varname>$::request</varname> ist ein generischer Platz um
7210 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
7211 at a distance benutzt werden, sondern um lokales memoizing zu
7212 ermöglichen, das garantiert am Ende des Requests zerstört
7215 <para>Vieles von dem, was im moment in <varname>$::form</varname>
7216 liegt, sollte eigentlich hier liegen. Die groben
7217 Differentialkriterien sind:</para>
7221 <para>Kommt es vom User, und soll unverändert wieder an den
7222 User? Dann <varname>$::form</varname>, steht da eh schon</para>
7226 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
7227 Requests gebraucht werden? Dann
7228 <varname>$::request</varname></para>
7232 <para>Muss ich von anderen Teilen des Programms lesend drauf
7233 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
7234 Wrappermethode</para>
7241 <title>Ehemalige globale Variablen</title>
7243 <para>Die folgenden Variablen waren einmal im Programm, und wurden
7247 <title>$::cgi</title>
7251 <para>war nötig, weil cookie Methoden nicht als
7252 Klassenfunktionen funktionieren</para>
7256 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
7257 Klassennamespace gehalten wird und über Requestgrenzen
7262 <para>liegt jetzt unter
7263 <varname>$::request->{cgi}</varname></para>
7269 <title>$::all_units</title>
7273 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
7274 ein paar hundert mal pro Request eine Liste der Einheiten
7275 brauchen, und de als Parameter durch einen Riesenstack von
7276 Funktionen geschleift werden müssten.</para>
7280 <para>Liegt jetzt unter
7281 <varname>$::request->{cache}{all_units}</varname></para>
7286 <function>AM->retrieve_all_units()</function> gesetzt oder
7293 <title>%::called_subs</title>
7297 <para>wurde benutzt um callsub deep recursions
7302 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
7303 möglichen Rekursioenen darstellt, und da nie welche
7308 <para>komplette recursion protection wurde entfernt.</para>
7315 <sect1 id="devel.fcgi">
7316 <title>Entwicklung unter FastCGI</title>
7318 <sect2 id="devel.fcgi.general">
7319 <title>Allgemeines</title>
7321 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
7322 werden, muss der Webserver neu gestartet werden.</para>
7324 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
7325 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
7326 müssen folgende Aspekte beachtet werden.</para>
7329 <sect2 id="devel.fcgi.exiting">
7330 <title>Programmende und Ausnahmen</title>
7332 <para>Betrifft die Funktionen <function>warn</function>,
7333 <function>die</function>, <function>exit</function>,
7334 <function>carp</function> und <function>confess</function>.</para>
7336 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
7337 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
7338 am Laufen zu halten. Man kann mit <function>die</function>,
7339 <function>confess</function> oder <function>carp</function> Fehler
7340 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
7341 eigene <function>$::form-</function>error()> tut im Prinzip das
7342 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
7343 <function>exit</function> hingegen werden nicht abgefangen.
7344 <function>warn</function> wird direkt nach STDERR, also in Server Log
7345 eine Nachricht schreiben (sofern in der Konfiguration nicht die
7346 Warnungen in das kivitendo Log umgeleitet wurden), und
7347 <function>exit</function> wird die Ausführung beenden.</para>
7349 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
7350 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
7351 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
7352 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
7355 <sect2 id="devel.fcgi.globals">
7356 <title>Globale Variablen</title>
7358 <para>Um zu vermeiden, dass Informationen von einem Request in einen
7359 anderen gelangen, müssen alle globalen Variablen vor einem Request
7360 sauber initialisiert werden. Das ist besonders wichtig im
7361 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
7362 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
7365 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
7366 abgetrennten Block, der alle kanonischen globalen Variablen listet und
7367 erklärt. Bitte keine anderen einführen ohne das sauber zu
7368 dokumentieren.</para>
7370 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
7371 man sicher geht, dass man die richtige erwischt.</para>
7374 <sect2 id="devel.fcgi.performance">
7375 <title>Performance und Statistiken</title>
7377 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
7378 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
7379 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
7380 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
7381 sind es je nach Menge der definierten Variablen 1-2s. Ab der
7382 Moose/Rose::DB Version sind es 5-6s.</para>
7384 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
7385 den kritischen Pfaden, unter 0,15 sonst.</para>
7389 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
7390 <title>SQL-Upgradedateien</title>
7392 <sect2 id="db-upgrade-files.introduction"
7393 xreflabel="Einführung in die Datenbank-Upgradedateien">
7394 <title>Einführung</title>
7396 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
7397 gesteuert, die sich im Verzeichnis
7398 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
7399 muss pro Datenbankupgrade eine Datei existieren, die neben den
7400 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
7401 Kontrollinformationen enthält.</para>
7403 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
7404 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
7405 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
7406 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
7407 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
7408 Versionsnummern braucht.</para>
7410 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
7411 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
7412 führt diese nicht erneut aus. Dazu dient die Tabelle
7413 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
7414 angelegt wird.</para>
7417 <sect2 id="db-upgrade-files.format"
7418 xreflabel="Format der Upgradedateien">
7419 <title>Format der Kontrollinformationen</title>
7421 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
7422 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
7423 hat dabei das folgende Format:</para>
7425 <para>Für SQL-Upgradedateien:</para>
7427 <programlisting>-- @key: value</programlisting>
7429 <para>Für Perl-Upgradedateien:</para>
7431 <programlisting># @key: value</programlisting>
7433 <para>Leerzeichen vor "<varname>value</varname>" werden
7436 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
7440 <term><varname>tag</varname></term>
7443 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
7444 Dieser "tag" kann von anderen Kontrolldateien in ihren
7445 Abhängigkeiten verwendet werden (Schlüsselwort
7446 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
7447 in der Datenbank eingetragen wird.</para>
7449 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
7450 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
7452 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
7453 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
7454 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
7460 <term><varname>charset</varname></term>
7463 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
7464 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
7465 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
7466 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
7467 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
7468 hingegen müssen immer in UTF-8 encodiert sein und sollten
7469 demnach auch ein "<literal>use utf8;</literal>"
7475 <term><varname>description</varname></term>
7478 <para>Benötigt. Eine Beschreibung, was in diesem Update
7479 passiert. Diese wird dem Benutzer beim eigentlichen
7480 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
7481 sein sollte, sollte die Beschreibung auf Deutsch
7487 <term><varname>depends</varname></term>
7490 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
7491 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
7492 dass die in dieser Liste aufgeführten Scripte bereits
7493 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
7495 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
7496 Script "b" existiert, das von Änderungen in "a" abhängt, und
7497 eine neue Kontrolldatei für "c" erstellt wird, die von
7498 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
7499 Tag "b" als Abhängigkeit zu definieren.</para>
7501 <para>Es ist nicht erlaubt, sich selbst referenzierende
7502 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
7503 und "c" -> "a").</para>
7508 <term><varname>priority</varname></term>
7511 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
7512 der Scripte ausgeführt werden, die die gleichen
7513 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
7514 der Wert 1000 benutzt.</para>
7516 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
7517 "depends" benutzt werden. kivitendo sortiert die auszuführenden
7518 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
7519 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
7520 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
7521 dann "y", dann "z"), dann nach der Priorität und bei gleicher
7522 Priorität alphabetisch nach dem "tag".</para>
7527 <term><varname>ignore</varname></term>
7530 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
7531 Skript bei der Anmeldung ignoriert und entsprechend nicht
7538 <sect2 id="db-upgrade-files.format-perl-files"
7539 xreflabel="Format von Perl-Upgradedateien">
7540 <title>Format von in Perl geschriebenen
7541 Datenbankupgradescripten</title>
7543 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
7544 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
7545 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
7547 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
7548 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
7549 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
7550 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
7551 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
7552 aufgerufen wird.</para>
7554 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
7555 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
7556 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
7557 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
7558 "<literal>SL::DBUpgrade2::tag</literal>".</para>
7560 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
7561 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
7562 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
7564 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
7567 <programlisting># @tag: beispiel-upgrade-file42
7568 # @description: Ein schönes Beispielscript
7569 # @depends: release_3_1_0
7570 package SL::DBUpgrade2::beispiel_upgrade_file42;
7575 use parent qw(SL::DBUpgrade2::Base);
7580 # hier Aktionen ausführen
7589 <sect2 id="db-upgrade-files.dbupgrade-tool"
7590 xreflabel="Hilfsscript dbupgrade2_tool.pl">
7591 <title>Hilfsscript dbupgrade2_tool.pl</title>
7593 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
7594 existiert ein Hilfsscript namens
7595 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
7596 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
7597 liest alle Datenbankupgradescripte aus dem Verzeichnis
7598 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
7599 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
7600 von der Kommandozeile überprüft werden können.</para>
7602 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
7603 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
7604 sich aber auch Informationen auf verschiedene Art ausgeben
7609 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
7610 --list</command>"</para>
7612 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
7613 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
7614 würde. Es werden neben der Listenposition der Tag, die
7615 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
7619 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
7620 --tree</command>"</para>
7622 <para>Listet alle Tags in Baumform basierend auf den
7623 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
7624 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
7625 beim übergeordneten Script als Abhängigkeit eingetragen
7629 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
7630 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
7631 --rtree</command>"</para>
7633 <para>Listet alle Tags in Baumform basierend auf den
7634 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
7635 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
7636 die das übergeordnete Script als Abhängigkeit eingetragen
7641 <para>Baumform mit Postscriptausgabe:
7642 "<command>./scripts/dbupgrade2_tool.pl
7643 --graphviz</command>"</para>
7645 <para>Benötigt das Tool "<command>graphviz</command>", um mit
7646 seiner Hilfe die <link
7647 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
7648 Baumform</link> in eine Postscriptdatei namens
7649 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
7650 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
7651 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
7652 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
7657 <para>Scripte, von denen kein anderes Script abhängt:
7658 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
7660 <para>Listet die Tags aller Scripte auf, von denen keine anderen
7661 Scripte abhängen.</para>
7667 <sect1 id="translations-languages" xreflabel="Translations and languages">
7668 <title>Translations and languages</title>
7670 <sect2 id="translations-languages.introduction"
7671 xreflabel="Introduction to translations and languages">
7672 <title>Introduction</title>
7675 <para>Dieser Abschnitt ist in Englisch geschrieben, um
7676 internationalen Übersetzern die Arbeit zu erleichtern.</para>
7679 <para>This section describes how localization packages in kivitendo
7680 are built. Currently the only language fully supported is German, and
7681 since most of the internal messages are held in English the English
7682 version is usable too.</para>
7685 <sect2 id="translations-languages.character-set"
7686 xreflabel="Character set">
7687 <title>Character set</title>
7689 <para>All files included in a language pack must use UTF-8 as their
7693 <sect2 id="translations-languages.file-structure"
7694 xreflabel="File structure">
7695 <title>File structure</title>
7697 <para>The structure of locales in kivitendo is:</para>
7699 <programlisting>kivitendo/locale/<langcode>/</programlisting>
7701 <para>where <langcode> stands for an abbreviation of the
7702 language package. The builtin packages use two letter <ulink
7703 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
7704 but the actual name is not relevant for the program and can easily be
7706 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
7707 tags</ulink> (i.e. "en_GB"). In fact the original language packages
7708 from SQL Ledger are named in this way.</para>
7710 <para>In such a language directory the following files are
7715 <term>LANGUAGE</term>
7718 <para>This file is mandatory.</para>
7720 <para>The <filename>LANGUAGE</filename> file contains the self
7721 descripted name of the language. It should contain a native
7722 representation first, and in parenthesis an english translation
7723 after that. Example:</para>
7725 <programlisting>Deutsch (German)</programlisting>
7733 <para>This file is mandatory.</para>
7735 <para>The central translation file. It is essentially an inline
7736 Perl script autogenerated by <command>locales.pl</command>. To
7737 generate it, generate the directory and the two files mentioned
7738 above, and execute the following command:</para>
7740 <programlisting>scripts/locales.pl <langcode></programlisting>
7742 <para>Otherwise you can simply copy one of the other languages.
7743 You will be told how many are missing like this:</para>
7745 <programlisting>$ scripts/locales.pl en
7746 English - 0.6% - 2015/2028 missing</programlisting>
7748 <para>A file named "<filename>missing</filename>" will be
7749 generated and can be edited. You can also edit the
7750 "<filename>all</filename>" file directly. Edit everything you
7751 like to fit the target language and execute
7752 <command>locales.pl</command> again. See how the missing words
7758 <term>Num2text</term>
7761 <para>Legacy code from SQL Ledger. It provides a means for
7762 numbers to be converted into natural language, like
7763 <literal>1523 => one thousand five hundred twenty
7764 three</literal>. If you want to provide it, it must be inlinable
7765 Perl code which provides a <function>num2text</function> sub. If
7766 an <function>init</function> sub exists it will be executed
7769 <para>Only used in the check and receipt printing module.</para>
7774 <term>special_chars</term>
7777 <para>kivitendo comes with a lot of interfaces to different
7778 formats, some of which are rather picky with their accepted
7779 charset. The <filename>special_chars</filename> file contains a
7780 listing of chars not suited for different file format and
7781 provides substitutions. It is written in "Simple Ini" style,
7782 containing a block for every file format.</para>
7784 <para>First entry should be the order of substitution for
7785 entries as a whitespace separated list. All entries are
7786 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
7787 and <literal>\\</literal> all work.</para>
7789 <para>After that every entry is a special char that should be
7790 translated when writing text into such a file.</para>
7792 <para>Example:</para>
7794 <programlisting>[Template/XML]
7795 order=& < > \n
7799 \n=<br></programlisting>
7801 <para>Note the importance of the order in this example.
7802 Substituting < and > befor & would lead to $gt; become
7805 <para>For a list of valid formats, see the German
7806 <filename>special_chars</filename> entry. As of this writing the
7807 following are recognized:</para>
7809 <programlisting>HTML
7814 Template/OpenDocument
7815 filenames</programlisting>
7817 <para>The last of which is very machine dependant. Remember that
7818 a lot of characters are forbidden by some filesystems, for
7819 example MS Windows doesn't like ':' in its files where Linux
7820 doesn't mind that. If you want the files created with your
7821 language pack to be portable, find all chars that could cause
7827 <term>missing</term>
7830 <para>This file is not a part of the language package
7833 <para>This is a file generated by
7834 <command>scripts/locales.pl</command> while processing your
7835 locales. It's only to have the missing entries singled out and
7836 does not belong to a language package.</para>
7844 <para>This file is not a part of the language package
7847 <para>Another file generated by
7848 <command>scripts/locales.pl</command>. If for any reason a
7849 translation does not appear anymore and can be deleted, it gets
7850 moved here. The last 50 or so entries deleted are saved here in
7851 case you made a typo, so that you don't have to translate
7852 everything again. If a tranlsation is missing, the lost file is
7853 checked first. If you maintain a language package, you might
7854 want to keep this safe somewhere.</para>
7859 <term>more/all</term>
7862 <para>This subdir and file is not a part of the language package
7865 <para>If the directory more exists and contains a file called
7866 all it will be parsed in addition to the mandatory all (see
7867 above). The file is useful if you want to change some
7868 translations for the current installation without conflicting
7869 further upgrades. The file is not autogenerated and has the same
7870 format as the all, but needs another key (more_texts). See the
7871 german translation for an example or copy the following code:
7874 # -*- coding: utf-8; -*-
7879 # These are additional texts for custom translations.
7880 # The format is the same as for the normal file all, only
7881 # with another key (more_texts instead of texts).
7882 # The file has the form of 'english text' => 'foreign text',
7884 $self->{more_texts} = {
7886 'Ship via' => 'Terms of delivery',
7887 'Shipping Point' => 'Delivery time',
7889 </programlisting></para>
7896 <sect1 id="devel.testsuite">
7897 <title>Die kivitendo-Test-Suite</title>
7899 <sect2 id="devel.testsuite.intro">
7900 <title>Einführung</title>
7902 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
7903 basiert auf dem Standard-Perl-Modul
7904 <literal>Test::More</literal>.</para>
7906 <para>Die grundlegenden Fakten sind:</para>
7910 <para>Alle Tests liegen im Unterverzeichnis
7911 <filename>t/</filename>.</para>
7915 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
7916 enthält einen oder mehrere Testfälle.</para>
7920 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
7921 Es sind selbstständig ausführbare Perl-Scripte.</para>
7925 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
7926 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
7927 auf <literal>.t</literal> endet.</para>
7932 <sect2 id="devel.testsuite.prerequisites">
7933 <title>Voraussetzungen</title>
7935 <para>Für die Ausführung werden neben den für kivitendo eh schon
7936 benötigten Module noch weitere Perl-Module benötigt. Diese
7941 <para><literal>Test::Deep</literal> (Debian-Paketname:
7942 <literal>libtest-deep-perl</literal>; Fedora:
7943 <literal>perl-Test-Deep</literal>; openSUSE:
7944 <literal>perl-Test-Deep</literal>)</para>
7948 <para><literal>Test::Exception</literal> (Debian-Paketname:
7949 <literal>libtest-exception-perl</literal>; Fedora:
7950 <literal>perl-Test-Exception</literal>; openSUSE:
7951 <literal>perl-Test-Exception</literal>)</para>
7955 <para><literal>Test::Output</literal> (Debian-Paketname:
7956 <literal>libtest-output-perl</literal>; Fedora:
7957 <literal>perl-Test-Output</literal>; openSUSE:
7958 <literal>perl-Test-Output</literal>)</para>
7962 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
7963 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
7964 kann für frühere Versionen aus dem <ulink
7965 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
7969 <para><literal>LWP::Simple</literal> aus dem Paket
7970 <literal>libwww-perl</literal> (Debian-Panetname:
7971 <literal>libwww-perl</literal>; Fedora:
7972 <literal>perl-libwww-perl</literal>; openSUSE:
7973 <literal>perl-libwww-perl</literal>)</para>
7977 <para><literal>URI::Find</literal> (Debian-Panetname:
7978 <literal>liburi-find-perl</literal>; Fedora:
7979 <literal>perl-URI-Find</literal>; openSUSE:
7980 <literal>perl-URI-Find</literal>)</para>
7984 <para><literal>Sys::CPU</literal> (Debian-Panetname: <literal>libsys-cpu-perl</literal>; Fedora und openSUSE: nicht
7989 <para><literal>Thread::Pool::Simple</literal> (Debian-Panetname: <literal>libthread-pool-simple-perl</literal>; Fedora und
7990 openSUSE: nicht vorhanden)</para>
7994 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
7995 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
7996 müssen in der Konfigurationsdatei im Abschnit
7997 <literal>testing/database</literal> Datenbankverbindungsparameter
7998 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
7999 Recht haben, Datenbanken anzulegen und zu löschen.</para>
8002 <sect2 id="devel.testsuite.execution">
8003 <title>Existierende Tests ausführen</title>
8005 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
8006 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
8007 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
8008 <filename>t/test.pl</filename>.</para>
8010 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
8011 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
8012 kivitendo-Basisverzeichnis heraus ausführen.</para>
8014 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
8015 an <filename>t/test.pl</filename>. Beispielsweise:</para>
8017 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
8020 <sect2 id="devel.testsuite.meaning_of_scripts">
8021 <title>Bedeutung der verschiedenen Test-Scripte</title>
8023 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
8024 Programmierstil. Einige besonders zu erwähnende, weil auch während der
8025 Entwicklung nützliche Tests sind:</para>
8029 <para><filename>t/001compile.t</filename> -- compiliert alle
8030 Quelldateien und bricht bei Fehlern sofort ab</para>
8034 <para><filename>t/002goodperl.t</filename> -- überprüft alle
8035 Perl-Dateien auf Anwesenheit von '<literal>use
8036 strict</literal>'-Anweisungen</para>
8040 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
8041 <function>system()</function> und <function>exec()</function> auf
8046 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
8047 Tab-Zeichen enthalten</para>
8051 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
8052 Rechtschreibfehlern</para>
8056 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
8057 Dokumentation im POD-Format auf Gültigkeit</para>
8061 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
8062 einzelner Funktionen und Module.</para>
8065 <sect2 id="devel.testsuite.create_new">
8066 <title>Neue Test-Scripte erstellen</title>
8068 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
8069 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
8070 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
8073 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
8074 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
8077 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
8082 <para>Überprüfung auf fehlende symbolische Links</para>
8086 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
8087 gewissen Einschränkungen wie das Erlauben von deutschen
8092 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
8096 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
8100 <para>Test, ob alle zu übersetzenden Strings in
8101 <filename>locale/de/all</filename> vorhanden sind</para>
8105 <para>Test, ob alle Webseiten-Templates in
8106 <filename>templates/webpages</filename> mit vom Perl-Modul
8107 <literal>Template</literal> compiliert werden können</para>
8112 <sect3 id="devel.testsuite.directory_and_test_names">
8113 <title>Konvention für Verzeichnis- und Dateinamen</title>
8115 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
8116 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
8117 und ihnen soweit es geht folgen:</para>
8121 <para>Die Dateiendung muss <filename>.t</filename>
8126 <para>Namen sind englisch, komplett klein geschrieben und
8127 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
8128 <filename>bad_function_params.t</filename>).</para>
8132 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
8133 benannt sein, mit dem sich die Scripte darin befassen
8134 (beispielsweise <filename>background_jobs</filename> für Tests
8135 rund um Hintergrund-Jobs).</para>
8139 <para>Test-Scripte sollten einen überschaubaren Bereich von
8140 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
8141 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
8142 Test-Scripte schreiben.</para>
8147 <sect3 id="devel.testsuite.minimal_example">
8148 <title>Minimales Skelett für eigene Scripte</title>
8150 <para>Der folgenden Programmcode enthält das kleinstmögliche
8151 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
8154 <programlisting>use Test::More tests => 0;
8158 use Support::TestSetup;
8160 Support::TestSetup::login();</programlisting>
8162 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
8163 benötigt (Stichwort: alle globalen Variablen wie
8164 <varname>$::auth</varname>, <varname>$::form</varname> oder
8165 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
8166 <filename>config/kivitendo.conf</filename> im Abschnitt
8167 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
8168 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
8170 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
8171 kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
8172 weggelassen werden, was die Ausführungszeit des Scripts leicht
8178 <sect1 id="devel.style-guide">
8179 <title>Stil-Richtlinien</title>
8181 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
8182 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
8183 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
8184 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
8186 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
8189 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
8190 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
8195 <para>Es werden keine echten Tabs sondern Leerzeichen
8200 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
8202 <programlisting>foreach my $row (@data) {
8204 # do something with $row
8208 $row->{modules} = MODULE->retrieve(
8209 id => $row->{id},
8210 date => $use_now ? localtime() : $row->{time},
8214 $report->add($row);
8219 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
8220 Zeile wie der letzte Befehl. Beispiele:</para>
8222 <programlisting>sub debug {
8228 <programlisting>if ($form->{item_rows} > 0) {
8234 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
8235 der Befehl / die öffnende schließende Klammer, die den Block
8236 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
8237 Beispiele wie bei 3. gelten.</para>
8241 <para>Die Wörter "<function>else</function>",
8242 "<function>elsif</function>", "<function>while</function>" befinden
8243 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
8246 <programlisting>if ($form->{sum} > 1000) {
8248 } elsif ($form->{sum} > 0) {
8256 } until ($a > 0);</programlisting>
8260 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
8261 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
8262 und grep-ähnliche Operatoren. Beispiel:</para>
8264 <programlisting>$main::lxdebug->message("Could not find file.");
8265 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
8269 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
8271 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
8272 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
8273 Blöcke schon. Beispiel:</para>
8275 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
8280 $form->{sum} += $form->{"row_$i"};
8281 $form->{ $form->{index} } += 1;
8283 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
8287 <para>Mehrzeilige Befehle</para>
8291 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
8292 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
8293 werden, in der die ersten Funktionsparameter in der ersten Zeile
8294 stehen. Beispiel:</para>
8296 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
8297 $form->{some_col_value});</programlisting>
8301 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
8302 besten in einer übersichtlichen Tabellenstruktur organisiert
8303 wird. Beispiel:</para>
8305 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
8306 : $form->{oldcount} ? $form->{oldcount} + 1
8307 : $form->{rowcount} - $form->{rowbase};</programlisting>
8313 <para>Kommentare</para>
8317 <para>Kommentare, die alleine in einer Zeile stehen, sollten
8318 soweit wie der Code eingerückt sein.</para>
8322 <para>Seitliche hängende Kommentare sollten einheitlich
8323 formatiert werden.</para>
8327 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
8328 auf Englisch zu verfassen. So wie ich keine Lust habe,
8329 französischen Quelltext zu lesen, sollte auch der kivitendo
8330 Quelltext für nicht-Deutschsprachige lesbar sein.
8333 <programlisting>my $found = 0;
8341 $i = 0 # initialize $i
8343 $i *= $const; # do something crazy
8344 $i = $n; # recover $i</programlisting>
8350 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
8351 Interpolation gewünscht ist. Beispiel:</para>
8353 <programlisting>$form->{sum} = 0;
8354 $form->{"row_$i"} = $form->{"row_$i"} - 5;
8355 $some_hash{42} = 54;</programlisting>
8359 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
8360 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
8361 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
8362 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
8364 <para>Als Beispiel sei die Funktion
8365 <function>print_options</function> aus
8366 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
8370 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
8371 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
8374 <para>Emacs und vim haben beide recht einfache Methoden zur
8375 Entfernung von trailing whitespace. Emacs kennt das Kommande
8376 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
8377 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
8378 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
8383 <para>Es wird kein <command>perltidy</command> verwendet.</para>
8385 <para>In der Vergangenheit wurde versucht,
8386 <command>perltidy</command> zu verwenden, um einen einheitlichen
8387 Stil zu erlangen. Es hat sich aber gezeigt, dass
8388 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
8389 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
8390 den Interessierten sind hier die
8391 <command>perltidy</command>-Optionen, die grob den beschriebenen
8392 Richtlinien entsprechen:</para>
8394 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
8395 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
8396 -lp -vt=1 -vtc=1</programlisting>
8400 <para><varname>STDERR</varname> ist tabu. Unkonditionale
8401 Debugmeldungen auch.</para>
8403 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
8404 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
8405 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
8407 <para>Die <classname>LXDebug</classname>-Methode
8408 "<function>message</function>" nimmt als ersten Paramter außerdem
8409 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
8410 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
8411 und werden in den meisten Fällen auch vom Repository
8412 zurückgewiesen.</para>
8416 <para>Alle neuen Module müssen use strict verwenden.</para>
8418 <para><varname>$form</varname>, <varname>$auth</varname>,
8419 <varname>$locale</varname>, <varname>$lxdebug</varname> und
8420 <varname>%myconfig</varname> werden derzeit aus dem main package
8421 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
8422 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
8427 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
8428 <title>Dokumentation erstellen</title>
8430 <sect2 id="devel.build-doc.introduction">
8431 <title>Einführung</title>
8433 <para>Diese Dokumentation ist in <productname>DocBook</productname>
8434 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
8435 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
8436 Editor nutzt, der spezielle Unterstützung für
8437 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
8438 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
8439 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
8443 <sect2 id="devel.build-doc.required-software">
8444 <title>Benötigte Software</title>
8446 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
8447 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
8448 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
8449 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
8450 <command>scripts/build_doc.sh</command>.</para>
8452 <para>Das Script benötigt zur Konvertierung verschiedene
8453 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
8459 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
8460 in einer halbwegs aktuellen Version</para>
8464 <para>Das Java-Build-System <ulink
8465 url="http://ant.apache.org/">Apache Ant</ulink></para>
8469 <para>Das Dokumentations-System Dobudish für
8470 <productname>DocBook</productname> 4.5, eine Zusammenstellung
8471 diverser Stylesheets und Grafiken zur Konvertierung von
8472 <productname>DocBook</productname> XML in andere Formate. Das
8473 Paket, das benötigt wird, ist zum Zeitpunkt der
8474 Dokumentationserstellung
8475 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
8476 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
8481 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
8482 sind auf allen gängigen Plattformen verfügbar. Beispiel für
8483 Debian/Ubuntu:</para>
8485 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
8487 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
8488 <filename>doc/build</filename> entpackt werden. Beispiel unter der
8489 Annahme, das <productname>Dobudish</productname> in
8490 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
8492 <programlisting>cd doc/build
8493 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
8496 <sect2 id="devel.build-doc.build">
8497 <title>PDFs und HTML-Seiten erstellen</title>
8499 <para>Die eigentliche Konvertierung erfolgt nach Installation der
8500 benötigten Software mit einem einfachen Aufruf direkt aus dem
8501 kivitendo-Installationsverzeichnis heraus:</para>
8503 <programlisting>./scripts/build_doc.sh</programlisting>
8506 <sect2 id="devel.build-doc.repository">
8507 <title>Einchecken in das Git-Repository</title>
8509 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
8510 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
8511 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
8512 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
8514 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
8515 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob