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>MIME::Entity</literal></para>
212 <para><literal>MIME::Parser</literal></para>
216 <para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71
217 inklusive; siehe <xref
218 linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para>
222 <para><literal>File::Copy::Recursive</literal></para>
226 <para><literal>GD</literal></para>
230 <para><literal>HTML::Parser</literal></para>
234 <para><literal>HTML::Restrict</literal></para>
238 <para><literal>Image::Info</literal></para>
242 <para><literal>JSON</literal></para>
246 <para><literal>List::MoreUtils</literal></para>
250 <para><literal>List::UtilsBy</literal></para>
254 <para><literal>Net::SMTP::SSL</literal> (optional, bei
255 E-Mail-Versand über SSL; siehe Abschnitt "<xref
256 linkend="config.sending-email.smtp"/>")</para>
260 <para><literal>Net::SSLGlue</literal> (optional, bei
261 E-Mail-Versand über TLS; siehe Abschnitt "<xref
262 linkend="config.sending-email.smtp"/>")</para>
266 <para><literal>Params::Validate</literal></para>
270 <para><literal>PBKDF2::Tiny</literal></para>
274 <para><literal>PDF::API2</literal></para>
278 <para><literal>Rose::Object</literal></para>
282 <para><literal>Rose::DB</literal></para>
286 <para><literal>Rose::DB::Object</literal> Version 0.788 oder
291 <para><literal>String::ShellQuote</literal></para>
295 <para><literal>Sort::Naturally</literal></para>
299 <para><literal>Template</literal></para>
303 <para><literal>Text::CSV_XS</literal></para>
307 <para><literal>Text::Iconv</literal></para>
311 <para><literal>URI</literal></para>
315 <para><literal>XML::Writer</literal></para>
319 <para><literal>YAML</literal></para>
323 <para>Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen:
324 <literal>Algorithm::CheckDigits</literal><literal>PBKDF2::Tiny</literal></para>
326 <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen:
327 <literal>GD</literal>, <literal>HTML::Restrict</literal>,
328 <literal>Image::Info</literal></para>
330 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen:
331 <literal>File::Copy::Recursive</literal>.</para>
333 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen:
334 <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
335 <literal>Net::SSLGlue</literal>.</para>
337 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
338 hinzugekommen, <literal>URI</literal> und
339 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
342 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
343 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
344 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
345 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
347 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
348 hinzugekommen.</para>
350 <para><literal>Email::Address</literal> und
351 <literal>List::MoreUtils</literal> sind schon länger feste
352 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
353 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
354 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
355 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
359 <title>Debian und Ubuntu</title>
361 <para>Für Debian und Ubuntu stehen die meisten der benötigten
362 Perl-Pakete als Debian-Pakete zur Verfügung. Sie können mit
363 folgendem Befehl installiert werden:</para>
365 <programlisting>apt install apache2 libarchive-zip-perl libclone-perl \
366 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
367 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
368 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
369 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
370 librose-db-perl librose-object-perl libsort-naturally-perl \
371 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
372 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
373 libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \
374 libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \
375 libcrypt-pbkdf2-perl git libcgi-pm-perl
378 <para>Für das Paket HTML::Restrict gibt es kein Debian-Paket, dies
379 muß per CPAN installiert werden. Unter Ubuntu funktioniert das
382 <programlisting>apt-get install build-essential
383 cpan HTML::Restrict</programlisting>
387 <title>Fedora</title>
389 <para>Für Fedora stehen die meisten der benötigten Perl-Pakete als
390 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
391 installiert werden:</para>
393 <programlisting>dnf install httpd mod_fcgid perl-Archive-Zip perl-Clone perl-DBD-Pg \
394 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
395 perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
396 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
397 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
398 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
399 perl-XML-Writer perl-YAML perl-parent postgresql-server perl-CPAN \
400 perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor perl-Text-Balanced</programlisting>
402 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
403 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
405 <programlisting>cpan Config::Std HTML::Restrict</programlisting>
409 <title>openSUSE</title>
411 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als
412 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
413 installiert werden:</para>
415 <programlisting>zypper install apache2 apache2-mod_fcgid perl-Archive-Zip perl-Clone \
416 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
417 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
418 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
419 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
420 perl-URI perl-XML-Writer perl-YAML perl-CPAN \
421 perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor postgresql-server</programlisting>
423 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
424 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
426 <programlisting>cpan Rose::Db::Object</programlisting>
430 <title>Andere Pakete installieren</title>
432 <para>Seit Version v3.4.0 wird für den Bankimport optional das Paket
433 'aqbanking-tools' benötigt.</para>
435 <para>Ubuntu: <programlisting>apt install aqbanking-tools</programlisting></para>
437 <para>OpenSuSE: <programlisting>zypper install aqbanking-tools</programlisting></para>
439 <para>Seit Version v3.4.1 wird generell zum Feststellen der
440 Seitenanzahl von PDF_Dokumenten 'pdfinfo' benötigt was im Paket
441 'poppler-utils' enthalten ist.</para>
443 <para>Ubuntu: <programlisting>apt install poppler-utils</programlisting></para>
445 <para>OpenSuSE: <programlisting>zypper install poppler-tools</programlisting></para>
450 <sect1 id="Manuelle-Installation-des-Programmpaketes"
451 xreflabel="Manuelle Installation des Programmpaketes">
452 <title>Manuelle Installation des Programmpaketes</title>
454 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github
455 gehostet und kann <ulink
456 url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
457 heruntergeladen werden.</para>
459 <para>Die kivitendo ERP Installationsdatei
460 (<filename>kivitendo-erp-3.4.1.tgz</filename>) wird im
461 Dokumentenverzeichnis des Webservers (z.B.
462 <filename>/var/www/html/</filename>,
463 <filename>/srv/www/htdocs</filename> oder
464 <filename>/var/www/</filename>) entpackt:</para>
466 <programlisting>cd /var/www
467 tar xvzf kivitendo-erp-3.4.1.tgz</programlisting>
469 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
471 <programlisting>cd kivitendo-erp</programlisting>
473 <para>Alternativ können Sie auch einen Alias in der
474 Webserverkonfiguration benutzen, um auf das tatsächliche
475 Installationsverzeichnis zu verweisen.</para>
477 <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
478 WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
480 <programlisting>mkdir webdav</programlisting>
482 <para>Die Verzeichnisse <filename>users</filename>,
483 <filename>spool</filename> und <filename>webdav</filename> müssen für
484 den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
485 restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer-
486 und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich
487 (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
488 <constant>apache</constant> oder bei OpenSUSE
489 <constant>wwwrun</constant>).</para>
491 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
492 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
494 <programlisting>chown -R www-data users spool webdav</programlisting>
496 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen
497 <filename>templates</filename> und <filename>users</filename>
498 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in
499 kivitendo angelegt wird:</para>
501 <programlisting>chown www-data templates users</programlisting>
504 <para>Wir empfehlen eine Installation mittels des Versionsmanagager
505 git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr
506 viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte
507 die Pfade anpassen) bspw. wie folgt: <programlisting>cd /usr/local/src/
508 git clone https://github.com/kivitendo/kivitendo-erp.git
510 git checkout `git tag -l | egrep -ve "(beta|rc)" | tail -1`</programlisting>
511 Sehr sinnvoll ist es, direkt im Anschluss einen eigenen Branch zu
512 erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen damit zu
513 verwalten. Hierfür reicht ein simples <programlisting> git checkout -b meine_eigenen_änderungen</programlisting>
514 nach dem letzten Kommando (weiterführende Informationen <ulink
515 url="http://git-scm.com/book/en/v2/Getting-Started-Git-Basics">getting
516 started with git</ulink>).</para>
520 <sect1 id="config.config-file">
521 <title>kivitendo-Konfigurationsdatei</title>
523 <sect2 id="config.config-file.introduction"
524 xreflabel="Einführung in die Konfigurationsdatei">
525 <title>Einführung</title>
527 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
528 benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die
529 Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von
530 kivitendo bzw. der Migration von älteren Versionen angelegt
533 <para>Als Vorlage dient die Datei
534 <filename>config/kivitendo.conf.default</filename> (kurz: "die
535 Default-Datei"):</para>
537 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
539 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
540 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
541 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
542 Abschnitte und Werte enthalten, die von denen der Default-Datei
546 <para>Vor der Umbenennung in kivitendo hieß diese Datei noch
547 <filename>config/lx_office.conf</filename>. Aus Gründen der
548 Kompatibilität wird diese Datei eingelesen, sofern die Datei
549 <filename>config/kivitendo.conf</filename> nicht existiert.</para>
552 <para>Diese Hauptkonfigurationsdatei ist dann eine
553 installationsspezifische Datei, d.h. sie enthält bspw. lokale
554 Passwörter und wird auch nicht im Versionsmanagement (git)
557 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
558 Mandaten, bzw. Datenbanken gleich.</para>
561 <sect2 id="config.config-file.sections-parameters">
562 <title>Abschnitte und Parameter</title>
564 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
565 entsprechend kommentiert sind:</para>
569 <para><literal>authentication</literal> (siehe Abschnitt "<xref
570 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
571 in diesem Kapitel)</para>
575 <para><literal>authentication/database</literal></para>
579 <para><literal>authentication/ldap</literal></para>
583 <para><literal>system</literal></para>
587 <para><literal>paths</literal></para>
591 <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
592 linkend="config.sending-email.smtp"/>)</para>
596 <para><literal>applications</literal></para>
600 <para><literal>environment</literal></para>
604 <para><literal>print_templates</literal></para>
608 <para><literal>task_server</literal></para>
612 <para><literal>periodic_invoices</literal></para>
616 <para><literal>self_tests</literal></para>
620 <para><literal>console</literal></para>
624 <para><literal>testing</literal></para>
628 <para><literal>testing/database</literal></para>
632 <para><literal>debug</literal></para>
636 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
637 einzustellen oder zu kontrollieren sind, sind:</para>
639 <programlisting>[authentication]
640 admin_password = geheim
642 [authentication/database]
650 default_manager = german</programlisting>
652 <para>Für kivitendo Installationen in der Schweiz sollte hier <varname>german</varname>
653 durch <varname>swiss</varname> ersetzt werden.</para>
654 <para>Die Einstellung <varname>default_manager = swiss</varname> bewirkt:</para>
657 <para>Beim Erstellen einer neuen Datenbank in der kivitendo Administration
658 werden automatisch die Standard-Werte für die Schweiz voreingestellt:
659 Währung CHF, 5er-Rundung, Schweizer KMU-Kontenplan, Sollversteuerung,
660 Aufwandsmethode, Bilanzierung (die Werte können aber manuell angepasst werden).</para>
663 <para>Einstellen der Standardkonten für Rundungserträge und -aufwendungen
664 (unter Mandantenkonfiguration → Standardkonten veränderbar)</para>
667 <para>das verwendete Zahlenformat wird auf <varname>1'000.00</varname> eingestellt
668 (unter Programm → Benutzereinstellungen veränderbar)</para>
671 <para>DATEV-Automatik und UStVA werden nicht angezeigt, Erfolgsrechnung
672 ersetzt GUV ( unter Mandantenkonfiguration → Features veränderbar)</para>
676 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
677 <varname>[periodic_invoices]</varname> den Login eines Benutzers
678 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
679 mit Informationen über die erstellten Rechnungen bekommt.</para>
681 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
682 Ausführung bestimmter Aufgaben mit, den <link
683 linkend="config.task-server">Taskserver</link>. Er wird u.a. für
684 Features wie die <link
685 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
686 benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
687 daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
688 <link linkend="config.task-server">Task-Server</link> genauer
691 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
692 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
695 <sect2 id="config.config-file.prior-versions">
696 <title>Versionen vor 2.6.3</title>
698 <para>In älteren kivitendo Versionen gab es im Verzeichnis
699 <filename>config</filename> die Dateien
700 <filename>authentication.pl</filename> und
701 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
702 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
703 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
704 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
706 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
707 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
708 manuell übertragen und die alten Konfigurationsdateien anschließend
709 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
710 entsprechende Fehlermeldung an.</para>
714 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
715 <title>Anpassung der PostgreSQL-Konfiguration</title>
717 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
719 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
720 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
722 <para>kivitendo setzt zwingend voraus, dass die Datenbank
723 Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
724 Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
726 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
727 Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
728 man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
730 <programlisting>su postgres
732 exit </programlisting>
734 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
735 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
736 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
739 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
741 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
742 Versionsnummer angepasst werden.</para>
744 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
746 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
747 <literal>\l</literal> geprüft werden.</para>
750 <sect2 id="Änderungen-an-Konfigurationsdateien">
751 <title>Änderungen an Konfigurationsdateien</title>
753 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
754 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
755 <filename>/var/lib/pgsql/data/</filename> oder
756 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
757 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
758 Parameter <varname>listen_address</varname> gesteuert. Laufen
759 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
760 <literal>localhost</literal> verwendet werden. Andernfalls müssen
761 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
762 was mit dem Wert <literal>*</literal> geschieht.</para>
764 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
765 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
766 sein sollte, müssen die Berechtigungen für den Zugriff geändert
767 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
768 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
769 Datenbank zum Beispiel:</para>
771 <programlisting>local all kivitendo password
772 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
775 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
776 <title>Erweiterung für servergespeicherte Prozeduren</title>
778 <para>In der Datenbank <literal>template1</literal> muss die
779 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
780 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
781 <programlisting>su - postgres
782 psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
784 <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
788 <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
789 bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
790 anzulegen. In diesen Versionen ist die Extension meist auch schon
791 vorhanden. Sollten Sie eine ältere Version von Postgres haben,
792 benutzen Sie stattdessen den folgenden Befehl.</para>
794 <programlisting>CREATE LANGUAGE 'plpgsql';
799 <sect2 id="Datenbankbenutzer-anlegen">
800 <title>Datenbankbenutzer anlegen</title>
802 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
803 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
804 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
807 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
808 nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
809 generieren nicht nötig.</para>
811 <programlisting>su - postgres
812 createuser -d -P kivitendo
813 exit</programlisting>
815 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
816 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
817 bzw. den hier gewählten Benutzernamen.</para>
821 <sect1 id="Apache-Konfiguration">
822 <title>Webserver-Konfiguration</title>
825 <title>Grundkonfiguration mittels CGI</title>
828 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
829 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
830 <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
833 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
834 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
835 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
836 anderen Datei hinzu, die beim Starten des Webservers eingelesen
839 <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
840 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
842 <Directory /var/www/kivitendo-erp>
843 AddHandler cgi-script .pl
844 Options ExecCGI Includes FollowSymlinks
847 <Directory /var/www/kivitendo-erp/users>
850 </Directory></programlisting>
852 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
853 das kivitendo-Archiv entpacket haben.</para>
856 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
857 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
859 <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
860 noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
861 aktiviert werden.</para>
864 <para>Auf einigen Webservern werden manchmal die Grafiken und
865 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
866 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
868 <programlisting>EnableSendfile Off</programlisting>
871 <sect2 id="Apache-Konfiguration.FCGI"
872 xreflabel="Konfiguration für FastCGI/FCGI">
873 <title>Konfiguration für FastCGI/FCGI</title>
875 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
876 <title>Was ist FastCGI?</title>
878 <para>Direkt aus <ulink
879 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
882 <para><citation> FastCGI ist ein Standard für die Einbindung
883 externer Software zur Generierung dynamischer Webseiten in einem
884 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
885 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
886 umgehen. </citation></para>
889 <sect3 id="Apache-Konfiguration.FCGI.Warum">
890 <title>Warum FastCGI?</title>
892 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
893 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
894 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
895 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
896 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
897 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
898 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
899 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
900 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
901 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
902 deutlich länger dauert als früher, und dass davon 90% für das Laden
903 der Module verwendet wird.</para>
905 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
906 wird nur die eigentliche Programmlogik ausgeführt.</para>
909 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
910 <title>Getestete Kombinationen aus Webservern und Plugin</title>
912 <para>Folgende Kombinationen sind getestet:</para>
916 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
920 <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
924 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
928 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
929 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
930 mod_fastcgi nicht mehr explizit eingegangen.</para>
932 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
936 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
937 strict in der Behandlung von Unicode, und verweigern bestimmte
938 Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
939 Installation gibt, muss zwingend Version 0.68 oder aber Version
940 0.72 und neuer eingesetzt werden.</para>
942 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
943 sich die Vorgängerversion wie folgt installieren:</para>
945 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
949 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
950 <title>Konfiguration des Webservers</title>
952 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
953 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
954 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
955 debuggen die beim ersten aufsetzen auftreten können. Sollte die
956 Installation schon funktionieren, lesen Sie weiter.</para>
958 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
959 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
961 <programlisting>a2enmod fcgid</programlisting>
963 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
964 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
965 und <function>Directory</function>-Direktiven. Dabei wird zwischen
966 dem Installationspfad von kivitendo im Dateisystem
967 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
968 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
969 ("<filename>/url/for/kivitendo-erp</filename>").</para>
971 <para>Folgender Konfigurationsschnipsel funktioniert mit
974 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
975 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
977 <Directory /path/to/kivitendo-erp>
979 Options ExecCGI Includes FollowSymlinks
983 <DirectoryMatch /path/to/kivitendo-erp/users>
985 </DirectoryMatch></programlisting>
988 <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
989 muss entsprechend die Syntax der Directorydirektiven verändert.
992 <programlisting>Require all granted</programlisting>
994 <para>muß man Folgendes einstellen:</para>
998 Allow from All </programlisting>
1000 <para>und statt</para>
1002 <programlisting>Require all denied</programlisting>
1004 <para>muss stehen:</para>
1008 Deny from All </programlisting>
1012 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
1013 die maximale Größe eines Requests. Diese sollte wie folgt
1014 hochgesetzt werden:</para>
1016 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
1018 <para>Das Ganze sollte dann so aussehen:</para>
1020 <programlisting>AddHandler fcgid-script .fpl
1021 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1022 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1023 FcgidMaxRequestLen 10485760
1025 <Directory /path/to/kivitendo-erp>
1027 Options ExecCGI Includes FollowSymlinks
1032 <DirectoryMatch /path/to/kivitendo-erp/users>
1035 </DirectoryMatch></programlisting>
1037 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
1038 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
1039 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
1040 gibt es hier kleine Performance-Einbußen.</para>
1042 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
1043 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
1044 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
1046 <programlisting># Zugriff über CGI
1047 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
1049 # Zugriff mit mod_fcgid:
1050 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1051 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
1053 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
1054 die normale Version erreichbar, und unter
1055 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
1056 FastCGI-Version.</para>
1061 <title>Weitergehende Konfiguration</title>
1063 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
1064 von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1065 weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1066 Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1067 Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1068 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1069 (Stand Sept. 2015)</ulink></para>
1073 <sect1 id="config.task-server">
1074 <title>Der Task-Server</title>
1076 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1077 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1078 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1079 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1080 essenzielle Aufgaben benutzt.</para>
1082 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1083 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1084 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1086 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1087 Servers integriert werden muss, damit er automatisch gestartet wird.
1088 Dies kann kivitendo nicht für Sie erledigen.</para>
1090 <sect2 id="Konfiguration-des-Task-Servers">
1091 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1093 <para>Die Konfiguration erfolgt über den Abschnitt
1094 <literal>[task_server]</literal> in der Datei
1095 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1096 Optionen sind:</para>
1100 <term><varname>run_as</varname></term>
1103 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1104 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1105 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1106 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1108 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1109 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1110 unter dem auch der Webserver läuft.</para>
1115 <term><varname>debug</varname></term>
1118 <para>Schaltet Debug-Informationen an und aus.</para>
1124 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1125 <title>Konfiguration der Mandanten für den Task-Server</title>
1127 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1128 anschließend jeder Mandant, für den der Task-Server laufen soll,
1129 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1130 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1131 ausgewählt werden, unter der der Task-Server seine Arbeit
1134 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1135 wird der Task-Server für diesen Mandanten keine Aufgaben
1139 <sect2 id="Einbinden-in-den-Boot-Prozess">
1140 <title>Automatisches Starten des Task-Servers beim Booten</title>
1142 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1143 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1144 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1146 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1147 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1148 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1149 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1150 anstelle eines symbolischen Links verwendet werden können.</para>
1153 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE,
1154 ältere Fedora)</title>
1156 <para>Kopieren Sie die Datei
1157 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1158 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1159 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1160 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1161 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1165 <para>Debian-basierende Systeme:</para>
1167 <programlisting>update-rc.d kivitendo-task-server defaults
1168 # Nur bei Debian Squeeze und neuer:
1169 insserv kivitendo-task-server</programlisting>
1173 <para>Ältere OpenSUSE und ältere Fedora:</para>
1175 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1179 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1182 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1186 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1188 <para>Kopieren Sie die Datei
1189 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1190 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1191 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1192 <literal>exec ....</literal>).</para>
1194 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1197 <programlisting>service kivitendo-task-server start</programlisting>
1201 <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1202 Fedora, neuere Ubuntu und Debians)</title>
1204 <para>Kopieren Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
1205 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeilen
1206 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>).</para>
1208 <para>Machen Sie anschließend das Script systemd bekannt, und binden Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden
1211 <programlisting>systemctl daemon-reload
1212 systemctl enable kivitendo-task-server.service</programlisting>
1214 <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt den Server neu zu starten, so können Sie das mit dem
1215 folgenden Befehl tun:</para>
1217 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1221 <sect2 id="Prozesskontrolle">
1222 <title>Wie der Task-Server gestartet und beendet wird</title>
1224 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1226 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1228 <para><literal>Befehl</literal> ist dabei eine der folgenden
1233 <para><literal>start</literal> startet eine neue Instanz des
1234 Task-Servers. Die Prozess-ID wird innerhalb des
1235 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1239 <para><literal>stop</literal> beendet einen laufenden
1244 <para><literal>restart</literal> beendet und startet ihn
1249 <para><literal>status</literal> berichtet, ob der Task-Server
1254 <para>Der Task-Server wechselt beim Starten automatisch in das
1255 kivitendo-Installationsverzeichnis.</para>
1257 <para>Dieselben Optionen können auch für die SystemV-basierenden
1258 Runlevel-Scripte benutzt werden (siehe oben).</para>
1262 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1263 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1265 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1266 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1268 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1269 <title>Grundlagen zur Benutzerauthentifizierung</title>
1271 <para>kivitendo verwaltet die Benutzerinformationen in einer
1272 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1273 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1274 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1275 können, müssen aber nicht unterschiedlich sein.</para>
1277 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1278 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1279 abgelegt werden.</para>
1281 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
1282 entweder gegen die Authentifizierungsdatenbank oder gegen einen
1283 LDAP-Server überprüft werden.</para>
1285 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1286 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1287 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1288 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1289 einer Version vor v2.6.0 angelegt werden. Eine
1290 Beispielkonfigurationsdatei
1291 <filename>config/kivitendo.conf.default</filename> existiert, die als
1292 Vorlage benutzt werden kann.</para>
1295 <sect2 id="Administratorpasswort">
1296 <title>Administratorpasswort</title>
1298 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1299 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1300 gespeichert. Es kann auch nur dort und nicht mehr im
1301 Administrationsinterface selber geändert werden. Der Parameter dazu
1302 heißt <varname>admin_password</varname> im Abschnitt
1303 <varname>[authentication]</varname>.</para>
1306 <sect2 id="Authentifizierungsdatenbank">
1307 <title>Authentifizierungsdatenbank</title>
1309 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1310 Parametern in <varname>[authentication/database]</varname>
1311 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1315 <term><literal>host</literal></term>
1318 <para>Der Rechnername oder die IP-Adresse des
1319 Datenbankservers</para>
1324 <term><literal>port</literal></term>
1327 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1332 <term><literal>db</literal></term>
1335 <para>Der Name der Authentifizierungsdatenbank</para>
1340 <term><literal>user</literal></term>
1343 <para>Der Benutzername, mit dem sich kivitendo beim
1344 Datenbankserver anmeldet (z.B.
1345 "<literal>postgres</literal>")</para>
1350 <term><literal>password</literal></term>
1353 <para>Das Passwort für den Datenbankbenutzer</para>
1358 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1359 automatisch anlegen (mehr dazu siehe unten).</para>
1362 <sect2 id="Passwortüberprüfung">
1363 <title>Passwortüberprüfung</title>
1365 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1366 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1367 Active-Directory-Server. Welche davon benutzt wird, regelt der
1368 Parameter <varname>module</varname> im Abschnitt
1369 <varname>[authentication]</varname>.</para>
1371 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1372 gespeichert werden, so muss der Parameter <varname>module</varname>
1373 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1374 der Administrator als auch die Benutzer selber ihre Passwörter in
1375 kivitendo ändern.</para>
1377 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1378 benutzt werden, so muss der Parameter <varname>module</varname> auf
1379 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1380 zusätzliche Informationen über den LDAP-Server im Abschnitt
1381 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1385 <term><literal>host</literal></term>
1388 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1389 Active-Directory-Servers. Diese Angabe ist zwingend
1390 erforderlich.</para>
1395 <term><literal>port</literal></term>
1398 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1403 <term><literal>tls</literal></term>
1406 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1407 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1408 ‘<literal>0</literal>’ belassen</para>
1413 <term><literal>attribute</literal></term>
1416 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1417 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1418 meist ‘<literal>sAMAccountName</literal>’, für andere
1419 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1420 zwingend erforderlich.</para>
1425 <term><literal>base_dn</literal></term>
1428 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1429 Diese Angabe ist zwingend erforderlich.</para>
1434 <term><literal>filter</literal></term>
1437 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1438 <literal><%login%></literal>, so wird dieses durch den vom
1439 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1440 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1441 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1446 <term><literal>bind_dn</literal> und
1447 <literal>bind_password</literal></term>
1450 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1451 durchsucht werden kann (z.B. ist dies bei
1452 Active-Directory-Servern der Fall), so kann diese hier angegeben
1453 werden. Für Active-Directory-Server kann als
1454 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1455 z.B. ‘<literal>cn=Martin
1456 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1457 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1458 also ‘<literal>Martin Mustermann</literal>’.</para>
1464 <sect2 id="Name-des-Session-Cookies">
1465 <title>Name des Session-Cookies</title>
1467 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1468 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1469 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1470 Parameter <varname>cookie_name</varname> im Abschnitt
1471 <varname>[authentication]</varname>gesetzt.</para>
1473 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1474 Server existiert.</para>
1477 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1478 <title>Anlegen der Authentifizierungsdatenbank</title>
1480 <para>Nachdem alle Einstellungen in
1481 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1482 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1483 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1484 der folgenden URL erreichbar sein sollte:</para>
1487 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1491 <sect1 id="Benutzer--und-Gruppenverwaltung">
1492 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1494 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1495 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1496 das Sie unter folgender URL finden:</para>
1499 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1501 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1502 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1504 <sect2 id="Zusammenhänge">
1505 <title>Zusammenhänge</title>
1507 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1508 in einer oder zwei Datenbanken gespeichert werden.</para>
1510 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1511 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1512 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1513 Diese Informationen werden in der Authentifizierungsdatenbank
1514 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1515 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1516 gespeichert werden.</para>
1518 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1519 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1520 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1521 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1522 einer solchen Mandantendatenbank werden im Administrationsbereich
1523 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1524 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1526 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1527 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1528 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1529 mehr als einem Mandanten, wird empfohlen, für die
1530 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1531 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1534 <sect2 id="Mandanten-Benutzer-Gruppen">
1535 <title>Mandanten, Benutzer und Gruppen</title>
1537 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1538 die sich frei zueinander zuordnen lassen.</para>
1540 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1541 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1542 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1543 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1544 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1545 Diese sollte über die <link
1546 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1549 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1550 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1551 der Administrator fest, an welchen Mandanten sich ein Benutzer
1552 anmelden kann, was beim Login verifiziert wird.</para>
1554 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1555 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1556 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1557 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1558 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1559 dann an einem Mandanten an, so erhält er alle Rechte von allen
1560 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1561 denen der Benutzer zum Anderen Mitglied ist,</para>
1563 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1564 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1565 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1567 <orderedlist numeration="arabic">
1569 <para>Datenbank anlegen</para>
1573 <para>Gruppen anlegen</para>
1577 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1581 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1586 <sect2 id="Datenbanken-anlegen">
1587 <title>Datenbanken anlegen</title>
1589 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1590 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1591 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1594 <sect2 id="Gruppen-anlegen">
1595 <title>Gruppen anlegen</title>
1597 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1598 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1599 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1600 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1602 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1603 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1604 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1605 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1606 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1607 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1608 A, B und C gültig").</para>
1610 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1611 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1612 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1613 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1614 Gruppen A, B und C").</para>
1617 <sect2 id="Benutzer-anlegen">
1618 <title>Benutzer anlegen</title>
1620 <para>Beim Anlegen von Benutzern werden für viele Parameter
1621 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1622 deutschen Raumes entsprechen.</para>
1624 <para>Zwingend anzugeben ist der Loginname. Wenn die
1625 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
1626 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
1627 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1630 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
1631 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
1632 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
1633 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
1634 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
1635 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
1636 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
1637 sind Benutzer A, B und C Mitglieder").</para>
1640 <sect2 id="Mandanten-anlegen">
1641 <title>Mandanten anlegen</title>
1643 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
1644 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
1645 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
1646 einer der eben angelegten Datenbanken eingetragen werden.</para>
1648 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
1649 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
1650 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
1651 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
1652 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
1653 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
1654 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
1655 Gruppe ist für Mandanten A, B und C gültig").</para>
1659 <sect1 id="Drucker--Systemverwaltung">
1660 <title>Drucker- und Systemverwaltung</title>
1662 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
1663 Druckeradministration und System.</para>
1665 <sect2 id="Druckeradministration">
1666 <title>Druckeradministration</title>
1668 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
1669 viele "Druckbefehle" im System verwalten. Diese Befehle werden
1670 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
1671 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
1672 angezeigt wird.</para>
1674 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
1675 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
1676 meinDrucker' oder ein kompletter Pfad zu einem Skript
1677 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
1678 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
1679 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
1680 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
1681 Ausdruck eines Angebots folgende Vorlage geparst:
1682 sales_quotation_epson_drucker.tex.</para>
1686 <title>System sperren / entsperren</title>
1688 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
1689 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
1690 gesamten kivitendo Installation gesperrt.</para>
1692 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
1693 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
1694 Wartungsarbeiten nicht zugänglich.'.</para>
1696 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
1697 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
1698 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
1699 inkonsistenten Datenbestand weitergearbeitet werden.</para>
1703 <sect1 id="config.sending-email"
1704 xreflabel="E-Mail-Versand aus kivitendo heraus">
1705 <title>E-Mail-Versand aus kivitendo heraus</title>
1707 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
1708 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
1709 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
1710 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
1711 Versand über einen lokalen E-Mail-Server (z.B. mit
1712 <productname>Postfix</productname> oder <productname>Exim</productname>,
1713 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
1714 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
1716 <para>Welche Methode und welcher Server verwendet werden, wird über die
1717 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1718 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
1719 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1721 <sect2 id="config.sending-email.sendmail"
1722 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1723 <title>Versand über lokalen E-Mail-Server</title>
1725 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
1726 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
1727 <productname>Postfix</productname>, <productname>Exim</productname>
1728 oder <productname>Sendmail</productname> läuft.</para>
1730 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1731 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1732 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1734 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
1735 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
1736 Standardwert verweist auf das Programm
1737 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1738 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1740 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
1741 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
1745 <sect2 id="config.sending-email.smtp"
1746 xreflabel="E-Mail-Versand über einen SMTP-Server">
1747 <title>Versand über einen SMTP-Server</title>
1749 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
1750 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
1753 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1754 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1755 Parameter dienen dabei der weiteren Konfiguration:</para>
1759 <term><varname>hostname</varname></term>
1762 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
1763 '<literal>localhost</literal>'</para>
1768 <term><varname>port</varname></term>
1771 <para>Portnummer. Der Standardwert hängt von der verwendeten
1772 Verschlüsselungsmethode ab. Gilt '<literal>security =
1773 none</literal>' oder '<literal>security = tls</literal>', so ist
1774 25 die Standardportnummer. Für '<literal>security =
1775 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
1776 geändert werden.</para>
1781 <term><varname>security</varname></term>
1784 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
1785 mit dem Server. Standardwert ist '<literal>none</literal>',
1786 wodurch keine Verschlüsselung verwendet wird. Mit
1787 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
1788 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
1789 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
1790 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
1791 (siehe unten).</para>
1796 <term><varname>login</varname> und
1797 <varname>password</varname></term>
1800 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
1801 so können mit diesen zwei Parametern der Benutzername und das
1802 Passwort angegeben werden. Wird Authentifizierung verwendet, so
1803 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
1804 aktiviert werden.</para>
1811 <sect1 id="Drucken-mit-kivitendo">
1812 <title>Drucken mit kivitendo</title>
1814 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
1815 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1816 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1817 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
1819 <para><programlisting>apt-get install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1820 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1822 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
1824 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
1825 texlive-collection-latexrecommended texlive-collection-langgerman \
1826 texlive-collection-langenglish</programlisting></para>
1828 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
1830 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
1831 texlive-collection-latexrecommended texlive-collection-langgerman \
1832 texlive-collection-langenglish</programlisting></para>
1834 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1846 <para>rev-odt</para>
1850 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version
1851 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
1853 <sect2 id="Vorlagenverzeichnis-anlegen"
1854 xreflabel="Vorlagenverzeichnis anlegen">
1855 <title>Vorlagenverzeichnis anlegen</title>
1857 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
1858 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1860 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1862 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
1863 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
1864 <xref linkend="Gruppen-anlegen"/>.</para>
1866 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
1867 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
1868 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
1869 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1873 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
1874 Vorlagensatz aus, der kopiert werden soll
1875 (<filename>RB</filename>, <filename>f-tex</filename> oder
1876 <filename>odt-rev</filename>.)</para>
1880 <para><option>Neuer Name</option>: Der Verzeichnisname für den
1881 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
1882 für Verzeichnisnamen frei gewählt werden.</para>
1886 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
1887 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
1888 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1889 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
1890 vorgenommen werden. Den Ordner findet man im Dateisystem unter
1891 <filename>./templates/[Neuer Name]</filename></para>
1894 <sect2 id="Vorlagen-RB">
1895 <title>Der Druckvorlagensatz RB</title>
1897 <para>Hierbei handelt es sich um einen vollständigen LaTeX
1898 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
1899 sind nicht gepflegt.</para>
1901 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
1902 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1903 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
1904 eigenen Firmendaten finden sich in der Datei Readme.tex im
1905 Vorlagenverzeichnis.</para>
1907 <para>Eine kurze Übersicht der Features:</para>
1911 <para>Mehrsprachenfähig, mit Deutscher und Englischer
1916 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
1917 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
1922 <para>mehrere vordefinierte Varianten für
1923 Logos/Hintergrundbilder</para>
1927 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
1928 "Außerhalb EU"</para>
1934 <title>f-tex</title>
1936 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur
1937 Verfügung stellt.</para>
1939 <sect3 id="f-tex-Feature-Übersicht">
1940 <title>Feature-Übersicht</title>
1944 <para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage
1945 für alle briefartigen Dokumente verwendet. Also Angebot,
1946 Rechnung, Proformarechnung, Lieferschein, aber eben nicht für
1947 Paketaufkleber etc.</para>
1951 <para>Leichte Anpassung an das Firmen-Layout durch Verwendung
1952 eines Hintergrund-PDFs. Dieses kann leicht mit dem eigenen
1953 Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp,
1958 <para>Hintergrund-PDF umschaltbar auf "nur erste Seite"
1959 (Standard) oder "alle Seiten" (Option
1960 "<option>bgPdfFirstPageOnly</option>" in Datei
1961 <filename>letter.lco</filename>)</para>
1965 <para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem
1966 Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1967 versendeten Dokumenten eingebunden (Option
1968 "<option>bgPdfEmailOnly</option>" in Datei
1969 <filename>letter.lco</filename>).</para>
1973 <para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch,
1974 Wiederholung von Kopfzeilen, Zwischensummen etc. (danke an
1975 Kai-Martin Knaak für die Vorarbeit)</para>
1979 <para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom
1980 Land des eigenen Unternehmens abweicht (also die Rechnung das
1981 Land verlässt).</para>
1985 <para>Multisprachfähig leicht um weitere Sprachen zu erweitern,
1986 alle Übersetzungen in der Datei
1987 <filename>translatinos.tex</filename>.</para>
1991 <para>Auflistung von Bruttopreisen für Endverbraucher.</para>
1996 <sect3 id="f-tex-Installation">
1997 <title>Die Installation</title>
2001 <para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref
2002 linkend="Vorlagenverzeichnis-anlegen"/>. Das Vorlagensystem
2003 funktioniert jetzt schon, hat allerdings noch einen
2004 Beispiel-Briefkopf.</para>
2008 <para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
2009 <filename>./letter_head.pdf</filename>.</para>
2013 <para>Editiere den Bereich "<option>settings</option>" in der
2014 datei <filename>letter.lco</filename>.</para>
2018 <para>oder etwas detaillierter:</para>
2020 <para>Es wird eine Datei <filename>sample.lco</filename> erstellt
2021 und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
2022 ist dies die Datei die für die firmenspezifischen Anpassungen
2023 gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist,
2024 wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle
2025 über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und
2026 <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung
2027 über eine <filename>*.lco</filename>-Datei, die letztlich auf
2028 <filename>letter.lco</filename> verlinkt ist ist aber auch
2031 <para>Es wird eine Datei <filename>sample_head.pdf</filename> mit
2032 ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
2033 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage.
2034 Schau Dir nach Abschluss der Installation die Datei
2035 <filename>sample_head.pdf</filename> an und erstelle ein
2036 entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
2037 Template Verzeichniss ablegen und statt
2038 <filename>sample_head.pdf</filename> nach
2039 <filename>letter_head.pdf</filename> verlinken.</para>
2041 <para>Letzlich muss <filename>letter_head.pdf</filename> auf das
2042 passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
2045 <para>Es wird eine Datei <filename>mydata.tex.example</filename>
2046 ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
2047 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das
2048 Land verwendet. Die Datei muss also nicht angefasst werden. Die
2049 anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit
2050 nicht im öffentlichen Zweig).</para>
2052 <para>Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
2053 sollten über die Hintergrund-PDF-Datei oder die
2054 <filename>*.lco</filename>-Datei erfolgen.</para>
2057 <sect3 id="f-tex-Funktionsübersicht">
2058 <title>f-tex Funktionsübersicht</title>
2060 <para>Das Konzept von kivitendo sieht vor, für jedes Dokument
2061 (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
2062 LaTeX-Vorlage vorzuhalten, dies ist sehr wartungsunfreundlich. Auch
2063 das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
2064 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen
2065 aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
2066 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
2067 LaTeX-Vorlage verwendet, welche über Codeweichen die Besonderheiten
2068 der jeweiligen Dokumente berücksichtigt:</para>
2072 <para>Tabellen mit oder ohne Preis</para>
2076 <para>Sprache der Tabellenüberschriften etc.</para>
2080 <para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
2081 Angebotsnummer)</para>
2085 <para>Darstellung von Brutto oder Netto-Preisen in der
2086 Auflistung (Endverbraucher versus gewerblicher Kunde)</para>
2090 <para>Nachteil:</para>
2092 <para>LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei
2093 <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
2094 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder
2095 geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch
2096 innerhalb der Tabellendarstellung gut persönliche Anpassungen
2097 vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell
2098 heftig in den Fuss schiessen.</para>
2100 <para>Wer nicht so tief in die Materie einsteigen will oder leicht
2101 zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
2102 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen,
2103 und sich an der Form der dargestellten Tabellen, wie sie
2104 ausgeliefert werden, erfreuen.</para>
2106 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine,
2107 kontinuierliche Schritte gehen.</para>
2110 <sect3 id="f-tex-Bruttopreise">
2111 <title>Bruttopreise für Endverbraucher</title>
2113 <para>Der auszuweisende Bruttopreis wird innerhalb der
2114 LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen
2115 "alle Preise Brutto" auszuwählen, aber:</para>
2119 <para>hierfür müssen die Preise auch in Brutto in der Datenbank
2120 stehen (ja - das lässt sich über die Preisgruppen und die
2121 Zuordung einer Default-Preisgruppe handhaben)</para>
2125 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses
2126 Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
2127 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche
2132 <para>Es gibt mit f-tex eine weitere Alternative. Die Information ob
2133 Brutto oder Nettorechnung wird mit den Zahlarten verknüpft.
2134 Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben
2135 werden sollen, enden mit "_E" (für Endverbraucher). Falls identische
2136 Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt
2137 man diese einfach doppelt an (einmal mit der Namensendung "_E").
2142 <para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist
2143 nicht mehr fix mit einer Preisliste verbunden.</para>
2147 <para>Die Default-Zahlart kann im Kundendatensatz hinterlegt
2148 werden, und man muss nicht mehr daran denken, "alle Preise
2149 Netto" auszuwählen.</para>
2153 <para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen
2154 werden, kann direkt beim Drucken revidiert werden, ohne dass
2155 sich der Auftragswert ändert.</para>
2160 <sect3 id="f-tex-lieferadressen">
2161 <title>Lieferadressen</title>
2163 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen
2164 im Adressfeld zum Einsatz. Wenn die
2165 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende
2166 Adressvariable eingesetzt. Wenn also die Lieferadresse in Straße,
2167 Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
2168 Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert
2169 der Hauptadresse angezeigt.</para>
2173 <sect2 id="Vorlagen-rev-odt">
2174 <title>Der Druckvorlagensatz rev-odt</title>
2176 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2177 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2178 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2179 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2180 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2181 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2182 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2184 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2185 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2186 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2187 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2188 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2189 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2191 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2192 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2193 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2194 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2195 die vom Parser nicht korrekt gelesen werden kann.</para>
2197 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2198 odt-Vorlagen bei Mahnungen, Briefen und Pflichtenheften einzusetzen.
2199 Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2201 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2202 empfang@revamp-it.ch</para>
2205 <sect2 id="allgemeine-hinweise-zu-latex">
2206 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2208 <para>In den allermeisten Installationen sollte das Drucken jetzt
2209 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2210 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2211 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2212 sind zum Beispiel:</para>
2216 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2217 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2218 allem bei Vorlagen aus der Community auf. Installieren Sie die
2219 entsprechenden Pakete.</para>
2223 <para>! Package inputenc Error: Unicode char \u8:... set up for
2224 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2225 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2226 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2227 diversen Tricks dazu gebracht werden andere Zeichen zu
2228 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2233 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2234 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2235 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2236 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2237 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2240 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2241 verifizieren lässt:</para>
2245 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2246 "keep_temp_files" auf 1</para>
2248 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2252 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2256 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2260 <para>wechsel in das users Verzeichnis von kivitendo</para>
2262 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2266 <para>LaTeX Suchpfad anpassen:</para>
2268 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2272 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2275 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2277 <para>Es sollte die letzte Datei ganz unten sein</para>
2281 <para>für besseren Hinweis auf Fehler texdatei nochmals
2284 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2286 <para>in der *.tex datei nach dem Fehler suchen.</para>
2292 <sect1 id="OpenDocument-Vorlagen">
2293 <title>OpenDocument-Vorlagen</title>
2295 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2296 OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2) erzeugen.
2297 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
2298 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2299 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2300 <filename>config/kivitendo.conf</filename> die Variable
2301 <literal>opendocument</literal> im Abschnitt
2302 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2303 Dieses ist die Standardeinstellung.</para>
2305 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2306 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2307 LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt werden, so muss
2308 neben LibreOffice oder OpenOffice auch der “X virtual frame buffer”
2309 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
2310 Andere Distributionen enthalten ihn in anderen Paketen.</para>
2312 <para>Nach der Installation müssen in der Datei
2313 <filename>config/kivitendo.conf</filename> im Abschnitt
2314 <literal>applications</literal> zwei weitere Variablen
2315 angepasst werden:</para>
2316 <para><literal>openofficeorg_writer</literal> muss den
2317 vollständigen Pfad zu LibreOffice oder OpenOffice enthalten.
2318 Dabei dürfen keine Anführungszeichen eingesetzt werden.</para>
2319 <para>Beispiel für Debian oder Ubuntu:</para>
2320 <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2321 <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2324 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2325 LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die benutzt
2326 wird, wenn die Variable <literal>$openofficeorg_daemon</literal> gesetzt
2327 ist, startet ein LibreOffice oder OpenOffice, das auch nach der Umwandlung
2328 des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen wird dann diese
2329 laufende Instanz benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung
2330 deutlich reduziert wird, weil nicht für jedes Dokument ein LibreOffice bzw.
2331 OpenOffice gestartet werden muss. Der Nachteil ist, dass diese Methode
2332 Python und die Python-UNO-Bindings benötigt, die Bestandteil von LibreOffice
2333 bzw. OpenOffice sind.</para>
2336 <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2337 normalerweise der Python-Interpreter
2338 <filename>/usr/bin/python</filename> benutzt.
2339 Sollte dies nicht der richtige sein, so kann man mit zwei
2340 Konfigurationsvariablen entscheiden, welcher Python-Interpreter
2341 genutzt wird. Mit der Option <literal>python_uno</literal> aus dem
2342 Abschnitt <literal>applications</literal> wird der Interpreter selber
2343 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2344 <literal>/usr/bin/python</literal>.</para>
2346 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2347 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2348 z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2349 OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2350 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2351 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2352 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2353 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2354 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2358 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2359 wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet
2360 und die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses
2361 Makro muss in der Dokumentenvorlage enthalten sein und
2362 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2363 ‘<literal>templates/print/rev-odt/invoice.odt</literal>’
2364 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
2365 ebenfalls enthalten sein muss.</para>
2367 <para>Als letztes muss herausgefunden werden, welchen Namen
2368 OpenOffice bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen
2369 gibt. Unter Debian ist dies momentan
2370 <literal>~/.config/libreoffice</literal>. kivitendo verwendet das
2371 Verzeichnis <literal>users/.openoffice.org2</literal>.
2372 Eventuell muss dieses Verzeichnis umbenannt werden.</para>
2374 <para>Dieses Verzeichnis, wie auch das komplette
2375 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2376 sein. Dieses wurde bereits erledigt (siehe <xref
2377 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber
2378 erneut überprüft werden, wenn die Konvertierung nach PDF
2382 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2384 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2385 Aufgaben erfüllen.</para>
2387 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2388 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2389 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2390 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2391 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2392 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2393 Anpassungen aufgeführt</emphasis>):</para>
2396 <title>Bezeichnung der Vorlagen</title>
2398 <para>Rechnung: invoice_besr.odt, Auftrag:
2399 sales_order_besr.odt</para>
2403 <title>Vorbereitungen im Adminbereich</title>
2405 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2406 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2407 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2408 ein Drucker eingerichtet werden:</para>
2412 <para>Druckeradministration → Drucker hinzufügen</para>
2416 <para>Mandant wählen</para>
2420 <para>Druckerbeschreibung → aussagekräftiger Text: wird in
2421 der Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B.
2422 mit Einzahlungsschein Bank xy)</para>
2426 <para>Druckbefehl → beliebiger Text (hat für das Erzeugen
2427 von Aufträgen oder Rechnungen als odt-Datei keine Bedeutung,
2428 darf aber nicht leer sein)</para>
2432 <para>Vorlagenkürzel → besr bzw. selbst gewähltes
2433 Vorlagensuffix (muss genau der Zeichenfolge entsprechen, die
2434 zwischen "invoice_" bzw. "sales_order_" und ".odt"
2439 <para>speichern</para>
2445 <title>Benutzereinstellungen</title>
2447 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2448 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2449 dies persönlich für sich bei den Benutzereinstellungen
2450 konfigurieren:</para>
2454 <para>Programm → Benutzereinstellungen →
2455 Druckoptionen</para>
2459 <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2463 <para>Standardausgabekanal → Bildschirm</para>
2467 <para>Standarddrucker → gewünschte Druckerbeschreibung
2468 auswählen (z.B. mit Einzahlungsschein Bank xy)</para>
2472 <para>Anzahl Kopien → leer</para>
2476 <para>speichern</para>
2482 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2484 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2485 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2486 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2487 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2492 <para>Für den Einzahlungsschein ist die letzte Seite des
2493 Dokuments reserviert</para>
2497 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2498 Zeile mit folgenden Angaben (<emphasis
2499 role="bold">Bank-Konto-Identifikationsnummer und
2500 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2501 Bank angepasst werden</emphasis>):<itemizedlist>
2503 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2504 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2506 <para>erster Wert: <emphasis
2507 role="bold">Bank-Konto-Identifikation</emphasis>
2508 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2509 angepasst werden</emphasis>.</para>
2513 <para>zweiter Wert: <%customernumber%>
2514 (Kundennummer: nur Ziffern, maximal 6)</para>
2518 <para>dritter Wert: <%ordnumber%>
2519 (Auftragsnummer bei Auftragsvorlage
2520 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2521 führende Buchstaben werden vom Makro entfernt</para>
2525 <para>vierter Wert: <%invnumber%>
2526 (Rechnungsnummer bei Rechnungsvorlage
2527 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2528 führende Buchstaben werden vom Makro entfernt</para>
2530 </itemizedlist></para>
2534 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2535 Bank, muss angepasst werden</emphasis>.</para>
2539 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2540 falls Einzahlungsschein ohne Betrag</para>
2544 <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2546 </itemizedlist></para>
2550 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2551 der Name und die Adresse der Bank, die Postkonto-Nummer der
2552 Bank, sowie der eigene Firmenname und die Firmenadresse
2553 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2554 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2555 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2561 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2562 ändernde Einträge in rot</screeninfo>
2566 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2573 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2574 odt-Rechnung (analog bei Auftrag)</title>
2576 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2577 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2578 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2579 den Benutzereinstellungen als persönlicher Standard gewählt
2584 <title>Makroeinstellungen in LibreOffice anpassen</title>
2586 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2587 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2588 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2589 angepasst werden:</para>
2593 <para>Extras → Optionen → Sicherheit →
2594 Makrosicherheit</para>
2598 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2599 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2600 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2605 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2606 der entsprechenden Nachfrage "Makros ausführen" auswählen.
2609 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2610 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2611 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2612 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2620 <sect1 id="config.eur">
2621 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
2624 <sect2 id="config.eur.introduction"
2625 xreflabel="Einführung in die Konfiguration zur EUR">
2626 <title>Einführung</title>
2628 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
2629 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
2630 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
2631 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
2632 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
2634 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
2635 die Mandantendatenbank verschoben und dabei auch gleich in drei
2636 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
2637 steuern lässt.</para>
2640 <sect2 id="config.eur.parameters"
2641 xreflabel="Konfigurationsparameter für EUR">
2642 <title>Konfigurationsparameter</title>
2644 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
2645 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
2649 <term><varname>profit_determination</varname></term>
2652 <para>Dieser Parameter legt die Berechnungsmethode für die
2653 Gewinnermittlung fest. Er enthält entweder
2654 <literal>balance</literal> für
2655 Betriebsvermögensvergleich/Bilanzierung oder
2656 <literal>income</literal> für die
2657 Einnahmen-Überschuss-Rechnung.</para>
2662 <term><varname>accounting_method</varname></term>
2665 <para>Dieser Parameter steuert die Buchungs- und
2666 Berechnungsmethoden für die Versteuerungsart. Er enthält
2667 entweder <literal>accrual</literal> für die Soll-Versteuerung
2668 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
2673 <term><varname>inventory_system</varname></term>
2676 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
2677 enthält entweder <literal>perpetual</literal> für die
2678 Bestandsmethode oder <literal>periodic</literal> für die
2679 Aufwandsmethode.</para>
2684 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
2685 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
2686 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
2687 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
2688 Bestandsmethode.</para>
2690 <para>Die Konfiguration "<varname>eur</varname>" unter
2691 <varname>[system]</varname> in der <link
2692 linkend="config.config-file">Konfigurationsdatei</link>
2693 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
2694 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
2697 <sect2 id="config.eur.setting-parameters">
2698 <title>Festlegen der Parameter</title>
2700 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
2701 der Admininstration können diese Optionen nun unabhängig voneinander
2702 eingestellt werden.</para>
2704 <para>Für die Schweiz sind folgende Einstellungen üblich:
2707 <para>Sollversteuerung</para>
2710 <para>Aufwandsmethode</para>
2713 <para>Bilanzierung</para>
2716 Diese Einstellungen werden automatisch beim Erstellen einer neuen
2717 Datenbank vorausgewählt, wenn in <filename>config/kivitendo.conf</filename> unter
2718 <varname>[system]</varname> <literal>default_manager = swiss</literal> eingestellt ist.
2721 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
2722 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
2725 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
2726 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
2727 angezeigt. Unter <guimenu>System</guimenu> →
2728 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
2729 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
2730 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
2731 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
2732 auch <link linkend="config.eur.inventory-system-perpetual">
2733 Bemerkungen zur Bestandsmethode</link>).</para>
2736 <sect2 id="config.eur.inventory-system-perpetual">
2737 <title>Bemerkungen zur Bestandsmethode</title>
2739 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
2740 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
2741 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
2742 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
2743 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
2744 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
2745 Einkaufsrechnungen berechnet wird.</para>
2747 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
2748 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
2749 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
2753 <sect2 id="config.eur.knonw-issues">
2754 <title>Bekannte Probleme</title>
2756 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
2757 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
2758 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
2759 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
2760 die Konfigurationsvariable
2761 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
2764 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
2765 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
2769 <sect1 id="config.skr04-update-3804">
2770 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
2772 <sect2 id="config.skr04-update-3804.introduction">
2773 <title>Einführung</title>
2775 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
2776 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
2777 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
2778 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
2779 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
2780 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
2781 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
2782 vielleicht schon selbst geholfen hat und mit seinen Änderungen
2783 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
2784 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
2785 Screenshots dargestellt.</para>
2787 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
2788 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
2789 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
2790 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
2793 <sect2 id="config.skr04-update-3804.create-chart">
2794 <title>Konto 3804 manuell anlegen</title>
2796 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
2797 anzulegen und zu konfigurieren. Zuerst wird in
2798 <guimenu>System</guimenu> →
2799 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konto
2800 erfassen</guimenuitem> das Konto angelegt.</para>
2803 <screeninfo>Konto 3804 erfassen</screeninfo>
2807 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
2812 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
2813 werden. Dazu unter <guimenu>System</guimenu> →
2814 <guisubmenu>Steuern</guisubmenu> →
2815 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
2816 13 auswählen und ihn wie im folgenden Screenshot angezeigt
2820 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
2824 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
2829 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
2830 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
2831 <guisubmenu>Steuern</guisubmenu> →
2832 <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem
2833 Screenshot übernehmen.</para>
2836 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
2840 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
2845 <para>Als Nächstes sind alle Konten anzupassen, die als
2846 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
2847 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
2848 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
2849 müssen Sie dazu unter <guimenu>System</guimenu> →
2850 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
2851 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
2852 wie im Screenshot gezeigt vornehmen.</para>
2855 <screeninfo>Konto 4315 anpassen</screeninfo>
2859 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
2864 <para>Als Letztes sollte die Steuerliste unter
2865 <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
2866 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
2867 Vergleich der Screenshot.</para>
2870 <screeninfo>Steuerliste vergleichen</screeninfo>
2874 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
2881 <sect1 id="config.bilanz">
2882 <title>Verhalten des Bilanzberichts</title>
2884 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
2885 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
2886 monatsweise führt dies zu falschen Werten.</para>
2888 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
2889 einstellen indem man:</para>
2893 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
2898 <para>immer den Jahresanfang nimmt (1.1. relativ zum
2903 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
2905 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
2908 <para>- oder mit "alle Buchungen" als Alternative"</para>
2912 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
2917 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
2921 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
2922 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
2923 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
2924 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
2925 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
2926 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
2927 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
2928 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
2929 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
2930 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
2931 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
2932 Erfolgsrechnung.</para>
2935 <sect1 id="config.erfolgsrechnung">
2936 <title>Erfolgsrechnung</title>
2938 <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht <emphasis role="bold">
2939 Erfolgsrechnung</emphasis>.</para>
2941 <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter Features
2942 an- oder abgeschaltet werden. Mit der Einstellung <varname>default_manager = swiss
2943 </varname> in der <filename>config/kivitendo.conf</filename> wird beim neu Erstellen
2944 einer Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü <guimenu>Berichte
2945 </guimenu> ausgewählt und ersetzt dort die GUV.</para>
2947 <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche Aufwands- und
2948 Erlöskonten einzeln aufgelistet (analog zur Bilanz), sortiert nach ERTRAG und AUFWAND.</para>
2950 <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der Erfolgsrechnung
2951 erscheinen soll, unter <varname>Sonstige Einstellungen/Erfolgsrechnung</varname>
2952 entweder <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal> ausgewählt
2955 <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal> ausgewählt,
2956 so wird dieses Konto als Aufwandsminderung unter AUFWAND aufgelistet.</para>
2958 <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal> ausgewählt,
2959 so wird dieses Konto als Ertragsminderung unter ERTRAG aufgelistet.</para>
2961 <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft zusätzlich
2962 die Erfolgsrechnung als Bericht verwendet werden, so müssen die Einstellungen
2963 zu allen Erlös- und Aufwandskonten unter <varname>Sonstige
2964 Einstellungen/Erfolgsrechnung</varname> überprüft und allenfalls neu gesetzt werden.</para>
2967 <sect1 id="config.rounding">
2968 <title>Rundung in Verkaufsbelegen</title>
2970 <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert von 5 Rappen (0.05 CHF).</para>
2972 <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer Genauigkeit
2973 von 0.01 CHF verwendet werden können, ist es trotzdem nach wie vor üblich,
2974 Rechnungen mit auf 0.05 CHF gerundeten Beträgen auszustellen.</para>
2976 <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine solche
2977 Rundung pro Mandant / Datenbank festgelegt werden.</para>
2979 <para>Die Einstellung wird beim Erstellen der Datenbank bei <literal>Genauigkeit</literal>
2980 festgelegt. Sie kann anschliessend über das Webinterface von kivitendo nicht mehr
2981 verändert werden.</para>
2983 <para>Abhängig vom Wert für <varname>default_manager</varname> in
2984 <filename>config/kivitendo.conf</filename> werden dabei folgende
2985 Werte voreingestellt:</para>
2988 <para>0.05 (default_manager = swiss)</para>
2991 <para>0.01 (default_manager = german)</para>
2994 <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
2995 </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
2997 <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
2998 und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet,
2999 wenn dieser nicht der eingestellten Genauigkeit entspricht.</para>
3001 <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
3002 automatisch auf die in der Mandantenkonfiguration festgelegten
3003 Standardkonten für Rundungserträge bzw. Rundungsaufwendungen gebucht.</para>
3005 <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr verändert.)</para>
3007 <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
3008 <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
3009 <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
3011 <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege
3012 in anderen Währungen als der Standardwährung erstellt, so muss in
3013 kivitendo 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
3014 <para>Das heisst, Firmen in der Schweiz, die teilweise Verkaufsrechnungen
3015 in Euro oder anderen Währungen erstellen wollen, müssen beim Erstellen
3016 der Datenbank als Genauigkeit 0.01 wählen und können zur Zeit die
3017 5er Rundung noch nicht nutzen.</para>
3020 <sect1 id="config.client">
3021 <title>Einstellungen pro Mandant</title>
3023 <para>Einige Einstellungen können von einem Benutzer mit dem <link
3024 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
3025 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
3026 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3027 Die Einstellungen sind unter <guimenu>System</guimenu> →
3028 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3030 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3031 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3032 geändert werden (siehe auch <link
3033 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3034 Bestandsmethode</link>).</para>
3036 <para>Die Einstellungen <literal>show_bestbefore</literal> und
3037 <literal>payments_changeable</literal> aus dem Abschnitt
3038 <literal>features</literal> und die Einstellungen im Abschnitt
3039 <literal>datev_check</literal> (sofern schon vorhanden) der <link
3040 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3041 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3042 Diese Einträge können danach aus der Konfigurationsdatei entfernt
3046 <sect1 id="kivitendo-ERP-verwenden">
3047 <title>kivitendo ERP verwenden</title>
3049 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3050 folgender URL erreichbar:</para>
3053 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3055 <para>Die Administrationsseite erreichen Sie unter:</para>
3058 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3062 <chapter id="features" xreflabel="Features und Funktionen">
3063 <title>Features und Funktionen</title>
3065 <sect1 id="features.periodic-invoices"
3066 xreflabel="Wiederkehrende Rechnungen">
3067 <title>Wiederkehrende Rechnungen</title>
3069 <sect2 id="features.periodic-invoices.introduction"
3070 xreflabel="Einführung in wiederkehrende Rechnungen">
3071 <title>Einführung</title>
3073 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3074 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3075 Die konfigurierten Aufträge werden später automatisch in Rechnungen
3076 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3077 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3078 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3079 wiederzufinden sind.</para>
3082 <sect2 id="features.periodic-invoices.configuration"
3083 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3084 <title>Konfiguration</title>
3086 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3087 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3088 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3089 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3090 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3093 <para>Folgende Parameter kann man konfigurieren:</para>
3100 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3101 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3102 eines neuen Monats).</para>
3104 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3105 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3106 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3107 nächsten Periodenwechsel für alle Perioden, seit der letzten
3108 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3109 verhindern, muss man vorher das Startdatum neu setzen.</para>
3111 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3112 erstellt. Man kann sich diese Aufträge aber gesondert in den
3113 Berichten anzeigen lassen.</para>
3118 <term>Periodizität</term>
3121 <para>Ob monatlich, quartalsweise oder jährlich auf neue
3122 Rechnungen überprüft werden soll. Für jede Periode seit dem
3123 Startdatum wird überprüft, ob für die Periode (beginnend immer
3124 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3125 wurde. Unter Umständen können bei einem Startdatum in der
3126 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3131 <term>Buchen auf</term>
3134 <para>Das Forderungskonto, in der Regel "Forderungen aus
3135 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3136 Buchungsgruppen der betreffenden Waren.</para>
3141 <term>Startdatum</term>
3144 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3150 <term>Enddatum</term>
3153 <para>ab wann keine Rechnungen mehr erstellt werden
3159 <term>Automatische Verlängerung um x Monate</term>
3162 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3163 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3164 hier die Anzahl der Monate eingeben, um die das Enddatum
3165 automatisch nach hinten geschoben wird.</para>
3170 <term>Drucken</term>
3173 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3174 Rechnungen auch gleich ausdrucken lassen.</para>
3179 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3180 Informationen zu den erstellten Rechnungen verschickt werden.
3181 Konfiguriert wird dies in der <link
3182 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3183 <filename>config/kivitendo.conf</filename> im Abschnitt
3184 <varname>[periodic_invoices]</varname>.</para>
3187 <sect2 id="features.periodic-invoices.variables">
3188 <title>Spezielle Variablen</title>
3190 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3191 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3192 formatierte Variablen durch für die jeweils aktuelle
3193 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3194 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3195 die Syntax <literal><%variablenname%></literal>.</para>
3197 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3198 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3199 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3200 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3201 Die zur verfügung stehenden Formatinformationen werden unten genauer
3204 <para>Diese Variablen können auch beim automatischen Versand der
3205 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3206 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3208 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3213 <para>Bemerkungen</para>
3217 <para>Interne Bemerkungen</para>
3221 <para>Vorgangsbezeichnung</para>
3225 <para>In den Beschreibungs- und Langtextfeldern aller
3230 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3234 <term><varname><%current_quarter%></varname>,
3235 <varname><%previous_quarter%></varname>,
3236 <varname><%next_quarter%></varname></term>
3239 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3240 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3245 <term><varname><%current_month%></varname>,
3246 <varname><%previous_month%></varname>,
3247 <varname><%next_month%></varname></term>
3250 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3251 <literal>1</literal> und <literal>12</literal>.</para>
3256 <term><varname><%current_month_long%></varname>,
3257 <varname><%previous_month_long%></varname>,
3258 <varname><%next_month_long%></varname></term>
3261 <para>Aktueller, vorheriger und nächster Monat als Name
3262 (<literal>Januar</literal>, <literal>Februar</literal>
3268 <term><varname><%current_year%></varname>,
3269 <varname><%previous_year%></varname>,
3270 <varname><%next_year%></varname></term>
3273 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3274 Jahreszahl (<literal>2013</literal> etc.).</para>
3279 <term><varname><%period_start_date%></varname>,
3280 <varname><%period_end_date%></varname></term>
3283 <para>Formatiertes Datum des ersten und letzten Tages im
3284 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3285 ersten Quartal von 2013 wären dies der
3286 <literal>01.01.2013</literal> und
3287 <literal>31.03.2013</literal>).</para>
3292 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3293 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3294 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3295 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3300 <term><varname>%a</varname></term>
3303 <para>Der abgekürzte Wochentagsname.</para>
3308 <term><varname>%A</varname></term>
3311 <para>Der ausgeschriebene Wochentagsname.</para>
3316 <term><varname>%b</varname></term>
3319 <para>Der abgekürzte Monatsname.</para>
3324 <term><varname>%B</varname></term>
3327 <para>Der ausgeschriebene Monatsname.</para>
3332 <term><varname>%C</varname></term>
3335 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3341 <term><varname>%d</varname></term>
3344 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3349 <term><varname>%D</varname></term>
3352 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3357 <term><varname>%e</varname></term>
3360 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3361 werden führende Nullen durch Leerzeichen ersetzt.</para>
3366 <term><varname>%F</varname></term>
3369 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3374 <term><varname>%j</varname></term>
3377 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3383 <term><varname>%m</varname></term>
3386 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3391 <term><varname>%u</varname></term>
3394 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3395 die 1 dem Montag entspricht.</para>
3400 <term><varname>%U</varname></term>
3403 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3404 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3410 <term><varname>%V</varname></term>
3413 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3414 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3415 vier Tage im Jahr liegen; Montag ist erster Tag der
3421 <term><varname>%w</varname></term>
3424 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3425 die 0 dem Sonntag entspricht.</para>
3430 <term><varname>%W</varname></term>
3433 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3434 wobei der erste Montag im Jahr das Startdatum von Woche 01
3440 <term><varname>%y</varname></term>
3443 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3449 <term><varname>%Y</varname></term>
3452 <para>Das Jahr als vierstellige Zahl.</para>
3457 <term><varname>%%</varname></term>
3460 <para>Das Prozentzeichen selber.</para>
3465 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3466 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3467 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3468 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3471 <sect2 id="features.periodic-invoices.reports">
3472 <title>Auflisten</title>
3474 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3475 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3476 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3477 wiederkehrenden Rechnungen verschaffen kann.</para>
3480 <sect2 id="features.periodic-invoices.task-server">
3481 <title>Erzeugung der eigentlichen Rechnungen</title>
3483 <para>Die zeitliche und periodische Überprüfung, ob eine
3484 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3485 durch den <link linkend="config.task-server">Taskserver</link>, einen
3486 externen Dienst, der automatisch beim Start des Servers gestartet
3487 werden sollte.</para>
3490 <sect2 id="features.periodic-invoices.create-for-current-month">
3491 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3493 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3494 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3495 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
3496 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3497 generiert hat. Alternativ setzt man das Startdatum auf den
3498 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3499 manuell über den Workflow.</para>
3503 <sect1 id="features.bank" xreflabel="bankerweiterung">
3504 <title>Bankerweiterung</title>
3506 <sect2 id="features.bank.introduction"
3507 xreflabel="Einführung in die Bankerweiterung">
3508 <title>Einführung</title>
3510 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3511 im Wiki und soll von dort später hierhin übernommen werden:</para>
3514 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3518 <sect1 id="dokumentenvorlagen-und-variablen">
3519 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3521 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3522 <title>Einführung</title>
3524 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3525 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3526 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3527 <function><%variablenname%></function> verwendet wird. Für
3528 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3530 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3532 <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3533 Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im
3534 Folgenden gesagte für alle Vorlagenarten.</para>
3536 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3537 verfügbar als hier aufgelistet werden. Die meisten davon können
3538 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3539 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3540 diese wie folgt erhalten werden:</para>
3544 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3545 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3549 <para>In <filename>Form.pm</filename> die Funktion
3550 <function>parse_template</function> suchen und hier die Zeile
3551 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3555 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3556 ein PDF für eine Rechnung erzeugen.</para>
3560 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3561 der Variablen <varname>$self</varname> in der Form <varname>'key'
3562 => 'value',</varname>. Alle <varname>key</varname>s sind
3568 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3569 <title>Variablen ausgeben</title>
3571 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3572 Tags geschrieben werden, also z.B.
3573 <varname><%variablenname%></varname>.</para>
3575 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3576 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3577 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
3578 werden die folgenden Flags unterstützt:</para>
3582 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3583 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3584 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3585 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3589 <para><option>NOESCAPE</option> unterdrückt das Escapen von
3590 Sonderzeichen für die Vorlagensprache. Wenn also in einer
3591 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
3592 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
3593 ist dieses Flag sinnvoll.</para>
3597 <para>Beispiel:</para>
3599 <programlisting><%quototal NOFORMAT%></programlisting>
3602 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
3603 <title>Verwendung in Druckbefehlen</title>
3605 <para>In der Admininstration können Drucker definiert werden. Auch im
3606 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
3607 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
3608 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
3609 <function>`...`</function> nicht zu unerwünschtem Verhalten
3612 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
3613 für das die Telefonnummer eines Ansprechpartners als Teil der
3614 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
3615 z.B. wie folgt aussehen:</para>
3617 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
3620 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
3621 xreflabel="Anfang und Ende der Tags verändern">
3622 <title>Anfang und Ende der Tags verändern</title>
3624 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
3625 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
3626 Prozentzeichen und dem Größerzeichen endet, beispielsweise
3627 <function><%customer%></function>. Da diese Form aber z.B. in
3628 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
3629 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
3630 Stil umgestellt werden.</para>
3632 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
3633 Format gültigen Kommentarzeichen anfangen, dann
3634 <function>config:</function> enthalten, die entsprechende Option
3635 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
3636 enden. Beispiel für LaTeX:</para>
3638 <programlisting>% config: tag-style=($ $)</programlisting>
3640 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
3641 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
3642 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
3644 <programlisting><!-- config: tag-style=($ $) --></programlisting>
3647 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
3648 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
3650 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
3651 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
3652 "<filename>.ext</filename>" geeignet zu ersetzen:
3653 "<filename>.tex</filename>" für LaTeX-Vorlagen und
3654 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
3658 <term><filename>bin_list.ext</filename></term>
3661 <para>Lagerliste</para>
3666 <term><filename>check.ext</filename></term>
3674 <term><filename>invoice.ext</filename></term>
3677 <para>Rechnung</para>
3682 <term><filename>packing_list.ext</filename></term>
3685 <para>Packliste</para>
3690 <term><filename>pick_list.ext</filename></term>
3693 <para>Sammelliste</para>
3698 <term><filename>purchase_delivery_order.ext</filename></term>
3701 <para>Lieferschein (Einkauf)</para>
3706 <term><filename>purcharse_order.ext</filename></term>
3709 <para>Bestellung an Lieferanten</para>
3714 <term><filename>request_quotation.ext</filename></term>
3717 <para>Anfrage an Lieferanten</para>
3722 <term><filename>sales_delivery_order.ext</filename></term>
3725 <para>Lieferschein (Verkauf)</para>
3730 <term><filename>sales_order.ext</filename></term>
3733 <para>Bestellung</para>
3738 <term><filename>sales_quotation.ext</filename></term>
3741 <para>Angebot an Kunden</para>
3746 <term><filename>zahlungserinnerung.ext</filename></term>
3749 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
3754 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
3757 <para>Rechnung über Mahngebühren (Dateiname im Programm
3758 konfigurierbar)</para>
3764 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
3765 <title>Sprache, Drucker und E-Mail</title>
3767 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
3768 eingearbeitet. So wird aus der Vorlage
3769 <filename>sales_order.ext</filename> bei Sprache
3770 <function>de</function> und Druckerkürzel <function>lpr2</function>
3771 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
3772 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
3773 bekommen dann noch das Kürzel <filename>_email</filename>, der
3774 vollständige Vorlagenname wäre dann
3775 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
3776 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
3777 werden. Diese wird verwendet, wenn keine der anderen Varianten
3778 gefunden wird.</para>
3780 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
3781 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
3782 verschickt wird, ist:</para>
3786 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
3790 <para><filename>sales_order_de_lpr2.tex</filename></para>
3794 <para><filename>sales_order.tex</filename></para>
3798 <para><filename>default.tex</filename></para>
3802 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
3803 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
3805 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
3808 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
3809 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
3812 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
3813 xreflabel="Metainformationen zur angeforderten Vorlage">
3814 <title>Metainformationen zur angeforderten Vorlage</title>
3816 <para>Diese Variablen liefern Informationen darüber welche Variante
3817 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
3818 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
3819 Formulare einbinden möchten.</para>
3823 <term><varname>template_meta.formname</varname></term>
3826 <para>Basisname der Vorlage. Identisch mit der <link
3827 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
3828 zu den Dateinamen</link> ohne die Erweiterung. Ein
3829 Verkaufsauftrag enthält hier
3830 <constant>sales_order</constant>.</para>
3835 <term><varname>template_meta.language.description</varname></term>
3838 <para>Beschreibung der verwendeten Sprache</para>
3843 <term><varname>template_meta.language.template_code</varname></term>
3846 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
3847 dem Kürzel das im Dateinamen verwendetet wird.</para>
3852 <term><varname>template_meta.language.output_numberformat</varname></term>
3855 <para>Zahlenformat der verwendeten Sprache in der Form
3856 "<constant>1.000,00</constant>". Experimentell! Nur
3857 interessant für Vorlagen die mit unformatierten Werten
3863 <term><varname>template_meta.language.output_dateformat</varname></term>
3866 <para>Datumsformat der verwendeten Sprache in der Form
3867 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
3868 interessant für Vorlagen die mit unformatierten Werten
3874 <term><varname>template_meta.format</varname></term>
3877 <para>Das angeforderte Format. Kann im Moment die Werte
3878 <constant>pdf</constant>, <constant>postscript</constant>,
3879 <constant>html</constant>, <constant>opendocument</constant>,
3880 <constant>opendocument_pdf</constant> und
3881 <constant>excel</constant> enthalten.</para>
3886 <term><varname>template_meta.extension</varname></term>
3889 <para>Dateierweiterung, wie im Dateinamen. Wird aus
3890 <constant>format</constant> entschieden.</para>
3895 <term><varname>template_meta.media</varname></term>
3898 <para>Ausgabemedium. Kann zur Zeit die Werte
3899 <constant>screen</constant> für Bildschirm,
3900 <constant>email</constant> für E-Mail (triggert das
3901 <constant>_email</constant> Kürzel im Dateinamen),
3902 <constant>printer</constant> für Drucker, und
3903 <constant>queue</constant> für Warteschlange enthalten.</para>
3908 <term><varname>template_meta.printer.description</varname></term>
3911 <para>Beschreibung des ausgewählten Druckers</para>
3916 <term><varname>template_meta.printer.template_code</varname></term>
3919 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
3920 dem Kürzel das im Dateinamen verwendetet wird.</para>
3925 <term><varname>template_meta.tmpfile</varname></term>
3928 <para>Datei-Prefix für temporäre Dateien.</para>
3934 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
3935 <title>Stammdaten von Kunden und Lieferanten</title>
3939 <term><varname>account_number</varname></term>
3942 <para>Kontonummer</para>
3947 <term><varname>bank</varname></term>
3950 <para>Name der Bank</para>
3955 <term><varname>bank_code</varname></term>
3958 <para>Bankleitzahl</para>
3963 <term><varname>bic</varname></term>
3966 <para>Bank-Identifikations-Code (Bank Identifier Code,
3972 <term><varname>business</varname></term>
3975 <para>Kunden-/Lieferantentyp</para>
3980 <term><varname>city</varname></term>
3988 <term><varname>contact</varname></term>
3991 <para>Kontakt</para>
3996 <term><varname>country</varname></term>
4004 <term><varname>c_vendor_id</varname></term>
4007 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
4012 <term><varname>v_customer_id</varname></term>
4015 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
4020 <term><varname>cp_email</varname></term>
4023 <para>Email des Ansprechpartners</para>
4028 <term><varname>cp_givenname</varname></term>
4031 <para>Vorname des Ansprechpartners</para>
4036 <term><varname>cp_greeting</varname></term>
4039 <para>Anrede des Ansprechpartners</para>
4044 <term><varname>cp_name</varname></term>
4047 <para>Name des Ansprechpartners</para>
4052 <term><varname>cp_phone1</varname></term>
4055 <para>Telefonnummer 1 des Ansprechpartners</para>
4060 <term><varname>cp_phone2</varname></term>
4063 <para>Telefonnummer 2 des Ansprechpartners</para>
4068 <term><varname>cp_title</varname></term>
4071 <para>Titel des Ansprechpartners</para>
4076 <term><varname>creditlimit</varname></term>
4079 <para>Kreditlimit</para>
4084 <term><varname>customeremail</varname></term>
4087 <para>Email des Kunden; nur für Kunden</para>
4092 <term><varname>customerfax</varname></term>
4095 <para>Faxnummer des Kunden; nur für Kunden</para>
4100 <term><varname>customernotes</varname></term>
4103 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4108 <term><varname>customernumber</varname></term>
4111 <para>Kundennummer; nur für Kunden</para>
4116 <term><varname>customerphone</varname></term>
4119 <para>Telefonnummer des Kunden; nur für Kunden</para>
4124 <term><varname>discount</varname></term>
4132 <term><varname>email</varname></term>
4135 <para>Emailadresse</para>
4140 <term><varname>fax</varname></term>
4143 <para>Faxnummer</para>
4148 <term><varname>gln</varname></term>
4151 <para>GLN (Globale Lokationsnummer)</para>
4156 <term><varname>greeting</varname></term>
4164 <term><varname>homepage</varname></term>
4167 <para>Homepage</para>
4172 <term><varname>iban</varname></term>
4175 <para>Internationale Kontonummer (International Bank Account
4176 Number, IBAN)</para>
4181 <term><varname>language</varname></term>
4184 <para>Sprache</para>
4189 <term><varname>name</varname></term>
4192 <para>Firmenname</para>
4197 <term><varname>payment_description</varname></term>
4200 <para>Name der Zahlart</para>
4205 <term><varname>payment_terms</varname></term>
4208 <para>Zahlungskonditionen</para>
4213 <term><varname>phone</varname></term>
4216 <para>Telefonnummer</para>
4221 <term><varname>shiptocity</varname></term>
4224 <para>Stadt (Lieferadresse) <link
4225 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4230 <term><varname>shiptocontact</varname></term>
4233 <para>Kontakt (Lieferadresse) <link
4234 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4239 <term><varname>shiptocountry</varname></term>
4242 <para>Land (Lieferadresse) <link
4243 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4248 <term><varname>shiptodepartment_1</varname></term>
4251 <para>Abteilung 1 (Lieferadresse) <link
4252 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4257 <term><varname>shiptodepartment_2</varname></term>
4260 <para>Abteilung 2 (Lieferadresse) <link
4261 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4266 <term><varname>shiptoemail</varname></term>
4269 <para>Email (Lieferadresse) <link
4270 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4275 <term><varname>shiptofax</varname></term>
4278 <para>Fax (Lieferadresse) <link
4279 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4284 <term><varname>shiptogln</varname></term>
4287 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4288 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4293 <term><varname>shiptoname</varname></term>
4296 <para>Firmenname (Lieferadresse) <link
4297 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4302 <term><varname>shiptophone</varname></term>
4305 <para>Telefonnummer (Lieferadresse) <link
4306 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4311 <term><varname>shiptostreet</varname></term>
4314 <para>Straße und Hausnummer (Lieferadresse) <link
4315 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4320 <term><varname>shiptozipcode</varname></term>
4323 <para>Postleitzahl (Lieferadresse) <link
4324 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4329 <term><varname>street</varname></term>
4332 <para>Straße und Hausnummer</para>
4337 <term><varname>taxnumber</varname></term>
4340 <para>Steuernummer</para>
4345 <term><varname>ustid</varname></term>
4348 <para>Umsatzsteuer-Identifikationsnummer</para>
4353 <term><varname>vendoremail</varname></term>
4356 <para>Email des Lieferanten; nur für Lieferanten</para>
4361 <term><varname>vendorfax</varname></term>
4364 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4369 <term><varname>vendornotes</varname></term>
4372 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4377 <term><varname>vendornumber</varname></term>
4380 <para>Lieferantennummer; nur für Lieferanten</para>
4385 <term><varname>vendorphone</varname></term>
4388 <para>Telefonnummer des Lieferanten; nur für
4394 <term><varname>zipcode</varname></term>
4397 <para>Postleitzahl</para>
4402 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4403 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4404 Stammdaten nicht eingetragen, so haben die Variablen
4405 <varname>shipto*</varname> den gleichen Wert wie die die
4406 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4407 einige <varname>shipto*</varname>-Variablen so nicht in den
4408 Stammdaten wiederfinden sondern schlicht Kopien der
4409 Lieferdatenvariablen sind (z.B.
4410 <varname>shiptocontact</varname>).</para>
4414 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4415 <title>Informationen über den Bearbeiter</title>
4419 <term><varname>employee_address</varname></term>
4422 <para>Adressfeld</para>
4427 <term><varname>employee_businessnumber</varname></term>
4430 <para>Firmennummer</para>
4435 <term><varname>employee_company</varname></term>
4438 <para>Firmenname</para>
4443 <term><varname>employee_co_ustid</varname></term>
4446 <para>Usatzsteuer-Identifikationsnummer</para>
4451 <term><varname>employee_duns</varname></term>
4454 <para>DUNS-Nummer</para>
4459 <term><varname>employee_email</varname></term>
4467 <term><varname>employee_fax</varname></term>
4475 <term><varname>employee_name</varname></term>
4478 <para>voller Name</para>
4483 <term><varname>employee_signature</varname></term>
4486 <para>Signatur</para>
4491 <term><varname>employee_taxnumber</varname></term>
4494 <para>Steuernummer</para>
4499 <term><varname>employee_tel</varname></term>
4502 <para>Telefonnummer</para>
4508 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4509 <title>Informationen über den Verkäufer</title>
4513 <term><varname>salesman_address</varname></term>
4516 <para>Adressfeld</para>
4521 <term><varname>salesman_businessnumber</varname></term>
4524 <para>Firmennummer</para>
4529 <term><varname>salesman_company</varname></term>
4532 <para>Firmenname</para>
4537 <term><varname>salesman_co_ustid</varname></term>
4540 <para>Usatzsteuer-Identifikationsnummer</para>
4545 <term><varname>salesman_duns</varname></term>
4548 <para>DUNS-Nummer</para>
4553 <term><varname>salesman_email</varname></term>
4561 <term><varname>salesman_fax</varname></term>
4569 <term><varname>salesman_name</varname></term>
4572 <para>voller Name</para>
4577 <term><varname>salesman_signature</varname></term>
4580 <para>Signatur</para>
4585 <term><varname>salesman_taxnumber</varname></term>
4588 <para>Steuernummer</para>
4593 <term><varname>salesman_tel</varname></term>
4596 <para>Telefonnummer</para>
4602 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
4603 <title>Variablen für die einzelnen Steuern</title>
4607 <term><varname>tax</varname></term>
4615 <term><varname>taxbase</varname></term>
4618 <para>zu versteuernder Betrag</para>
4623 <term><varname>taxdescription</varname></term>
4626 <para>Name der Steuer</para>
4631 <term><varname>taxrate</varname></term>
4634 <para>Steuersatz</para>
4640 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
4641 <title>Variablen für Lieferbedingungen</title>
4645 <term><varname>delivery_term</varname></term>
4648 <para>Datenbank-Objekt der Lieferbedingung</para>
4653 <term><varname>delivery_term.description</varname></term>
4656 <para>Beschreibung der Lieferbedingung</para>
4661 <term><varname>delivery_term.description_long</varname></term>
4664 <para>Langtext bzw. übersetzter Langtext der
4665 Lieferbedingung</para>
4672 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
4673 <title>Variablen in Rechnungen</title>
4675 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
4676 <title>Allgemeine Variablen</title>
4680 <term><varname>creditremaining</varname></term>
4683 <para>Verbleibender Kredit</para>
4688 <term><varname>currency</varname></term>
4691 <para>Währung</para>
4696 <term><varname>cusordnumber</varname></term>
4699 <para>Bestellnummer beim Kunden</para>
4704 <term><varname>deliverydate</varname></term>
4707 <para>Lieferdatum</para>
4712 <term><varname>duedate</varname></term>
4715 <para>Fälligkeitsdatum</para>
4720 <term><varname>globalprojectnumber</varname></term>
4723 <para>Projektnummer des ganzen Beleges</para>
4728 <term><varname>globalprojectdescription</varname></term>
4731 <para>Projekbeschreibung des ganzen Beleges</para>
4736 <term><varname>intnotes</varname></term>
4739 <para>Interne Bemerkungen</para>
4744 <term><varname>invdate</varname></term>
4747 <para>Rechnungsdatum</para>
4752 <term><varname>invnumber</varname></term>
4755 <para>Rechnungsnummer</para>
4760 <term><varname>invtotal</varname></term>
4763 <para>gesamter Rechnungsbetrag</para>
4768 <term><varname>notes</varname></term>
4771 <para>Bemerkungen der Rechnung</para>
4776 <term><varname>orddate</varname></term>
4779 <para>Auftragsdatum</para>
4784 <term><varname>ordnumber</varname></term>
4787 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
4788 erstellt wurde</para>
4793 <term><varname>payment_description</varname></term>
4796 <para>Name der Zahlart</para>
4801 <term><varname>payment_terms</varname></term>
4804 <para>Zahlungskonditionen</para>
4809 <term><varname>quodate</varname></term>
4812 <para>Angebotsdatum</para>
4817 <term><varname>quonumber</varname></term>
4820 <para>Angebotsnummer</para>
4825 <term><varname>rounding</varname></term>
4828 <para>Betrag, um den <varname>invtotal</varname> gerundet wurde
4829 (kann positiv oder negativ sein)</para>
4834 <term><varname>shippingpoint</varname></term>
4837 <para>Versandort</para>
4842 <term><varname>shipvia</varname></term>
4845 <para>Transportmittel</para>
4850 <term><varname>subtotal</varname></term>
4853 <para>Zwischensumme aller Posten ohne Steuern</para>
4858 <term><varname>total</varname></term>
4861 <para>Restsumme der Rechnung (Summe abzüglich bereits
4862 bezahlter Posten)</para>
4867 <term><varname>transaction_description</varname></term>
4870 <para>Vorgangsbezeichnung</para>
4875 <term><varname>transdate</varname></term>
4878 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
4879 erstellt wurde</para>
4885 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
4886 <title>Variablen für jeden Posten auf der Rechnung</title>
4890 <term><varname>bin</varname></term>
4893 <para>Stellage</para>
4898 <term><varname>description</varname></term>
4901 <para>Artikelbeschreibung</para>
4906 <term><varname>cusordnumber_oe</varname></term>
4909 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
4910 Posten ursprünglich stammt (nur Verkauf)</para>
4915 <term><varname>discount</varname></term>
4918 <para>Rabatt als Betrag</para>
4923 <term><varname>discount_sub</varname></term>
4926 <para>Zwischensumme mit Rabatt</para>
4931 <term><varname>donumber_do</varname></term>
4934 <para>Lieferscheinnummer des Lieferscheins, aus dem die
4935 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
4936 Workflows aus einem Lieferschein erstellt wurde.</para>
4941 <term><varname>drawing</varname></term>
4944 <para>Zeichnung</para>
4949 <term><varname>ean</varname></term>
4952 <para>EAN-Code</para>
4957 <term><varname>image</varname></term>
4965 <term><varname>linetotal</varname></term>
4968 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
4973 <term><varname>longdescription</varname></term>
4976 <para>Langtext</para>
4981 <term><varname>microfiche</varname></term>
4984 <para>Mikrofilm</para>
4989 <term><varname>netprice</varname></term>
4992 <para>Alternative zu <varname>sellprice</varname>, aber
4993 <varname>netprice</varname> entspricht dem effektiven
4994 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
4995 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
4996 / Menge. Diese Variable ist nützlich, wenn man den gewährten
4997 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
4998 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
4999 <varname>netprice</varname> hat nichts mit Netto/Brutto im
5000 Sinne von Steuern zu tun.</para>
5005 <term><varname>nodiscount_linetotal</varname></term>
5008 <para>Zeilensumme ohne Rabatt</para>
5013 <term><varname>nodiscount_sub</varname></term>
5016 <para>Zwischensumme ohne Rabatt</para>
5021 <term><varname>number</varname></term>
5024 <para>Artikelnummer</para>
5029 <term><varname>ordnumber_oe</varname></term>
5032 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5033 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5034 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5035 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5036 letzterem Fall wird die unsprüngliche Auftragsnummer
5042 <term><varname>p_discount</varname></term>
5045 <para>Rabatt in Prozent</para>
5050 <term><varname>partnotes</varname></term>
5053 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5058 <term><varname>partsgroup</varname></term>
5061 <para>Warengruppe</para>
5066 <term><varname>price_factor</varname></term>
5069 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5075 <term><varname>price_factor_name</varname></term>
5078 <para>Der Name des Preisfaktors, sofern einer eingestellt
5084 <term><varname>projectnumber</varname></term>
5087 <para>Projektnummer</para>
5092 <term><varname>projectdescription</varname></term>
5095 <para>Projektbeschreibung</para>
5100 <term><varname>qty</varname></term>
5108 <term><varname>reqdate</varname></term>
5111 <para>Lieferdatum</para>
5116 <term><varname>runningnumber</varname></term>
5119 <para>Position auf der Rechnung (1, 2, 3...)</para>
5124 <term><varname>sellprice</varname></term>
5127 <para>Verkaufspreis</para>
5132 <term><varname>serialnumber</varname></term>
5135 <para>Seriennummer</para>
5140 <term><varname>tax_rate</varname></term>
5143 <para>Steuersatz</para>
5148 <term><varname>transdate_do</varname></term>
5151 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5152 Workflows aus einem Lieferschein stammte.</para>
5157 <term><varname>transdate_oe</varname></term>
5160 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5161 Workflows aus einem Auftrag erstellt wurde. Wenn es
5162 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5168 <term><varname>transdate_quo</varname></term>
5171 <para>Datum des Angebots, wenn die Position im Rahmen des
5172 Workflows aus einem Angebot stammte.</para>
5177 <term><varname>unit</varname></term>
5180 <para>Einheit</para>
5185 <term><varname>weight</varname></term>
5188 <para>Gewicht</para>
5193 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5194 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5195 einer <function>foreach</function>-Schleife ausgegeben werden, da
5196 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5197 können. Die Variablen dafür lauten:</para>
5201 <term><varname>make</varname></term>
5204 <para>Lieferant</para>
5209 <term><varname>model</varname></term>
5212 <para>Lieferantenartikelnummer</para>
5218 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5219 <title>Variablen für die einzelnen Zahlungseingänge</title>
5223 <term><varname>payment</varname></term>
5231 <term><varname>paymentaccount</varname></term>
5239 <term><varname>paymentdate</varname></term>
5247 <term><varname>paymentmemo</varname></term>
5255 <term><varname>paymentsource</varname></term>
5264 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5265 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5267 <para>Die vom Benutzer definierten Variablen für Kunden und
5268 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5269 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5270 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5271 Variablennamen zusammen.</para>
5273 <para>Beispiel: Der Benutzer hat eine Variable namens
5274 <varname>number_of_employees</varname> definiert, die die Anzahl der
5275 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5276 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5279 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5280 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5281 Präfix <varname>shiptocvar_</varname>.</para>
5285 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5286 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5288 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5289 <title>Namen der Vorlagen</title>
5291 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5292 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5293 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5294 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5295 Vorlagenname für diese Mahnstufe mit dem Zusatz
5296 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5297 für die ausgewählte Sprache und den ausgewählten Drucker
5301 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5302 <title>Allgemeine Variablen in Mahnungen</title>
5304 <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie gewohnt als
5305 <varname>employee_...</varname> bzw. <varname>salesman_...</varname> zur Verfügung.
5306 Werden mehrere Rechnungen in einer Mahnung zusammengefasst, so werden
5307 die Metadaten (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung
5308 im Ausdruck genommen.</para>
5309 <para>Die Adressdaten des Kunden stehen als Variablen <varname>name</varname>,
5310 <varname>street</varname>, <varname>zipcode</varname>,
5311 <varname>city</varname>, <varname>country</varname>,
5312 <varname>department_1</varname>, <varname>department_2</varname>,
5313 und <varname>email</varname> zur Verfügung. Der Ansprechpartner <varname>cp_...</varname>
5314 steht auch zu Verfügung, wird allerdings auch nur von der ersten angemahnten Rechnung (s.o.)
5317 <para>Weitere Variablen beinhalten:</para>
5321 <term><varname>dunning_date</varname></term>
5324 <para>Datum der Mahnung</para>
5329 <term><varname>dunning_duedate</varname></term>
5332 <para>Fälligkeitsdatum für diese Mahhnung</para>
5337 <term><varname>dunning_id</varname></term>
5340 <para>Mahnungsnummer</para>
5345 <term><varname>fee</varname></term>
5348 <para>Kumulative Mahngebühren</para>
5353 <term><varname>interest_rate</varname></term>
5356 <para>Zinssatz per anno in Prozent</para>
5361 <term><varname>total_amount</varname></term>
5364 <para>Gesamter noch zu zahlender Betrag als
5365 <function>fee</function> + <function>total_interest</function>
5366 + <function>total_open_amount</function></para>
5371 <term><varname>total_interest</varname></term>
5374 <para>Zinsen per anno über alle Rechnungen</para>
5379 <term><varname>total_open_amount</varname></term>
5382 <para>Summe über alle offene Beträge der Rechnungen</para>
5388 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5389 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5393 <term><varname>dn_amount</varname></term>
5396 <para>Rechnungssumme (brutto)</para>
5401 <term><varname>dn_duedate</varname></term>
5404 <para>Originales Fälligkeitsdatum der Rechnung</para>
5409 <term><varname>dn_dunning_date</varname></term>
5412 <para>Datum der Mahnung</para>
5417 <term><varname>dn_dunning_duedate</varname></term>
5420 <para>Fälligkeitsdatum der Mahnung</para>
5425 <term><varname>dn_fee</varname></term>
5428 <para>Kummulative Mahngebühr</para>
5433 <term><varname>dn_interest</varname></term>
5436 <para>Zinsen per anno für diese Rechnung</para>
5441 <term><varname>dn_invnumber</varname></term>
5444 <para>Rechnungsnummer</para>
5449 <term><varname>dn_linetotal</varname></term>
5452 <para>Noch zu zahlender Betrag (ergibt sich aus
5453 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5454 + <varname>dn_interest</varname>)</para>
5459 <term><varname>dn_netamount</varname></term>
5462 <para>Rechnungssumme (netto)</para>
5467 <term><varname>dn_open_amount</varname></term>
5470 <para>Offener Rechnungsbetrag</para>
5475 <term><varname>dn_ordnumber</varname></term>
5478 <para>Bestellnummer</para>
5483 <term><varname>dn_transdate</varname></term>
5486 <para>Rechnungsdatum</para>
5491 <term><varname>dn_curr</varname></term>
5494 <para>Währung, in der die Rechnung erstellt wurde. (Die
5495 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5501 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5502 <title>Variablen in automatisch erzeugten Rechnungen über
5503 Mahngebühren</title>
5505 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5506 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5507 Kunden stehen als Variablen <varname>name</varname>,
5508 <varname>street</varname>, <varname>zipcode</varname>,
5509 <varname>city</varname>, <varname>country</varname>,
5510 <varname>department_1</varname>, <varname>department_2</varname>,
5511 und <varname>email</varname> zur Verfügung.</para>
5513 <para>Weitere Variablen beinhalten:</para>
5517 <term><varname>duedate</varname></term>
5520 <para>Fälligkeitsdatum der Rechnung</para>
5525 <term><varname>dunning_id</varname></term>
5528 <para>Mahnungsnummer</para>
5533 <term><varname>fee</varname></term>
5536 <para>Mahngebühren</para>
5541 <term><varname>interest</varname></term>
5549 <term><varname>invamount</varname></term>
5552 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
5553 <varname>interest</varname>)</para>
5558 <term><varname>invdate</varname></term>
5561 <para>Rechnungsdatum</para>
5566 <term><varname>invnumber</varname></term>
5569 <para>Rechnungsnummer</para>
5576 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
5577 <title>Variablen in anderen Vorlagen</title>
5580 <title>Einführung</title>
5582 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
5583 Rechnung. Allerdings heißen die Variablen, die mit
5584 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
5585 fangen sie mit <varname>quo</varname> für "quotation" an:
5586 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
5587 wiederum fangen sie mit <varname>ord</varname> für "order" an:
5588 <varname>ordnumber</varname> für Bestellnummer etc.</para>
5590 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
5591 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
5592 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
5593 Vorlage keine Bedeutung haben oder noch nicht belegt sein
5596 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
5597 in Rechnungen aufgeführt.</para>
5600 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
5601 <title>Angebote und Preisanfragen</title>
5605 <term><varname>quonumber</varname></term>
5608 <para>Angebots- bzw. Anfragenummer</para>
5613 <term><varname>reqdate</varname></term>
5616 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
5617 Preisanfragen)</para>
5622 <term><varname>transdate</varname></term>
5625 <para>Angebots- bzw. Anfragedatum</para>
5631 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
5632 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
5636 <term><varname>ordnumber</varname></term>
5639 <para>Auftragsnummer</para>
5644 <term><varname>reqdate</varname></term>
5647 <para>Lieferdatum</para>
5652 <term><varname>transdate</varname></term>
5655 <para>Auftragsdatum</para>
5661 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
5662 <title>Lieferscheine (Verkauf und Einkauf)</title>
5666 <term><varname>cusordnumber</varname></term>
5669 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
5670 des Lieferanten (im Einkauf)</para>
5675 <term><varname>donumber</varname></term>
5678 <para>Lieferscheinnummer</para>
5683 <term><varname>transdate</varname></term>
5686 <para>Lieferscheindatum</para>
5691 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
5692 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
5693 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
5694 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
5695 <function>foreach</function>-Schleife ausgegeben werden. Diese
5696 Variablen sind:</para>
5700 <term><varname>si_bin</varname></term>
5703 <para>Lagerplatz</para>
5708 <term><varname>si_chargenumber</varname></term>
5711 <para>Chargennummer</para>
5716 <term><varname>si_bestbefore</varname></term>
5719 <para>Mindesthaltbarkeit</para>
5724 <term><varname>si_number</varname></term>
5727 <para>Artikelnummer</para>
5732 <term><varname>si_qty</varname></term>
5735 <para>Anzahl bzw. Menge</para>
5740 <term><varname>si_runningnumber</varname></term>
5743 <para>Positionsnummer (1, 2, 3 etc)</para>
5748 <term><varname>si_unit</varname></term>
5751 <para>Einheit</para>
5756 <term><varname>si_warehouse</varname></term>
5765 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
5766 <title>Variablen für Sammelrechnung</title>
5770 <term><varname>c0total</varname></term>
5773 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
5779 <term><varname>c30total</varname></term>
5782 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
5783 und < 60 Tage</para>
5788 <term><varname>c60total</varname></term>
5791 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
5792 und < 90 Tage</para>
5797 <term><varname>c90total</varname></term>
5800 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
5806 <term><varname>total</varname></term>
5809 <para>Gesamtbetrag aller Rechnungen</para>
5814 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
5818 <term><varname>invnumber</varname></term>
5821 <para>Rechnungsnummer</para>
5826 <term><varname>invdate</varname></term>
5829 <para>Rechnungsdatum</para>
5834 <term><varname>duedate</varname></term>
5837 <para>Fälligkeitsdatum</para>
5842 <term><varname>amount</varname></term>
5845 <para>Summe der Rechnung</para>
5850 <term><varname>open</varname></term>
5853 <para>Noch offener Betrag der Rechnung</para>
5858 <term><varname>c0</varname></term>
5861 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
5867 <term><varname>c30</varname></term>
5870 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
5876 <term><varname>c60</varname></term>
5879 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
5885 <term><varname>c90</varname></term>
5888 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
5896 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
5897 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
5899 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
5900 <title>Einführung</title>
5902 <para>Der Parser kennt neben den Variablen einige weitere
5903 Konstrukte, die gesondert behandelt werden. Diese sind wie
5904 Variablennamen in spezieller Weise markiert:
5905 <command><%anweisung%> ... <%end%></command></para>
5907 <para>Anmerkung zum <command><%end%></command>: Der besseren
5908 Verständlichkeit halber kann man nach dem <command>end</command>
5909 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
5910 Anweisung (z.B. <command>if</command> oder
5911 <command>foreach</command>) damit abgeschlossen wird.</para>
5913 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
5914 <command><%if type == "sales_quotation"%></command>, so könnte
5915 er mit <command><%end%></command> genauso abgeschlossen werden
5916 wie mit <command><%end if%></command> oder auch
5917 <command><%end type == "sales_quotation"%></command>.</para>
5920 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
5921 <title>Der if-Block</title>
5923 <programlisting><%if variablenname%>
5925 <%end%></programlisting>
5927 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
5928 und dem "end" werden nur ausgegeben, wenn die Variable
5929 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
5931 <para>Handelt es sich bei der benannten Variable um ein Array, also
5932 um einen Variablennamen, über den man mit <command><%foreach
5933 variablenname%></command> iteriert, so wird mit diesem Konstrukt
5934 darauf getestet, ob das Array Elemente enthält. Somit würde im
5935 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
5936 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
5937 welche getätigt wurden:</para>
5939 <programlisting><%if payment%>
5941 <%foreach payment%>
5942 Am <%paymentdate%>: <%payment%> €
5943 <%end foreach%>
5944 <%end if%></programlisting>
5946 <para>Die Bedingung kann auch negiert werden, indem das Wort
5947 <function>not</function> nach dem <filename>if</filename> verwendet
5948 wird. Beispiel:</para>
5950 <programlisting><%if not cp_greeting%>
5952 <%end%></programlisting>
5954 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
5955 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
5956 einer Variablen mit einer festen Zeichenkette oder einer anderen
5957 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
5958 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
5959 die rechte Seite des Vergleichsoperators in Anführungszeichen
5960 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
5961 anderer Variablen). Zwei Beispiele, die beide Vergleiche
5964 <programlisting><%if var1 == "Wert"%></programlisting>
5966 <para>Testet die Variable <varname>var1</varname> auf
5967 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
5968 Mittels <function>!=</function> anstelle von <function>==</function>
5969 würde auf Ungleichheit getestet.</para>
5971 <programlisting><%if var1 == var2%></programlisting>
5973 <para>Testet die Variable <varname>var1</varname> auf
5974 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
5975 <function>!=</function> anstelle von <function>==</function> würde
5976 auf Ungleichheit getestet.</para>
5978 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
5979 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
5980 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
5981 dieselbe Syntax wie oben nur mit <function>=~</function> und
5982 <function>!~</function> als Vergleichsoperatoren.</para>
5984 <para>Beispiel für einen Test, ob die Variable
5985 <varname>intnotes</varname> (interne Bemerkungen) das Wort
5986 <constant>schwierig</constant> enthält:</para>
5988 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
5991 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
5992 <title>Der foreach-Block</title>
5994 <programlisting><%foreach variablenname%>
5996 <%end%></programlisting>
5998 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
5999 wie das Perl-Array der Variablen <varname>variablenname</varname>
6000 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
6001 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
6002 benutzt. In jedem Durchlauf werden die <link
6003 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
6004 Variablen</link> jeweils auf den Wert für die aktuelle Position
6007 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
6009 <programlisting><%foreach number%>
6010 Position: <%runningnumber%>
6011 Anzahl: <%qty%>
6012 Artikelnummer: <%number%>
6013 Beschreibung: <%description%>
6015 <%end%></programlisting>
6017 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
6018 <function><%foreach%></function>-Block innerhalb einer
6019 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
6020 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
6021 Inhalt zwischen <function><%foreach%></function> und
6022 <function><%end%></function> wiederholt, nicht aber die
6023 komplette Zeile, in der er steht.</para>
6027 <sect2 id="dokumentenvorlagen-und-variablen.markup">
6028 <title>Markup-Code zur Textformatierung innerhalb von
6031 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6032 anders formatiert haben möchte, so ist dies begrenzt möglich.
6033 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6034 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6035 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6036 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6037 (HTML oder PDF über LaTeX) umgesetzt.</para>
6039 <para>Die unterstützen Formatierungen sind:</para>
6043 <term><b>Text</b></term>
6046 <para>Text wird in Fettdruck gesetzt.</para>
6051 <term><i>Text</i></term>
6054 <para>Text wird kursiv gesetzt.</para>
6059 <term><u>Text</u></term>
6062 <para>Text wird unterstrichen.</para>
6067 <term><s>Text</s></term>
6070 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6071 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6076 <term><bullet></term>
6079 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6085 <para>Der Befehl <command><bullet></command> funktioniert
6086 momentan auch nur in Latex-Vorlagen.</para>
6090 <sect1 id="excel-templates">
6091 <title>Excel-Vorlagen</title>
6093 <sect2 id="excel-templates.summary">
6094 <title>Zusammenfassung</title>
6096 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6097 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6101 <sect2 id="excel-templates.usage">
6102 <title>Bedienung</title>
6104 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6105 werden. Die Konfigurationsoption heißt <varname>excel_templates =
6106 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6108 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6109 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6110 werden. In den normalen Verkaufsmasken taucht nun
6111 <constant>Excel</constant> als auswählbares Format auf und kann von da
6112 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6114 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6115 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6116 <filename>sales_quotation.xls</filename> gespeichert.</para>
6119 <sect2 id="excel-templates.syntax">
6120 <title>Variablensyntax</title>
6122 <para>Einfache Syntax:
6123 <command><<varname>></command></para>
6125 <para>Dabei sind <constant><<</constant> und
6126 <constant>>></constant> die Delimiter. Da Excel auf festen
6127 Breiten besteht, kann der Tag künstlich verlängert werden, indem
6128 weitere <constant><</constant> oder <constant>></constant>
6129 eingefügt werden. Der Tag muss nicht symmetrisch sein.
6132 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6134 <para>Um die Limitierung der festen Breite zu reduzieren, können
6135 weitere Variablen in einem Block interpoliert werden. Whitespace wird
6136 dazwishen dann erhalten. Beispiel:</para>
6138 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6140 <para>Die Variablen werden interpoliert, und linksbündig mit
6141 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6142 lang, werden überzählige Zeichen abgeschnitten.</para>
6144 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6145 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6147 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6149 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6150 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6154 <sect2 id="excel-templates.limitations">
6155 <title>Einschränkungen</title>
6157 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6158 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6159 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6160 Text zu ersetzen.</para>
6162 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6163 <command><%if%></command> und
6164 <command><%foreach%></command> nicht vorhanden. Der Delimiter
6165 <constant><% %></constant> kommt in den Headerinformationen
6166 evtl. vor. Deshalb wurde auf den sichereren Delimiter
6167 <constant><<</constant> und <constant>>></constant>
6172 <sect1 id="features.warehouse">
6175 <title>Mandantenkonfiguration Lager</title>
6178 Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6179 Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. Ferner kann jede Position eines Lieferscheins
6180 ein-, bzw. ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele Lager mit beliebig vielen Lagerplätzen abgebildet
6181 werden. Die Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder Einzelposition und das Auswählen dieser Position zu
6182 einem Lager mit Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je nachdem wie die Einstellungen in der
6183 Mandatenkonfiguration gesetzt werden.
6188 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6189 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6190 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6191 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6195 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6196 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6197 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6198 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6199 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6200 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6205 Zusätzliche Funktionshinweise:
6210 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6211 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6212 Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6216 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6217 Stammdaten definiert</option> Wird beim 'Auslagern über
6218 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6219 so wird mit dieser Option einfach der Standardlagerplatz
6227 <sect1 id="features.swiss-charts-of-accounts">
6228 <title>Schweizer Kontenpläne</title>
6230 <para>Seit der Version 3.4.1 stehen in kivitendo 2 Kontenpläne für
6231 den Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6232 Organisationen, die nicht mehrwertsteuerpflichtig sind, und einer
6233 für Firmen, die mehrwertsteuerpflichtig sind.</para>
6235 <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6236 verwendeten KMU-Kontenrahmen und sind mit der Revision des Schweizerischen
6237 Obligationenrechts (OR) vom 1.1.2013 kompatibel, insbesondere
6238 <literal>Art.957a Abs.2</literal>.</para>
6240 <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der aktuellen
6241 Version von kivitendo noch nicht integriert.</para>
6243 <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6244 Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6245 Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen
6246 alle Aufwandskonten editiert werden und dort der Steuersatz auf 0%
6247 gesetzt werden.</para>
6249 <para>So werden bei Kreditorenbuchungen keine Vorsteuern verbucht.</para>
6251 <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6252 Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne
6253 bitte an <literal>empfang@revamp-it.ch</literal> senden.</para>
6256 <sect1 id="features.part_classification">
6257 <title>Artikelklassifizierung</title>
6260 <title>Übersicht</title>
6262 <para>Die Klassifizierung von Artikeln dient einer weiteren Gliederung
6263 um zum Beispiel den Einkauf vom Verkauf zu trennen, gekennzeichnet
6264 durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel (z.B. "E").
6265 Für jede Klassifizierung besteht eine Beschreibung und eine Abkürzung
6266 die normalerweise aus einem Zeichen besteht, kann aber auf mehrere
6267 Zeichen erweitert werden, falls zur Unterscheidung notwendig, sinnvoll
6268 sind jedoch nur maximal 2 Zeichen.</para>
6272 <title>Basisklassifizierung</title>
6274 <para>Als Basisklassifizierungen gibt es</para>
6278 <para>Einkauf</para>
6282 <para>Verkauf</para>
6286 <para>Handelsware</para>
6290 <para>Produktion</para>
6294 <para>- keine - (diese wird bei einer Aktualisierung für alle
6295 existierenden Artikel genommen, gültig für Verkauf und
6300 <para>Es können weitere Klassifizierungen angelegt werden. So kann es
6301 z.B. für separat auszuweisende Artikel folgened Klassen geben:</para>
6305 <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
6309 <para>Material (Verpackungsmaterial) mit Kürzel M</para>
6315 <title>Attribute</title>
6317 <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
6318 alle gleichzeitg gültig sein können</para>
6322 <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
6327 <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
6332 <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
6333 (LaTeX) zusätzliche Variable</para>
6337 <para>Beim separat ausweisen stehen im LaTeX die Variable <emphasis
6338 role="bold"><%non_separate_subtotal%> </emphasis>zur Verfügung,
6339 die alle nicht separat auszuweisenden Artikelkosten saldiert, sowie
6340 pro separat auszuweisenden Klassifizierungen die Variable<emphasis
6341 role="bold"> <%separate_X_subtotal%></emphasis> wobei X das
6342 Kürzel der Klassifizierung ist.</para>
6344 <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
6345 role="bold"><%separate_L_subtotal%></emphasis> und für
6346 Verpackungsmaterial <emphasis
6347 role="bold"><%separate_M_subtotal%> </emphasis>.</para>
6351 <title>Zwei-Zeichen Abkürzung</title>
6353 <para>Der Typ des Artikel und die Klassifizierung werden durch zwei
6354 Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
6355 Typs des Artikel ('P','A','S') , deutch 'W', 'E', und 'D' für Ware
6356 Erzeugnis oder Dienstleistung, ggf. weitere Typen.</para>
6358 <para>Der zweite (und ggf. auch ein dritter Buchstabe, falls nötig)
6359 entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
6361 <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
6362 Erleichterung mit dargestellt.</para>
6366 <sect1 id="features.file_managment">
6367 <title>Dateiverwaltung (Mini-DMS)</title>
6370 <title>Übersicht</title>
6371 <para>Parallel zum alten WebDAV gibt es eine Datei-Management-Sytem, daß Dateien
6372 verschiedenen Typs verwaltet. Dies können</para>
6375 <para>aus ERP-Daten per LaTeX Template erzeugte PDF-Dokumente,</para>
6378 <para>zu bestimmten ERP-Daten gehörende Anhangdateien unterschiedlichen Formats,</para>
6381 <para>per Scanner eingelesene PDF-Dateien,</para>
6384 <para>per Email empfangene Dateianhänge unterschiedlichen Formats,</para>
6387 <para>sowie speziel an Artikel hochgeladene Bilder sein.</para>
6391 <screeninfo>Übersicht</screeninfo>
6394 <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
6401 <title>Struktur</title>
6403 <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:
6407 <para>Dateisystem,</para>
6410 <para>WebDAV,</para>
6413 <para>Schnittstelle zu externem Dokumenten-Management-System,</para>
6416 <para>andere Datenbank,</para>
6419 <para>etc ...</para>
6422 <para>Es gibt unterschiedliche Typen von Dateien, jedem Typ läßt sich in der
6423 Mandantenkonfigurierung ein bestimmtes Backend zuordnen.
6427 <para>"document", das sind entweder generierte,eingescannte oder hochgeladene PDF-Dateien,
6428 die zu bestimmten ERP-Daten (ERP-Objekte, wi z.B. Rechnung, Lieferschein) gehören.</para>
6431 <para>"attachment", zusätzlich hochgeladene Dokumente, die an bestimmte ERP-Objekte angehängt werden,
6432 z.B. technische Zeichnungen,Aufmaße. Diese können auch an Artikeln,
6433 Lieferanten und Kunden hinterlegt sein</para>
6436 <para>"image", Bilder an Artikeln. Diese können auch verkleinert in einer Vorschau (Thumbnail)
6437 angezeigt werden.</para>
6440 <para>Zusätzlich werden in der Datenbank zu den Dateien neben der Zuordnung zu ERP-Objekten, des Dateityps
6441 des Dateinamens und des Backends in dem die Datei gespeichert ist auch die Quelle der Datei notiert:
6445 <para> "created" , vom System erzeugte Dokumente"</para>
6448 <para> "uploaded", hochgeladene Dokumente</para>
6451 <para> "email", vom Mailsystem empfangene Dateien</para>
6454 <para> "scanner[1]", von einem oder mehreren Scannern erzeugte Dateien. Existieren mehrere Scanner,
6455 so sind diese durch unterschiedliche Quellennamen zu definieren</para>
6458 <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es für "attachment" und "image" nur
6459 die Quelle "uploaded". Für "document" gibt es auf jeden Fall die Quelle "created".
6460 Die Quellen "scanner" und "email" müssen derzeit in der Datenbank konfiguriert werden (siehe <xref linkend="file_management.dbconfig"/>.</para>
6464 <title>Anwendung</title>
6465 <para>Die Daten werden bei den ERP-Objekten als extra Reiter dargestellt.
6466 Eine Verkaufsrechnung z.B. hat die
6467 Reiter "Dokumente" und "Dateianhänge.</para>
6469 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6472 <imagedata scale="50" fileref="images/DMS-Anhaenge.png"/>
6476 <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer Datei angezeigt.
6477 Wird eine Datei mit gleichem Namen hochgeladen, so wird eine neue Version der Datei erstellt.
6478 Vorher wird der Anwender durch einen Dialog ob er eine neue Version anlegen will oder
6479 ob er die Datei umbenennen will, falls es eine neue Datei sein soll.</para>
6481 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6484 <imagedata width="100" contentwidth="40" fileref="images/DMS-Anhaenge-hochladen.png"/>
6488 <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
6489 solange in Summe die maximale Größe nicht überschritten wird.
6490 (siehe <xref linkend="file_management.clientconfig"/></para>
6492 <screeninfo>Reiter "Dokumente"</screeninfo>
6495 <imagedata width="500" fileref="images/DMS-Dokumente.png"/>
6499 <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt es nur "erzeugte Dokumente".
6500 Es werden alle Versionen der generierten Datei angezeigt. Für Verkaufsrechnungen kommen keine
6501 anderen Quellen zur Geltung. Werden entsprechend
6502 <xref linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert, so sind diese z.B. bei
6503 Einkaufsrechnungen sichtbar:</para>
6505 <screeninfo>Reiter "Dokumente"</screeninfo>
6508 <imagedata contentwidth="600" fileref="images/DMS-Dokumente-Scanner.png"/>
6512 <para>Statt des Löschens wird hier die Datei zurück zur Quelle verschoben. Somit kann die Datei anschließend
6513 an ein anderes ERP-Objekt angehängt werden.</para>
6514 <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie sind bisher nur bei Bildern relevant.</para>
6518 <title>Konfigurierung</title>
6519 <sect3 id="file_management.clientconfig" xreflabel="Mandantenkonfigurierung">
6520 <title>Mandantenkonfigurierung</title>
6522 <title>Reiter "Features"</title>
6523 <para>Unter dem Reiter <emphasis role="bold">Features</emphasis> im Abschnit Dateimanagement ist
6524 neben dem "alten" WebDAV das Dateimangement general zu- und abschaltbar, sowie die Zuordnung der
6525 Dateitypen zu Backends. Die Löschbarkeit von Dateien sowie die maximale Uploadgröße sind Backend-unabhängig</para>
6527 <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
6530 <imagedata width="500" fileref="images/DMS-ClientConfig.png"/>
6534 <para>Die einzelnen Backends sind einzeln einschaltbar. Spezifische Backend-Konfigurierungen sind hier
6535 noch ergänzbar. Für das Backend Dateisystem ist das Wurzelverzeichnis für den Mandanten einzugeben.</para>
6538 <title>Reiter "Allgemeine Dokumentenanhänge"</title>
6539 <para>Unter dem Reiter <emphasis role="bold">Allgemeine Dokumentenanhänge</emphasis>
6540 kann für alle ERP-Dokumente ( Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und Einkauf )
6541 allgemeingültige Anhänge hochgeladen werden.</para>
6543 <screeninfo>Mandantenkonfig Reiter "Allgemeine Dokumentenanhänge"</screeninfo>
6546 <imagedata width="500" fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"/>
6550 <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die ERP-Dokumente angehängt,
6551 z.B. AGBs oder aktuelle Angebote. Es werden in dem Fall die Daten kopiert, sodaß an den ERP-Dokumenten immer
6552 die Anhänge zum Generierungszeitpunkt eingebettet sind.
6556 <sect3 id="file_management.dbconfig" xreflabel="Datenbank-Konfigurierung">
6557 <title>Datenbank-Konfigurierung</title>
6558 <para>Die zusätzlichen Quellen für email oder ein oder mehrere Scanner sind derzeit vom Administrator
6559 direkt in der Datenbanktablle "user_preferences" einzurichten. Die "value" ist im JSON-Format
6560 mit den jeweiligen Werten des Verzeichnisses und der Beschreibung der Quelle.</para>
6562 id | login | namespace | version | key | value
6563 ----+-----------+--------------+---------+----------+---------------------------
6564 1 | #default# | file_sources | 0.00000 | scanner1 |
6565 {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
6566 2 | #default# | file_sources | 0.00000 | scanner2 |
6567 {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
6568 3 | #default# | file_sources | 0.00000 | emails |
6569 {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
6571 <para>Es ist daran gedacht, statt dem default Eintrag später für bestimmte Benutzer ('login') bestimmte Quellen zuzulassen,
6572 dies wird nach Bedarf implementiert.</para>
6579 <title>Entwicklerdokumentation</title>
6581 <sect1 id="devel.globals" xreflabel="Globale Variablen">
6582 <title>Globale Variablen</title>
6585 <title>Wie sehen globale Variablen in Perl aus?</title>
6587 <para>Globale Variablen liegen in einem speziellen namespace namens
6588 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
6589 globs global und die meisten speziellen Variablen sind...
6592 <para>Daraus ergeben sich folgende Formen:</para>
6596 <term><literal>$main::form</literal></term>
6599 <para>expliziter Namespace "main"</para>
6604 <term><literal>$::form</literal></term>
6607 <para>impliziter Namespace "main"</para>
6612 <term><literal>open FILE, "file.txt"</literal></term>
6615 <para><varname>FILE</varname> ist global</para>
6620 <term><literal>$_</literal></term>
6623 <para>speziell</para>
6628 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
6629 Schlüsselwort wie "<function>global</function>", mit dem man
6630 importieren kann. <function>my</function>, <function>our</function>
6631 und <function>local</function> machen was anderes.</para>
6635 <term><literal>my $form</literal></term>
6638 <para>lexikalische Variable, gültig bis zum Ende des
6644 <term><literal>our $form</literal></term>
6647 <para><varname>$form</varname> referenziert ab hier
6648 <varname>$PACKAGE::form</varname>.</para>
6653 <term><literal>local $form</literal></term>
6656 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
6657 des scopes zurückgesetzt</para>
6664 <title>Warum sind globale Variablen ein Problem?</title>
6666 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
6668 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
6669 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
6670 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
6671 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
6672 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
6673 Datenbankverbindungen, weil die sehr lange zum Initialisieren
6676 <para>Das zweite Problem ist <function>strict</function>. Unter
6677 <function>strict</function> werden alle Variablen die nicht explizit
6678 mit <function>Package</function>, <function>my</function> oder
6679 <function>our</function> angegeben werden als Tippfehler angemarkert,
6680 dies hat, seit der Einführung, u.a. schon so manche langwierige
6681 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
6682 angegeben werden, werden die nicht geprüft, und somit kann sich
6683 schnell ein Tippfehler einschleichen.</para>
6687 <title>Kanonische globale Variablen</title>
6689 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
6690 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
6691 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
6692 umhergereicht werden.</para>
6694 <para>Diese Variablen sind im Moment die folgenden neun:</para>
6698 <para><varname>$::form</varname></para>
6702 <para><varname>%::myconfig</varname></para>
6706 <para><varname>$::locale</varname></para>
6710 <para><varname>$::lxdebug</varname></para>
6714 <para><varname>$::auth</varname></para>
6718 <para><varname>$::lx_office_conf</varname></para>
6722 <para><varname>$::instance_conf</varname></para>
6726 <para><varname>$::dispatcher</varname></para>
6730 <para><varname>$::request</varname></para>
6734 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
6735 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
6736 Eigenschaften (Konventionen):</para>
6739 <title>$::form</title>
6743 <para>Ist ein Objekt der Klasse
6744 "<classname>Form</classname>"</para>
6748 <para>Wird nach jedem Request gelöscht</para>
6752 <para>Muss auch in Tests und Konsolenscripts vorhanden
6757 <para>Enthält am Anfang eines Requests die Requestparameter vom
6762 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
6763 cachen, das wird aber momentan absichtlich zerstört</para>
6767 <para><varname>$::form</varname> wurde unter <productname>SQL
6768 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
6769 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
6770 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
6771 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
6772 <function>IS->retrieve_customer()</function> in Sicherheit
6775 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
6776 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
6777 3552, Stand version 2.7beta), um dies hinterher wieder auf den
6778 richtigen Wert zu setzen:</para>
6780 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
6781 $::myconfig{numberformat} = $numberformat;
6782 # (...) div Berechnungen
6783 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
6785 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
6786 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
6787 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
6788 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
6789 Es geht ziemlich sicher etwas kaputt.</para>
6791 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
6792 in den <productname>Template::Toolkit</productname> Templates
6793 außerhalb der Controller: der Ausdruck <function>[% var
6794 %]</function> greift auf <varname>$::form->{var}</varname> zu.
6795 Unter Controllern ist der Standard Scope anders, da lautet der
6796 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
6797 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
6798 <function><%var%></function> zeigt auf
6799 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
6800 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
6803 <programlisting>[%- IF business %]
6804 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
6805 [%- END %]</programlisting>
6807 <para>Entweder wird hier dann $::form->{business} ausgewertet
6808 oder aber der Funktion
6809 <function>$form->parse_html_template</function> wird explizit
6810 noch ein zusätzlicher Hash übergeben, der dann auch in den
6811 (Web-)Templates zu Verfügung steht, bspw. so:</para>
6813 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
6815 <para>Innerhalb von Schleifen wird
6816 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
6817 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
6818 welches über alle Positionen eines Lieferscheins in Schleife
6821 <programlisting>for $i (1 .. $form->{rowcount}) {
6823 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
6824 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
6825 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
6831 <title>%::myconfig</title>
6835 <para>Das einzige Hash unter den globalen Variablen</para>
6839 <para>Wird spätestens benötigt wenn auf die Datenbank
6840 zugegriffen wird</para>
6844 <para>Wird bei jedem Request neu erstellt.</para>
6848 <para>Enthält die Userdaten des aktuellen Logins</para>
6852 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
6853 extern serialisiert werden, weil da auch der Datenbankzugriff
6854 für diesen user drinsteht.</para>
6858 <para>Enthält unter anderem Datumsformat dateformat und Nummernformat numberformat</para>
6862 <para>Enthält Datenbankzugriffinformationen</para>
6866 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
6867 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
6868 aktuellen Users entscheiden müssen, befragen
6869 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
6870 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
6871 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
6872 Informationen über den Benutzer die über die
6873 Administrator-Schnittstelle eingegeben wurden.</para>
6877 <title>$::locale</title>
6881 <para>Objekt der Klasse "Locale"</para>
6885 <para>Wird pro Request erstellt</para>
6889 <para>Muss auch für Tests und Scripte immer verfügbar
6894 <para>Cached intern über Requestgrenzen hinweg benutzte
6899 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
6900 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
6904 <title>$::lxdebug</title>
6908 <para>Objekt der Klasse "LXDebug"</para>
6912 <para>Wird global gecached</para>
6916 <para>Muss immer verfügbar sein, in nahezu allen
6921 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
6922 bereit, wie "<function>enter_sub</function>" und
6923 "<function>leave_sub</function>", mit denen in den alten Modulen ein
6924 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
6925 der man die Wallclockzeit seit Requeststart loggen kann, sowie
6926 "<function>message</function>" und "<function>dump</function>" mit
6927 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
6930 <para>Beispielsweise so:</para>
6932 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
6933 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
6937 <title>$::auth</title>
6941 <para>Objekt der Klasse "SL::Auth"</para>
6945 <para>Wird global gecached</para>
6949 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
6953 <para>Wird nach jedem Request resettet.</para>
6957 <para><varname>$::auth</varname> stellt Funktionen bereit um die
6958 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
6959 vom aktuellen User abhängen wird das Objekt aus
6960 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
6961 Request kurz resettet.</para>
6963 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
6964 Dessen Einstellungen können über
6965 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
6966 ist ein Hash mit den Werten aus der Tabelle
6967 <literal>auth.clients</literal>.</para>
6971 <title>$::lx_office_conf</title>
6975 <para>Objekt der Klasse
6976 "<classname>SL::LxOfficeConf</classname>"</para>
6980 <para>Global gecached</para>
6984 <para>Repräsentation der
6985 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
6989 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
6990 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
6991 das Programm die Konfiguration ändern kann oder sollte.</para>
6993 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
6994 Debug- und Trace-Log-Datei wie folgt konfiguriert und
6997 <programlisting>[debug]
6998 file_name = /tmp/kivitendo-debug.log</programlisting>
7000 <para>ist der Key <varname>file</varname> im Programm als
7001 <varname>$::lx_office_conf->{debug}{file}</varname>
7005 <para>Zugriff auf die Konfiguration erfolgt im Moment über
7006 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
7011 <title>$::instance_conf</title>
7015 <para>Objekt der Klasse
7016 "<classname>SL::InstanceConfiguration</classname>"</para>
7020 <para>wird pro Request neu erstellt</para>
7024 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
7025 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
7026 ist hier eine Mandantendatenbank. Beispielsweise überprüft
7027 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
7028 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
7032 <title>$::dispatcher</title>
7036 <para>Objekt der Klasse
7037 "<varname>SL::Dispatcher</varname>"</para>
7041 <para>wird pro Serverprozess erstellt.</para>
7045 <para>enthält Informationen über die technische Verbindung zum
7050 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
7051 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
7052 Objekt untergebracht.</para>
7056 <title>$::request</title>
7060 <para>Hashref (evtl später Objekt)</para>
7064 <para>Wird pro Request neu initialisiert.</para>
7068 <para>Keine Unterstruktur garantiert.</para>
7072 <para><varname>$::request</varname> ist ein generischer Platz um
7073 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
7074 at a distance benutzt werden, sondern um lokales memoizing zu
7075 ermöglichen, das garantiert am Ende des Requests zerstört
7078 <para>Vieles von dem, was im moment in <varname>$::form</varname>
7079 liegt, sollte eigentlich hier liegen. Die groben
7080 Differentialkriterien sind:</para>
7084 <para>Kommt es vom User, und soll unverändert wieder an den
7085 User? Dann <varname>$::form</varname>, steht da eh schon</para>
7089 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
7090 Requests gebraucht werden? Dann
7091 <varname>$::request</varname></para>
7095 <para>Muss ich von anderen Teilen des Programms lesend drauf
7096 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
7097 Wrappermethode</para>
7104 <title>Ehemalige globale Variablen</title>
7106 <para>Die folgenden Variablen waren einmal im Programm, und wurden
7110 <title>$::cgi</title>
7114 <para>war nötig, weil cookie Methoden nicht als
7115 Klassenfunktionen funktionieren</para>
7119 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
7120 Klassennamespace gehalten wird und über Requestgrenzen
7125 <para>liegt jetzt unter
7126 <varname>$::request->{cgi}</varname></para>
7132 <title>$::all_units</title>
7136 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
7137 ein paar hundert mal pro Request eine Liste der Einheiten
7138 brauchen, und de als Parameter durch einen Riesenstack von
7139 Funktionen geschleift werden müssten.</para>
7143 <para>Liegt jetzt unter
7144 <varname>$::request->{cache}{all_units}</varname></para>
7149 <function>AM->retrieve_all_units()</function> gesetzt oder
7156 <title>%::called_subs</title>
7160 <para>wurde benutzt um callsub deep recursions
7165 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
7166 möglichen Rekursioenen darstellt, und da nie welche
7171 <para>komplette recursion protection wurde entfernt.</para>
7178 <sect1 id="devel.fcgi">
7179 <title>Entwicklung unter FastCGI</title>
7181 <sect2 id="devel.fcgi.general">
7182 <title>Allgemeines</title>
7184 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
7185 werden, muss der Webserver neu gestartet werden.</para>
7187 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
7188 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
7189 müssen folgende Aspekte beachtet werden.</para>
7192 <sect2 id="devel.fcgi.exiting">
7193 <title>Programmende und Ausnahmen</title>
7195 <para>Betrifft die Funktionen <function>warn</function>,
7196 <function>die</function>, <function>exit</function>,
7197 <function>carp</function> und <function>confess</function>.</para>
7199 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
7200 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
7201 am Laufen zu halten. Man kann mit <function>die</function>,
7202 <function>confess</function> oder <function>carp</function> Fehler
7203 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
7204 eigene <function>$::form-</function>error()> tut im Prinzip das
7205 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
7206 <function>exit</function> hingegen werden nicht abgefangen.
7207 <function>warn</function> wird direkt nach STDERR, also in Server Log
7208 eine Nachricht schreiben (sofern in der Konfiguration nicht die
7209 Warnungen in das kivitendo Log umgeleitet wurden), und
7210 <function>exit</function> wird die Ausführung beenden.</para>
7212 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
7213 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
7214 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
7215 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
7218 <sect2 id="devel.fcgi.globals">
7219 <title>Globale Variablen</title>
7221 <para>Um zu vermeiden, dass Informationen von einem Request in einen
7222 anderen gelangen, müssen alle globalen Variablen vor einem Request
7223 sauber initialisiert werden. Das ist besonders wichtig im
7224 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
7225 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
7228 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
7229 abgetrennten Block, der alle kanonischen globalen Variablen listet und
7230 erklärt. Bitte keine anderen einführen ohne das sauber zu
7231 dokumentieren.</para>
7233 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
7234 man sicher geht, dass man die richtige erwischt.</para>
7237 <sect2 id="devel.fcgi.performance">
7238 <title>Performance und Statistiken</title>
7240 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
7241 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
7242 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
7243 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
7244 sind es je nach Menge der definierten Variablen 1-2s. Ab der
7245 Moose/Rose::DB Version sind es 5-6s.</para>
7247 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
7248 den kritischen Pfaden, unter 0,15 sonst.</para>
7252 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
7253 <title>SQL-Upgradedateien</title>
7255 <sect2 id="db-upgrade-files.introduction"
7256 xreflabel="Einführung in die Datenbank-Upgradedateien">
7257 <title>Einführung</title>
7259 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
7260 gesteuert, die sich im Verzeichnis
7261 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
7262 muss pro Datenbankupgrade eine Datei existieren, die neben den
7263 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
7264 Kontrollinformationen enthält.</para>
7266 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
7267 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
7268 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
7269 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
7270 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
7271 Versionsnummern braucht.</para>
7273 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
7274 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
7275 führt diese nicht erneut aus. Dazu dient die Tabelle
7276 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
7277 angelegt wird.</para>
7280 <sect2 id="db-upgrade-files.format"
7281 xreflabel="Format der Upgradedateien">
7282 <title>Format der Kontrollinformationen</title>
7284 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
7285 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
7286 hat dabei das folgende Format:</para>
7288 <para>Für SQL-Upgradedateien:</para>
7290 <programlisting>-- @key: value</programlisting>
7292 <para>Für Perl-Upgradedateien:</para>
7294 <programlisting># @key: value</programlisting>
7296 <para>Leerzeichen vor "<varname>value</varname>" werden
7299 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
7303 <term><varname>tag</varname></term>
7306 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
7307 Dieser "tag" kann von anderen Kontrolldateien in ihren
7308 Abhängigkeiten verwendet werden (Schlüsselwort
7309 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
7310 in der Datenbank eingetragen wird.</para>
7312 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
7313 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
7315 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
7316 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
7317 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
7323 <term><varname>charset</varname></term>
7326 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
7327 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
7328 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
7329 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
7330 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
7331 hingegen müssen immer in UTF-8 encodiert sein und sollten
7332 demnach auch ein "<literal>use utf8;</literal>"
7338 <term><varname>description</varname></term>
7341 <para>Benötigt. Eine Beschreibung, was in diesem Update
7342 passiert. Diese wird dem Benutzer beim eigentlichen
7343 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
7344 sein sollte, sollte die Beschreibung auf Deutsch
7350 <term><varname>depends</varname></term>
7353 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
7354 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
7355 dass die in dieser Liste aufgeführten Scripte bereits
7356 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
7358 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
7359 Script "b" existiert, das von Änderungen in "a" abhängt, und
7360 eine neue Kontrolldatei für "c" erstellt wird, die von
7361 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
7362 Tag "b" als Abhängigkeit zu definieren.</para>
7364 <para>Es ist nicht erlaubt, sich selbst referenzierende
7365 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
7366 und "c" -> "a").</para>
7371 <term><varname>priority</varname></term>
7374 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
7375 der Scripte ausgeführt werden, die die gleichen
7376 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
7377 der Wert 1000 benutzt.</para>
7379 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
7380 "depends" benutzt werden. kivitendo sortiert die auszuführenden
7381 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
7382 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
7383 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
7384 dann "y", dann "z"), dann nach der Priorität und bei gleicher
7385 Priorität alphabetisch nach dem "tag".</para>
7390 <term><varname>ignore</varname></term>
7393 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
7394 Skript bei der Anmeldung ignoriert und entsprechend nicht
7401 <sect2 id="db-upgrade-files.format-perl-files"
7402 xreflabel="Format von Perl-Upgradedateien">
7403 <title>Format von in Perl geschriebenen
7404 Datenbankupgradescripten</title>
7406 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
7407 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
7408 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
7410 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
7411 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
7412 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
7413 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
7414 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
7415 aufgerufen wird.</para>
7417 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
7418 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
7419 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
7420 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
7421 "<literal>SL::DBUpgrade2::tag</literal>".</para>
7423 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
7424 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
7425 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
7427 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
7430 <programlisting># @tag: beispiel-upgrade-file42
7431 # @description: Ein schönes Beispielscript
7432 # @depends: release_3_1_0
7433 package SL::DBUpgrade2::beispiel_upgrade_file42;
7438 use parent qw(SL::DBUpgrade2::Base);
7443 # hier Aktionen ausführen
7452 <sect2 id="db-upgrade-files.dbupgrade-tool"
7453 xreflabel="Hilfsscript dbupgrade2_tool.pl">
7454 <title>Hilfsscript dbupgrade2_tool.pl</title>
7456 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
7457 existiert ein Hilfsscript namens
7458 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
7459 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
7460 liest alle Datenbankupgradescripte aus dem Verzeichnis
7461 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
7462 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
7463 von der Kommandozeile überprüft werden können.</para>
7465 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
7466 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
7467 sich aber auch Informationen auf verschiedene Art ausgeben
7472 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
7473 --list</command>"</para>
7475 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
7476 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
7477 würde. Es werden neben der Listenposition der Tag, die
7478 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
7482 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
7483 --tree</command>"</para>
7485 <para>Listet alle Tags in Baumform basierend auf den
7486 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
7487 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
7488 beim übergeordneten Script als Abhängigkeit eingetragen
7492 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
7493 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
7494 --rtree</command>"</para>
7496 <para>Listet alle Tags in Baumform basierend auf den
7497 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
7498 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
7499 die das übergeordnete Script als Abhängigkeit eingetragen
7504 <para>Baumform mit Postscriptausgabe:
7505 "<command>./scripts/dbupgrade2_tool.pl
7506 --graphviz</command>"</para>
7508 <para>Benötigt das Tool "<command>graphviz</command>", um mit
7509 seiner Hilfe die <link
7510 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
7511 Baumform</link> in eine Postscriptdatei namens
7512 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
7513 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
7514 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
7515 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
7520 <para>Scripte, von denen kein anderes Script abhängt:
7521 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
7523 <para>Listet die Tags aller Scripte auf, von denen keine anderen
7524 Scripte abhängen.</para>
7530 <sect1 id="translations-languages" xreflabel="Translations and languages">
7531 <title>Translations and languages</title>
7533 <sect2 id="translations-languages.introduction"
7534 xreflabel="Introduction to translations and languages">
7535 <title>Introduction</title>
7538 <para>Dieser Abschnitt ist in Englisch geschrieben, um
7539 internationalen Übersetzern die Arbeit zu erleichtern.</para>
7542 <para>This section describes how localization packages in kivitendo
7543 are built. Currently the only language fully supported is German, and
7544 since most of the internal messages are held in English the English
7545 version is usable too.</para>
7548 <sect2 id="translations-languages.character-set"
7549 xreflabel="Character set">
7550 <title>Character set</title>
7552 <para>All files included in a language pack must use UTF-8 as their
7556 <sect2 id="translations-languages.file-structure"
7557 xreflabel="File structure">
7558 <title>File structure</title>
7560 <para>The structure of locales in kivitendo is:</para>
7562 <programlisting>kivitendo/locale/<langcode>/</programlisting>
7564 <para>where <langcode> stands for an abbreviation of the
7565 language package. The builtin packages use two letter <ulink
7566 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
7567 but the actual name is not relevant for the program and can easily be
7569 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
7570 tags</ulink> (i.e. "en_GB"). In fact the original language packages
7571 from SQL Ledger are named in this way.</para>
7573 <para>In such a language directory the following files are
7578 <term>LANGUAGE</term>
7581 <para>This file is mandatory.</para>
7583 <para>The <filename>LANGUAGE</filename> file contains the self
7584 descripted name of the language. It should contain a native
7585 representation first, and in parenthesis an english translation
7586 after that. Example:</para>
7588 <programlisting>Deutsch (German)</programlisting>
7596 <para>This file is mandatory.</para>
7598 <para>The central translation file. It is essentially an inline
7599 Perl script autogenerated by <command>locales.pl</command>. To
7600 generate it, generate the directory and the two files mentioned
7601 above, and execute the following command:</para>
7603 <programlisting>scripts/locales.pl <langcode></programlisting>
7605 <para>Otherwise you can simply copy one of the other languages.
7606 You will be told how many are missing like this:</para>
7608 <programlisting>$ scripts/locales.pl en
7609 English - 0.6% - 2015/2028 missing</programlisting>
7611 <para>A file named "<filename>missing</filename>" will be
7612 generated and can be edited. You can also edit the
7613 "<filename>all</filename>" file directly. Edit everything you
7614 like to fit the target language and execute
7615 <command>locales.pl</command> again. See how the missing words
7621 <term>Num2text</term>
7624 <para>Legacy code from SQL Ledger. It provides a means for
7625 numbers to be converted into natural language, like
7626 <literal>1523 => one thousand five hundred twenty
7627 three</literal>. If you want to provide it, it must be inlinable
7628 Perl code which provides a <function>num2text</function> sub. If
7629 an <function>init</function> sub exists it will be executed
7632 <para>Only used in the check and receipt printing module.</para>
7637 <term>special_chars</term>
7640 <para>kivitendo comes with a lot of interfaces to different
7641 formats, some of which are rather picky with their accepted
7642 charset. The <filename>special_chars</filename> file contains a
7643 listing of chars not suited for different file format and
7644 provides substitutions. It is written in "Simple Ini" style,
7645 containing a block for every file format.</para>
7647 <para>First entry should be the order of substitution for
7648 entries as a whitespace separated list. All entries are
7649 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
7650 and <literal>\\</literal> all work.</para>
7652 <para>After that every entry is a special char that should be
7653 translated when writing text into such a file.</para>
7655 <para>Example:</para>
7657 <programlisting>[Template/XML]
7658 order=& < > \n
7662 \n=<br></programlisting>
7664 <para>Note the importance of the order in this example.
7665 Substituting < and > befor & would lead to $gt; become
7668 <para>For a list of valid formats, see the German
7669 <filename>special_chars</filename> entry. As of this writing the
7670 following are recognized:</para>
7672 <programlisting>HTML
7677 Template/OpenDocument
7678 filenames</programlisting>
7680 <para>The last of which is very machine dependant. Remember that
7681 a lot of characters are forbidden by some filesystems, for
7682 example MS Windows doesn't like ':' in its files where Linux
7683 doesn't mind that. If you want the files created with your
7684 language pack to be portable, find all chars that could cause
7690 <term>missing</term>
7693 <para>This file is not a part of the language package
7696 <para>This is a file generated by
7697 <command>scripts/locales.pl</command> while processing your
7698 locales. It's only to have the missing entries singled out and
7699 does not belong to a language package.</para>
7707 <para>This file is not a part of the language package
7710 <para>Another file generated by
7711 <command>scripts/locales.pl</command>. If for any reason a
7712 translation does not appear anymore and can be deleted, it gets
7713 moved here. The last 50 or so entries deleted are saved here in
7714 case you made a typo, so that you don't have to translate
7715 everything again. If a tranlsation is missing, the lost file is
7716 checked first. If you maintain a language package, you might
7717 want to keep this safe somewhere.</para>
7722 <term>more/all</term>
7725 <para>This subdir and file is not a part of the language package
7728 <para>If the directory more exists and contains a file called
7729 all it will be parsed in addition to the mandatory all (see
7730 above). The file is useful if you want to change some
7731 translations for the current installation without conflicting
7732 further upgrades. The file is not autogenerated and has the same
7733 format as the all, but needs another key (more_texts). See the
7734 german translation for an example or copy the following code:
7737 # -*- coding: utf-8; -*-
7742 # These are additional texts for custom translations.
7743 # The format is the same as for the normal file all, only
7744 # with another key (more_texts instead of texts).
7745 # The file has the form of 'english text' => 'foreign text',
7747 $self->{more_texts} = {
7749 'Ship via' => 'Terms of delivery',
7750 'Shipping Point' => 'Delivery time',
7752 </programlisting></para>
7759 <sect1 id="devel.testsuite">
7760 <title>Die kivitendo-Test-Suite</title>
7762 <sect2 id="devel.testsuite.intro">
7763 <title>Einführung</title>
7765 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
7766 basiert auf dem Standard-Perl-Modul
7767 <literal>Test::More</literal>.</para>
7769 <para>Die grundlegenden Fakten sind:</para>
7773 <para>Alle Tests liegen im Unterverzeichnis
7774 <filename>t/</filename>.</para>
7778 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
7779 enthält einen oder mehrere Testfälle.</para>
7783 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
7784 Es sind selbstständig ausführbare Perl-Scripte.</para>
7788 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
7789 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
7790 auf <literal>.t</literal> endet.</para>
7795 <sect2 id="devel.testsuite.prerequisites">
7796 <title>Voraussetzungen</title>
7798 <para>Für die Ausführung werden neben den für kivitendo eh schon
7799 benötigten Module noch weitere Perl-Module benötigt. Diese
7804 <para><literal>Test::Deep</literal> (Debian-Paketname:
7805 <literal>libtest-deep-perl</literal>; Fedora:
7806 <literal>perl-Test-Deep</literal>; openSUSE:
7807 <literal>perl-Test-Deep</literal>)</para>
7811 <para><literal>Test::Exception</literal> (Debian-Paketname:
7812 <literal>libtest-exception-perl</literal>; Fedora:
7813 <literal>perl-Test-Exception</literal>; openSUSE:
7814 <literal>perl-Test-Exception</literal>)</para>
7818 <para><literal>Test::Output</literal> (Debian-Paketname:
7819 <literal>libtest-output-perl</literal>; Fedora:
7820 <literal>perl-Test-Output</literal>; openSUSE:
7821 <literal>perl-Test-Output</literal>)</para>
7825 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
7826 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
7827 kann für frühere Versionen aus dem <ulink
7828 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
7832 <para><literal>LWP::Simple</literal> aus dem Paket
7833 <literal>libwww-perl</literal> (Debian-Panetname:
7834 <literal>libwww-perl</literal>; Fedora:
7835 <literal>perl-libwww-perl</literal>; openSUSE:
7836 <literal>perl-libwww-perl</literal>)</para>
7840 <para><literal>URI::Find</literal> (Debian-Panetname:
7841 <literal>liburi-find-perl</literal>; Fedora:
7842 <literal>perl-URI-Find</literal>; openSUSE:
7843 <literal>perl-URI-Find</literal>)</para>
7847 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
7848 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
7849 müssen in der Konfigurationsdatei im Abschnit
7850 <literal>testing/database</literal> Datenbankverbindungsparameter
7851 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
7852 Recht haben, Datenbanken anzulegen und zu löschen.</para>
7855 <sect2 id="devel.testsuite.execution">
7856 <title>Existierende Tests ausführen</title>
7858 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
7859 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
7860 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
7861 <filename>t/test.pl</filename>.</para>
7863 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
7864 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
7865 kivitendo-Basisverzeichnis heraus ausführen.</para>
7867 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
7868 an <filename>t/test.pl</filename>. Beispielsweise:</para>
7870 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
7873 <sect2 id="devel.testsuite.meaning_of_scripts">
7874 <title>Bedeutung der verschiedenen Test-Scripte</title>
7876 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
7877 Programmierstil. Einige besonders zu erwähnende, weil auch während der
7878 Entwicklung nützliche Tests sind:</para>
7882 <para><filename>t/001compile.t</filename> -- compiliert alle
7883 Quelldateien und bricht bei Fehlern sofort ab</para>
7887 <para><filename>t/002goodperl.t</filename> -- überprüft alle
7888 Perl-Dateien auf Anwesenheit von '<literal>use
7889 strict</literal>'-Anweisungen</para>
7893 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
7894 <function>system()</function> und <function>exec()</function> auf
7899 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
7900 Tab-Zeichen enthalten</para>
7904 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
7905 Rechtschreibfehlern</para>
7909 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
7910 Dokumentation im POD-Format auf Gültigkeit</para>
7914 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
7915 einzelner Funktionen und Module.</para>
7918 <sect2 id="devel.testsuite.create_new">
7919 <title>Neue Test-Scripte erstellen</title>
7921 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
7922 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
7923 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
7926 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
7927 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
7930 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
7935 <para>Überprüfung auf fehlende symbolische Links</para>
7939 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
7940 gewissen Einschränkungen wie das Erlauben von deutschen
7945 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
7949 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
7953 <para>Test, ob alle zu übersetzenden Strings in
7954 <filename>locale/de/all</filename> vorhanden sind</para>
7958 <para>Test, ob alle Webseiten-Templates in
7959 <filename>templates/webpages</filename> mit vom Perl-Modul
7960 <literal>Template</literal> compiliert werden können</para>
7965 <sect3 id="devel.testsuite.directory_and_test_names">
7966 <title>Konvention für Verzeichnis- und Dateinamen</title>
7968 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
7969 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
7970 und ihnen soweit es geht folgen:</para>
7974 <para>Die Dateiendung muss <filename>.t</filename>
7979 <para>Namen sind englisch, komplett klein geschrieben und
7980 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
7981 <filename>bad_function_params.t</filename>).</para>
7985 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
7986 benannt sein, mit dem sich die Scripte darin befassen
7987 (beispielsweise <filename>background_jobs</filename> für Tests
7988 rund um Hintergrund-Jobs).</para>
7992 <para>Test-Scripte sollten einen überschaubaren Bereich von
7993 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
7994 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
7995 Test-Scripte schreiben.</para>
8000 <sect3 id="devel.testsuite.minimal_example">
8001 <title>Minimales Skelett für eigene Scripte</title>
8003 <para>Der folgenden Programmcode enthält das kleinstmögliche
8004 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
8007 <programlisting>use Test::More tests => 0;
8011 use Support::TestSetup;
8013 Support::TestSetup::login();</programlisting>
8015 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
8016 benötigt (Stichwort: alle globalen Variablen wie
8017 <varname>$::auth</varname>, <varname>$::form</varname> oder
8018 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
8019 <filename>config/kivitendo.conf</filename> im Abschnitt
8020 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
8021 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
8023 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
8024 kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
8025 weggelassen werden, was die Ausführungszeit des Scripts leicht
8031 <sect1 id="devel.style-guide">
8032 <title>Stil-Richtlinien</title>
8034 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
8035 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
8036 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
8037 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
8039 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
8042 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
8043 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
8048 <para>Es werden keine echten Tabs sondern Leerzeichen
8053 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
8055 <programlisting>foreach my $row (@data) {
8057 # do something with $row
8061 $row->{modules} = MODULE->retrieve(
8062 id => $row->{id},
8063 date => $use_now ? localtime() : $row->{time},
8067 $report->add($row);
8072 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
8073 Zeile wie der letzte Befehl. Beispiele:</para>
8075 <programlisting>sub debug {
8081 <programlisting>if ($form->{item_rows} > 0) {
8087 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
8088 der Befehl / die öffnende schließende Klammer, die den Block
8089 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
8090 Beispiele wie bei 3. gelten.</para>
8094 <para>Die Wörter "<function>else</function>",
8095 "<function>elsif</function>", "<function>while</function>" befinden
8096 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
8099 <programlisting>if ($form->{sum} > 1000) {
8101 } elsif ($form->{sum} > 0) {
8109 } until ($a > 0);</programlisting>
8113 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
8114 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
8115 und grep-ähnliche Operatoren. Beispiel:</para>
8117 <programlisting>$main::lxdebug->message("Could not find file.");
8118 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
8122 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
8124 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
8125 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
8126 Blöcke schon. Beispiel:</para>
8128 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
8133 $form->{sum} += $form->{"row_$i"};
8134 $form->{ $form->{index} } += 1;
8136 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
8140 <para>Mehrzeilige Befehle</para>
8144 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
8145 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
8146 werden, in der die ersten Funktionsparameter in der ersten Zeile
8147 stehen. Beispiel:</para>
8149 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
8150 $form->{some_col_value});</programlisting>
8154 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
8155 besten in einer übersichtlichen Tabellenstruktur organisiert
8156 wird. Beispiel:</para>
8158 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
8159 : $form->{oldcount} ? $form->{oldcount} + 1
8160 : $form->{rowcount} - $form->{rowbase};</programlisting>
8166 <para>Kommentare</para>
8170 <para>Kommentare, die alleine in einer Zeile stehen, sollten
8171 soweit wie der Code eingerückt sein.</para>
8175 <para>Seitliche hängende Kommentare sollten einheitlich
8176 formatiert werden.</para>
8180 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
8181 auf Englisch zu verfassen. So wie ich keine Lust habe,
8182 französischen Quelltext zu lesen, sollte auch der kivitendo
8183 Quelltext für nicht-Deutschsprachige lesbar sein.
8186 <programlisting>my $found = 0;
8194 $i = 0 # initialize $i
8196 $i *= $const; # do something crazy
8197 $i = $n; # recover $i</programlisting>
8203 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
8204 Interpolation gewünscht ist. Beispiel:</para>
8206 <programlisting>$form->{sum} = 0;
8207 $form->{"row_$i"} = $form->{"row_$i"} - 5;
8208 $some_hash{42} = 54;</programlisting>
8212 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
8213 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
8214 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
8215 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
8217 <para>Als Beispiel sei die Funktion
8218 <function>print_options</function> aus
8219 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
8223 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
8224 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
8227 <para>Emacs und vim haben beide recht einfache Methoden zur
8228 Entfernung von trailing whitespace. Emacs kennt das Kommande
8229 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
8230 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
8231 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
8236 <para>Es wird kein <command>perltidy</command> verwendet.</para>
8238 <para>In der Vergangenheit wurde versucht,
8239 <command>perltidy</command> zu verwenden, um einen einheitlichen
8240 Stil zu erlangen. Es hat sich aber gezeigt, dass
8241 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
8242 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
8243 den Interessierten sind hier die
8244 <command>perltidy</command>-Optionen, die grob den beschriebenen
8245 Richtlinien entsprechen:</para>
8247 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
8248 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
8249 -lp -vt=1 -vtc=1</programlisting>
8253 <para><varname>STDERR</varname> ist tabu. Unkonditionale
8254 Debugmeldungen auch.</para>
8256 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
8257 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
8258 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
8260 <para>Die <classname>LXDebug</classname>-Methode
8261 "<function>message</function>" nimmt als ersten Paramter außerdem
8262 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
8263 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
8264 und werden in den meisten Fällen auch vom Repository
8265 zurückgewiesen.</para>
8269 <para>Alle neuen Module müssen use strict verwenden.</para>
8271 <para><varname>$form</varname>, <varname>$auth</varname>,
8272 <varname>$locale</varname>, <varname>$lxdebug</varname> und
8273 <varname>%myconfig</varname> werden derzeit aus dem main package
8274 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
8275 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
8280 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
8281 <title>Dokumentation erstellen</title>
8283 <sect2 id="devel.build-doc.introduction">
8284 <title>Einführung</title>
8286 <para>Diese Dokumentation ist in <productname>DocBook</productname>
8287 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
8288 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
8289 Editor nutzt, der spezielle Unterstützung für
8290 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
8291 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
8292 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
8296 <sect2 id="devel.build-doc.required-software">
8297 <title>Benötigte Software</title>
8299 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
8300 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
8301 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
8302 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
8303 <command>scripts/build_doc.sh</command>.</para>
8305 <para>Das Script benötigt zur Konvertierung verschiedene
8306 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
8312 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
8313 in einer halbwegs aktuellen Version</para>
8317 <para>Das Java-Build-System <ulink
8318 url="http://ant.apache.org/">Apache Ant</ulink></para>
8322 <para>Das Dokumentations-System Dobudish für
8323 <productname>DocBook</productname> 4.5, eine Zusammenstellung
8324 diverser Stylesheets und Grafiken zur Konvertierung von
8325 <productname>DocBook</productname> XML in andere Formate. Das
8326 Paket, das benötigt wird, ist zum Zeitpunkt der
8327 Dokumentationserstellung
8328 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
8329 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
8334 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
8335 sind auf allen gängigen Plattformen verfügbar. Beispiel für
8336 Debian/Ubuntu:</para>
8338 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
8340 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
8341 <filename>doc/build</filename> entpackt werden. Beispiel unter der
8342 Annahme, das <productname>Dobudish</productname> in
8343 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
8345 <programlisting>cd doc/build
8346 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
8349 <sect2 id="devel.build-doc.build">
8350 <title>PDFs und HTML-Seiten erstellen</title>
8352 <para>Die eigentliche Konvertierung erfolgt nach Installation der
8353 benötigten Software mit einem einfachen Aufruf direkt aus dem
8354 kivitendo-Installationsverzeichnis heraus:</para>
8356 <programlisting>./scripts/build_doc.sh</programlisting>
8359 <sect2 id="devel.build-doc.repository">
8360 <title>Einchecken in das Git-Repository</title>
8362 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
8363 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
8364 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
8365 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
8367 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
8368 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob