1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <book id="kivitendo-documentation" lang="de">
5 <title>kivitendo 3.4.1: Installation, Konfiguration, Entwicklung</title>
7 <chapter id="Aktuelle-Hinweise">
8 <title>Aktuelle Hinweise</title>
10 <para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>
14 <para>im Community-Forum: <ulink
15 url="https://forum.kivitendo.de:32443">https://forum.kivitendo.de:32443</ulink></para>
19 <para>im Kunden-Forum: <ulink
20 url="http://redmine.kivitendo-premium.de/projects/forum/boards/">http://redmine.kivitendo-premium.de/projects/forum/boards/</ulink></para>
24 <para>in der doc/UPGRADE Datei im doc-Verzeichnis der
29 <para>Im Schulungs- und Dienstleistungsangebot der entsprechenden
30 kivitendo-Partner: <ulink
31 url="http://www.kivitendo.de/partner.html">http://www.kivitendo.de/partner.html</ulink></para>
37 <title>Installation und Grundkonfiguration</title>
39 <sect1 id="Installation-Übersicht">
40 <title>Übersicht</title>
42 <para>Die Installation von kivitendo umfasst mehrere Schritte. Die
43 folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
44 Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit
45 minimalen Features möglichst schnell zum Laufen zu kriegen.</para>
49 <para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo
50 benötigt gewisse Ressourcen und benutzt weitere Programme. Das
51 Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert
52 diese. Auch die Liste der benötigten Perl-Module befindet sich
57 <para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst
58 die "<xref linkend="Manuelle-Installation-des-Programmpaketes"/>"
59 sowie grundlegende Einstellungen, die der "<xref
60 linkend="config.config-file"/>" erläutert.</para>
64 <para><emphasis>Konfiguration externer Programme</emphasis>: hierzu
65 gehören die Datenbank ("<xref
66 linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der
67 Webserver ("<xref linkend="Apache-Konfiguration"/>").</para>
71 <para><emphasis>Benutzerinformationen speichern können</emphasis>:
72 man benötigt mindestens eine Datenbank, in der Informationen zur
73 Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man
74 das als Administrator macht, verrät "<xref
75 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para>
79 <para><emphasis>Benutzer, Gruppen und Datenbanken
80 anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
81 linkend="Benutzer--und-Gruppenverwaltung"/>".</para>
85 <para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann
86 kann es losgehen: "<xref linkend="kivitendo-ERP-verwenden"/>"</para>
90 <para>Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls
91 wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen
95 <sect1 id="Benötigte-Software-und-Pakete">
96 <title>Benötigte Software und Pakete</title>
98 <sect2 id="Betriebssystem">
99 <title>Betriebssystem</title>
101 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
102 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
103 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
104 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
105 ohne große Probleme auf den derzeit aktuellen verbreiteten
106 Distributionen läuft.</para>
108 <para>Anfang 2016 sind das folgende Systeme, von denen bekannt ist,
109 dass kivitendo auf ihnen läuft:</para>
117 <para>7.0 "Wheezy"</para>
121 <para>8.0 "Jessie"</para>
127 <para>Ubuntu 12.04 LTS "Precise Pangolin", 14.04 "Trusty Tahr"
128 LTS, 15.10 "Wily Werewolf" und 16.04 "Xenial Xerus" LTS
133 <para>openSUSE LEAP 42.1</para>
137 <para>Fedora 22</para>
142 <sect2 id="Pakete" xreflabel="Pakete">
143 <title>Benötigte Perl-Pakete installieren</title>
145 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
146 Apache) und ein Datenbankserver (PostgreSQL) in einer aktuellen Version
147 (s.a. Liste der unterstützten Betriebssysteme) benötigt.</para>
149 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht
150 Bestandteil einer Standard-Perl-Installation sind. Um zu überprüfen,
151 ob die erforderlichen Pakete installiert und aktuell genug sind, wird
152 ein Script mitgeliefert, das wie folgt aufgerufen wird:</para>
154 <programlisting>./scripts/installation_check.pl</programlisting>
156 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
160 <para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para>
164 <para><literal>Archive::Zip</literal></para>
168 <para><literal>Algorithm::CheckDigits</literal></para>
172 <para><literal>CGI</literal></para>
176 <para><literal>Clone</literal></para>
180 <para><literal>Config::Std</literal></para>
184 <para><literal>DateTime</literal></para>
188 <para><literal>DateTime::Format::Strptime</literal></para>
192 <para><literal>DBI</literal></para>
196 <para><literal>DBD::Pg</literal></para>
200 <para><literal>Email::Address</literal></para>
204 <para><literal>Email::MIME</literal></para>
208 <para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71
209 inklusive; siehe <xref
210 linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para>
214 <para><literal>File::Copy::Recursive</literal></para>
218 <para><literal>GD</literal></para>
222 <para><literal>HTML::Parser</literal></para>
226 <para><literal>HTML::Restrict</literal></para>
230 <para><literal>Image::Info</literal></para>
234 <para><literal>JSON</literal></para>
238 <para><literal>List::MoreUtils</literal></para>
242 <para><literal>List::UtilsBy</literal></para>
246 <para><literal>Net::SMTP::SSL</literal> (optional, bei
247 E-Mail-Versand über SSL; siehe Abschnitt "<xref
248 linkend="config.sending-email.smtp"/>")</para>
252 <para><literal>Net::SSLGlue</literal> (optional, bei
253 E-Mail-Versand über TLS; siehe Abschnitt "<xref
254 linkend="config.sending-email.smtp"/>")</para>
258 <para><literal>Params::Validate</literal></para>
262 <para><literal>PBKDF2::Tiny</literal></para>
266 <para><literal>PDF::API2</literal></para>
270 <para><literal>Rose::Object</literal></para>
274 <para><literal>Rose::DB</literal></para>
278 <para><literal>Rose::DB::Object</literal> Version 0.788 oder
283 <para><literal>String::ShellQuote</literal></para>
287 <para><literal>Sort::Naturally</literal></para>
291 <para><literal>Template</literal></para>
295 <para><literal>Text::CSV_XS</literal></para>
299 <para><literal>Text::Iconv</literal></para>
303 <para><literal>URI</literal></para>
307 <para><literal>XML::Writer</literal></para>
311 <para><literal>YAML</literal></para>
315 <para>Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen:
316 <literal>Algorithm::CheckDigits</literal><literal>PBKDF2::Tiny</literal></para>
318 <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen:
319 <literal>GD</literal>, <literal>HTML::Restrict</literal>,
320 <literal>Image::Info</literal></para>
322 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen:
323 <literal>File::Copy::Recursive</literal>.</para>
325 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen:
326 <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
327 <literal>Net::SSLGlue</literal>.</para>
329 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
330 hinzugekommen, <literal>URI</literal> und
331 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
334 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
335 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
336 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
337 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
339 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
340 hinzugekommen.</para>
342 <para><literal>Email::Address</literal> und
343 <literal>List::MoreUtils</literal> sind schon länger feste
344 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
345 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
346 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
347 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
351 <title>Debian und Ubuntu</title>
353 <para>Für Debian und Ubuntu stehen die meisten der benötigten
354 Perl-Pakete als Debian-Pakete zur Verfügung. Sie können mit
355 folgendem Befehl installiert werden:</para>
357 <programlisting>apt install apache2 libarchive-zip-perl libclone-perl \
358 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
359 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
360 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
361 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
362 librose-db-perl librose-object-perl libsort-naturally-perl \
363 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
364 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
365 libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \
366 libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \
367 libcrypt-pbkdf2-perl git libcgi-pm-perl
370 <para>Für das Paket HTML::Restrict gibt es kein Debian-Paket, dies
371 muß per CPAN installiert werden. Unter Ubuntu funktioniert das
374 <programlisting>apt-get install build-essential
375 cpan HTML::Restrict</programlisting>
379 <title>Fedora</title>
381 <para>Für Fedora stehen die meisten der benötigten Perl-Pakete als
382 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
383 installiert werden:</para>
385 <programlisting>dnf install httpd mod_fcgid perl-Archive-Zip perl-Clone perl-DBD-Pg \
386 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
387 perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
388 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
389 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
390 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
391 perl-XML-Writer perl-YAML perl-parent postgresql-server perl-CPAN \
392 perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor perl-Text-Balanced</programlisting>
394 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
395 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
397 <programlisting>cpan Config::Std HTML::Restrict</programlisting>
401 <title>openSUSE</title>
403 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als
404 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
405 installiert werden:</para>
407 <programlisting>zypper install apache2 apache2-mod_fcgid perl-Archive-Zip perl-Clone \
408 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
409 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
410 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
411 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
412 perl-URI perl-XML-Writer perl-YAML perl-CPAN \
413 perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor postgresql-server</programlisting>
415 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
416 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
418 <programlisting>cpan Rose::Db::Object</programlisting>
422 <title>Andere Pakete installieren</title>
424 <para>Seit Version v3.4.0 wird für den Bankimport optional das Paket
425 'aqbanking-tools' benötigt.</para>
427 <para>Ubuntu: <programlisting>apt install aqbanking-tools</programlisting></para>
429 <para>OpenSuSE: <programlisting>zypper install aqbanking-tools</programlisting></para>
431 <para>Seit Version v3.4.1 wird generell zum Feststellen der
432 Seitenanzahl von PDF_Dokumenten 'pdfinfo' benötigt was im Paket
433 'poppler-utils' enthalten ist.</para>
435 <para>Ubuntu: <programlisting>apt install poppler-utils</programlisting></para>
437 <para>OpenSuSE: <programlisting>zypper install poppler-tools</programlisting></para>
442 <sect1 id="Manuelle-Installation-des-Programmpaketes"
443 xreflabel="Manuelle Installation des Programmpaketes">
444 <title>Manuelle Installation des Programmpaketes</title>
446 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github
447 gehostet und kann <ulink
448 url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
449 heruntergeladen werden.</para>
451 <para>Die kivitendo ERP Installationsdatei
452 (<filename>kivitendo-erp-3.4.1.tgz</filename>) wird im
453 Dokumentenverzeichnis des Webservers (z.B.
454 <filename>/var/www/html/</filename>,
455 <filename>/srv/www/htdocs</filename> oder
456 <filename>/var/www/</filename>) entpackt:</para>
458 <programlisting>cd /var/www
459 tar xvzf kivitendo-erp-3.4.1.tgz</programlisting>
461 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
463 <programlisting>cd kivitendo-erp</programlisting>
465 <para>Alternativ können Sie auch einen Alias in der
466 Webserverkonfiguration benutzen, um auf das tatsächliche
467 Installationsverzeichnis zu verweisen.</para>
469 <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
470 WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
472 <programlisting>mkdir webdav</programlisting>
474 <para>Die Verzeichnisse <filename>users</filename>,
475 <filename>spool</filename> und <filename>webdav</filename> müssen für
476 den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
477 restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer-
478 und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich
479 (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
480 <constant>apache</constant> oder bei OpenSUSE
481 <constant>wwwrun</constant>).</para>
483 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
484 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
486 <programlisting>chown -R www-data users spool webdav</programlisting>
488 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen
489 <filename>templates</filename> und <filename>users</filename>
490 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in
491 kivitendo angelegt wird:</para>
493 <programlisting>chown www-data templates users</programlisting>
496 <para>Wir empfehlen eine Installation mittels des Versionsmanagager
497 git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr
498 viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte
499 die Pfade anpassen) bspw. wie folgt: <programlisting>cd /usr/local/src/
500 git clone https://github.com/kivitendo/kivitendo-erp.git
502 git checkout `git tag -l | egrep -ve "(beta|rc)" | tail -1`</programlisting>
503 Sehr sinnvoll ist es, direkt im Anschluss einen eigenen Branch zu
504 erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen damit zu
505 verwalten. Hierfür reicht ein simples <programlisting> git checkout -b meine_eigenen_änderungen</programlisting>
506 nach dem letzten Kommando (weiterführende Informationen <ulink
507 url="http://git-scm.com/book/en/v2/Getting-Started-Git-Basics">getting
508 started with git</ulink>).</para>
512 <sect1 id="config.config-file">
513 <title>kivitendo-Konfigurationsdatei</title>
515 <sect2 id="config.config-file.introduction"
516 xreflabel="Einführung in die Konfigurationsdatei">
517 <title>Einführung</title>
519 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
520 benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die
521 Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von
522 kivitendo bzw. der Migration von älteren Versionen angelegt
525 <para>Als Vorlage dient die Datei
526 <filename>config/kivitendo.conf.default</filename> (kurz: "die
527 Default-Datei"):</para>
529 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
531 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
532 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
533 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
534 Abschnitte und Werte enthalten, die von denen der Default-Datei
538 <para>Vor der Umbenennung in kivitendo hieß diese Datei noch
539 <filename>config/lx_office.conf</filename>. Aus Gründen der
540 Kompatibilität wird diese Datei eingelesen, sofern die Datei
541 <filename>config/kivitendo.conf</filename> nicht existiert.</para>
544 <para>Diese Hauptkonfigurationsdatei ist dann eine
545 installationsspezifische Datei, d.h. sie enthält bspw. lokale
546 Passwörter und wird auch nicht im Versionsmanagement (git)
549 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
550 Mandaten, bzw. Datenbanken gleich.</para>
553 <sect2 id="config.config-file.sections-parameters">
554 <title>Abschnitte und Parameter</title>
556 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
557 entsprechend kommentiert sind:</para>
561 <para><literal>authentication</literal> (siehe Abschnitt "<xref
562 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
563 in diesem Kapitel)</para>
567 <para><literal>authentication/database</literal></para>
571 <para><literal>authentication/ldap</literal></para>
575 <para><literal>system</literal></para>
579 <para><literal>paths</literal></para>
583 <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
584 linkend="config.sending-email.smtp"/>)</para>
588 <para><literal>applications</literal></para>
592 <para><literal>environment</literal></para>
596 <para><literal>print_templates</literal></para>
600 <para><literal>task_server</literal></para>
604 <para><literal>periodic_invoices</literal></para>
608 <para><literal>self_tests</literal></para>
612 <para><literal>console</literal></para>
616 <para><literal>testing</literal></para>
620 <para><literal>testing/database</literal></para>
624 <para><literal>debug</literal></para>
628 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
629 einzustellen oder zu kontrollieren sind, sind:</para>
631 <programlisting>[authentication]
632 admin_password = geheim
634 [authentication/database]
642 default_manager = german</programlisting>
644 <para>Für kivitendo Installationen in der Schweiz sollte hier <varname>german</varname>
645 durch <varname>swiss</varname> ersetzt werden.</para>
646 <para>Die Einstellung <varname>default_manager = swiss</varname> bewirkt:</para>
649 <para>Beim Erstellen einer neuen Datenbank in der kivitendo Administration
650 werden automatisch die Standard-Werte für die Schweiz voreingestellt:
651 Währung CHF, 5er-Rundung, Schweizer KMU-Kontenplan, Sollversteuerung,
652 Aufwandsmethode, Bilanzierung (die Werte können aber manuell angepasst werden).</para>
655 <para>Einstellen der Standardkonten für Rundungserträge und -aufwendungen
656 (unter Mandantenkonfiguration → Standardkonten veränderbar)</para>
659 <para>das verwendete Zahlenformat wird auf <varname>1'000.00</varname> eingestellt
660 (unter Programm → Benutzereinstellungen veränderbar)</para>
663 <para>DATEV-Automatik und UStVA werden nicht angezeigt, Erfolgsrechnung
664 ersetzt GUV ( unter Mandantenkonfiguration → Features veränderbar)</para>
668 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
669 <varname>[periodic_invoices]</varname> den Login eines Benutzers
670 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
671 mit Informationen über die erstellten Rechnungen bekommt.</para>
673 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
674 Ausführung bestimmter Aufgaben mit, den <link
675 linkend="config.task-server">Taskserver</link>. Er wird u.a. für
676 Features wie die <link
677 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
678 benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
679 daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
680 <link linkend="config.task-server">Task-Server</link> genauer
683 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
684 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
687 <sect2 id="config.config-file.prior-versions">
688 <title>Versionen vor 2.6.3</title>
690 <para>In älteren kivitendo Versionen gab es im Verzeichnis
691 <filename>config</filename> die Dateien
692 <filename>authentication.pl</filename> und
693 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
694 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
695 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
696 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
698 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
699 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
700 manuell übertragen und die alten Konfigurationsdateien anschließend
701 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
702 entsprechende Fehlermeldung an.</para>
706 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
707 <title>Anpassung der PostgreSQL-Konfiguration</title>
709 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
711 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
712 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
714 <para>kivitendo setzt zwingend voraus, dass die Datenbank
715 Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
716 Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
718 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
719 Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
720 man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
722 <programlisting>su postgres
724 exit </programlisting>
726 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
727 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
728 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
731 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
733 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
734 Versionsnummer angepasst werden.</para>
736 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
738 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
739 <literal>\l</literal> geprüft werden.</para>
742 <sect2 id="Änderungen-an-Konfigurationsdateien">
743 <title>Änderungen an Konfigurationsdateien</title>
745 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
746 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
747 <filename>/var/lib/pgsql/data/</filename> oder
748 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
749 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
750 Parameter <varname>listen_address</varname> gesteuert. Laufen
751 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
752 <literal>localhost</literal> verwendet werden. Andernfalls müssen
753 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
754 was mit dem Wert <literal>*</literal> geschieht.</para>
756 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
757 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
758 sein sollte, müssen die Berechtigungen für den Zugriff geändert
759 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
760 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
761 Datenbank zum Beispiel:</para>
763 <programlisting>local all kivitendo password
764 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
767 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
768 <title>Erweiterung für servergespeicherte Prozeduren</title>
770 <para>In der Datenbank <literal>template1</literal> muss die
771 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
772 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
773 <programlisting>su - postgres
774 psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
776 <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
780 <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
781 bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
782 anzulegen. In diesen Versionen ist die Extension meist auch schon
783 vorhanden. Sollten Sie eine ältere Version von Postgres haben,
784 benutzen Sie stattdessen den folgenden Befehl.</para>
786 <programlisting>CREATE LANGUAGE 'plpgsql';
791 <sect2 id="Datenbankbenutzer-anlegen">
792 <title>Datenbankbenutzer anlegen</title>
794 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
795 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
796 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
799 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
800 nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
801 generieren nicht nötig.</para>
803 <programlisting>su - postgres
804 createuser -d -P kivitendo
805 exit</programlisting>
807 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
808 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
809 bzw. den hier gewählten Benutzernamen.</para>
813 <sect1 id="Apache-Konfiguration">
814 <title>Webserver-Konfiguration</title>
817 <title>Grundkonfiguration mittels CGI</title>
820 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
821 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
822 <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
825 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
826 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
827 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
828 anderen Datei hinzu, die beim Starten des Webservers eingelesen
831 <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
832 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
834 <Directory /var/www/kivitendo-erp>
835 AddHandler cgi-script .pl
836 Options ExecCGI Includes FollowSymlinks
839 <Directory /var/www/kivitendo-erp/users>
842 </Directory></programlisting>
844 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
845 das kivitendo-Archiv entpacket haben.</para>
848 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
849 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
851 <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
852 noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
853 aktiviert werden.</para>
856 <para>Auf einigen Webservern werden manchmal die Grafiken und
857 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
858 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
860 <programlisting>EnableSendfile Off</programlisting>
863 <sect2 id="Apache-Konfiguration.FCGI"
864 xreflabel="Konfiguration für FastCGI/FCGI">
865 <title>Konfiguration für FastCGI/FCGI</title>
867 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
868 <title>Was ist FastCGI?</title>
870 <para>Direkt aus <ulink
871 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
874 <para><citation> FastCGI ist ein Standard für die Einbindung
875 externer Software zur Generierung dynamischer Webseiten in einem
876 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
877 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
878 umgehen. </citation></para>
881 <sect3 id="Apache-Konfiguration.FCGI.Warum">
882 <title>Warum FastCGI?</title>
884 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
885 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
886 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
887 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
888 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
889 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
890 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
891 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
892 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
893 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
894 deutlich länger dauert als früher, und dass davon 90% für das Laden
895 der Module verwendet wird.</para>
897 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
898 wird nur die eigentliche Programmlogik ausgeführt.</para>
901 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
902 <title>Getestete Kombinationen aus Webservern und Plugin</title>
904 <para>Folgende Kombinationen sind getestet:</para>
908 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
912 <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
916 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
920 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
921 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
922 mod_fastcgi nicht mehr explizit eingegangen.</para>
924 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
928 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
929 strict in der Behandlung von Unicode, und verweigern bestimmte
930 Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
931 Installation gibt, muss zwingend Version 0.68 oder aber Version
932 0.72 und neuer eingesetzt werden.</para>
934 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
935 sich die Vorgängerversion wie folgt installieren:</para>
937 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
941 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
942 <title>Konfiguration des Webservers</title>
944 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
945 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
946 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
947 debuggen die beim ersten aufsetzen auftreten können. Sollte die
948 Installation schon funktionieren, lesen Sie weiter.</para>
950 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
951 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
953 <programlisting>a2enmod fcgid</programlisting>
955 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
956 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
957 und <function>Directory</function>-Direktiven. Dabei wird zwischen
958 dem Installationspfad von kivitendo im Dateisystem
959 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
960 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
961 ("<filename>/url/for/kivitendo-erp</filename>").</para>
963 <para>Folgender Konfigurationsschnipsel funktioniert mit
966 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
967 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
969 <Directory /path/to/kivitendo-erp>
971 Options ExecCGI Includes FollowSymlinks
975 <DirectoryMatch /path/to/kivitendo-erp/users>
977 </DirectoryMatch></programlisting>
980 <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
981 muss entsprechend die Syntax der Directorydirektiven verändert.
984 <programlisting>Require all granted</programlisting>
986 <para>muß man Folgendes einstellen:</para>
990 Allow from All </programlisting>
992 <para>und statt</para>
994 <programlisting>Require all denied</programlisting>
996 <para>muss stehen:</para>
1000 Deny from All </programlisting>
1004 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
1005 die maximale Größe eines Requests. Diese sollte wie folgt
1006 hochgesetzt werden:</para>
1008 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
1010 <para>Das Ganze sollte dann so aussehen:</para>
1012 <programlisting>AddHandler fcgid-script .fpl
1013 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1014 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1015 FcgidMaxRequestLen 10485760
1017 <Directory /path/to/kivitendo-erp>
1019 Options ExecCGI Includes FollowSymlinks
1024 <DirectoryMatch /path/to/kivitendo-erp/users>
1027 </DirectoryMatch></programlisting>
1029 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
1030 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
1031 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
1032 gibt es hier kleine Performance-Einbußen.</para>
1034 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
1035 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
1036 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
1038 <programlisting># Zugriff über CGI
1039 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
1041 # Zugriff mit mod_fcgid:
1042 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1043 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
1045 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
1046 die normale Version erreichbar, und unter
1047 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
1048 FastCGI-Version.</para>
1053 <title>Weitergehende Konfiguration</title>
1055 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
1056 von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1057 weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1058 Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1059 Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1060 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1061 (Stand Sept. 2015)</ulink></para>
1065 <sect1 id="config.task-server">
1066 <title>Der Task-Server</title>
1068 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1069 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1070 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1071 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1072 essenzielle Aufgaben benutzt.</para>
1074 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1075 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1076 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1078 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1079 Servers integriert werden muss, damit er automatisch gestartet wird.
1080 Dies kann kivitendo nicht für Sie erledigen.</para>
1082 <sect2 id="Konfiguration-des-Task-Servers">
1083 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1085 <para>Die Konfiguration erfolgt über den Abschnitt
1086 <literal>[task_server]</literal> in der Datei
1087 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1088 Optionen sind:</para>
1092 <term><varname>run_as</varname></term>
1095 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1096 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1097 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1098 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1100 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1101 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1102 unter dem auch der Webserver läuft.</para>
1107 <term><varname>debug</varname></term>
1110 <para>Schaltet Debug-Informationen an und aus.</para>
1116 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1117 <title>Konfiguration der Mandanten für den Task-Server</title>
1119 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1120 anschließend jeder Mandant, für den der Task-Server laufen soll,
1121 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1122 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1123 ausgewählt werden, unter der der Task-Server seine Arbeit
1126 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1127 wird der Task-Server für diesen Mandanten keine Aufgaben
1131 <sect2 id="Einbinden-in-den-Boot-Prozess">
1132 <title>Automatisches Starten des Task-Servers beim Booten</title>
1134 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1135 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1136 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1138 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1139 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1140 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1141 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1142 anstelle eines symbolischen Links verwendet werden können.</para>
1145 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE,
1146 ältere Fedora)</title>
1148 <para>Kopieren Sie die Datei
1149 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1150 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1151 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1152 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1153 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1157 <para>Debian-basierende Systeme:</para>
1159 <programlisting>update-rc.d kivitendo-task-server defaults
1160 # Nur bei Debian Squeeze und neuer:
1161 insserv kivitendo-task-server</programlisting>
1165 <para>Ältere OpenSUSE und ältere Fedora:</para>
1167 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1171 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1174 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1178 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1180 <para>Kopieren Sie die Datei
1181 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1182 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1183 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1184 <literal>exec ....</literal>).</para>
1186 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1189 <programlisting>service kivitendo-task-server start</programlisting>
1193 <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1194 Fedora, neuere Ubuntu und Debians)</title>
1196 <para>Kopieren Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
1197 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeilen
1198 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>).</para>
1200 <para>Machen Sie anschließend das Script systemd bekannt, und binden Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden
1203 <programlisting>systemctl daemon-reload
1204 systemctl enable kivitendo-task-server.service</programlisting>
1206 <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt den Server neu zu starten, so können Sie das mit dem
1207 folgenden Befehl tun:</para>
1209 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1213 <sect2 id="Prozesskontrolle">
1214 <title>Wie der Task-Server gestartet und beendet wird</title>
1216 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1218 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1220 <para><literal>Befehl</literal> ist dabei eine der folgenden
1225 <para><literal>start</literal> startet eine neue Instanz des
1226 Task-Servers. Die Prozess-ID wird innerhalb des
1227 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1231 <para><literal>stop</literal> beendet einen laufenden
1236 <para><literal>restart</literal> beendet und startet ihn
1241 <para><literal>status</literal> berichtet, ob der Task-Server
1246 <para>Der Task-Server wechselt beim Starten automatisch in das
1247 kivitendo-Installationsverzeichnis.</para>
1249 <para>Dieselben Optionen können auch für die SystemV-basierenden
1250 Runlevel-Scripte benutzt werden (siehe oben).</para>
1254 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1255 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1257 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1258 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1260 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1261 <title>Grundlagen zur Benutzerauthentifizierung</title>
1263 <para>kivitendo verwaltet die Benutzerinformationen in einer
1264 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1265 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1266 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1267 können, müssen aber nicht unterschiedlich sein.</para>
1269 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1270 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1271 abgelegt werden.</para>
1273 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
1274 entweder gegen die Authentifizierungsdatenbank oder gegen einen
1275 LDAP-Server überprüft werden.</para>
1277 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1278 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1279 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1280 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1281 einer Version vor v2.6.0 angelegt werden. Eine
1282 Beispielkonfigurationsdatei
1283 <filename>config/kivitendo.conf.default</filename> existiert, die als
1284 Vorlage benutzt werden kann.</para>
1287 <sect2 id="Administratorpasswort">
1288 <title>Administratorpasswort</title>
1290 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1291 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1292 gespeichert. Es kann auch nur dort und nicht mehr im
1293 Administrationsinterface selber geändert werden. Der Parameter dazu
1294 heißt <varname>admin_password</varname> im Abschnitt
1295 <varname>[authentication]</varname>.</para>
1298 <sect2 id="Authentifizierungsdatenbank">
1299 <title>Authentifizierungsdatenbank</title>
1301 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1302 Parametern in <varname>[authentication/database]</varname>
1303 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1307 <term><literal>host</literal></term>
1310 <para>Der Rechnername oder die IP-Adresse des
1311 Datenbankservers</para>
1316 <term><literal>port</literal></term>
1319 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1324 <term><literal>db</literal></term>
1327 <para>Der Name der Authentifizierungsdatenbank</para>
1332 <term><literal>user</literal></term>
1335 <para>Der Benutzername, mit dem sich kivitendo beim
1336 Datenbankserver anmeldet (z.B.
1337 "<literal>postgres</literal>")</para>
1342 <term><literal>password</literal></term>
1345 <para>Das Passwort für den Datenbankbenutzer</para>
1350 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1351 automatisch anlegen (mehr dazu siehe unten).</para>
1354 <sect2 id="Passwortüberprüfung">
1355 <title>Passwortüberprüfung</title>
1357 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1358 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1359 Active-Directory-Server. Welche davon benutzt wird, regelt der
1360 Parameter <varname>module</varname> im Abschnitt
1361 <varname>[authentication]</varname>.</para>
1363 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1364 gespeichert werden, so muss der Parameter <varname>module</varname>
1365 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1366 der Administrator als auch die Benutzer selber ihre Passwörter in
1367 kivitendo ändern.</para>
1369 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1370 benutzt werden, so muss der Parameter <varname>module</varname> auf
1371 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1372 zusätzliche Informationen über den LDAP-Server im Abschnitt
1373 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1377 <term><literal>host</literal></term>
1380 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1381 Active-Directory-Servers. Diese Angabe ist zwingend
1382 erforderlich.</para>
1387 <term><literal>port</literal></term>
1390 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1395 <term><literal>tls</literal></term>
1398 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1399 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1400 ‘<literal>0</literal>’ belassen</para>
1405 <term><literal>attribute</literal></term>
1408 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1409 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1410 meist ‘<literal>sAMAccountName</literal>’, für andere
1411 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1412 zwingend erforderlich.</para>
1417 <term><literal>base_dn</literal></term>
1420 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1421 Diese Angabe ist zwingend erforderlich.</para>
1426 <term><literal>filter</literal></term>
1429 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1430 <literal><%login%></literal>, so wird dieses durch den vom
1431 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1432 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1433 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1438 <term><literal>bind_dn</literal> und
1439 <literal>bind_password</literal></term>
1442 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1443 durchsucht werden kann (z.B. ist dies bei
1444 Active-Directory-Servern der Fall), so kann diese hier angegeben
1445 werden. Für Active-Directory-Server kann als
1446 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1447 z.B. ‘<literal>cn=Martin
1448 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1449 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1450 also ‘<literal>Martin Mustermann</literal>’.</para>
1456 <sect2 id="Name-des-Session-Cookies">
1457 <title>Name des Session-Cookies</title>
1459 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1460 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1461 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1462 Parameter <varname>cookie_name</varname> im Abschnitt
1463 <varname>[authentication]</varname>gesetzt.</para>
1465 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1466 Server existiert.</para>
1469 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1470 <title>Anlegen der Authentifizierungsdatenbank</title>
1472 <para>Nachdem alle Einstellungen in
1473 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1474 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1475 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1476 der folgenden URL erreichbar sein sollte:</para>
1479 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1483 <sect1 id="Benutzer--und-Gruppenverwaltung">
1484 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1486 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1487 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1488 das Sie unter folgender URL finden:</para>
1491 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1493 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1494 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1496 <sect2 id="Zusammenhänge">
1497 <title>Zusammenhänge</title>
1499 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1500 in einer oder zwei Datenbanken gespeichert werden.</para>
1502 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1503 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1504 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1505 Diese Informationen werden in der Authentifizierungsdatenbank
1506 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1507 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1508 gespeichert werden.</para>
1510 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1511 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1512 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1513 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1514 einer solchen Mandantendatenbank werden im Administrationsbereich
1515 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1516 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1518 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1519 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1520 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1521 mehr als einem Mandanten, wird empfohlen, für die
1522 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1523 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1526 <sect2 id="Mandanten-Benutzer-Gruppen">
1527 <title>Mandanten, Benutzer und Gruppen</title>
1529 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1530 die sich frei zueinander zuordnen lassen.</para>
1532 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1533 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1534 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1535 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1536 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1537 Diese sollte über die <link
1538 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1541 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1542 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1543 der Administrator fest, an welchen Mandanten sich ein Benutzer
1544 anmelden kann, was beim Login verifiziert wird.</para>
1546 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1547 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1548 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1549 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1550 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1551 dann an einem Mandanten an, so erhält er alle Rechte von allen
1552 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1553 denen der Benutzer zum Anderen Mitglied ist,</para>
1555 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1556 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1557 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1559 <orderedlist numeration="arabic">
1561 <para>Datenbank anlegen</para>
1565 <para>Gruppen anlegen</para>
1569 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1573 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1578 <sect2 id="Datenbanken-anlegen">
1579 <title>Datenbanken anlegen</title>
1581 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1582 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1583 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1586 <sect2 id="Gruppen-anlegen">
1587 <title>Gruppen anlegen</title>
1589 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1590 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1591 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1592 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1594 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1595 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1596 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1597 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1598 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1599 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1600 A, B und C gültig").</para>
1602 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1603 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1604 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1605 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1606 Gruppen A, B und C").</para>
1609 <sect2 id="Benutzer-anlegen">
1610 <title>Benutzer anlegen</title>
1612 <para>Beim Anlegen von Benutzern werden für viele Parameter
1613 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1614 deutschen Raumes entsprechen.</para>
1616 <para>Zwingend anzugeben ist der Loginname. Wenn die
1617 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
1618 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
1619 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1622 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
1623 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
1624 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
1625 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
1626 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
1627 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
1628 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
1629 sind Benutzer A, B und C Mitglieder").</para>
1632 <sect2 id="Mandanten-anlegen">
1633 <title>Mandanten anlegen</title>
1635 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
1636 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
1637 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
1638 einer der eben angelegten Datenbanken eingetragen werden.</para>
1640 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
1641 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
1642 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
1643 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
1644 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
1645 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
1646 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
1647 Gruppe ist für Mandanten A, B und C gültig").</para>
1651 <sect1 id="Drucker--Systemverwaltung">
1652 <title>Drucker- und Systemverwaltung</title>
1654 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
1655 Druckeradministration und System.</para>
1657 <sect2 id="Druckeradministration">
1658 <title>Druckeradministration</title>
1660 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
1661 viele "Druckbefehle" im System verwalten. Diese Befehle werden
1662 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
1663 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
1664 angezeigt wird.</para>
1666 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
1667 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
1668 meinDrucker' oder ein kompletter Pfad zu einem Skript
1669 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
1670 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
1671 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
1672 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
1673 Ausdruck eines Angebots folgende Vorlage geparst:
1674 sales_quotation_epson_drucker.tex.</para>
1678 <title>System sperren / entsperren</title>
1680 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
1681 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
1682 gesamten kivitendo Installation gesperrt.</para>
1684 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
1685 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
1686 Wartungsarbeiten nicht zugänglich.'.</para>
1688 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
1689 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
1690 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
1691 inkonsistenten Datenbestand weitergearbeitet werden.</para>
1695 <sect1 id="config.sending-email"
1696 xreflabel="E-Mail-Versand aus kivitendo heraus">
1697 <title>E-Mail-Versand aus kivitendo heraus</title>
1699 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
1700 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
1701 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
1702 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
1703 Versand über einen lokalen E-Mail-Server (z.B. mit
1704 <productname>Postfix</productname> oder <productname>Exim</productname>,
1705 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
1706 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
1708 <para>Welche Methode und welcher Server verwendet werden, wird über die
1709 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1710 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
1711 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1713 <sect2 id="config.sending-email.sendmail"
1714 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1715 <title>Versand über lokalen E-Mail-Server</title>
1717 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
1718 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
1719 <productname>Postfix</productname>, <productname>Exim</productname>
1720 oder <productname>Sendmail</productname> läuft.</para>
1722 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1723 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1724 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1726 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
1727 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
1728 Standardwert verweist auf das Programm
1729 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1730 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1732 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
1733 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
1737 <sect2 id="config.sending-email.smtp"
1738 xreflabel="E-Mail-Versand über einen SMTP-Server">
1739 <title>Versand über einen SMTP-Server</title>
1741 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
1742 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
1745 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1746 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1747 Parameter dienen dabei der weiteren Konfiguration:</para>
1751 <term><varname>hostname</varname></term>
1754 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
1755 '<literal>localhost</literal>'</para>
1760 <term><varname>port</varname></term>
1763 <para>Portnummer. Der Standardwert hängt von der verwendeten
1764 Verschlüsselungsmethode ab. Gilt '<literal>security =
1765 none</literal>' oder '<literal>security = tls</literal>', so ist
1766 25 die Standardportnummer. Für '<literal>security =
1767 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
1768 geändert werden.</para>
1773 <term><varname>security</varname></term>
1776 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
1777 mit dem Server. Standardwert ist '<literal>none</literal>',
1778 wodurch keine Verschlüsselung verwendet wird. Mit
1779 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
1780 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
1781 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
1782 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
1783 (siehe unten).</para>
1788 <term><varname>login</varname> und
1789 <varname>password</varname></term>
1792 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
1793 so können mit diesen zwei Parametern der Benutzername und das
1794 Passwort angegeben werden. Wird Authentifizierung verwendet, so
1795 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
1796 aktiviert werden.</para>
1803 <sect1 id="Drucken-mit-kivitendo">
1804 <title>Drucken mit kivitendo</title>
1806 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
1807 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1808 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1809 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
1811 <para><programlisting>apt-get install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1812 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1814 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
1816 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
1817 texlive-collection-latexrecommended texlive-collection-langgerman \
1818 texlive-collection-langenglish</programlisting></para>
1820 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
1822 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
1823 texlive-collection-latexrecommended texlive-collection-langgerman \
1824 texlive-collection-langenglish</programlisting></para>
1826 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1838 <para>rev-odt</para>
1842 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version
1843 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
1845 <sect2 id="Vorlagenverzeichnis-anlegen"
1846 xreflabel="Vorlagenverzeichnis anlegen">
1847 <title>Vorlagenverzeichnis anlegen</title>
1849 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
1850 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1852 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1854 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
1855 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
1856 <xref linkend="Gruppen-anlegen"/>.</para>
1858 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
1859 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
1860 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
1861 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1865 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
1866 Vorlagensatz aus, der kopiert werden soll
1867 (<filename>RB</filename>, <filename>f-tex</filename> oder
1868 <filename>odt-rev</filename>.)</para>
1872 <para><option>Neuer Name</option>: Der Verzeichnisname für den
1873 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
1874 für Verzeichnisnamen frei gewählt werden.</para>
1878 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
1879 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
1880 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1881 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
1882 vorgenommen werden. Den Ordner findet man im Dateisystem unter
1883 <filename>./templates/[Neuer Name]</filename></para>
1886 <sect2 id="Vorlagen-RB">
1887 <title>Der Druckvorlagensatz RB</title>
1889 <para>Hierbei handelt es sich um einen vollständigen LaTeX
1890 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
1891 sind nicht gepflegt.</para>
1893 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
1894 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1895 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
1896 eigenen Firmendaten finden sich in der Datei Readme.tex im
1897 Vorlagenverzeichnis.</para>
1899 <para>Eine kurze Übersicht der Features:</para>
1903 <para>Mehrsprachenfähig, mit Deutscher und Englischer
1908 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
1909 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
1914 <para>mehrere vordefinierte Varianten für
1915 Logos/Hintergrundbilder</para>
1919 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
1920 "Außerhalb EU"</para>
1926 <title>f-tex</title>
1928 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur
1929 Verfügung stellt.</para>
1931 <sect3 id="f-tex-Feature-Übersicht">
1932 <title>Feature-Übersicht</title>
1936 <para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage
1937 für alle briefartigen Dokumente verwendet. Also Angebot,
1938 Rechnung, Proformarechnung, Lieferschein, aber eben nicht für
1939 Paketaufkleber etc.</para>
1943 <para>Leichte Anpassung an das Firmen-Layout durch Verwendung
1944 eines Hintergrund-PDFs. Dieses kann leicht mit dem eigenen
1945 Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp,
1950 <para>Hintergrund-PDF umschaltbar auf "nur erste Seite"
1951 (Standard) oder "alle Seiten" (Option
1952 "<option>bgPdfFirstPageOnly</option>" in Datei
1953 <filename>letter.lco</filename>)</para>
1957 <para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem
1958 Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1959 versendeten Dokumenten eingebunden (Option
1960 "<option>bgPdfEmailOnly</option>" in Datei
1961 <filename>letter.lco</filename>).</para>
1965 <para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch,
1966 Wiederholung von Kopfzeilen, Zwischensummen etc. (danke an
1967 Kai-Martin Knaak für die Vorarbeit)</para>
1971 <para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom
1972 Land des eigenen Unternehmens abweicht (also die Rechnung das
1973 Land verlässt).</para>
1977 <para>Multisprachfähig leicht um weitere Sprachen zu erweitern,
1978 alle Übersetzungen in der Datei
1979 <filename>translatinos.tex</filename>.</para>
1983 <para>Auflistung von Bruttopreisen für Endverbraucher.</para>
1988 <sect3 id="f-tex-Installation">
1989 <title>Die Installation</title>
1993 <para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref
1994 linkend="Vorlagenverzeichnis-anlegen"/>. Das Vorlagensystem
1995 funktioniert jetzt schon, hat allerdings noch einen
1996 Beispiel-Briefkopf.</para>
2000 <para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
2001 <filename>./letter_head.pdf</filename>.</para>
2005 <para>Editiere den Bereich "<option>settings</option>" in der
2006 datei <filename>letter.lco</filename>.</para>
2010 <para>oder etwas detaillierter:</para>
2012 <para>Es wird eine Datei <filename>sample.lco</filename> erstellt
2013 und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
2014 ist dies die Datei die für die firmenspezifischen Anpassungen
2015 gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist,
2016 wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle
2017 über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und
2018 <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung
2019 über eine <filename>*.lco</filename>-Datei, die letztlich auf
2020 <filename>letter.lco</filename> verlinkt ist ist aber auch
2023 <para>Es wird eine Datei <filename>sample_head.pdf</filename> mit
2024 ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
2025 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage.
2026 Schau Dir nach Abschluss der Installation die Datei
2027 <filename>sample_head.pdf</filename> an und erstelle ein
2028 entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
2029 Template Verzeichniss ablegen und statt
2030 <filename>sample_head.pdf</filename> nach
2031 <filename>letter_head.pdf</filename> verlinken.</para>
2033 <para>Letzlich muss <filename>letter_head.pdf</filename> auf das
2034 passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
2037 <para>Es wird eine Datei <filename>mydata.tex.example</filename>
2038 ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
2039 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das
2040 Land verwendet. Die Datei muss also nicht angefasst werden. Die
2041 anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit
2042 nicht im öffentlichen Zweig).</para>
2044 <para>Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
2045 sollten über die Hintergrund-PDF-Datei oder die
2046 <filename>*.lco</filename>-Datei erfolgen.</para>
2049 <sect3 id="f-tex-Funktionsübersicht">
2050 <title>f-tex Funktionsübersicht</title>
2052 <para>Das Konzept von kivitendo sieht vor, für jedes Dokument
2053 (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
2054 LaTeX-Vorlage vorzuhalten, dies ist sehr wartungsunfreundlich. Auch
2055 das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
2056 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen
2057 aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
2058 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
2059 LaTeX-Vorlage verwendet, welche über Codeweichen die Besonderheiten
2060 der jeweiligen Dokumente berücksichtigt:</para>
2064 <para>Tabellen mit oder ohne Preis</para>
2068 <para>Sprache der Tabellenüberschriften etc.</para>
2072 <para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
2073 Angebotsnummer)</para>
2077 <para>Darstellung von Brutto oder Netto-Preisen in der
2078 Auflistung (Endverbraucher versus gewerblicher Kunde)</para>
2082 <para>Nachteil:</para>
2084 <para>LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei
2085 <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
2086 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder
2087 geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch
2088 innerhalb der Tabellendarstellung gut persönliche Anpassungen
2089 vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell
2090 heftig in den Fuss schiessen.</para>
2092 <para>Wer nicht so tief in die Materie einsteigen will oder leicht
2093 zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
2094 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen,
2095 und sich an der Form der dargestellten Tabellen, wie sie
2096 ausgeliefert werden, erfreuen.</para>
2098 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine,
2099 kontinuierliche Schritte gehen.</para>
2102 <sect3 id="f-tex-Bruttopreise">
2103 <title>Bruttopreise für Endverbraucher</title>
2105 <para>Der auszuweisende Bruttopreis wird innerhalb der
2106 LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen
2107 "alle Preise Brutto" auszuwählen, aber:</para>
2111 <para>hierfür müssen die Preise auch in Brutto in der Datenbank
2112 stehen (ja - das lässt sich über die Preisgruppen und die
2113 Zuordung einer Default-Preisgruppe handhaben)</para>
2117 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses
2118 Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
2119 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche
2124 <para>Es gibt mit f-tex eine weitere Alternative. Die Information ob
2125 Brutto oder Nettorechnung wird mit den Zahlarten verknüpft.
2126 Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben
2127 werden sollen, enden mit "_E" (für Endverbraucher). Falls identische
2128 Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt
2129 man diese einfach doppelt an (einmal mit der Namensendung "_E").
2134 <para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist
2135 nicht mehr fix mit einer Preisliste verbunden.</para>
2139 <para>Die Default-Zahlart kann im Kundendatensatz hinterlegt
2140 werden, und man muss nicht mehr daran denken, "alle Preise
2141 Netto" auszuwählen.</para>
2145 <para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen
2146 werden, kann direkt beim Drucken revidiert werden, ohne dass
2147 sich der Auftragswert ändert.</para>
2152 <sect3 id="f-tex-lieferadressen">
2153 <title>Lieferadressen</title>
2155 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen
2156 im Adressfeld zum Einsatz. Wenn die
2157 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende
2158 Adressvariable eingesetzt. Wenn also die Lieferadresse in Straße,
2159 Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
2160 Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert
2161 der Hauptadresse angezeigt.</para>
2165 <sect2 id="Vorlagen-rev-odt">
2166 <title>Der Druckvorlagensatz rev-odt</title>
2168 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2169 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2170 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2171 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2172 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2173 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2174 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2176 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2177 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2178 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2179 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2180 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2181 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2183 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2184 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2185 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2186 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2187 die vom Parser nicht korrekt gelesen werden kann.</para>
2189 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2190 odt-Vorlagen bei Mahnungen, Briefen und Pflichtenheften einzusetzen.
2191 Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2193 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2194 empfang@revamp-it.ch</para>
2197 <sect2 id="allgemeine-hinweise-zu-latex">
2198 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2200 <para>In den allermeisten Installationen sollte das Drucken jetzt
2201 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2202 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2203 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2204 sind zum Beispiel:</para>
2208 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2209 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2210 allem bei Vorlagen aus der Community auf. Installieren Sie die
2211 entsprechenden Pakete.</para>
2215 <para>! Package inputenc Error: Unicode char \u8:... set up for
2216 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2217 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2218 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2219 diversen Tricks dazu gebracht werden andere Zeichen zu
2220 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2225 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2226 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2227 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2228 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2229 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2232 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2233 verifizieren lässt:</para>
2237 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2238 "keep_temp_files" auf 1</para>
2240 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2244 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2248 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2252 <para>wechsel in das users Verzeichnis von kivitendo</para>
2254 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2258 <para>LaTeX Suchpfad anpassen:</para>
2260 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2264 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2267 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2269 <para>Es sollte die letzte Datei ganz unten sein</para>
2273 <para>für besseren Hinweis auf Fehler texdatei nochmals
2276 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2278 <para>in der *.tex datei nach dem Fehler suchen.</para>
2284 <sect1 id="OpenDocument-Vorlagen">
2285 <title>OpenDocument-Vorlagen</title>
2287 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2288 OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2) erzeugen.
2289 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
2290 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2291 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2292 <filename>config/kivitendo.conf</filename> die Variable
2293 <literal>opendocument</literal> im Abschnitt
2294 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2295 Dieses ist die Standardeinstellung.</para>
2297 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2298 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2299 LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt werden, so muss
2300 neben LibreOffice oder OpenOffice auch der “X virtual frame buffer”
2301 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
2302 Andere Distributionen enthalten ihn in anderen Paketen.</para>
2304 <para>Nach der Installation müssen in der Datei
2305 <filename>config/kivitendo.conf</filename> im Abschnitt
2306 <literal>applications</literal> zwei weitere Variablen
2307 angepasst werden:</para>
2308 <para><literal>openofficeorg_writer</literal> muss den
2309 vollständigen Pfad zu LibreOffice oder OpenOffice enthalten.
2310 Dabei dürfen keine Anführungszeichen eingesetzt werden.</para>
2311 <para>Beispiel für Debian oder Ubuntu:</para>
2312 <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2313 <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2316 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2317 LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die benutzt
2318 wird, wenn die Variable <literal>$openofficeorg_daemon</literal> gesetzt
2319 ist, startet ein LibreOffice oder OpenOffice, das auch nach der Umwandlung
2320 des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen wird dann diese
2321 laufende Instanz benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung
2322 deutlich reduziert wird, weil nicht für jedes Dokument ein LibreOffice bzw.
2323 OpenOffice gestartet werden muss. Der Nachteil ist, dass diese Methode
2324 Python und die Python-UNO-Bindings benötigt, die Bestandteil von LibreOffice
2325 bzw. OpenOffice sind.</para>
2328 <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2329 normalerweise der Python-Interpreter
2330 <filename>/usr/bin/python</filename> benutzt.
2331 Sollte dies nicht der richtige sein, so kann man mit zwei
2332 Konfigurationsvariablen entscheiden, welcher Python-Interpreter
2333 genutzt wird. Mit der Option <literal>python_uno</literal> aus dem
2334 Abschnitt <literal>applications</literal> wird der Interpreter selber
2335 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2336 <literal>/usr/bin/python</literal>.</para>
2338 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2339 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2340 z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2341 OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2342 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2343 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2344 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2345 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2346 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2350 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2351 wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet
2352 und die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses
2353 Makro muss in der Dokumentenvorlage enthalten sein und
2354 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2355 ‘<literal>templates/print/rev-odt/invoice.odt</literal>’
2356 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
2357 ebenfalls enthalten sein muss.</para>
2359 <para>Als letztes muss herausgefunden werden, welchen Namen
2360 OpenOffice bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen
2361 gibt. Unter Debian ist dies momentan
2362 <literal>~/.config/libreoffice</literal>. kivitendo verwendet das
2363 Verzeichnis <literal>users/.openoffice.org2</literal>.
2364 Eventuell muss dieses Verzeichnis umbenannt werden.</para>
2366 <para>Dieses Verzeichnis, wie auch das komplette
2367 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2368 sein. Dieses wurde bereits erledigt (siehe <xref
2369 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber
2370 erneut überprüft werden, wenn die Konvertierung nach PDF
2374 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2376 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2377 Aufgaben erfüllen.</para>
2379 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2380 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2381 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2382 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2383 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2384 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2385 Anpassungen aufgeführt</emphasis>):</para>
2388 <title>Bezeichnung der Vorlagen</title>
2390 <para>Rechnung: invoice_besr.odt, Auftrag:
2391 sales_order_besr.odt</para>
2395 <title>Vorbereitungen im Adminbereich</title>
2397 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2398 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2399 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2400 ein Drucker eingerichtet werden:</para>
2404 <para>Druckeradministration → Drucker hinzufügen</para>
2408 <para>Mandant wählen</para>
2412 <para>Druckerbeschreibung → aussagekräftiger Text: wird in
2413 der Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B.
2414 mit Einzahlungsschein Bank xy)</para>
2418 <para>Druckbefehl → beliebiger Text (hat für das Erzeugen
2419 von Aufträgen oder Rechnungen als odt-Datei keine Bedeutung,
2420 darf aber nicht leer sein)</para>
2424 <para>Vorlagenkürzel → besr bzw. selbst gewähltes
2425 Vorlagensuffix (muss genau der Zeichenfolge entsprechen, die
2426 zwischen "invoice_" bzw. "sales_order_" und ".odt"
2431 <para>speichern</para>
2437 <title>Benutzereinstellungen</title>
2439 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2440 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2441 dies persönlich für sich bei den Benutzereinstellungen
2442 konfigurieren:</para>
2446 <para>Programm → Benutzereinstellungen →
2447 Druckoptionen</para>
2451 <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2455 <para>Standardausgabekanal → Bildschirm</para>
2459 <para>Standarddrucker → gewünschte Druckerbeschreibung
2460 auswählen (z.B. mit Einzahlungsschein Bank xy)</para>
2464 <para>Anzahl Kopien → leer</para>
2468 <para>speichern</para>
2474 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2476 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2477 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2478 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2479 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2484 <para>Für den Einzahlungsschein ist die letzte Seite des
2485 Dokuments reserviert</para>
2489 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2490 Zeile mit folgenden Angaben (<emphasis
2491 role="bold">Bank-Konto-Identifikationsnummer und
2492 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2493 Bank angepasst werden</emphasis>):<itemizedlist>
2495 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2496 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2498 <para>erster Wert: <emphasis
2499 role="bold">Bank-Konto-Identifikation</emphasis>
2500 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2501 angepasst werden</emphasis>.</para>
2505 <para>zweiter Wert: <%customernumber%>
2506 (Kundennummer: nur Ziffern, maximal 6)</para>
2510 <para>dritter Wert: <%ordnumber%>
2511 (Auftragsnummer bei Auftragsvorlage
2512 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2513 führende Buchstaben werden vom Makro entfernt</para>
2517 <para>vierter Wert: <%invnumber%>
2518 (Rechnungsnummer bei Rechnungsvorlage
2519 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2520 führende Buchstaben werden vom Makro entfernt</para>
2522 </itemizedlist></para>
2526 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2527 Bank, muss angepasst werden</emphasis>.</para>
2531 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2532 falls Einzahlungsschein ohne Betrag</para>
2536 <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2538 </itemizedlist></para>
2542 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2543 der Name und die Adresse der Bank, die Postkonto-Nummer der
2544 Bank, sowie der eigene Firmenname und die Firmenadresse
2545 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2546 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2547 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2553 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2554 ändernde Einträge in rot</screeninfo>
2558 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2565 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2566 odt-Rechnung (analog bei Auftrag)</title>
2568 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2569 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2570 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2571 den Benutzereinstellungen als persönlicher Standard gewählt
2576 <title>Makroeinstellungen in LibreOffice anpassen</title>
2578 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2579 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2580 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2581 angepasst werden:</para>
2585 <para>Extras → Optionen → Sicherheit →
2586 Makrosicherheit</para>
2590 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2591 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2592 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2597 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2598 der entsprechenden Nachfrage "Makros ausführen" auswählen.
2601 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2602 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2603 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2604 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2612 <sect1 id="config.eur">
2613 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
2616 <sect2 id="config.eur.introduction"
2617 xreflabel="Einführung in die Konfiguration zur EUR">
2618 <title>Einführung</title>
2620 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
2621 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
2622 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
2623 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
2624 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
2626 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
2627 die Mandantendatenbank verschoben und dabei auch gleich in drei
2628 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
2629 steuern lässt.</para>
2632 <sect2 id="config.eur.parameters"
2633 xreflabel="Konfigurationsparameter für EUR">
2634 <title>Konfigurationsparameter</title>
2636 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
2637 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
2641 <term><varname>profit_determination</varname></term>
2644 <para>Dieser Parameter legt die Berechnungsmethode für die
2645 Gewinnermittlung fest. Er enthält entweder
2646 <literal>balance</literal> für
2647 Betriebsvermögensvergleich/Bilanzierung oder
2648 <literal>income</literal> für die
2649 Einnahmen-Überschuss-Rechnung.</para>
2654 <term><varname>accounting_method</varname></term>
2657 <para>Dieser Parameter steuert die Buchungs- und
2658 Berechnungsmethoden für die Versteuerungsart. Er enthält
2659 entweder <literal>accrual</literal> für die Soll-Versteuerung
2660 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
2665 <term><varname>inventory_system</varname></term>
2668 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
2669 enthält entweder <literal>perpetual</literal> für die
2670 Bestandsmethode oder <literal>periodic</literal> für die
2671 Aufwandsmethode.</para>
2676 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
2677 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
2678 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
2679 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
2680 Bestandsmethode.</para>
2682 <para>Die Konfiguration "<varname>eur</varname>" unter
2683 <varname>[system]</varname> in der <link
2684 linkend="config.config-file">Konfigurationsdatei</link>
2685 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
2686 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
2689 <sect2 id="config.eur.setting-parameters">
2690 <title>Festlegen der Parameter</title>
2692 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
2693 der Admininstration können diese Optionen nun unabhängig voneinander
2694 eingestellt werden.</para>
2696 <para>Für die Schweiz sind folgende Einstellungen üblich:
2699 <para>Sollversteuerung</para>
2702 <para>Aufwandsmethode</para>
2705 <para>Bilanzierung</para>
2708 Diese Einstellungen werden automatisch beim Erstellen einer neuen
2709 Datenbank vorausgewählt, wenn in <filename>config/kivitendo.conf</filename> unter
2710 <varname>[system]</varname> <literal>default_manager = swiss</literal> eingestellt ist.
2713 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
2714 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
2717 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
2718 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
2719 angezeigt. Unter <guimenu>System</guimenu> →
2720 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
2721 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
2722 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
2723 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
2724 auch <link linkend="config.eur.inventory-system-perpetual">
2725 Bemerkungen zur Bestandsmethode</link>).</para>
2728 <sect2 id="config.eur.inventory-system-perpetual">
2729 <title>Bemerkungen zur Bestandsmethode</title>
2731 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
2732 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
2733 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
2734 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
2735 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
2736 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
2737 Einkaufsrechnungen berechnet wird.</para>
2739 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
2740 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
2741 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
2745 <sect2 id="config.eur.knonw-issues">
2746 <title>Bekannte Probleme</title>
2748 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
2749 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
2750 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
2751 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
2752 die Konfigurationsvariable
2753 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
2756 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
2757 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
2761 <sect1 id="config.skr04-update-3804">
2762 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
2764 <sect2 id="config.skr04-update-3804.introduction">
2765 <title>Einführung</title>
2767 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
2768 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
2769 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
2770 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
2771 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
2772 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
2773 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
2774 vielleicht schon selbst geholfen hat und mit seinen Änderungen
2775 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
2776 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
2777 Screenshots dargestellt.</para>
2779 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
2780 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
2781 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
2782 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
2785 <sect2 id="config.skr04-update-3804.create-chart">
2786 <title>Konto 3804 manuell anlegen</title>
2788 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
2789 anzulegen und zu konfigurieren. Zuerst wird in
2790 <guimenu>System</guimenu> →
2791 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konto
2792 erfassen</guimenuitem> das Konto angelegt.</para>
2795 <screeninfo>Konto 3804 erfassen</screeninfo>
2799 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
2804 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
2805 werden. Dazu unter <guimenu>System</guimenu> →
2806 <guisubmenu>Steuern</guisubmenu> →
2807 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
2808 13 auswählen und ihn wie im folgenden Screenshot angezeigt
2812 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
2816 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
2821 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
2822 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
2823 <guisubmenu>Steuern</guisubmenu> →
2824 <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem
2825 Screenshot übernehmen.</para>
2828 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
2832 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
2837 <para>Als Nächstes sind alle Konten anzupassen, die als
2838 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
2839 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
2840 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
2841 müssen Sie dazu unter <guimenu>System</guimenu> →
2842 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
2843 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
2844 wie im Screenshot gezeigt vornehmen.</para>
2847 <screeninfo>Konto 4315 anpassen</screeninfo>
2851 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
2856 <para>Als Letztes sollte die Steuerliste unter
2857 <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
2858 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
2859 Vergleich der Screenshot.</para>
2862 <screeninfo>Steuerliste vergleichen</screeninfo>
2866 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
2873 <sect1 id="config.bilanz">
2874 <title>Verhalten des Bilanzberichts</title>
2876 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
2877 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
2878 monatsweise führt dies zu falschen Werten.</para>
2880 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
2881 einstellen indem man:</para>
2885 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
2890 <para>immer den Jahresanfang nimmt (1.1. relativ zum
2895 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
2897 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
2900 <para>- oder mit "alle Buchungen" als Alternative"</para>
2904 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
2909 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
2913 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
2914 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
2915 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
2916 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
2917 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
2918 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
2919 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
2920 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
2921 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
2922 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
2923 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
2924 Erfolgsrechnung.</para>
2927 <sect1 id="config.erfolgsrechnung">
2928 <title>Erfolgsrechnung</title>
2930 <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht <emphasis role="bold">
2931 Erfolgsrechnung</emphasis>.</para>
2933 <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter Features
2934 an- oder abgeschaltet werden. Mit der Einstellung <varname>default_manager = swiss
2935 </varname> in der <filename>config/kivitendo.conf</filename> wird beim neu Erstellen
2936 einer Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü <guimenu>Berichte
2937 </guimenu> ausgewählt und ersetzt dort die GUV.</para>
2939 <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche Aufwands- und
2940 Erlöskonten einzeln aufgelistet (analog zur Bilanz), sortiert nach ERTRAG und AUFWAND.</para>
2942 <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der Erfolgsrechnung
2943 erscheinen soll, unter <varname>Sonstige Einstellungen/Erfolgsrechnung</varname>
2944 entweder <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal> ausgewählt
2947 <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal> ausgewählt,
2948 so wird dieses Konto als Aufwandsminderung unter AUFWAND aufgelistet.</para>
2950 <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal> ausgewählt,
2951 so wird dieses Konto als Ertragsminderung unter ERTRAG aufgelistet.</para>
2953 <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft zusätzlich
2954 die Erfolgsrechnung als Bericht verwendet werden, so müssen die Einstellungen
2955 zu allen Erlös- und Aufwandskonten unter <varname>Sonstige
2956 Einstellungen/Erfolgsrechnung</varname> überprüft und allenfalls neu gesetzt werden.</para>
2959 <sect1 id="config.rounding">
2960 <title>Rundung in Verkaufsbelegen</title>
2962 <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert von 5 Rappen (0.05 CHF).</para>
2964 <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer Genauigkeit
2965 von 0.01 CHF verwendet werden können, ist es trotzdem nach wie vor üblich,
2966 Rechnungen mit auf 0.05 CHF gerundeten Beträgen auszustellen.</para>
2968 <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine solche
2969 Rundung pro Mandant / Datenbank festgelegt werden.</para>
2971 <para>Die Einstellung wird beim Erstellen der Datenbank bei <literal>Genauigkeit</literal>
2972 festgelegt. Sie kann anschliessend über das Webinterface von kivitendo nicht mehr
2973 verändert werden.</para>
2975 <para>Abhängig vom Wert für <varname>default_manager</varname> in
2976 <filename>config/kivitendo.conf</filename> werden dabei folgende
2977 Werte voreingestellt:</para>
2980 <para>0.05 (default_manager = swiss)</para>
2983 <para>0.01 (default_manager = german)</para>
2986 <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
2987 </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
2989 <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
2990 und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet,
2991 wenn dieser nicht der eingestellten Genauigkeit entspricht.</para>
2993 <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
2994 automatisch auf die in der Mandantenkonfiguration festgelegten
2995 Standardkonten für Rundungserträge bzw. Rundungsaufwendungen gebucht.</para>
2997 <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr verändert.)</para>
2999 <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
3000 <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
3001 <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
3003 <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege
3004 in anderen Währungen als der Standardwährung erstellt, so muss in
3005 kivitendo 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
3006 <para>Das heisst, Firmen in der Schweiz, die teilweise Verkaufsrechnungen
3007 in Euro oder anderen Währungen erstellen wollen, müssen beim Erstellen
3008 der Datenbank als Genauigkeit 0.01 wählen und können zur Zeit die
3009 5er Rundung noch nicht nutzen.</para>
3012 <sect1 id="config.client">
3013 <title>Einstellungen pro Mandant</title>
3015 <para>Einige Einstellungen können von einem Benutzer mit dem <link
3016 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
3017 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
3018 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3019 Die Einstellungen sind unter <guimenu>System</guimenu> →
3020 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3022 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3023 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3024 geändert werden (siehe auch <link
3025 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3026 Bestandsmethode</link>).</para>
3028 <para>Die Einstellungen <literal>show_bestbefore</literal> und
3029 <literal>payments_changeable</literal> aus dem Abschnitt
3030 <literal>features</literal> und die Einstellungen im Abschnitt
3031 <literal>datev_check</literal> (sofern schon vorhanden) der <link
3032 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3033 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3034 Diese Einträge können danach aus der Konfigurationsdatei entfernt
3038 <sect1 id="kivitendo-ERP-verwenden">
3039 <title>kivitendo ERP verwenden</title>
3041 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3042 folgender URL erreichbar:</para>
3045 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3047 <para>Die Administrationsseite erreichen Sie unter:</para>
3050 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3054 <chapter id="features" xreflabel="Features und Funktionen">
3055 <title>Features und Funktionen</title>
3057 <sect1 id="features.periodic-invoices"
3058 xreflabel="Wiederkehrende Rechnungen">
3059 <title>Wiederkehrende Rechnungen</title>
3061 <sect2 id="features.periodic-invoices.introduction"
3062 xreflabel="Einführung in wiederkehrende Rechnungen">
3063 <title>Einführung</title>
3065 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3066 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3067 Die konfigurierten Aufträge werden später automatisch in Rechnungen
3068 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3069 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3070 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3071 wiederzufinden sind.</para>
3074 <sect2 id="features.periodic-invoices.configuration"
3075 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3076 <title>Konfiguration</title>
3078 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3079 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3080 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3081 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3082 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3085 <para>Folgende Parameter kann man konfigurieren:</para>
3092 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3093 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3094 eines neuen Monats).</para>
3096 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3097 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3098 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3099 nächsten Periodenwechsel für alle Perioden, seit der letzten
3100 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3101 verhindern, muss man vorher das Startdatum neu setzen.</para>
3103 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3104 erstellt. Man kann sich diese Aufträge aber gesondert in den
3105 Berichten anzeigen lassen.</para>
3110 <term>Periodizität</term>
3113 <para>Ob monatlich, quartalsweise oder jährlich auf neue
3114 Rechnungen überprüft werden soll. Für jede Periode seit dem
3115 Startdatum wird überprüft, ob für die Periode (beginnend immer
3116 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3117 wurde. Unter Umständen können bei einem Startdatum in der
3118 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3123 <term>Buchen auf</term>
3126 <para>Das Forderungskonto, in der Regel "Forderungen aus
3127 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3128 Buchungsgruppen der betreffenden Waren.</para>
3133 <term>Startdatum</term>
3136 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3142 <term>Enddatum</term>
3145 <para>ab wann keine Rechnungen mehr erstellt werden
3151 <term>Automatische Verlängerung um x Monate</term>
3154 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3155 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3156 hier die Anzahl der Monate eingeben, um die das Enddatum
3157 automatisch nach hinten geschoben wird.</para>
3162 <term>Drucken</term>
3165 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3166 Rechnungen auch gleich ausdrucken lassen.</para>
3171 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3172 Informationen zu den erstellten Rechnungen verschickt werden.
3173 Konfiguriert wird dies in der <link
3174 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3175 <filename>config/kivitendo.conf</filename> im Abschnitt
3176 <varname>[periodic_invoices]</varname>.</para>
3179 <sect2 id="features.periodic-invoices.variables">
3180 <title>Spezielle Variablen</title>
3182 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3183 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3184 formatierte Variablen durch für die jeweils aktuelle
3185 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3186 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3187 die Syntax <literal><%variablenname%></literal>.</para>
3189 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3190 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3191 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3192 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3193 Die zur verfügung stehenden Formatinformationen werden unten genauer
3196 <para>Diese Variablen können auch beim automatischen Versand der
3197 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3198 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3200 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3205 <para>Bemerkungen</para>
3209 <para>Interne Bemerkungen</para>
3213 <para>Vorgangsbezeichnung</para>
3217 <para>In den Beschreibungs- und Langtextfeldern aller
3222 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3226 <term><varname><%current_quarter%></varname>,
3227 <varname><%previous_quarter%></varname>,
3228 <varname><%next_quarter%></varname></term>
3231 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3232 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3237 <term><varname><%current_month%></varname>,
3238 <varname><%previous_month%></varname>,
3239 <varname><%next_month%></varname></term>
3242 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3243 <literal>1</literal> und <literal>12</literal>.</para>
3248 <term><varname><%current_month_long%></varname>,
3249 <varname><%previous_month_long%></varname>,
3250 <varname><%next_month_long%></varname></term>
3253 <para>Aktueller, vorheriger und nächster Monat als Name
3254 (<literal>Januar</literal>, <literal>Februar</literal>
3260 <term><varname><%current_year%></varname>,
3261 <varname><%previous_year%></varname>,
3262 <varname><%next_year%></varname></term>
3265 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3266 Jahreszahl (<literal>2013</literal> etc.).</para>
3271 <term><varname><%period_start_date%></varname>,
3272 <varname><%period_end_date%></varname></term>
3275 <para>Formatiertes Datum des ersten und letzten Tages im
3276 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3277 ersten Quartal von 2013 wären dies der
3278 <literal>01.01.2013</literal> und
3279 <literal>31.03.2013</literal>).</para>
3284 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3285 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3286 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3287 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3292 <term><varname>%a</varname></term>
3295 <para>Der abgekürzte Wochentagsname.</para>
3300 <term><varname>%A</varname></term>
3303 <para>Der ausgeschriebene Wochentagsname.</para>
3308 <term><varname>%b</varname></term>
3311 <para>Der abgekürzte Monatsname.</para>
3316 <term><varname>%B</varname></term>
3319 <para>Der ausgeschriebene Monatsname.</para>
3324 <term><varname>%C</varname></term>
3327 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3333 <term><varname>%d</varname></term>
3336 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3341 <term><varname>%D</varname></term>
3344 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3349 <term><varname>%e</varname></term>
3352 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3353 werden führende Nullen durch Leerzeichen ersetzt.</para>
3358 <term><varname>%F</varname></term>
3361 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3366 <term><varname>%j</varname></term>
3369 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3375 <term><varname>%m</varname></term>
3378 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3383 <term><varname>%u</varname></term>
3386 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3387 die 1 dem Montag entspricht.</para>
3392 <term><varname>%U</varname></term>
3395 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3396 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3402 <term><varname>%V</varname></term>
3405 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3406 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3407 vier Tage im Jahr liegen; Montag ist erster Tag der
3413 <term><varname>%w</varname></term>
3416 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3417 die 0 dem Sonntag entspricht.</para>
3422 <term><varname>%W</varname></term>
3425 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3426 wobei der erste Montag im Jahr das Startdatum von Woche 01
3432 <term><varname>%y</varname></term>
3435 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3441 <term><varname>%Y</varname></term>
3444 <para>Das Jahr als vierstellige Zahl.</para>
3449 <term><varname>%%</varname></term>
3452 <para>Das Prozentzeichen selber.</para>
3457 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3458 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3459 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3460 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3463 <sect2 id="features.periodic-invoices.reports">
3464 <title>Auflisten</title>
3466 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3467 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3468 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3469 wiederkehrenden Rechnungen verschaffen kann.</para>
3472 <sect2 id="features.periodic-invoices.task-server">
3473 <title>Erzeugung der eigentlichen Rechnungen</title>
3475 <para>Die zeitliche und periodische Überprüfung, ob eine
3476 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3477 durch den <link linkend="config.task-server">Taskserver</link>, einen
3478 externen Dienst, der automatisch beim Start des Servers gestartet
3479 werden sollte.</para>
3482 <sect2 id="features.periodic-invoices.create-for-current-month">
3483 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3485 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3486 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3487 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
3488 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3489 generiert hat. Alternativ setzt man das Startdatum auf den
3490 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3491 manuell über den Workflow.</para>
3495 <sect1 id="features.bank" xreflabel="bankerweiterung">
3496 <title>Bankerweiterung</title>
3498 <sect2 id="features.bank.introduction"
3499 xreflabel="Einführung in die Bankerweiterung">
3500 <title>Einführung</title>
3502 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3503 im Wiki und soll von dort später hierhin übernommen werden:</para>
3506 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3510 <sect1 id="dokumentenvorlagen-und-variablen">
3511 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3513 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3514 <title>Einführung</title>
3516 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3517 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3518 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3519 <function><%variablenname%></function> verwendet wird. Für
3520 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3522 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3524 <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3525 Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im
3526 Folgenden gesagte für alle Vorlagenarten.</para>
3528 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3529 verfügbar als hier aufgelistet werden. Die meisten davon können
3530 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3531 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3532 diese wie folgt erhalten werden:</para>
3536 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3537 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3541 <para>In <filename>Form.pm</filename> die Funktion
3542 <function>parse_template</function> suchen und hier die Zeile
3543 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3547 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3548 ein PDF für eine Rechnung erzeugen.</para>
3552 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3553 der Variablen <varname>$self</varname> in der Form <varname>'key'
3554 => 'value',</varname>. Alle <varname>key</varname>s sind
3560 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3561 <title>Variablen ausgeben</title>
3563 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3564 Tags geschrieben werden, also z.B.
3565 <varname><%variablenname%></varname>.</para>
3567 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3568 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3569 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
3570 werden die folgenden Flags unterstützt:</para>
3574 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3575 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3576 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3577 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3581 <para><option>NOESCAPE</option> unterdrückt das Escapen von
3582 Sonderzeichen für die Vorlagensprache. Wenn also in einer
3583 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
3584 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
3585 ist dieses Flag sinnvoll.</para>
3589 <para>Beispiel:</para>
3591 <programlisting><%quototal NOFORMAT%></programlisting>
3594 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
3595 <title>Verwendung in Druckbefehlen</title>
3597 <para>In der Admininstration können Drucker definiert werden. Auch im
3598 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
3599 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
3600 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
3601 <function>`...`</function> nicht zu unerwünschtem Verhalten
3604 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
3605 für das die Telefonnummer eines Ansprechpartners als Teil der
3606 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
3607 z.B. wie folgt aussehen:</para>
3609 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
3612 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
3613 xreflabel="Anfang und Ende der Tags verändern">
3614 <title>Anfang und Ende der Tags verändern</title>
3616 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
3617 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
3618 Prozentzeichen und dem Größerzeichen endet, beispielsweise
3619 <function><%customer%></function>. Da diese Form aber z.B. in
3620 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
3621 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
3622 Stil umgestellt werden.</para>
3624 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
3625 Format gültigen Kommentarzeichen anfangen, dann
3626 <function>config:</function> enthalten, die entsprechende Option
3627 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
3628 enden. Beispiel für LaTeX:</para>
3630 <programlisting>% config: tag-style=($ $)</programlisting>
3632 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
3633 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
3634 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
3636 <programlisting><!-- config: tag-style=($ $) --></programlisting>
3639 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
3640 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
3642 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
3643 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
3644 "<filename>.ext</filename>" geeignet zu ersetzen:
3645 "<filename>.tex</filename>" für LaTeX-Vorlagen und
3646 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
3650 <term><filename>bin_list.ext</filename></term>
3653 <para>Lagerliste</para>
3658 <term><filename>check.ext</filename></term>
3666 <term><filename>invoice.ext</filename></term>
3669 <para>Rechnung</para>
3674 <term><filename>packing_list.ext</filename></term>
3677 <para>Packliste</para>
3682 <term><filename>pick_list.ext</filename></term>
3685 <para>Sammelliste</para>
3690 <term><filename>purchase_delivery_order.ext</filename></term>
3693 <para>Lieferschein (Einkauf)</para>
3698 <term><filename>purcharse_order.ext</filename></term>
3701 <para>Bestellung an Lieferanten</para>
3706 <term><filename>request_quotation.ext</filename></term>
3709 <para>Anfrage an Lieferanten</para>
3714 <term><filename>sales_delivery_order.ext</filename></term>
3717 <para>Lieferschein (Verkauf)</para>
3722 <term><filename>sales_order.ext</filename></term>
3725 <para>Bestellung</para>
3730 <term><filename>sales_quotation.ext</filename></term>
3733 <para>Angebot an Kunden</para>
3738 <term><filename>zahlungserinnerung.ext</filename></term>
3741 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
3746 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
3749 <para>Rechnung über Mahngebühren (Dateiname im Programm
3750 konfigurierbar)</para>
3756 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
3757 <title>Sprache, Drucker und E-Mail</title>
3759 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
3760 eingearbeitet. So wird aus der Vorlage
3761 <filename>sales_order.ext</filename> bei Sprache
3762 <function>de</function> und Druckerkürzel <function>lpr2</function>
3763 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
3764 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
3765 bekommen dann noch das Kürzel <filename>_email</filename>, der
3766 vollständige Vorlagenname wäre dann
3767 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
3768 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
3769 werden. Diese wird verwendet, wenn keine der anderen Varianten
3770 gefunden wird.</para>
3772 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
3773 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
3774 verschickt wird, ist:</para>
3778 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
3782 <para><filename>sales_order_de_lpr2.tex</filename></para>
3786 <para><filename>sales_order.tex</filename></para>
3790 <para><filename>default.tex</filename></para>
3794 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
3795 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
3797 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
3800 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
3801 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
3804 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
3805 xreflabel="Metainformationen zur angeforderten Vorlage">
3806 <title>Metainformationen zur angeforderten Vorlage</title>
3808 <para>Diese Variablen liefern Informationen darüber welche Variante
3809 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
3810 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
3811 Formulare einbinden möchten.</para>
3815 <term><varname>template_meta.formname</varname></term>
3818 <para>Basisname der Vorlage. Identisch mit der <link
3819 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
3820 zu den Dateinamen</link> ohne die Erweiterung. Ein
3821 Verkaufsauftrag enthält hier
3822 <constant>sales_order</constant>.</para>
3827 <term><varname>template_meta.language.description</varname></term>
3830 <para>Beschreibung der verwendeten Sprache</para>
3835 <term><varname>template_meta.language.template_code</varname></term>
3838 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
3839 dem Kürzel das im Dateinamen verwendetet wird.</para>
3844 <term><varname>template_meta.language.output_numberformat</varname></term>
3847 <para>Zahlenformat der verwendeten Sprache in der Form
3848 "<constant>1.000,00</constant>". Experimentell! Nur
3849 interessant für Vorlagen die mit unformatierten Werten
3855 <term><varname>template_meta.language.output_dateformat</varname></term>
3858 <para>Datumsformat der verwendeten Sprache in der Form
3859 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
3860 interessant für Vorlagen die mit unformatierten Werten
3866 <term><varname>template_meta.format</varname></term>
3869 <para>Das angeforderte Format. Kann im Moment die Werte
3870 <constant>pdf</constant>, <constant>postscript</constant>,
3871 <constant>html</constant>, <constant>opendocument</constant>,
3872 <constant>opendocument_pdf</constant> und
3873 <constant>excel</constant> enthalten.</para>
3878 <term><varname>template_meta.extension</varname></term>
3881 <para>Dateierweiterung, wie im Dateinamen. Wird aus
3882 <constant>format</constant> entschieden.</para>
3887 <term><varname>template_meta.media</varname></term>
3890 <para>Ausgabemedium. Kann zur Zeit die Werte
3891 <constant>screen</constant> für Bildschirm,
3892 <constant>email</constant> für E-Mail (triggert das
3893 <constant>_email</constant> Kürzel im Dateinamen),
3894 <constant>printer</constant> für Drucker, und
3895 <constant>queue</constant> für Warteschlange enthalten.</para>
3900 <term><varname>template_meta.printer.description</varname></term>
3903 <para>Beschreibung des ausgewählten Druckers</para>
3908 <term><varname>template_meta.printer.template_code</varname></term>
3911 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
3912 dem Kürzel das im Dateinamen verwendetet wird.</para>
3917 <term><varname>template_meta.tmpfile</varname></term>
3920 <para>Datei-Prefix für temporäre Dateien.</para>
3926 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
3927 <title>Stammdaten von Kunden und Lieferanten</title>
3931 <term><varname>account_number</varname></term>
3934 <para>Kontonummer</para>
3939 <term><varname>bank</varname></term>
3942 <para>Name der Bank</para>
3947 <term><varname>bank_code</varname></term>
3950 <para>Bankleitzahl</para>
3955 <term><varname>bic</varname></term>
3958 <para>Bank-Identifikations-Code (Bank Identifier Code,
3964 <term><varname>business</varname></term>
3967 <para>Kunden-/Lieferantentyp</para>
3972 <term><varname>city</varname></term>
3980 <term><varname>contact</varname></term>
3983 <para>Kontakt</para>
3988 <term><varname>country</varname></term>
3996 <term><varname>c_vendor_id</varname></term>
3999 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
4004 <term><varname>v_customer_id</varname></term>
4007 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
4012 <term><varname>cp_email</varname></term>
4015 <para>Email des Ansprechpartners</para>
4020 <term><varname>cp_givenname</varname></term>
4023 <para>Vorname des Ansprechpartners</para>
4028 <term><varname>cp_greeting</varname></term>
4031 <para>Anrede des Ansprechpartners</para>
4036 <term><varname>cp_name</varname></term>
4039 <para>Name des Ansprechpartners</para>
4044 <term><varname>cp_phone1</varname></term>
4047 <para>Telefonnummer 1 des Ansprechpartners</para>
4052 <term><varname>cp_phone2</varname></term>
4055 <para>Telefonnummer 2 des Ansprechpartners</para>
4060 <term><varname>cp_title</varname></term>
4063 <para>Titel des Ansprechpartners</para>
4068 <term><varname>creditlimit</varname></term>
4071 <para>Kreditlimit</para>
4076 <term><varname>customeremail</varname></term>
4079 <para>Email des Kunden; nur für Kunden</para>
4084 <term><varname>customerfax</varname></term>
4087 <para>Faxnummer des Kunden; nur für Kunden</para>
4092 <term><varname>customernotes</varname></term>
4095 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4100 <term><varname>customernumber</varname></term>
4103 <para>Kundennummer; nur für Kunden</para>
4108 <term><varname>customerphone</varname></term>
4111 <para>Telefonnummer des Kunden; nur für Kunden</para>
4116 <term><varname>discount</varname></term>
4124 <term><varname>email</varname></term>
4127 <para>Emailadresse</para>
4132 <term><varname>fax</varname></term>
4135 <para>Faxnummer</para>
4140 <term><varname>gln</varname></term>
4143 <para>GLN (Globale Lokationsnummer)</para>
4148 <term><varname>greeting</varname></term>
4156 <term><varname>homepage</varname></term>
4159 <para>Homepage</para>
4164 <term><varname>iban</varname></term>
4167 <para>Internationale Kontonummer (International Bank Account
4168 Number, IBAN)</para>
4173 <term><varname>language</varname></term>
4176 <para>Sprache</para>
4181 <term><varname>name</varname></term>
4184 <para>Firmenname</para>
4189 <term><varname>payment_description</varname></term>
4192 <para>Name der Zahlart</para>
4197 <term><varname>payment_terms</varname></term>
4200 <para>Zahlungskonditionen</para>
4205 <term><varname>phone</varname></term>
4208 <para>Telefonnummer</para>
4213 <term><varname>shiptocity</varname></term>
4216 <para>Stadt (Lieferadresse) <link
4217 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4222 <term><varname>shiptocontact</varname></term>
4225 <para>Kontakt (Lieferadresse) <link
4226 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4231 <term><varname>shiptocountry</varname></term>
4234 <para>Land (Lieferadresse) <link
4235 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4240 <term><varname>shiptodepartment_1</varname></term>
4243 <para>Abteilung 1 (Lieferadresse) <link
4244 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4249 <term><varname>shiptodepartment_2</varname></term>
4252 <para>Abteilung 2 (Lieferadresse) <link
4253 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4258 <term><varname>shiptoemail</varname></term>
4261 <para>Email (Lieferadresse) <link
4262 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4267 <term><varname>shiptofax</varname></term>
4270 <para>Fax (Lieferadresse) <link
4271 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4276 <term><varname>shiptogln</varname></term>
4279 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4280 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4285 <term><varname>shiptoname</varname></term>
4288 <para>Firmenname (Lieferadresse) <link
4289 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4294 <term><varname>shiptophone</varname></term>
4297 <para>Telefonnummer (Lieferadresse) <link
4298 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4303 <term><varname>shiptostreet</varname></term>
4306 <para>Straße und Hausnummer (Lieferadresse) <link
4307 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4312 <term><varname>shiptozipcode</varname></term>
4315 <para>Postleitzahl (Lieferadresse) <link
4316 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4321 <term><varname>street</varname></term>
4324 <para>Straße und Hausnummer</para>
4329 <term><varname>taxnumber</varname></term>
4332 <para>Steuernummer</para>
4337 <term><varname>ustid</varname></term>
4340 <para>Umsatzsteuer-Identifikationsnummer</para>
4345 <term><varname>vendoremail</varname></term>
4348 <para>Email des Lieferanten; nur für Lieferanten</para>
4353 <term><varname>vendorfax</varname></term>
4356 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4361 <term><varname>vendornotes</varname></term>
4364 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4369 <term><varname>vendornumber</varname></term>
4372 <para>Lieferantennummer; nur für Lieferanten</para>
4377 <term><varname>vendorphone</varname></term>
4380 <para>Telefonnummer des Lieferanten; nur für
4386 <term><varname>zipcode</varname></term>
4389 <para>Postleitzahl</para>
4394 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4395 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4396 Stammdaten nicht eingetragen, so haben die Variablen
4397 <varname>shipto*</varname> den gleichen Wert wie die die
4398 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4399 einige <varname>shipto*</varname>-Variablen so nicht in den
4400 Stammdaten wiederfinden sondern schlicht Kopien der
4401 Lieferdatenvariablen sind (z.B.
4402 <varname>shiptocontact</varname>).</para>
4406 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4407 <title>Informationen über den Bearbeiter</title>
4411 <term><varname>employee_address</varname></term>
4414 <para>Adressfeld</para>
4419 <term><varname>employee_businessnumber</varname></term>
4422 <para>Firmennummer</para>
4427 <term><varname>employee_company</varname></term>
4430 <para>Firmenname</para>
4435 <term><varname>employee_co_ustid</varname></term>
4438 <para>Usatzsteuer-Identifikationsnummer</para>
4443 <term><varname>employee_duns</varname></term>
4446 <para>DUNS-Nummer</para>
4451 <term><varname>employee_email</varname></term>
4459 <term><varname>employee_fax</varname></term>
4467 <term><varname>employee_name</varname></term>
4470 <para>voller Name</para>
4475 <term><varname>employee_signature</varname></term>
4478 <para>Signatur</para>
4483 <term><varname>employee_taxnumber</varname></term>
4486 <para>Steuernummer</para>
4491 <term><varname>employee_tel</varname></term>
4494 <para>Telefonnummer</para>
4500 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4501 <title>Informationen über den Verkäufer</title>
4505 <term><varname>salesman_address</varname></term>
4508 <para>Adressfeld</para>
4513 <term><varname>salesman_businessnumber</varname></term>
4516 <para>Firmennummer</para>
4521 <term><varname>salesman_company</varname></term>
4524 <para>Firmenname</para>
4529 <term><varname>salesman_co_ustid</varname></term>
4532 <para>Usatzsteuer-Identifikationsnummer</para>
4537 <term><varname>salesman_duns</varname></term>
4540 <para>DUNS-Nummer</para>
4545 <term><varname>salesman_email</varname></term>
4553 <term><varname>salesman_fax</varname></term>
4561 <term><varname>salesman_name</varname></term>
4564 <para>voller Name</para>
4569 <term><varname>salesman_signature</varname></term>
4572 <para>Signatur</para>
4577 <term><varname>salesman_taxnumber</varname></term>
4580 <para>Steuernummer</para>
4585 <term><varname>salesman_tel</varname></term>
4588 <para>Telefonnummer</para>
4594 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
4595 <title>Variablen für die einzelnen Steuern</title>
4599 <term><varname>tax</varname></term>
4607 <term><varname>taxbase</varname></term>
4610 <para>zu versteuernder Betrag</para>
4615 <term><varname>taxdescription</varname></term>
4618 <para>Name der Steuer</para>
4623 <term><varname>taxrate</varname></term>
4626 <para>Steuersatz</para>
4632 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
4633 <title>Variablen für Lieferbedingungen</title>
4637 <term><varname>delivery_term</varname></term>
4640 <para>Datenbank-Objekt der Lieferbedingung</para>
4645 <term><varname>delivery_term.description</varname></term>
4648 <para>Beschreibung der Lieferbedingung</para>
4653 <term><varname>delivery_term.description_long</varname></term>
4656 <para>Langtext bzw. übersetzter Langtext der
4657 Lieferbedingung</para>
4664 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
4665 <title>Variablen in Rechnungen</title>
4667 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
4668 <title>Allgemeine Variablen</title>
4672 <term><varname>creditremaining</varname></term>
4675 <para>Verbleibender Kredit</para>
4680 <term><varname>currency</varname></term>
4683 <para>Währung</para>
4688 <term><varname>cusordnumber</varname></term>
4691 <para>Bestellnummer beim Kunden</para>
4696 <term><varname>deliverydate</varname></term>
4699 <para>Lieferdatum</para>
4704 <term><varname>duedate</varname></term>
4707 <para>Fälligkeitsdatum</para>
4712 <term><varname>globalprojectnumber</varname></term>
4715 <para>Projektnummer des ganzen Beleges</para>
4720 <term><varname>globalprojectdescription</varname></term>
4723 <para>Projekbeschreibung des ganzen Beleges</para>
4728 <term><varname>intnotes</varname></term>
4731 <para>Interne Bemerkungen</para>
4736 <term><varname>invdate</varname></term>
4739 <para>Rechnungsdatum</para>
4744 <term><varname>invnumber</varname></term>
4747 <para>Rechnungsnummer</para>
4752 <term><varname>invtotal</varname></term>
4755 <para>gesamter Rechnungsbetrag</para>
4760 <term><varname>notes</varname></term>
4763 <para>Bemerkungen der Rechnung</para>
4768 <term><varname>orddate</varname></term>
4771 <para>Auftragsdatum</para>
4776 <term><varname>ordnumber</varname></term>
4779 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
4780 erstellt wurde</para>
4785 <term><varname>payment_description</varname></term>
4788 <para>Name der Zahlart</para>
4793 <term><varname>payment_terms</varname></term>
4796 <para>Zahlungskonditionen</para>
4801 <term><varname>quodate</varname></term>
4804 <para>Angebotsdatum</para>
4809 <term><varname>quonumber</varname></term>
4812 <para>Angebotsnummer</para>
4817 <term><varname>rounding</varname></term>
4820 <para>Betrag, um den <varname>invtotal</varname> gerundet wurde
4821 (kann positiv oder negativ sein)</para>
4826 <term><varname>shippingpoint</varname></term>
4829 <para>Versandort</para>
4834 <term><varname>shipvia</varname></term>
4837 <para>Transportmittel</para>
4842 <term><varname>subtotal</varname></term>
4845 <para>Zwischensumme aller Posten ohne Steuern</para>
4850 <term><varname>total</varname></term>
4853 <para>Restsumme der Rechnung (Summe abzüglich bereits
4854 bezahlter Posten)</para>
4859 <term><varname>transaction_description</varname></term>
4862 <para>Vorgangsbezeichnung</para>
4867 <term><varname>transdate</varname></term>
4870 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
4871 erstellt wurde</para>
4877 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
4878 <title>Variablen für jeden Posten auf der Rechnung</title>
4882 <term><varname>bin</varname></term>
4885 <para>Stellage</para>
4890 <term><varname>description</varname></term>
4893 <para>Artikelbeschreibung</para>
4898 <term><varname>cusordnumber_oe</varname></term>
4901 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
4902 Posten ursprünglich stammt (nur Verkauf)</para>
4907 <term><varname>discount</varname></term>
4910 <para>Rabatt als Betrag</para>
4915 <term><varname>discount_sub</varname></term>
4918 <para>Zwischensumme mit Rabatt</para>
4923 <term><varname>donumber_do</varname></term>
4926 <para>Lieferscheinnummer des Lieferscheins, aus dem die
4927 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
4928 Workflows aus einem Lieferschein erstellt wurde.</para>
4933 <term><varname>drawing</varname></term>
4936 <para>Zeichnung</para>
4941 <term><varname>ean</varname></term>
4944 <para>EAN-Code</para>
4949 <term><varname>image</varname></term>
4957 <term><varname>linetotal</varname></term>
4960 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
4965 <term><varname>longdescription</varname></term>
4968 <para>Langtext</para>
4973 <term><varname>microfiche</varname></term>
4976 <para>Mikrofilm</para>
4981 <term><varname>netprice</varname></term>
4984 <para>Alternative zu <varname>sellprice</varname>, aber
4985 <varname>netprice</varname> entspricht dem effektiven
4986 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
4987 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
4988 / Menge. Diese Variable ist nützlich, wenn man den gewährten
4989 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
4990 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
4991 <varname>netprice</varname> hat nichts mit Netto/Brutto im
4992 Sinne von Steuern zu tun.</para>
4997 <term><varname>nodiscount_linetotal</varname></term>
5000 <para>Zeilensumme ohne Rabatt</para>
5005 <term><varname>nodiscount_sub</varname></term>
5008 <para>Zwischensumme ohne Rabatt</para>
5013 <term><varname>number</varname></term>
5016 <para>Artikelnummer</para>
5021 <term><varname>ordnumber_oe</varname></term>
5024 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5025 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5026 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5027 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5028 letzterem Fall wird die unsprüngliche Auftragsnummer
5034 <term><varname>p_discount</varname></term>
5037 <para>Rabatt in Prozent</para>
5042 <term><varname>partnotes</varname></term>
5045 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5050 <term><varname>partsgroup</varname></term>
5053 <para>Warengruppe</para>
5058 <term><varname>price_factor</varname></term>
5061 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5067 <term><varname>price_factor_name</varname></term>
5070 <para>Der Name des Preisfaktors, sofern einer eingestellt
5076 <term><varname>projectnumber</varname></term>
5079 <para>Projektnummer</para>
5084 <term><varname>projectdescription</varname></term>
5087 <para>Projektbeschreibung</para>
5092 <term><varname>qty</varname></term>
5100 <term><varname>reqdate</varname></term>
5103 <para>Lieferdatum</para>
5108 <term><varname>runningnumber</varname></term>
5111 <para>Position auf der Rechnung (1, 2, 3...)</para>
5116 <term><varname>sellprice</varname></term>
5119 <para>Verkaufspreis</para>
5124 <term><varname>serialnumber</varname></term>
5127 <para>Seriennummer</para>
5132 <term><varname>tax_rate</varname></term>
5135 <para>Steuersatz</para>
5140 <term><varname>transdate_do</varname></term>
5143 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5144 Workflows aus einem Lieferschein stammte.</para>
5149 <term><varname>transdate_oe</varname></term>
5152 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5153 Workflows aus einem Auftrag erstellt wurde. Wenn es
5154 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5160 <term><varname>transdate_quo</varname></term>
5163 <para>Datum des Angebots, wenn die Position im Rahmen des
5164 Workflows aus einem Angebot stammte.</para>
5169 <term><varname>unit</varname></term>
5172 <para>Einheit</para>
5177 <term><varname>weight</varname></term>
5180 <para>Gewicht</para>
5185 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5186 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5187 einer <function>foreach</function>-Schleife ausgegeben werden, da
5188 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5189 können. Die Variablen dafür lauten:</para>
5193 <term><varname>make</varname></term>
5196 <para>Lieferant</para>
5201 <term><varname>model</varname></term>
5204 <para>Lieferantenartikelnummer</para>
5210 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5211 <title>Variablen für die einzelnen Zahlungseingänge</title>
5215 <term><varname>payment</varname></term>
5223 <term><varname>paymentaccount</varname></term>
5231 <term><varname>paymentdate</varname></term>
5239 <term><varname>paymentmemo</varname></term>
5247 <term><varname>paymentsource</varname></term>
5256 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5257 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5259 <para>Die vom Benutzer definierten Variablen für Kunden und
5260 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5261 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5262 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5263 Variablennamen zusammen.</para>
5265 <para>Beispiel: Der Benutzer hat eine Variable namens
5266 <varname>number_of_employees</varname> definiert, die die Anzahl der
5267 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5268 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5271 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5272 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5273 Präfix <varname>shiptocvar_</varname>.</para>
5277 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5278 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5280 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5281 <title>Namen der Vorlagen</title>
5283 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5284 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5285 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5286 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5287 Vorlagenname für diese Mahnstufe mit dem Zusatz
5288 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5289 für die ausgewählte Sprache und den ausgewählten Drucker
5293 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5294 <title>Allgemeine Variablen in Mahnungen</title>
5296 <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie gewohnt als
5297 <varname>employee_...</varname> bzw. <varname>salesman_...</varname> zur Verfügung.
5298 Werden mehrere Rechnungen in einer Mahnung zusammengefasst, so werden
5299 die Metadaten (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung
5300 im Ausdruck genommen.</para>
5301 <para>Die Adressdaten des Kunden stehen als Variablen <varname>name</varname>,
5302 <varname>street</varname>, <varname>zipcode</varname>,
5303 <varname>city</varname>, <varname>country</varname>,
5304 <varname>department_1</varname>, <varname>department_2</varname>,
5305 und <varname>email</varname> zur Verfügung. Der Ansprechpartner <varname>cp_...</varname>
5306 steht auch zu Verfügung, wird allerdings auch nur von der ersten angemahnten Rechnung (s.o.)
5309 <para>Weitere Variablen beinhalten:</para>
5313 <term><varname>dunning_date</varname></term>
5316 <para>Datum der Mahnung</para>
5321 <term><varname>dunning_duedate</varname></term>
5324 <para>Fälligkeitsdatum für diese Mahhnung</para>
5329 <term><varname>dunning_id</varname></term>
5332 <para>Mahnungsnummer</para>
5337 <term><varname>fee</varname></term>
5340 <para>Kumulative Mahngebühren</para>
5345 <term><varname>interest_rate</varname></term>
5348 <para>Zinssatz per anno in Prozent</para>
5353 <term><varname>total_amount</varname></term>
5356 <para>Gesamter noch zu zahlender Betrag als
5357 <function>fee</function> + <function>total_interest</function>
5358 + <function>total_open_amount</function></para>
5363 <term><varname>total_interest</varname></term>
5366 <para>Zinsen per anno über alle Rechnungen</para>
5371 <term><varname>total_open_amount</varname></term>
5374 <para>Summe über alle offene Beträge der Rechnungen</para>
5380 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5381 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5385 <term><varname>dn_amount</varname></term>
5388 <para>Rechnungssumme (brutto)</para>
5393 <term><varname>dn_duedate</varname></term>
5396 <para>Originales Fälligkeitsdatum der Rechnung</para>
5401 <term><varname>dn_dunning_date</varname></term>
5404 <para>Datum der Mahnung</para>
5409 <term><varname>dn_dunning_duedate</varname></term>
5412 <para>Fälligkeitsdatum der Mahnung</para>
5417 <term><varname>dn_fee</varname></term>
5420 <para>Kummulative Mahngebühr</para>
5425 <term><varname>dn_interest</varname></term>
5428 <para>Zinsen per anno für diese Rechnung</para>
5433 <term><varname>dn_invnumber</varname></term>
5436 <para>Rechnungsnummer</para>
5441 <term><varname>dn_linetotal</varname></term>
5444 <para>Noch zu zahlender Betrag (ergibt sich aus
5445 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5446 + <varname>dn_interest</varname>)</para>
5451 <term><varname>dn_netamount</varname></term>
5454 <para>Rechnungssumme (netto)</para>
5459 <term><varname>dn_open_amount</varname></term>
5462 <para>Offener Rechnungsbetrag</para>
5467 <term><varname>dn_ordnumber</varname></term>
5470 <para>Bestellnummer</para>
5475 <term><varname>dn_transdate</varname></term>
5478 <para>Rechnungsdatum</para>
5483 <term><varname>dn_curr</varname></term>
5486 <para>Währung, in der die Rechnung erstellt wurde. (Die
5487 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5493 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5494 <title>Variablen in automatisch erzeugten Rechnungen über
5495 Mahngebühren</title>
5497 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5498 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5499 Kunden stehen als Variablen <varname>name</varname>,
5500 <varname>street</varname>, <varname>zipcode</varname>,
5501 <varname>city</varname>, <varname>country</varname>,
5502 <varname>department_1</varname>, <varname>department_2</varname>,
5503 und <varname>email</varname> zur Verfügung.</para>
5505 <para>Weitere Variablen beinhalten:</para>
5509 <term><varname>duedate</varname></term>
5512 <para>Fälligkeitsdatum der Rechnung</para>
5517 <term><varname>dunning_id</varname></term>
5520 <para>Mahnungsnummer</para>
5525 <term><varname>fee</varname></term>
5528 <para>Mahngebühren</para>
5533 <term><varname>interest</varname></term>
5541 <term><varname>invamount</varname></term>
5544 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
5545 <varname>interest</varname>)</para>
5550 <term><varname>invdate</varname></term>
5553 <para>Rechnungsdatum</para>
5558 <term><varname>invnumber</varname></term>
5561 <para>Rechnungsnummer</para>
5568 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
5569 <title>Variablen in anderen Vorlagen</title>
5572 <title>Einführung</title>
5574 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
5575 Rechnung. Allerdings heißen die Variablen, die mit
5576 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
5577 fangen sie mit <varname>quo</varname> für "quotation" an:
5578 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
5579 wiederum fangen sie mit <varname>ord</varname> für "order" an:
5580 <varname>ordnumber</varname> für Bestellnummer etc.</para>
5582 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
5583 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
5584 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
5585 Vorlage keine Bedeutung haben oder noch nicht belegt sein
5588 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
5589 in Rechnungen aufgeführt.</para>
5592 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
5593 <title>Angebote und Preisanfragen</title>
5597 <term><varname>quonumber</varname></term>
5600 <para>Angebots- bzw. Anfragenummer</para>
5605 <term><varname>reqdate</varname></term>
5608 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
5609 Preisanfragen)</para>
5614 <term><varname>transdate</varname></term>
5617 <para>Angebots- bzw. Anfragedatum</para>
5623 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
5624 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
5628 <term><varname>ordnumber</varname></term>
5631 <para>Auftragsnummer</para>
5636 <term><varname>reqdate</varname></term>
5639 <para>Lieferdatum</para>
5644 <term><varname>transdate</varname></term>
5647 <para>Auftragsdatum</para>
5653 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
5654 <title>Lieferscheine (Verkauf und Einkauf)</title>
5658 <term><varname>cusordnumber</varname></term>
5661 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
5662 des Lieferanten (im Einkauf)</para>
5667 <term><varname>donumber</varname></term>
5670 <para>Lieferscheinnummer</para>
5675 <term><varname>transdate</varname></term>
5678 <para>Lieferscheindatum</para>
5683 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
5684 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
5685 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
5686 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
5687 <function>foreach</function>-Schleife ausgegeben werden. Diese
5688 Variablen sind:</para>
5692 <term><varname>si_bin</varname></term>
5695 <para>Lagerplatz</para>
5700 <term><varname>si_chargenumber</varname></term>
5703 <para>Chargennummer</para>
5708 <term><varname>si_bestbefore</varname></term>
5711 <para>Mindesthaltbarkeit</para>
5716 <term><varname>si_number</varname></term>
5719 <para>Artikelnummer</para>
5724 <term><varname>si_qty</varname></term>
5727 <para>Anzahl bzw. Menge</para>
5732 <term><varname>si_runningnumber</varname></term>
5735 <para>Positionsnummer (1, 2, 3 etc)</para>
5740 <term><varname>si_unit</varname></term>
5743 <para>Einheit</para>
5748 <term><varname>si_warehouse</varname></term>
5757 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
5758 <title>Variablen für Sammelrechnung</title>
5762 <term><varname>c0total</varname></term>
5765 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
5771 <term><varname>c30total</varname></term>
5774 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
5775 und < 60 Tage</para>
5780 <term><varname>c60total</varname></term>
5783 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
5784 und < 90 Tage</para>
5789 <term><varname>c90total</varname></term>
5792 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
5798 <term><varname>total</varname></term>
5801 <para>Gesamtbetrag aller Rechnungen</para>
5806 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
5810 <term><varname>invnumber</varname></term>
5813 <para>Rechnungsnummer</para>
5818 <term><varname>invdate</varname></term>
5821 <para>Rechnungsdatum</para>
5826 <term><varname>duedate</varname></term>
5829 <para>Fälligkeitsdatum</para>
5834 <term><varname>amount</varname></term>
5837 <para>Summe der Rechnung</para>
5842 <term><varname>open</varname></term>
5845 <para>Noch offener Betrag der Rechnung</para>
5850 <term><varname>c0</varname></term>
5853 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
5859 <term><varname>c30</varname></term>
5862 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
5868 <term><varname>c60</varname></term>
5871 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
5877 <term><varname>c90</varname></term>
5880 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
5888 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
5889 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
5891 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
5892 <title>Einführung</title>
5894 <para>Der Parser kennt neben den Variablen einige weitere
5895 Konstrukte, die gesondert behandelt werden. Diese sind wie
5896 Variablennamen in spezieller Weise markiert:
5897 <command><%anweisung%> ... <%end%></command></para>
5899 <para>Anmerkung zum <command><%end%></command>: Der besseren
5900 Verständlichkeit halber kann man nach dem <command>end</command>
5901 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
5902 Anweisung (z.B. <command>if</command> oder
5903 <command>foreach</command>) damit abgeschlossen wird.</para>
5905 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
5906 <command><%if type == "sales_quotation"%></command>, so könnte
5907 er mit <command><%end%></command> genauso abgeschlossen werden
5908 wie mit <command><%end if%></command> oder auch
5909 <command><%end type == "sales_quotation"%></command>.</para>
5912 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
5913 <title>Der if-Block</title>
5915 <programlisting><%if variablenname%>
5917 <%end%></programlisting>
5919 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
5920 und dem "end" werden nur ausgegeben, wenn die Variable
5921 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
5923 <para>Handelt es sich bei der benannten Variable um ein Array, also
5924 um einen Variablennamen, über den man mit <command><%foreach
5925 variablenname%></command> iteriert, so wird mit diesem Konstrukt
5926 darauf getestet, ob das Array Elemente enthält. Somit würde im
5927 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
5928 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
5929 welche getätigt wurden:</para>
5931 <programlisting><%if payment%>
5933 <%foreach payment%>
5934 Am <%paymentdate%>: <%payment%> €
5935 <%end foreach%>
5936 <%end if%></programlisting>
5938 <para>Die Bedingung kann auch negiert werden, indem das Wort
5939 <function>not</function> nach dem <filename>if</filename> verwendet
5940 wird. Beispiel:</para>
5942 <programlisting><%if not cp_greeting%>
5944 <%end%></programlisting>
5946 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
5947 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
5948 einer Variablen mit einer festen Zeichenkette oder einer anderen
5949 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
5950 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
5951 die rechte Seite des Vergleichsoperators in Anführungszeichen
5952 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
5953 anderer Variablen). Zwei Beispiele, die beide Vergleiche
5956 <programlisting><%if var1 == "Wert"%></programlisting>
5958 <para>Testet die Variable <varname>var1</varname> auf
5959 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
5960 Mittels <function>!=</function> anstelle von <function>==</function>
5961 würde auf Ungleichheit getestet.</para>
5963 <programlisting><%if var1 == var2%></programlisting>
5965 <para>Testet die Variable <varname>var1</varname> auf
5966 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
5967 <function>!=</function> anstelle von <function>==</function> würde
5968 auf Ungleichheit getestet.</para>
5970 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
5971 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
5972 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
5973 dieselbe Syntax wie oben nur mit <function>=~</function> und
5974 <function>!~</function> als Vergleichsoperatoren.</para>
5976 <para>Beispiel für einen Test, ob die Variable
5977 <varname>intnotes</varname> (interne Bemerkungen) das Wort
5978 <constant>schwierig</constant> enthält:</para>
5980 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
5983 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
5984 <title>Der foreach-Block</title>
5986 <programlisting><%foreach variablenname%>
5988 <%end%></programlisting>
5990 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
5991 wie das Perl-Array der Variablen <varname>variablenname</varname>
5992 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
5993 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
5994 benutzt. In jedem Durchlauf werden die <link
5995 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
5996 Variablen</link> jeweils auf den Wert für die aktuelle Position
5999 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
6001 <programlisting><%foreach number%>
6002 Position: <%runningnumber%>
6003 Anzahl: <%qty%>
6004 Artikelnummer: <%number%>
6005 Beschreibung: <%description%>
6007 <%end%></programlisting>
6009 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
6010 <function><%foreach%></function>-Block innerhalb einer
6011 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
6012 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
6013 Inhalt zwischen <function><%foreach%></function> und
6014 <function><%end%></function> wiederholt, nicht aber die
6015 komplette Zeile, in der er steht.</para>
6019 <sect2 id="dokumentenvorlagen-und-variablen.markup">
6020 <title>Markup-Code zur Textformatierung innerhalb von
6023 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6024 anders formatiert haben möchte, so ist dies begrenzt möglich.
6025 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6026 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6027 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6028 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6029 (HTML oder PDF über LaTeX) umgesetzt.</para>
6031 <para>Die unterstützen Formatierungen sind:</para>
6035 <term><b>Text</b></term>
6038 <para>Text wird in Fettdruck gesetzt.</para>
6043 <term><i>Text</i></term>
6046 <para>Text wird kursiv gesetzt.</para>
6051 <term><u>Text</u></term>
6054 <para>Text wird unterstrichen.</para>
6059 <term><s>Text</s></term>
6062 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6063 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6068 <term><bullet></term>
6071 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6077 <para>Der Befehl <command><bullet></command> funktioniert
6078 momentan auch nur in Latex-Vorlagen.</para>
6082 <sect1 id="excel-templates">
6083 <title>Excel-Vorlagen</title>
6085 <sect2 id="excel-templates.summary">
6086 <title>Zusammenfassung</title>
6088 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6089 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6093 <sect2 id="excel-templates.usage">
6094 <title>Bedienung</title>
6096 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6097 werden. Die Konfigurationsoption heißt <varname>excel_templates =
6098 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6100 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6101 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6102 werden. In den normalen Verkaufsmasken taucht nun
6103 <constant>Excel</constant> als auswählbares Format auf und kann von da
6104 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6106 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6107 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6108 <filename>sales_quotation.xls</filename> gespeichert.</para>
6111 <sect2 id="excel-templates.syntax">
6112 <title>Variablensyntax</title>
6114 <para>Einfache Syntax:
6115 <command><<varname>></command></para>
6117 <para>Dabei sind <constant><<</constant> und
6118 <constant>>></constant> die Delimiter. Da Excel auf festen
6119 Breiten besteht, kann der Tag künstlich verlängert werden, indem
6120 weitere <constant><</constant> oder <constant>></constant>
6121 eingefügt werden. Der Tag muss nicht symmetrisch sein.
6124 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6126 <para>Um die Limitierung der festen Breite zu reduzieren, können
6127 weitere Variablen in einem Block interpoliert werden. Whitespace wird
6128 dazwishen dann erhalten. Beispiel:</para>
6130 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6132 <para>Die Variablen werden interpoliert, und linksbündig mit
6133 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6134 lang, werden überzählige Zeichen abgeschnitten.</para>
6136 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6137 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6139 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6141 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6142 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6146 <sect2 id="excel-templates.limitations">
6147 <title>Einschränkungen</title>
6149 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6150 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6151 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6152 Text zu ersetzen.</para>
6154 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6155 <command><%if%></command> und
6156 <command><%foreach%></command> nicht vorhanden. Der Delimiter
6157 <constant><% %></constant> kommt in den Headerinformationen
6158 evtl. vor. Deshalb wurde auf den sichereren Delimiter
6159 <constant><<</constant> und <constant>>></constant>
6164 <sect1 id="features.warehouse">
6167 <title>Mandantenkonfiguration Lager</title>
6170 Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6171 Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. Ferner kann jede Position eines Lieferscheins
6172 ein-, bzw. ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele Lager mit beliebig vielen Lagerplätzen abgebildet
6173 werden. Die Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder Einzelposition und das Auswählen dieser Position zu
6174 einem Lager mit Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je nachdem wie die Einstellungen in der
6175 Mandatenkonfiguration gesetzt werden.
6180 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6181 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6182 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6183 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6187 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6188 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6189 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6190 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6191 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6192 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6197 Zusätzliche Funktionshinweise:
6202 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6203 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6204 Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6208 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6209 Stammdaten definiert</option> Wird beim 'Auslagern über
6210 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6211 so wird mit dieser Option einfach der Standardlagerplatz
6219 <sect1 id="features.swiss-charts-of-accounts">
6220 <title>Schweizer Kontenpläne</title>
6222 <para>Seit der Version 3.4.1 stehen in kivitendo 2 Kontenpläne für
6223 den Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6224 Organisationen, die nicht mehrwertsteuerpflichtig sind, und einer
6225 für Firmen, die mehrwertsteuerpflichtig sind.</para>
6227 <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6228 verwendeten KMU-Kontenrahmen und sind mit der Revision des Schweizerischen
6229 Obligationenrechts (OR) vom 1.1.2013 kompatibel, insbesondere
6230 <literal>Art.957a Abs.2</literal>.</para>
6232 <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der aktuellen
6233 Version von kivitendo noch nicht integriert.</para>
6235 <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6236 Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6237 Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen
6238 alle Aufwandskonten editiert werden und dort der Steuersatz auf 0%
6239 gesetzt werden.</para>
6241 <para>So werden bei Kreditorenbuchungen keine Vorsteuern verbucht.</para>
6243 <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6244 Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne
6245 bitte an <literal>empfang@revamp-it.ch</literal> senden.</para>
6248 <sect1 id="features.part_classification">
6249 <title>Artikelklassifizierung</title>
6252 <title>Übersicht</title>
6254 <para>Die Klassifizierung von Artikeln dient einer weiteren Gliederung
6255 um zum Beispiel den Einkauf vom Verkauf zu trennen, gekennzeichnet
6256 durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel (z.B. "E").
6257 Für jede Klassifizierung besteht eine Beschreibung und eine Abkürzung
6258 die normalerweise aus einem Zeichen besteht, kann aber auf mehrere
6259 Zeichen erweitert werden, falls zur Unterscheidung notwendig, sinnvoll
6260 sind jedoch nur maximal 2 Zeichen.</para>
6264 <title>Basisklassifizierung</title>
6266 <para>Als Basisklassifizierungen gibt es</para>
6270 <para>Einkauf</para>
6274 <para>Verkauf</para>
6278 <para>Handelsware</para>
6282 <para>Produktion</para>
6286 <para>- keine - (diese wird bei einer Aktualisierung für alle
6287 existierenden Artikel genommen, gültig für Verkauf und
6292 <para>Es können weitere Klassifizierungen angelegt werden. So kann es
6293 z.B. für separat auszuweisende Artikel folgened Klassen geben:</para>
6297 <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
6301 <para>Material (Verpackungsmaterial) mit Kürzel M</para>
6307 <title>Attribute</title>
6309 <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
6310 alle gleichzeitg gültig sein können</para>
6314 <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
6319 <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
6324 <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
6325 (LaTeX) zusätzliche Variable</para>
6329 <para>Beim separat ausweisen stehen im LaTeX die Variable <emphasis
6330 role="bold"><%non_separate_subtotal%> </emphasis>zur Verfügung,
6331 die alle nicht separat auszuweisenden Artikelkosten saldiert, sowie
6332 pro separat auszuweisenden Klassifizierungen die Variable<emphasis
6333 role="bold"> <%separate_X_subtotal%></emphasis> wobei X das
6334 Kürzel der Klassifizierung ist.</para>
6336 <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
6337 role="bold"><%separate_L_subtotal%></emphasis> und für
6338 Verpackungsmaterial <emphasis
6339 role="bold"><%separate_M_subtotal%> </emphasis>.</para>
6343 <title>Zwei-Zeichen Abkürzung</title>
6345 <para>Der Typ des Artikel und die Klassifizierung werden durch zwei
6346 Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
6347 Typs des Artikel ('P','A','S') , deutch 'W', 'E', und 'D' für Ware
6348 Erzeugnis oder Dienstleistung, ggf. weitere Typen.</para>
6350 <para>Der zweite (und ggf. auch ein dritter Buchstabe, falls nötig)
6351 entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
6353 <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
6354 Erleichterung mit dargestellt.</para>
6358 <sect1 id="features.file_managment">
6359 <title>Dateiverwaltung (Mini-DMS)</title>
6362 <title>Übersicht</title>
6363 <para>Parallel zum alten WebDAV gibt es eine Datei-Management-Sytem, daß Dateien
6364 verschiedenen Typs verwaltet. Dies können</para>
6367 <para>aus ERP-Daten per LaTeX Template erzeugte PDF-Dokumente,</para>
6370 <para>zu bestimmten ERP-Daten gehörende Anhangdateien unterschiedlichen Formats,</para>
6373 <para>per Scanner eingelesene PDF-Dateien,</para>
6376 <para>per Email empfangene Dateianhänge unterschiedlichen Formats,</para>
6379 <para>sowie speziel an Artikel hochgeladene Bilder sein.</para>
6383 <screeninfo>Übersicht</screeninfo>
6386 <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
6393 <title>Struktur</title>
6395 <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:
6399 <para>Dateisystem,</para>
6402 <para>WebDAV,</para>
6405 <para>Schnittstelle zu externem Dokumenten-Management-System,</para>
6408 <para>andere Datenbank,</para>
6411 <para>etc ...</para>
6414 <para>Es gibt unterschiedliche Typen von Dateien, jedem Typ läßt sich in der
6415 Mandantenkonfigurierung ein bestimmtes Backend zuordnen.
6419 <para>"document", das sind entweder generierte,eingescannte oder hochgeladene PDF-Dateien,
6420 die zu bestimmten ERP-Daten (ERP-Objekte, wi z.B. Rechnung, Lieferschein) gehören.</para>
6423 <para>"attachment", zusätzlich hochgeladene Dokumente, die an bestimmte ERP-Objekte angehängt werden,
6424 z.B. technische Zeichnungen,Aufmaße. Diese können auch an Artikeln,
6425 Lieferanten und Kunden hinterlegt sein</para>
6428 <para>"image", Bilder an Artikeln. Diese können auch verkleinert in einer Vorschau (Thumbnail)
6429 angezeigt werden.</para>
6432 <para>Zusätzlich werden in der Datenbank zu den Dateien neben der Zuordnung zu ERP-Objekten, des Dateityps
6433 des Dateinamens und des Backends in dem die Datei gespeichert ist auch die Quelle der Datei notiert:
6437 <para> "created" , vom System erzeugte Dokumente"</para>
6440 <para> "uploaded", hochgeladene Dokumente</para>
6443 <para> "email", vom Mailsystem empfangene Dateien</para>
6446 <para> "scanner[1]", von einem oder mehreren Scannern erzeugte Dateien. Existieren mehrere Scanner,
6447 so sind diese durch unterschiedliche Quellennamen zu definieren</para>
6450 <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es für "attachment" und "image" nur
6451 die Quelle "uploaded". Für "document" gibt es auf jeden Fall die Quelle "created".
6452 Die Quellen "scanner" und "email" müssen derzeit in der Datenbank konfiguriert werden (siehe <xref linkend="file_management.dbconfig"/>.</para>
6456 <title>Anwendung</title>
6457 <para>Die Daten werden bei den ERP-Objekten als extra Reiter dargestellt.
6458 Eine Verkaufsrechnung z.B. hat die
6459 Reiter "Dokumente" und "Dateianhänge.</para>
6461 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6464 <imagedata scale="50" fileref="images/DMS-Anhaenge.png"/>
6468 <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer Datei angezeigt.
6469 Wird eine Datei mit gleichem Namen hochgeladen, so wird eine neue Version der Datei erstellt.
6470 Vorher wird der Anwender durch einen Dialog ob er eine neue Version anlegen will oder
6471 ob er die Datei umbenennen will, falls es eine neue Datei sein soll.</para>
6473 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6476 <imagedata width="100" contentwidth="40" fileref="images/DMS-Anhaenge-hochladen.png"/>
6480 <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
6481 solange in Summe die maximale Größe nicht überschritten wird.
6482 (siehe <xref linkend="file_management.clientconfig"/></para>
6484 <screeninfo>Reiter "Dokumente"</screeninfo>
6487 <imagedata width="500" fileref="images/DMS-Dokumente.png"/>
6491 <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt es nur "erzeugte Dokumente".
6492 Es werden alle Versionen der generierten Datei angezeigt. Für Verkaufsrechnungen kommen keine
6493 anderen Quellen zur Geltung. Werden entsprechend
6494 <xref linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert, so sind diese z.B. bei
6495 Einkaufsrechnungen sichtbar:</para>
6497 <screeninfo>Reiter "Dokumente"</screeninfo>
6500 <imagedata contentwidth="600" fileref="images/DMS-Dokumente-Scanner.png"/>
6504 <para>Statt des Löschens wird hier die Datei zurück zur Quelle verschoben. Somit kann die Datei anschließend
6505 an ein anderes ERP-Objekt angehängt werden.</para>
6506 <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie sind bisher nur bei Bildern relevant.</para>
6510 <title>Konfigurierung</title>
6511 <sect3 id="file_management.clientconfig" xreflabel="Mandantenkonfigurierung">
6512 <title>Mandantenkonfigurierung</title>
6514 <title>Reiter "Features"</title>
6515 <para>Unter dem Reiter <emphasis role="bold">Features</emphasis> im Abschnit Dateimanagement ist
6516 neben dem "alten" WebDAV das Dateimangement general zu- und abschaltbar, sowie die Zuordnung der
6517 Dateitypen zu Backends. Die Löschbarkeit von Dateien sowie die maximale Uploadgröße sind Backend-unabhängig</para>
6519 <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
6522 <imagedata width="500" fileref="images/DMS-ClientConfig.png"/>
6526 <para>Die einzelnen Backends sind einzeln einschaltbar. Spezifische Backend-Konfigurierungen sind hier
6527 noch ergänzbar. Für das Backend Dateisystem ist das Wurzelverzeichnis für den Mandanten einzugeben.</para>
6530 <title>Reiter "Allgemeine Dokumentenanhänge"</title>
6531 <para>Unter dem Reiter <emphasis role="bold">Allgemeine Dokumentenanhänge</emphasis>
6532 kann für alle ERP-Dokumente ( Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und Einkauf )
6533 allgemeingültige Anhänge hochgeladen werden.</para>
6535 <screeninfo>Mandantenkonfig Reiter "Allgemeine Dokumentenanhänge"</screeninfo>
6538 <imagedata width="500" fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"/>
6542 <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die ERP-Dokumente angehängt,
6543 z.B. AGBs oder aktuelle Angebote. Es werden in dem Fall die Daten kopiert, sodaß an den ERP-Dokumenten immer
6544 die Anhänge zum Generierungszeitpunkt eingebettet sind.
6548 <sect3 id="file_management.dbconfig" xreflabel="Datenbank-Konfigurierung">
6549 <title>Datenbank-Konfigurierung</title>
6550 <para>Die zusätzlichen Quellen für email oder ein oder mehrere Scanner sind derzeit vom Administrator
6551 direkt in der Datenbanktablle "user_preferences" einzurichten. Die "value" ist im JSON-Format
6552 mit den jeweiligen Werten des Verzeichnisses und der Beschreibung der Quelle.</para>
6554 id | login | namespace | version | key | value
6555 ----+-----------+--------------+---------+----------+---------------------------
6556 1 | #default# | file_sources | 0.00000 | scanner1 |
6557 {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
6558 2 | #default# | file_sources | 0.00000 | scanner2 |
6559 {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
6560 3 | #default# | file_sources | 0.00000 | emails |
6561 {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
6563 <para>Es ist daran gedacht, statt dem default Eintrag später für bestimmte Benutzer ('login') bestimmte Quellen zuzulassen,
6564 dies wird nach Bedarf implementiert.</para>
6571 <title>Entwicklerdokumentation</title>
6573 <sect1 id="devel.globals" xreflabel="Globale Variablen">
6574 <title>Globale Variablen</title>
6577 <title>Wie sehen globale Variablen in Perl aus?</title>
6579 <para>Globale Variablen liegen in einem speziellen namespace namens
6580 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
6581 globs global und die meisten speziellen Variablen sind...
6584 <para>Daraus ergeben sich folgende Formen:</para>
6588 <term><literal>$main::form</literal></term>
6591 <para>expliziter Namespace "main"</para>
6596 <term><literal>$::form</literal></term>
6599 <para>impliziter Namespace "main"</para>
6604 <term><literal>open FILE, "file.txt"</literal></term>
6607 <para><varname>FILE</varname> ist global</para>
6612 <term><literal>$_</literal></term>
6615 <para>speziell</para>
6620 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
6621 Schlüsselwort wie "<function>global</function>", mit dem man
6622 importieren kann. <function>my</function>, <function>our</function>
6623 und <function>local</function> machen was anderes.</para>
6627 <term><literal>my $form</literal></term>
6630 <para>lexikalische Variable, gültig bis zum Ende des
6636 <term><literal>our $form</literal></term>
6639 <para><varname>$form</varname> referenziert ab hier
6640 <varname>$PACKAGE::form</varname>.</para>
6645 <term><literal>local $form</literal></term>
6648 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
6649 des scopes zurückgesetzt</para>
6656 <title>Warum sind globale Variablen ein Problem?</title>
6658 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
6660 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
6661 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
6662 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
6663 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
6664 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
6665 Datenbankverbindungen, weil die sehr lange zum Initialisieren
6668 <para>Das zweite Problem ist <function>strict</function>. Unter
6669 <function>strict</function> werden alle Variablen die nicht explizit
6670 mit <function>Package</function>, <function>my</function> oder
6671 <function>our</function> angegeben werden als Tippfehler angemarkert,
6672 dies hat, seit der Einführung, u.a. schon so manche langwierige
6673 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
6674 angegeben werden, werden die nicht geprüft, und somit kann sich
6675 schnell ein Tippfehler einschleichen.</para>
6679 <title>Kanonische globale Variablen</title>
6681 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
6682 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
6683 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
6684 umhergereicht werden.</para>
6686 <para>Diese Variablen sind im Moment die folgenden neun:</para>
6690 <para><varname>$::form</varname></para>
6694 <para><varname>%::myconfig</varname></para>
6698 <para><varname>$::locale</varname></para>
6702 <para><varname>$::lxdebug</varname></para>
6706 <para><varname>$::auth</varname></para>
6710 <para><varname>$::lx_office_conf</varname></para>
6714 <para><varname>$::instance_conf</varname></para>
6718 <para><varname>$::dispatcher</varname></para>
6722 <para><varname>$::request</varname></para>
6726 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
6727 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
6728 Eigenschaften (Konventionen):</para>
6731 <title>$::form</title>
6735 <para>Ist ein Objekt der Klasse
6736 "<classname>Form</classname>"</para>
6740 <para>Wird nach jedem Request gelöscht</para>
6744 <para>Muss auch in Tests und Konsolenscripts vorhanden
6749 <para>Enthält am Anfang eines Requests die Requestparameter vom
6754 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
6755 cachen, das wird aber momentan absichtlich zerstört</para>
6759 <para><varname>$::form</varname> wurde unter <productname>SQL
6760 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
6761 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
6762 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
6763 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
6764 <function>IS->retrieve_customer()</function> in Sicherheit
6767 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
6768 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
6769 3552, Stand version 2.7beta), um dies hinterher wieder auf den
6770 richtigen Wert zu setzen:</para>
6772 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
6773 $::myconfig{numberformat} = $numberformat;
6774 # (...) div Berechnungen
6775 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
6777 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
6778 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
6779 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
6780 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
6781 Es geht ziemlich sicher etwas kaputt.</para>
6783 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
6784 in den <productname>Template::Toolkit</productname> Templates
6785 außerhalb der Controller: der Ausdruck <function>[% var
6786 %]</function> greift auf <varname>$::form->{var}</varname> zu.
6787 Unter Controllern ist der Standard Scope anders, da lautet der
6788 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
6789 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
6790 <function><%var%></function> zeigt auf
6791 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
6792 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
6795 <programlisting>[%- IF business %]
6796 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
6797 [%- END %]</programlisting>
6799 <para>Entweder wird hier dann $::form->{business} ausgewertet
6800 oder aber der Funktion
6801 <function>$form->parse_html_template</function> wird explizit
6802 noch ein zusätzlicher Hash übergeben, der dann auch in den
6803 (Web-)Templates zu Verfügung steht, bspw. so:</para>
6805 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
6807 <para>Innerhalb von Schleifen wird
6808 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
6809 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
6810 welches über alle Positionen eines Lieferscheins in Schleife
6813 <programlisting>for $i (1 .. $form->{rowcount}) {
6815 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
6816 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
6817 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
6823 <title>%::myconfig</title>
6827 <para>Das einzige Hash unter den globalen Variablen</para>
6831 <para>Wird spätestens benötigt wenn auf die Datenbank
6832 zugegriffen wird</para>
6836 <para>Wird bei jedem Request neu erstellt.</para>
6840 <para>Enthält die Userdaten des aktuellen Logins</para>
6844 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
6845 extern serialisiert werden, weil da auch der Datenbankzugriff
6846 für diesen user drinsteht.</para>
6850 <para>Enthält unter anderem Datumsformat dateformat und Nummernformat numberformat</para>
6854 <para>Enthält Datenbankzugriffinformationen</para>
6858 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
6859 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
6860 aktuellen Users entscheiden müssen, befragen
6861 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
6862 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
6863 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
6864 Informationen über den Benutzer die über die
6865 Administrator-Schnittstelle eingegeben wurden.</para>
6869 <title>$::locale</title>
6873 <para>Objekt der Klasse "Locale"</para>
6877 <para>Wird pro Request erstellt</para>
6881 <para>Muss auch für Tests und Scripte immer verfügbar
6886 <para>Cached intern über Requestgrenzen hinweg benutzte
6891 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
6892 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
6896 <title>$::lxdebug</title>
6900 <para>Objekt der Klasse "LXDebug"</para>
6904 <para>Wird global gecached</para>
6908 <para>Muss immer verfügbar sein, in nahezu allen
6913 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
6914 bereit, wie "<function>enter_sub</function>" und
6915 "<function>leave_sub</function>", mit denen in den alten Modulen ein
6916 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
6917 der man die Wallclockzeit seit Requeststart loggen kann, sowie
6918 "<function>message</function>" und "<function>dump</function>" mit
6919 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
6922 <para>Beispielsweise so:</para>
6924 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
6925 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
6929 <title>$::auth</title>
6933 <para>Objekt der Klasse "SL::Auth"</para>
6937 <para>Wird global gecached</para>
6941 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
6945 <para>Wird nach jedem Request resettet.</para>
6949 <para><varname>$::auth</varname> stellt Funktionen bereit um die
6950 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
6951 vom aktuellen User abhängen wird das Objekt aus
6952 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
6953 Request kurz resettet.</para>
6955 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
6956 Dessen Einstellungen können über
6957 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
6958 ist ein Hash mit den Werten aus der Tabelle
6959 <literal>auth.clients</literal>.</para>
6963 <title>$::lx_office_conf</title>
6967 <para>Objekt der Klasse
6968 "<classname>SL::LxOfficeConf</classname>"</para>
6972 <para>Global gecached</para>
6976 <para>Repräsentation der
6977 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
6981 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
6982 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
6983 das Programm die Konfiguration ändern kann oder sollte.</para>
6985 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
6986 Debug- und Trace-Log-Datei wie folgt konfiguriert und
6989 <programlisting>[debug]
6990 file_name = /tmp/kivitendo-debug.log</programlisting>
6992 <para>ist der Key <varname>file</varname> im Programm als
6993 <varname>$::lx_office_conf->{debug}{file}</varname>
6997 <para>Zugriff auf die Konfiguration erfolgt im Moment über
6998 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
7003 <title>$::instance_conf</title>
7007 <para>Objekt der Klasse
7008 "<classname>SL::InstanceConfiguration</classname>"</para>
7012 <para>wird pro Request neu erstellt</para>
7016 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
7017 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
7018 ist hier eine Mandantendatenbank. Beispielsweise überprüft
7019 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
7020 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
7024 <title>$::dispatcher</title>
7028 <para>Objekt der Klasse
7029 "<varname>SL::Dispatcher</varname>"</para>
7033 <para>wird pro Serverprozess erstellt.</para>
7037 <para>enthält Informationen über die technische Verbindung zum
7042 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
7043 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
7044 Objekt untergebracht.</para>
7048 <title>$::request</title>
7052 <para>Hashref (evtl später Objekt)</para>
7056 <para>Wird pro Request neu initialisiert.</para>
7060 <para>Keine Unterstruktur garantiert.</para>
7064 <para><varname>$::request</varname> ist ein generischer Platz um
7065 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
7066 at a distance benutzt werden, sondern um lokales memoizing zu
7067 ermöglichen, das garantiert am Ende des Requests zerstört
7070 <para>Vieles von dem, was im moment in <varname>$::form</varname>
7071 liegt, sollte eigentlich hier liegen. Die groben
7072 Differentialkriterien sind:</para>
7076 <para>Kommt es vom User, und soll unverändert wieder an den
7077 User? Dann <varname>$::form</varname>, steht da eh schon</para>
7081 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
7082 Requests gebraucht werden? Dann
7083 <varname>$::request</varname></para>
7087 <para>Muss ich von anderen Teilen des Programms lesend drauf
7088 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
7089 Wrappermethode</para>
7096 <title>Ehemalige globale Variablen</title>
7098 <para>Die folgenden Variablen waren einmal im Programm, und wurden
7102 <title>$::cgi</title>
7106 <para>war nötig, weil cookie Methoden nicht als
7107 Klassenfunktionen funktionieren</para>
7111 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
7112 Klassennamespace gehalten wird und über Requestgrenzen
7117 <para>liegt jetzt unter
7118 <varname>$::request->{cgi}</varname></para>
7124 <title>$::all_units</title>
7128 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
7129 ein paar hundert mal pro Request eine Liste der Einheiten
7130 brauchen, und de als Parameter durch einen Riesenstack von
7131 Funktionen geschleift werden müssten.</para>
7135 <para>Liegt jetzt unter
7136 <varname>$::request->{cache}{all_units}</varname></para>
7141 <function>AM->retrieve_all_units()</function> gesetzt oder
7148 <title>%::called_subs</title>
7152 <para>wurde benutzt um callsub deep recursions
7157 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
7158 möglichen Rekursioenen darstellt, und da nie welche
7163 <para>komplette recursion protection wurde entfernt.</para>
7170 <sect1 id="devel.fcgi">
7171 <title>Entwicklung unter FastCGI</title>
7173 <sect2 id="devel.fcgi.general">
7174 <title>Allgemeines</title>
7176 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
7177 werden, muss der Webserver neu gestartet werden.</para>
7179 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
7180 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
7181 müssen folgende Aspekte beachtet werden.</para>
7184 <sect2 id="devel.fcgi.exiting">
7185 <title>Programmende und Ausnahmen</title>
7187 <para>Betrifft die Funktionen <function>warn</function>,
7188 <function>die</function>, <function>exit</function>,
7189 <function>carp</function> und <function>confess</function>.</para>
7191 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
7192 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
7193 am Laufen zu halten. Man kann mit <function>die</function>,
7194 <function>confess</function> oder <function>carp</function> Fehler
7195 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
7196 eigene <function>$::form-</function>error()> tut im Prinzip das
7197 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
7198 <function>exit</function> hingegen werden nicht abgefangen.
7199 <function>warn</function> wird direkt nach STDERR, also in Server Log
7200 eine Nachricht schreiben (sofern in der Konfiguration nicht die
7201 Warnungen in das kivitendo Log umgeleitet wurden), und
7202 <function>exit</function> wird die Ausführung beenden.</para>
7204 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
7205 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
7206 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
7207 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
7210 <sect2 id="devel.fcgi.globals">
7211 <title>Globale Variablen</title>
7213 <para>Um zu vermeiden, dass Informationen von einem Request in einen
7214 anderen gelangen, müssen alle globalen Variablen vor einem Request
7215 sauber initialisiert werden. Das ist besonders wichtig im
7216 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
7217 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
7220 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
7221 abgetrennten Block, der alle kanonischen globalen Variablen listet und
7222 erklärt. Bitte keine anderen einführen ohne das sauber zu
7223 dokumentieren.</para>
7225 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
7226 man sicher geht, dass man die richtige erwischt.</para>
7229 <sect2 id="devel.fcgi.performance">
7230 <title>Performance und Statistiken</title>
7232 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
7233 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
7234 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
7235 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
7236 sind es je nach Menge der definierten Variablen 1-2s. Ab der
7237 Moose/Rose::DB Version sind es 5-6s.</para>
7239 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
7240 den kritischen Pfaden, unter 0,15 sonst.</para>
7244 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
7245 <title>SQL-Upgradedateien</title>
7247 <sect2 id="db-upgrade-files.introduction"
7248 xreflabel="Einführung in die Datenbank-Upgradedateien">
7249 <title>Einführung</title>
7251 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
7252 gesteuert, die sich im Verzeichnis
7253 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
7254 muss pro Datenbankupgrade eine Datei existieren, die neben den
7255 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
7256 Kontrollinformationen enthält.</para>
7258 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
7259 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
7260 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
7261 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
7262 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
7263 Versionsnummern braucht.</para>
7265 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
7266 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
7267 führt diese nicht erneut aus. Dazu dient die Tabelle
7268 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
7269 angelegt wird.</para>
7272 <sect2 id="db-upgrade-files.format"
7273 xreflabel="Format der Upgradedateien">
7274 <title>Format der Kontrollinformationen</title>
7276 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
7277 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
7278 hat dabei das folgende Format:</para>
7280 <para>Für SQL-Upgradedateien:</para>
7282 <programlisting>-- @key: value</programlisting>
7284 <para>Für Perl-Upgradedateien:</para>
7286 <programlisting># @key: value</programlisting>
7288 <para>Leerzeichen vor "<varname>value</varname>" werden
7291 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
7295 <term><varname>tag</varname></term>
7298 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
7299 Dieser "tag" kann von anderen Kontrolldateien in ihren
7300 Abhängigkeiten verwendet werden (Schlüsselwort
7301 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
7302 in der Datenbank eingetragen wird.</para>
7304 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
7305 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
7307 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
7308 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
7309 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
7315 <term><varname>charset</varname></term>
7318 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
7319 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
7320 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
7321 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
7322 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
7323 hingegen müssen immer in UTF-8 encodiert sein und sollten
7324 demnach auch ein "<literal>use utf8;</literal>"
7330 <term><varname>description</varname></term>
7333 <para>Benötigt. Eine Beschreibung, was in diesem Update
7334 passiert. Diese wird dem Benutzer beim eigentlichen
7335 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
7336 sein sollte, sollte die Beschreibung auf Deutsch
7342 <term><varname>depends</varname></term>
7345 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
7346 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
7347 dass die in dieser Liste aufgeführten Scripte bereits
7348 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
7350 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
7351 Script "b" existiert, das von Änderungen in "a" abhängt, und
7352 eine neue Kontrolldatei für "c" erstellt wird, die von
7353 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
7354 Tag "b" als Abhängigkeit zu definieren.</para>
7356 <para>Es ist nicht erlaubt, sich selbst referenzierende
7357 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
7358 und "c" -> "a").</para>
7363 <term><varname>priority</varname></term>
7366 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
7367 der Scripte ausgeführt werden, die die gleichen
7368 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
7369 der Wert 1000 benutzt.</para>
7371 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
7372 "depends" benutzt werden. kivitendo sortiert die auszuführenden
7373 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
7374 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
7375 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
7376 dann "y", dann "z"), dann nach der Priorität und bei gleicher
7377 Priorität alphabetisch nach dem "tag".</para>
7382 <term><varname>ignore</varname></term>
7385 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
7386 Skript bei der Anmeldung ignoriert und entsprechend nicht
7393 <sect2 id="db-upgrade-files.format-perl-files"
7394 xreflabel="Format von Perl-Upgradedateien">
7395 <title>Format von in Perl geschriebenen
7396 Datenbankupgradescripten</title>
7398 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
7399 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
7400 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
7402 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
7403 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
7404 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
7405 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
7406 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
7407 aufgerufen wird.</para>
7409 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
7410 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
7411 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
7412 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
7413 "<literal>SL::DBUpgrade2::tag</literal>".</para>
7415 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
7416 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
7417 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
7419 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
7422 <programlisting># @tag: beispiel-upgrade-file42
7423 # @description: Ein schönes Beispielscript
7424 # @depends: release_3_1_0
7425 package SL::DBUpgrade2::beispiel_upgrade_file42;
7430 use parent qw(SL::DBUpgrade2::Base);
7435 # hier Aktionen ausführen
7444 <sect2 id="db-upgrade-files.dbupgrade-tool"
7445 xreflabel="Hilfsscript dbupgrade2_tool.pl">
7446 <title>Hilfsscript dbupgrade2_tool.pl</title>
7448 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
7449 existiert ein Hilfsscript namens
7450 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
7451 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
7452 liest alle Datenbankupgradescripte aus dem Verzeichnis
7453 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
7454 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
7455 von der Kommandozeile überprüft werden können.</para>
7457 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
7458 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
7459 sich aber auch Informationen auf verschiedene Art ausgeben
7464 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
7465 --list</command>"</para>
7467 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
7468 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
7469 würde. Es werden neben der Listenposition der Tag, die
7470 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
7474 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
7475 --tree</command>"</para>
7477 <para>Listet alle Tags in Baumform basierend auf den
7478 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
7479 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
7480 beim übergeordneten Script als Abhängigkeit eingetragen
7484 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
7485 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
7486 --rtree</command>"</para>
7488 <para>Listet alle Tags in Baumform basierend auf den
7489 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
7490 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
7491 die das übergeordnete Script als Abhängigkeit eingetragen
7496 <para>Baumform mit Postscriptausgabe:
7497 "<command>./scripts/dbupgrade2_tool.pl
7498 --graphviz</command>"</para>
7500 <para>Benötigt das Tool "<command>graphviz</command>", um mit
7501 seiner Hilfe die <link
7502 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
7503 Baumform</link> in eine Postscriptdatei namens
7504 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
7505 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
7506 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
7507 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
7512 <para>Scripte, von denen kein anderes Script abhängt:
7513 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
7515 <para>Listet die Tags aller Scripte auf, von denen keine anderen
7516 Scripte abhängen.</para>
7522 <sect1 id="translations-languages" xreflabel="Translations and languages">
7523 <title>Translations and languages</title>
7525 <sect2 id="translations-languages.introduction"
7526 xreflabel="Introduction to translations and languages">
7527 <title>Introduction</title>
7530 <para>Dieser Abschnitt ist in Englisch geschrieben, um
7531 internationalen Übersetzern die Arbeit zu erleichtern.</para>
7534 <para>This section describes how localization packages in kivitendo
7535 are built. Currently the only language fully supported is German, and
7536 since most of the internal messages are held in English the English
7537 version is usable too.</para>
7540 <sect2 id="translations-languages.character-set"
7541 xreflabel="Character set">
7542 <title>Character set</title>
7544 <para>All files included in a language pack must use UTF-8 as their
7548 <sect2 id="translations-languages.file-structure"
7549 xreflabel="File structure">
7550 <title>File structure</title>
7552 <para>The structure of locales in kivitendo is:</para>
7554 <programlisting>kivitendo/locale/<langcode>/</programlisting>
7556 <para>where <langcode> stands for an abbreviation of the
7557 language package. The builtin packages use two letter <ulink
7558 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
7559 but the actual name is not relevant for the program and can easily be
7561 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
7562 tags</ulink> (i.e. "en_GB"). In fact the original language packages
7563 from SQL Ledger are named in this way.</para>
7565 <para>In such a language directory the following files are
7570 <term>LANGUAGE</term>
7573 <para>This file is mandatory.</para>
7575 <para>The <filename>LANGUAGE</filename> file contains the self
7576 descripted name of the language. It should contain a native
7577 representation first, and in parenthesis an english translation
7578 after that. Example:</para>
7580 <programlisting>Deutsch (German)</programlisting>
7588 <para>This file is mandatory.</para>
7590 <para>The central translation file. It is essentially an inline
7591 Perl script autogenerated by <command>locales.pl</command>. To
7592 generate it, generate the directory and the two files mentioned
7593 above, and execute the following command:</para>
7595 <programlisting>scripts/locales.pl <langcode></programlisting>
7597 <para>Otherwise you can simply copy one of the other languages.
7598 You will be told how many are missing like this:</para>
7600 <programlisting>$ scripts/locales.pl en
7601 English - 0.6% - 2015/2028 missing</programlisting>
7603 <para>A file named "<filename>missing</filename>" will be
7604 generated and can be edited. You can also edit the
7605 "<filename>all</filename>" file directly. Edit everything you
7606 like to fit the target language and execute
7607 <command>locales.pl</command> again. See how the missing words
7613 <term>Num2text</term>
7616 <para>Legacy code from SQL Ledger. It provides a means for
7617 numbers to be converted into natural language, like
7618 <literal>1523 => one thousand five hundred twenty
7619 three</literal>. If you want to provide it, it must be inlinable
7620 Perl code which provides a <function>num2text</function> sub. If
7621 an <function>init</function> sub exists it will be executed
7624 <para>Only used in the check and receipt printing module.</para>
7629 <term>special_chars</term>
7632 <para>kivitendo comes with a lot of interfaces to different
7633 formats, some of which are rather picky with their accepted
7634 charset. The <filename>special_chars</filename> file contains a
7635 listing of chars not suited for different file format and
7636 provides substitutions. It is written in "Simple Ini" style,
7637 containing a block for every file format.</para>
7639 <para>First entry should be the order of substitution for
7640 entries as a whitespace separated list. All entries are
7641 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
7642 and <literal>\\</literal> all work.</para>
7644 <para>After that every entry is a special char that should be
7645 translated when writing text into such a file.</para>
7647 <para>Example:</para>
7649 <programlisting>[Template/XML]
7650 order=& < > \n
7654 \n=<br></programlisting>
7656 <para>Note the importance of the order in this example.
7657 Substituting < and > befor & would lead to $gt; become
7660 <para>For a list of valid formats, see the German
7661 <filename>special_chars</filename> entry. As of this writing the
7662 following are recognized:</para>
7664 <programlisting>HTML
7669 Template/OpenDocument
7670 filenames</programlisting>
7672 <para>The last of which is very machine dependant. Remember that
7673 a lot of characters are forbidden by some filesystems, for
7674 example MS Windows doesn't like ':' in its files where Linux
7675 doesn't mind that. If you want the files created with your
7676 language pack to be portable, find all chars that could cause
7682 <term>missing</term>
7685 <para>This file is not a part of the language package
7688 <para>This is a file generated by
7689 <command>scripts/locales.pl</command> while processing your
7690 locales. It's only to have the missing entries singled out and
7691 does not belong to a language package.</para>
7699 <para>This file is not a part of the language package
7702 <para>Another file generated by
7703 <command>scripts/locales.pl</command>. If for any reason a
7704 translation does not appear anymore and can be deleted, it gets
7705 moved here. The last 50 or so entries deleted are saved here in
7706 case you made a typo, so that you don't have to translate
7707 everything again. If a tranlsation is missing, the lost file is
7708 checked first. If you maintain a language package, you might
7709 want to keep this safe somewhere.</para>
7714 <term>more/all</term>
7717 <para>This subdir and file is not a part of the language package
7720 <para>If the directory more exists and contains a file called
7721 all it will be parsed in addition to the mandatory all (see
7722 above). The file is useful if you want to change some
7723 translations for the current installation without conflicting
7724 further upgrades. The file is not autogenerated and has the same
7725 format as the all, but needs another key (more_texts). See the
7726 german translation for an example or copy the following code:
7729 # -*- coding: utf-8; -*-
7734 # These are additional texts for custom translations.
7735 # The format is the same as for the normal file all, only
7736 # with another key (more_texts instead of texts).
7737 # The file has the form of 'english text' => 'foreign text',
7739 $self->{more_texts} = {
7741 'Ship via' => 'Terms of delivery',
7742 'Shipping Point' => 'Delivery time',
7744 </programlisting></para>
7751 <sect1 id="devel.testsuite">
7752 <title>Die kivitendo-Test-Suite</title>
7754 <sect2 id="devel.testsuite.intro">
7755 <title>Einführung</title>
7757 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
7758 basiert auf dem Standard-Perl-Modul
7759 <literal>Test::More</literal>.</para>
7761 <para>Die grundlegenden Fakten sind:</para>
7765 <para>Alle Tests liegen im Unterverzeichnis
7766 <filename>t/</filename>.</para>
7770 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
7771 enthält einen oder mehrere Testfälle.</para>
7775 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
7776 Es sind selbstständig ausführbare Perl-Scripte.</para>
7780 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
7781 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
7782 auf <literal>.t</literal> endet.</para>
7787 <sect2 id="devel.testsuite.prerequisites">
7788 <title>Voraussetzungen</title>
7790 <para>Für die Ausführung werden neben den für kivitendo eh schon
7791 benötigten Module noch weitere Perl-Module benötigt. Diese
7796 <para><literal>Test::Deep</literal> (Debian-Paketname:
7797 <literal>libtest-deep-perl</literal>; Fedora:
7798 <literal>perl-Test-Deep</literal>; openSUSE:
7799 <literal>perl-Test-Deep</literal>)</para>
7803 <para><literal>Test::Exception</literal> (Debian-Paketname:
7804 <literal>libtest-exception-perl</literal>; Fedora:
7805 <literal>perl-Test-Exception</literal>; openSUSE:
7806 <literal>perl-Test-Exception</literal>)</para>
7810 <para><literal>Test::Output</literal> (Debian-Paketname:
7811 <literal>libtest-output-perl</literal>; Fedora:
7812 <literal>perl-Test-Output</literal>; openSUSE:
7813 <literal>perl-Test-Output</literal>)</para>
7817 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
7818 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
7819 kann für frühere Versionen aus dem <ulink
7820 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
7824 <para><literal>LWP::Simple</literal> aus dem Paket
7825 <literal>libwww-perl</literal> (Debian-Panetname:
7826 <literal>libwww-perl</literal>; Fedora:
7827 <literal>perl-libwww-perl</literal>; openSUSE:
7828 <literal>perl-libwww-perl</literal>)</para>
7832 <para><literal>URI::Find</literal> (Debian-Panetname:
7833 <literal>liburi-find-perl</literal>; Fedora:
7834 <literal>perl-URI-Find</literal>; openSUSE:
7835 <literal>perl-URI-Find</literal>)</para>
7839 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
7840 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
7841 müssen in der Konfigurationsdatei im Abschnit
7842 <literal>testing/database</literal> Datenbankverbindungsparameter
7843 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
7844 Recht haben, Datenbanken anzulegen und zu löschen.</para>
7847 <sect2 id="devel.testsuite.execution">
7848 <title>Existierende Tests ausführen</title>
7850 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
7851 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
7852 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
7853 <filename>t/test.pl</filename>.</para>
7855 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
7856 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
7857 kivitendo-Basisverzeichnis heraus ausführen.</para>
7859 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
7860 an <filename>t/test.pl</filename>. Beispielsweise:</para>
7862 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
7865 <sect2 id="devel.testsuite.meaning_of_scripts">
7866 <title>Bedeutung der verschiedenen Test-Scripte</title>
7868 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
7869 Programmierstil. Einige besonders zu erwähnende, weil auch während der
7870 Entwicklung nützliche Tests sind:</para>
7874 <para><filename>t/001compile.t</filename> -- compiliert alle
7875 Quelldateien und bricht bei Fehlern sofort ab</para>
7879 <para><filename>t/002goodperl.t</filename> -- überprüft alle
7880 Perl-Dateien auf Anwesenheit von '<literal>use
7881 strict</literal>'-Anweisungen</para>
7885 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
7886 <function>system()</function> und <function>exec()</function> auf
7891 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
7892 Tab-Zeichen enthalten</para>
7896 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
7897 Rechtschreibfehlern</para>
7901 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
7902 Dokumentation im POD-Format auf Gültigkeit</para>
7906 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
7907 einzelner Funktionen und Module.</para>
7910 <sect2 id="devel.testsuite.create_new">
7911 <title>Neue Test-Scripte erstellen</title>
7913 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
7914 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
7915 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
7918 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
7919 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
7922 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
7927 <para>Überprüfung auf fehlende symbolische Links</para>
7931 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
7932 gewissen Einschränkungen wie das Erlauben von deutschen
7937 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
7941 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
7945 <para>Test, ob alle zu übersetzenden Strings in
7946 <filename>locale/de/all</filename> vorhanden sind</para>
7950 <para>Test, ob alle Webseiten-Templates in
7951 <filename>templates/webpages</filename> mit vom Perl-Modul
7952 <literal>Template</literal> compiliert werden können</para>
7957 <sect3 id="devel.testsuite.directory_and_test_names">
7958 <title>Konvention für Verzeichnis- und Dateinamen</title>
7960 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
7961 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
7962 und ihnen soweit es geht folgen:</para>
7966 <para>Die Dateiendung muss <filename>.t</filename>
7971 <para>Namen sind englisch, komplett klein geschrieben und
7972 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
7973 <filename>bad_function_params.t</filename>).</para>
7977 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
7978 benannt sein, mit dem sich die Scripte darin befassen
7979 (beispielsweise <filename>background_jobs</filename> für Tests
7980 rund um Hintergrund-Jobs).</para>
7984 <para>Test-Scripte sollten einen überschaubaren Bereich von
7985 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
7986 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
7987 Test-Scripte schreiben.</para>
7992 <sect3 id="devel.testsuite.minimal_example">
7993 <title>Minimales Skelett für eigene Scripte</title>
7995 <para>Der folgenden Programmcode enthält das kleinstmögliche
7996 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
7999 <programlisting>use Test::More tests => 0;
8003 use Support::TestSetup;
8005 Support::TestSetup::login();</programlisting>
8007 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
8008 benötigt (Stichwort: alle globalen Variablen wie
8009 <varname>$::auth</varname>, <varname>$::form</varname> oder
8010 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
8011 <filename>config/kivitendo.conf</filename> im Abschnitt
8012 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
8013 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
8015 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
8016 kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
8017 weggelassen werden, was die Ausführungszeit des Scripts leicht
8023 <sect1 id="devel.style-guide">
8024 <title>Stil-Richtlinien</title>
8026 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
8027 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
8028 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
8029 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
8031 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
8034 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
8035 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
8040 <para>Es werden keine echten Tabs sondern Leerzeichen
8045 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
8047 <programlisting>foreach my $row (@data) {
8049 # do something with $row
8053 $row->{modules} = MODULE->retrieve(
8054 id => $row->{id},
8055 date => $use_now ? localtime() : $row->{time},
8059 $report->add($row);
8064 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
8065 Zeile wie der letzte Befehl. Beispiele:</para>
8067 <programlisting>sub debug {
8073 <programlisting>if ($form->{item_rows} > 0) {
8079 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
8080 der Befehl / die öffnende schließende Klammer, die den Block
8081 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
8082 Beispiele wie bei 3. gelten.</para>
8086 <para>Die Wörter "<function>else</function>",
8087 "<function>elsif</function>", "<function>while</function>" befinden
8088 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
8091 <programlisting>if ($form->{sum} > 1000) {
8093 } elsif ($form->{sum} > 0) {
8101 } until ($a > 0);</programlisting>
8105 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
8106 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
8107 und grep-ähnliche Operatoren. Beispiel:</para>
8109 <programlisting>$main::lxdebug->message("Could not find file.");
8110 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
8114 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
8116 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
8117 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
8118 Blöcke schon. Beispiel:</para>
8120 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
8125 $form->{sum} += $form->{"row_$i"};
8126 $form->{ $form->{index} } += 1;
8128 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
8132 <para>Mehrzeilige Befehle</para>
8136 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
8137 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
8138 werden, in der die ersten Funktionsparameter in der ersten Zeile
8139 stehen. Beispiel:</para>
8141 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
8142 $form->{some_col_value});</programlisting>
8146 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
8147 besten in einer übersichtlichen Tabellenstruktur organisiert
8148 wird. Beispiel:</para>
8150 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
8151 : $form->{oldcount} ? $form->{oldcount} + 1
8152 : $form->{rowcount} - $form->{rowbase};</programlisting>
8158 <para>Kommentare</para>
8162 <para>Kommentare, die alleine in einer Zeile stehen, sollten
8163 soweit wie der Code eingerückt sein.</para>
8167 <para>Seitliche hängende Kommentare sollten einheitlich
8168 formatiert werden.</para>
8172 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
8173 auf Englisch zu verfassen. So wie ich keine Lust habe,
8174 französischen Quelltext zu lesen, sollte auch der kivitendo
8175 Quelltext für nicht-Deutschsprachige lesbar sein.
8178 <programlisting>my $found = 0;
8186 $i = 0 # initialize $i
8188 $i *= $const; # do something crazy
8189 $i = $n; # recover $i</programlisting>
8195 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
8196 Interpolation gewünscht ist. Beispiel:</para>
8198 <programlisting>$form->{sum} = 0;
8199 $form->{"row_$i"} = $form->{"row_$i"} - 5;
8200 $some_hash{42} = 54;</programlisting>
8204 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
8205 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
8206 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
8207 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
8209 <para>Als Beispiel sei die Funktion
8210 <function>print_options</function> aus
8211 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
8215 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
8216 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
8219 <para>Emacs und vim haben beide recht einfache Methoden zur
8220 Entfernung von trailing whitespace. Emacs kennt das Kommande
8221 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
8222 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
8223 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
8228 <para>Es wird kein <command>perltidy</command> verwendet.</para>
8230 <para>In der Vergangenheit wurde versucht,
8231 <command>perltidy</command> zu verwenden, um einen einheitlichen
8232 Stil zu erlangen. Es hat sich aber gezeigt, dass
8233 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
8234 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
8235 den Interessierten sind hier die
8236 <command>perltidy</command>-Optionen, die grob den beschriebenen
8237 Richtlinien entsprechen:</para>
8239 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
8240 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
8241 -lp -vt=1 -vtc=1</programlisting>
8245 <para><varname>STDERR</varname> ist tabu. Unkonditionale
8246 Debugmeldungen auch.</para>
8248 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
8249 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
8250 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
8252 <para>Die <classname>LXDebug</classname>-Methode
8253 "<function>message</function>" nimmt als ersten Paramter außerdem
8254 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
8255 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
8256 und werden in den meisten Fällen auch vom Repository
8257 zurückgewiesen.</para>
8261 <para>Alle neuen Module müssen use strict verwenden.</para>
8263 <para><varname>$form</varname>, <varname>$auth</varname>,
8264 <varname>$locale</varname>, <varname>$lxdebug</varname> und
8265 <varname>%myconfig</varname> werden derzeit aus dem main package
8266 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
8267 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
8272 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
8273 <title>Dokumentation erstellen</title>
8275 <sect2 id="devel.build-doc.introduction">
8276 <title>Einführung</title>
8278 <para>Diese Dokumentation ist in <productname>DocBook</productname>
8279 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
8280 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
8281 Editor nutzt, der spezielle Unterstützung für
8282 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
8283 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
8284 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
8288 <sect2 id="devel.build-doc.required-software">
8289 <title>Benötigte Software</title>
8291 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
8292 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
8293 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
8294 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
8295 <command>scripts/build_doc.sh</command>.</para>
8297 <para>Das Script benötigt zur Konvertierung verschiedene
8298 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
8304 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
8305 in einer halbwegs aktuellen Version</para>
8309 <para>Das Java-Build-System <ulink
8310 url="http://ant.apache.org/">Apache Ant</ulink></para>
8314 <para>Das Dokumentations-System Dobudish für
8315 <productname>DocBook</productname> 4.5, eine Zusammenstellung
8316 diverser Stylesheets und Grafiken zur Konvertierung von
8317 <productname>DocBook</productname> XML in andere Formate. Das
8318 Paket, das benötigt wird, ist zum Zeitpunkt der
8319 Dokumentationserstellung
8320 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
8321 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
8326 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
8327 sind auf allen gängigen Plattformen verfügbar. Beispiel für
8328 Debian/Ubuntu:</para>
8330 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
8332 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
8333 <filename>doc/build</filename> entpackt werden. Beispiel unter der
8334 Annahme, das <productname>Dobudish</productname> in
8335 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
8337 <programlisting>cd doc/build
8338 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
8341 <sect2 id="devel.build-doc.build">
8342 <title>PDFs und HTML-Seiten erstellen</title>
8344 <para>Die eigentliche Konvertierung erfolgt nach Installation der
8345 benötigten Software mit einem einfachen Aufruf direkt aus dem
8346 kivitendo-Installationsverzeichnis heraus:</para>
8348 <programlisting>./scripts/build_doc.sh</programlisting>
8351 <sect2 id="devel.build-doc.repository">
8352 <title>Einchecken in das Git-Repository</title>
8354 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
8355 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
8356 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
8357 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
8359 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
8360 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob