1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <book id="kivitendo-documentation" lang="de">
5 <title>kivitendo 3.5.0-beta: Installation, Konfiguration, Entwicklung</title>
7 <chapter id="Aktuelle-Hinweise">
8 <title>Aktuelle Hinweise</title>
10 <para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>
14 <para>im Community-Forum: <ulink
15 url="https://forum.kivitendo.de:32443">https://forum.kivitendo.de:32443</ulink></para>
19 <para>im Kunden-Forum: <ulink
20 url="http://redmine.kivitendo-premium.de/projects/forum/boards/">http://redmine.kivitendo-premium.de/projects/forum/boards/</ulink></para>
24 <para>in der doc/UPGRADE Datei im doc-Verzeichnis der
29 <para>Im Schulungs- und Dienstleistungsangebot der entsprechenden
30 kivitendo-Partner: <ulink
31 url="http://www.kivitendo.de/partner.html">http://www.kivitendo.de/partner.html</ulink></para>
37 <title>Installation und Grundkonfiguration</title>
39 <sect1 id="Installation-Übersicht">
40 <title>Übersicht</title>
42 <para>Die Installation von kivitendo umfasst mehrere Schritte. Die
43 folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
44 Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit
45 minimalen Features möglichst schnell zum Laufen zu kriegen.</para>
49 <para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo
50 benötigt gewisse Ressourcen und benutzt weitere Programme. Das
51 Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert
52 diese. Auch die Liste der benötigten Perl-Module befindet sich
57 <para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst
58 die "<xref linkend="Manuelle-Installation-des-Programmpaketes"/>"
59 sowie grundlegende Einstellungen, die der "<xref
60 linkend="config.config-file"/>" erläutert.</para>
64 <para><emphasis>Konfiguration externer Programme</emphasis>: hierzu
65 gehören die Datenbank ("<xref
66 linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der
67 Webserver ("<xref linkend="Apache-Konfiguration"/>").</para>
71 <para><emphasis>Benutzerinformationen speichern können</emphasis>:
72 man benötigt mindestens eine Datenbank, in der Informationen zur
73 Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man
74 das als Administrator macht, verrät "<xref
75 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para>
79 <para><emphasis>Benutzer, Gruppen und Datenbanken
80 anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
81 linkend="Benutzer--und-Gruppenverwaltung"/>".</para>
85 <para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann
86 kann es losgehen: "<xref linkend="kivitendo-ERP-verwenden"/>"</para>
90 <para>Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls
91 wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen
95 <sect1 id="Benötigte-Software-und-Pakete">
96 <title>Benötigte Software und Pakete</title>
98 <sect2 id="Betriebssystem">
99 <title>Betriebssystem</title>
101 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
102 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
103 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
104 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
105 ohne große Probleme auf den derzeit aktuellen verbreiteten
106 Distributionen läuft.</para>
108 <para>Anfang 2016 sind das folgende Systeme, von denen bekannt ist,
109 dass kivitendo auf ihnen läuft:</para>
117 <para>7.0 "Wheezy"</para>
121 <para>8.0 "Jessie"</para>
127 <para>Ubuntu 12.04 LTS "Precise Pangolin", 14.04 "Trusty Tahr"
128 LTS, 15.10 "Wily Werewolf" und 16.04 "Xenial Xerus" LTS
133 <para>openSUSE LEAP 42.1</para>
137 <para>Fedora 22</para>
142 <sect2 id="Pakete" xreflabel="Pakete">
143 <title>Benötigte Perl-Pakete installieren</title>
145 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
146 Apache) und ein Datenbankserver (PostgreSQL) in einer aktuellen Version
147 (s.a. Liste der unterstützten Betriebssysteme) benötigt.</para>
149 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht
150 Bestandteil einer Standard-Perl-Installation sind. Um zu überprüfen,
151 ob die erforderlichen Pakete installiert und aktuell genug sind, wird
152 ein Script mitgeliefert, das wie folgt aufgerufen wird:</para>
154 <programlisting>./scripts/installation_check.pl</programlisting>
156 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
160 <para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para>
164 <para><literal>Archive::Zip</literal></para>
168 <para><literal>Algorithm::CheckDigits</literal></para>
172 <para><literal>CGI</literal></para>
176 <para><literal>Clone</literal></para>
180 <para><literal>Config::Std</literal></para>
184 <para><literal>DateTime</literal></para>
188 <para><literal>DateTime::Format::Strptime</literal></para>
192 <para><literal>DBI</literal></para>
196 <para><literal>DBD::Pg</literal></para>
200 <para><literal>Email::Address</literal></para>
204 <para><literal>Email::MIME</literal></para>
208 <para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71
209 inklusive; siehe <xref
210 linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para>
214 <para><literal>File::Copy::Recursive</literal></para>
218 <para><literal>File::MimeInfo::Magic</literal></para>
222 <para><literal>GD</literal></para>
226 <para><literal>HTML::Parser</literal></para>
230 <para><literal>HTML::Restrict</literal></para>
234 <para><literal>Image::Info</literal></para>
238 <para><literal>JSON</literal></para>
242 <para><literal>List::MoreUtils</literal></para>
246 <para><literal>List::UtilsBy</literal></para>
250 <para><literal>Net::SMTP::SSL</literal> (optional, bei
251 E-Mail-Versand über SSL; siehe Abschnitt "<xref
252 linkend="config.sending-email.smtp"/>")</para>
256 <para><literal>Net::SSLGlue</literal> (optional, bei
257 E-Mail-Versand über TLS; siehe Abschnitt "<xref
258 linkend="config.sending-email.smtp"/>")</para>
262 <para><literal>Params::Validate</literal></para>
266 <para><literal>PBKDF2::Tiny</literal></para>
270 <para><literal>PDF::API2</literal></para>
274 <para><literal>Rose::Object</literal></para>
278 <para><literal>Rose::DB</literal></para>
282 <para><literal>Rose::DB::Object</literal> Version 0.788 oder
287 <para><literal>String::ShellQuote</literal></para>
291 <para><literal>Sort::Naturally</literal></para>
295 <para><literal>Template</literal></para>
299 <para><literal>Text::CSV_XS</literal></para>
303 <para><literal>Text::Iconv</literal></para>
307 <para><literal>URI</literal></para>
311 <para><literal>XML::Writer</literal></para>
315 <para><literal>YAML</literal></para>
319 <para>Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen:
320 <literal>Algorithm::CheckDigits</literal><literal>PBKDF2::Tiny</literal></para>
322 <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen:
323 <literal>GD</literal>, <literal>HTML::Restrict</literal>,
324 <literal>Image::Info</literal></para>
326 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen:
327 <literal>File::Copy::Recursive</literal>.</para>
329 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen:
330 <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
331 <literal>Net::SSLGlue</literal>.</para>
333 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
334 hinzugekommen, <literal>URI</literal> und
335 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
338 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
339 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
340 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
341 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
343 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
344 hinzugekommen.</para>
346 <para><literal>Email::Address</literal> und
347 <literal>List::MoreUtils</literal> sind schon länger feste
348 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
349 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
350 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
351 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
355 <title>Debian und Ubuntu</title>
357 <para>Für Debian und Ubuntu stehen die meisten der benötigten
358 Perl-Pakete als Debian-Pakete zur Verfügung. Sie können mit
359 folgendem Befehl installiert werden:</para>
361 <programlisting>apt install apache2 libarchive-zip-perl libclone-perl \
362 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
363 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
364 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
365 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
366 librose-db-perl librose-object-perl libsort-naturally-perl \
367 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
368 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
369 libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \
370 libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \
371 libcrypt-pbkdf2-perl git libcgi-pm-perl
374 <para>Für das Paket HTML::Restrict gibt es kein Debian-Paket, dies
375 muß per CPAN installiert werden. Unter Ubuntu funktioniert das
378 <programlisting>apt-get install build-essential
379 cpan HTML::Restrict</programlisting>
383 <title>Fedora</title>
385 <para>Für Fedora stehen die meisten der benötigten Perl-Pakete als
386 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
387 installiert werden:</para>
389 <programlisting>dnf install httpd mod_fcgid perl-Archive-Zip perl-Clone perl-DBD-Pg \
390 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
391 perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
392 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
393 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
394 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
395 perl-XML-Writer perl-YAML perl-parent postgresql-server perl-CPAN \
396 perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor perl-Text-Balanced</programlisting>
398 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
399 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
401 <programlisting>cpan Config::Std HTML::Restrict</programlisting>
405 <title>openSUSE</title>
407 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als
408 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
409 installiert werden:</para>
411 <programlisting>zypper install apache2 apache2-mod_fcgid perl-Archive-Zip perl-Clone \
412 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
413 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
414 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
415 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
416 perl-URI perl-XML-Writer perl-YAML perl-CPAN \
417 perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor postgresql-server</programlisting>
419 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
420 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
422 <programlisting>cpan Rose::Db::Object</programlisting>
426 <title>Andere Pakete installieren</title>
428 <para>Seit Version v3.4.0 wird für den Bankimport optional das Paket
429 'aqbanking-tools' benötigt.</para>
431 <para>Ubuntu: <programlisting>apt install aqbanking-tools</programlisting></para>
433 <para>OpenSuSE: <programlisting>zypper install aqbanking-tools</programlisting></para>
435 <para>Seit Version v3.4.1 wird generell zum Feststellen der
436 Seitenanzahl von PDF_Dokumenten 'pdfinfo' benötigt was im Paket
437 'poppler-utils' enthalten ist.</para>
439 <para>Ubuntu: <programlisting>apt install poppler-utils</programlisting></para>
441 <para>OpenSuSE: <programlisting>zypper install poppler-tools</programlisting></para>
446 <sect1 id="Manuelle-Installation-des-Programmpaketes"
447 xreflabel="Manuelle Installation des Programmpaketes">
448 <title>Manuelle Installation des Programmpaketes</title>
450 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github
451 gehostet und kann <ulink
452 url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
453 heruntergeladen werden.</para>
455 <para>Die kivitendo ERP Installationsdatei
456 (<filename>kivitendo-erp-3.4.1.tgz</filename>) wird im
457 Dokumentenverzeichnis des Webservers (z.B.
458 <filename>/var/www/html/</filename>,
459 <filename>/srv/www/htdocs</filename> oder
460 <filename>/var/www/</filename>) entpackt:</para>
462 <programlisting>cd /var/www
463 tar xvzf kivitendo-erp-3.4.1.tgz</programlisting>
465 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
467 <programlisting>cd kivitendo-erp</programlisting>
469 <para>Alternativ können Sie auch einen Alias in der
470 Webserverkonfiguration benutzen, um auf das tatsächliche
471 Installationsverzeichnis zu verweisen.</para>
473 <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
474 WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
476 <programlisting>mkdir webdav</programlisting>
478 <para>Die Verzeichnisse <filename>users</filename>,
479 <filename>spool</filename> und <filename>webdav</filename> müssen für
480 den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
481 restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer-
482 und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich
483 (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
484 <constant>apache</constant> oder bei OpenSUSE
485 <constant>wwwrun</constant>).</para>
487 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
488 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
490 <programlisting>chown -R www-data users spool webdav</programlisting>
492 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen
493 <filename>templates</filename> und <filename>users</filename>
494 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in
495 kivitendo angelegt wird:</para>
497 <programlisting>chown www-data templates users</programlisting>
500 <para>Wir empfehlen eine Installation mittels des Versionsmanagager
501 git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr
502 viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte
503 die Pfade anpassen) bspw. wie folgt: <programlisting>cd /usr/local/src/
504 git clone https://github.com/kivitendo/kivitendo-erp.git
506 git checkout `git tag -l | egrep -ve "(beta|rc)" | tail -1`</programlisting>
507 Sehr sinnvoll ist es, direkt im Anschluss einen eigenen Branch zu
508 erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen damit zu
509 verwalten. Hierfür reicht ein simples <programlisting> git checkout -b meine_eigenen_änderungen</programlisting>
510 nach dem letzten Kommando (weiterführende Informationen <ulink
511 url="http://git-scm.com/book/en/v2/Getting-Started-Git-Basics">getting
512 started with git</ulink>).</para>
516 <sect1 id="config.config-file">
517 <title>kivitendo-Konfigurationsdatei</title>
519 <sect2 id="config.config-file.introduction"
520 xreflabel="Einführung in die Konfigurationsdatei">
521 <title>Einführung</title>
523 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
524 benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die
525 Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von
526 kivitendo bzw. der Migration von älteren Versionen angelegt
529 <para>Als Vorlage dient die Datei
530 <filename>config/kivitendo.conf.default</filename> (kurz: "die
531 Default-Datei"):</para>
533 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
535 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
536 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
537 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
538 Abschnitte und Werte enthalten, die von denen der Default-Datei
542 <para>Vor der Umbenennung in kivitendo hieß diese Datei noch
543 <filename>config/lx_office.conf</filename>. Aus Gründen der
544 Kompatibilität wird diese Datei eingelesen, sofern die Datei
545 <filename>config/kivitendo.conf</filename> nicht existiert.</para>
548 <para>Diese Hauptkonfigurationsdatei ist dann eine
549 installationsspezifische Datei, d.h. sie enthält bspw. lokale
550 Passwörter und wird auch nicht im Versionsmanagement (git)
553 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
554 Mandaten, bzw. Datenbanken gleich.</para>
557 <sect2 id="config.config-file.sections-parameters">
558 <title>Abschnitte und Parameter</title>
560 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
561 entsprechend kommentiert sind:</para>
565 <para><literal>authentication</literal> (siehe Abschnitt "<xref
566 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
567 in diesem Kapitel)</para>
571 <para><literal>authentication/database</literal></para>
575 <para><literal>authentication/ldap</literal></para>
579 <para><literal>system</literal></para>
583 <para><literal>paths</literal></para>
587 <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
588 linkend="config.sending-email.smtp"/>)</para>
592 <para><literal>applications</literal></para>
596 <para><literal>environment</literal></para>
600 <para><literal>print_templates</literal></para>
604 <para><literal>task_server</literal></para>
608 <para><literal>periodic_invoices</literal></para>
612 <para><literal>self_tests</literal></para>
616 <para><literal>console</literal></para>
620 <para><literal>testing</literal></para>
624 <para><literal>testing/database</literal></para>
628 <para><literal>debug</literal></para>
632 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
633 einzustellen oder zu kontrollieren sind, sind:</para>
635 <programlisting>[authentication]
636 admin_password = geheim
638 [authentication/database]
646 default_manager = german</programlisting>
648 <para>Für kivitendo Installationen in der Schweiz sollte hier <varname>german</varname>
649 durch <varname>swiss</varname> ersetzt werden.</para>
650 <para>Die Einstellung <varname>default_manager = swiss</varname> bewirkt:</para>
653 <para>Beim Erstellen einer neuen Datenbank in der kivitendo Administration
654 werden automatisch die Standard-Werte für die Schweiz voreingestellt:
655 Währung CHF, 5er-Rundung, Schweizer KMU-Kontenplan, Sollversteuerung,
656 Aufwandsmethode, Bilanzierung (die Werte können aber manuell angepasst werden).</para>
659 <para>Einstellen der Standardkonten für Rundungserträge und -aufwendungen
660 (unter Mandantenkonfiguration → Standardkonten veränderbar)</para>
663 <para>das verwendete Zahlenformat wird auf <varname>1'000.00</varname> eingestellt
664 (unter Programm → Benutzereinstellungen veränderbar)</para>
667 <para>DATEV-Automatik und UStVA werden nicht angezeigt, Erfolgsrechnung
668 ersetzt GUV ( unter Mandantenkonfiguration → Features veränderbar)</para>
672 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
673 <varname>[periodic_invoices]</varname> den Login eines Benutzers
674 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
675 mit Informationen über die erstellten Rechnungen bekommt.</para>
677 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
678 Ausführung bestimmter Aufgaben mit, den <link
679 linkend="config.task-server">Taskserver</link>. Er wird u.a. für
680 Features wie die <link
681 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
682 benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
683 daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
684 <link linkend="config.task-server">Task-Server</link> genauer
687 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
688 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
691 <sect2 id="config.config-file.prior-versions">
692 <title>Versionen vor 2.6.3</title>
694 <para>In älteren kivitendo Versionen gab es im Verzeichnis
695 <filename>config</filename> die Dateien
696 <filename>authentication.pl</filename> und
697 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
698 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
699 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
700 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
702 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
703 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
704 manuell übertragen und die alten Konfigurationsdateien anschließend
705 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
706 entsprechende Fehlermeldung an.</para>
710 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
711 <title>Anpassung der PostgreSQL-Konfiguration</title>
713 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
715 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
716 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
718 <para>kivitendo setzt zwingend voraus, dass die Datenbank
719 Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
720 Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
722 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
723 Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
724 man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
726 <programlisting>su postgres
728 exit </programlisting>
730 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
731 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
732 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
735 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
737 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
738 Versionsnummer angepasst werden.</para>
740 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
742 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
743 <literal>\l</literal> geprüft werden.</para>
746 <sect2 id="Änderungen-an-Konfigurationsdateien">
747 <title>Änderungen an Konfigurationsdateien</title>
749 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
750 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
751 <filename>/var/lib/pgsql/data/</filename> oder
752 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
753 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
754 Parameter <varname>listen_address</varname> gesteuert. Laufen
755 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
756 <literal>localhost</literal> verwendet werden. Andernfalls müssen
757 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
758 was mit dem Wert <literal>*</literal> geschieht.</para>
760 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
761 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
762 sein sollte, müssen die Berechtigungen für den Zugriff geändert
763 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
764 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
765 Datenbank zum Beispiel:</para>
767 <programlisting>local all kivitendo password
768 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
771 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
772 <title>Erweiterung für servergespeicherte Prozeduren</title>
774 <para>In der Datenbank <literal>template1</literal> muss die
775 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
776 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
777 <programlisting>su - postgres
778 psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
780 <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
784 <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
785 bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
786 anzulegen. In diesen Versionen ist die Extension meist auch schon
787 vorhanden. Sollten Sie eine ältere Version von Postgres haben,
788 benutzen Sie stattdessen den folgenden Befehl.</para>
790 <programlisting>CREATE LANGUAGE 'plpgsql';
795 <sect2 id="Datenbankbenutzer-anlegen">
796 <title>Datenbankbenutzer anlegen</title>
798 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
799 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
800 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
803 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
804 nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
805 generieren nicht nötig.</para>
807 <programlisting>su - postgres
808 createuser -d -P kivitendo
809 exit</programlisting>
811 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
812 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
813 bzw. den hier gewählten Benutzernamen.</para>
817 <sect1 id="Apache-Konfiguration">
818 <title>Webserver-Konfiguration</title>
821 <title>Grundkonfiguration mittels CGI</title>
824 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
825 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
826 <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
829 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
830 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
831 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
832 anderen Datei hinzu, die beim Starten des Webservers eingelesen
835 <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
836 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
838 <Directory /var/www/kivitendo-erp>
839 AddHandler cgi-script .pl
840 Options ExecCGI Includes FollowSymlinks
843 <Directory /var/www/kivitendo-erp/users>
846 </Directory></programlisting>
848 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
849 das kivitendo-Archiv entpacket haben.</para>
852 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
853 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
855 <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
856 noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
857 aktiviert werden.</para>
860 <para>Auf einigen Webservern werden manchmal die Grafiken und
861 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
862 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
864 <programlisting>EnableSendfile Off</programlisting>
867 <sect2 id="Apache-Konfiguration.FCGI"
868 xreflabel="Konfiguration für FastCGI/FCGI">
869 <title>Konfiguration für FastCGI/FCGI</title>
871 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
872 <title>Was ist FastCGI?</title>
874 <para>Direkt aus <ulink
875 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
878 <para><citation> FastCGI ist ein Standard für die Einbindung
879 externer Software zur Generierung dynamischer Webseiten in einem
880 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
881 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
882 umgehen. </citation></para>
885 <sect3 id="Apache-Konfiguration.FCGI.Warum">
886 <title>Warum FastCGI?</title>
888 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
889 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
890 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
891 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
892 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
893 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
894 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
895 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
896 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
897 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
898 deutlich länger dauert als früher, und dass davon 90% für das Laden
899 der Module verwendet wird.</para>
901 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
902 wird nur die eigentliche Programmlogik ausgeführt.</para>
905 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
906 <title>Getestete Kombinationen aus Webservern und Plugin</title>
908 <para>Folgende Kombinationen sind getestet:</para>
912 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
916 <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
920 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
924 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
925 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
926 mod_fastcgi nicht mehr explizit eingegangen.</para>
928 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
932 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
933 strict in der Behandlung von Unicode, und verweigern bestimmte
934 Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
935 Installation gibt, muss zwingend Version 0.68 oder aber Version
936 0.72 und neuer eingesetzt werden.</para>
938 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
939 sich die Vorgängerversion wie folgt installieren:</para>
941 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
945 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
946 <title>Konfiguration des Webservers</title>
948 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
949 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
950 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
951 debuggen die beim ersten aufsetzen auftreten können. Sollte die
952 Installation schon funktionieren, lesen Sie weiter.</para>
954 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
955 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
957 <programlisting>a2enmod fcgid</programlisting>
959 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
960 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
961 und <function>Directory</function>-Direktiven. Dabei wird zwischen
962 dem Installationspfad von kivitendo im Dateisystem
963 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
964 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
965 ("<filename>/url/for/kivitendo-erp</filename>").</para>
967 <para>Folgender Konfigurationsschnipsel funktioniert mit
970 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
971 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
973 <Directory /path/to/kivitendo-erp>
975 Options ExecCGI Includes FollowSymlinks
979 <DirectoryMatch /path/to/kivitendo-erp/users>
981 </DirectoryMatch></programlisting>
984 <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
985 muss entsprechend die Syntax der Directorydirektiven verändert.
988 <programlisting>Require all granted</programlisting>
990 <para>muß man Folgendes einstellen:</para>
994 Allow from All </programlisting>
996 <para>und statt</para>
998 <programlisting>Require all denied</programlisting>
1000 <para>muss stehen:</para>
1004 Deny from All </programlisting>
1008 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
1009 die maximale Größe eines Requests. Diese sollte wie folgt
1010 hochgesetzt werden:</para>
1012 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
1014 <para>Das Ganze sollte dann so aussehen:</para>
1016 <programlisting>AddHandler fcgid-script .fpl
1017 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1018 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1019 FcgidMaxRequestLen 10485760
1021 <Directory /path/to/kivitendo-erp>
1023 Options ExecCGI Includes FollowSymlinks
1028 <DirectoryMatch /path/to/kivitendo-erp/users>
1031 </DirectoryMatch></programlisting>
1033 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
1034 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
1035 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
1036 gibt es hier kleine Performance-Einbußen.</para>
1038 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
1039 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
1040 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
1042 <programlisting># Zugriff über CGI
1043 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
1045 # Zugriff mit mod_fcgid:
1046 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1047 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
1049 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
1050 die normale Version erreichbar, und unter
1051 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
1052 FastCGI-Version.</para>
1057 <title>Weitergehende Konfiguration</title>
1059 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
1060 von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1061 weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1062 Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1063 Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1064 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1065 (Stand Sept. 2015)</ulink> und einen aktuellen (Stand Mai 2017)
1066 <ulink url="https://mozilla.github.io/server-side-tls/ssl-config-generator/">
1067 SSL-Konfigurations-Generator</ulink>.</para>
1071 <sect1 id="config.task-server">
1072 <title>Der Task-Server</title>
1074 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1075 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1076 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1077 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1078 essenzielle Aufgaben benutzt.</para>
1080 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1081 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1082 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1084 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1085 Servers integriert werden muss, damit er automatisch gestartet wird.
1086 Dies kann kivitendo nicht für Sie erledigen.</para>
1088 <sect2 id="Konfiguration-des-Task-Servers">
1089 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1091 <para>Die Konfiguration erfolgt über den Abschnitt
1092 <literal>[task_server]</literal> in der Datei
1093 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1094 Optionen sind:</para>
1098 <term><varname>run_as</varname></term>
1101 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1102 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1103 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1104 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1106 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1107 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1108 unter dem auch der Webserver läuft.</para>
1113 <term><varname>debug</varname></term>
1116 <para>Schaltet Debug-Informationen an und aus.</para>
1122 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1123 <title>Konfiguration der Mandanten für den Task-Server</title>
1125 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1126 anschließend jeder Mandant, für den der Task-Server laufen soll,
1127 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1128 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1129 ausgewählt werden, unter der der Task-Server seine Arbeit
1132 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1133 wird der Task-Server für diesen Mandanten keine Aufgaben
1137 <sect2 id="Einbinden-in-den-Boot-Prozess">
1138 <title>Automatisches Starten des Task-Servers beim Booten</title>
1140 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1141 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1142 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1144 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1145 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1146 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1147 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1148 anstelle eines symbolischen Links verwendet werden können.</para>
1151 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE,
1152 ältere Fedora)</title>
1154 <para>Kopieren Sie die Datei
1155 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1156 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1157 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1158 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1159 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1163 <para>Debian-basierende Systeme:</para>
1165 <programlisting>update-rc.d kivitendo-task-server defaults
1166 # Nur bei Debian Squeeze und neuer:
1167 insserv kivitendo-task-server</programlisting>
1171 <para>Ältere OpenSUSE und ältere Fedora:</para>
1173 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1177 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1180 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1184 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1186 <para>Kopieren Sie die Datei
1187 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1188 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1189 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1190 <literal>exec ....</literal>).</para>
1192 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1195 <programlisting>service kivitendo-task-server start</programlisting>
1199 <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1200 Fedora, neuere Ubuntu und Debians)</title>
1202 <para>Kopieren Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
1203 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeilen
1204 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>).</para>
1206 <para>Machen Sie anschließend das Script systemd bekannt, und binden Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden
1209 <programlisting>systemctl daemon-reload
1210 systemctl enable kivitendo-task-server.service</programlisting>
1212 <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt den Server neu zu starten, so können Sie das mit dem
1213 folgenden Befehl tun:</para>
1215 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1219 <sect2 id="Prozesskontrolle">
1220 <title>Wie der Task-Server gestartet und beendet wird</title>
1222 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1224 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1226 <para><literal>Befehl</literal> ist dabei eine der folgenden
1231 <para><literal>start</literal> startet eine neue Instanz des
1232 Task-Servers. Die Prozess-ID wird innerhalb des
1233 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1237 <para><literal>stop</literal> beendet einen laufenden
1242 <para><literal>restart</literal> beendet und startet ihn
1247 <para><literal>status</literal> berichtet, ob der Task-Server
1252 <para>Der Task-Server wechselt beim Starten automatisch in das
1253 kivitendo-Installationsverzeichnis.</para>
1255 <para>Dieselben Optionen können auch für die SystemV-basierenden
1256 Runlevel-Scripte benutzt werden (siehe oben).</para>
1260 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1261 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1263 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1264 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1266 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1267 <title>Grundlagen zur Benutzerauthentifizierung</title>
1269 <para>kivitendo verwaltet die Benutzerinformationen in einer
1270 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1271 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1272 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1273 können, müssen aber nicht unterschiedlich sein.</para>
1275 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1276 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1277 abgelegt werden.</para>
1279 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
1280 entweder gegen die Authentifizierungsdatenbank oder gegen einen
1281 LDAP-Server überprüft werden.</para>
1283 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1284 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1285 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1286 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1287 einer Version vor v2.6.0 angelegt werden. Eine
1288 Beispielkonfigurationsdatei
1289 <filename>config/kivitendo.conf.default</filename> existiert, die als
1290 Vorlage benutzt werden kann.</para>
1293 <sect2 id="Administratorpasswort">
1294 <title>Administratorpasswort</title>
1296 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1297 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1298 gespeichert. Es kann auch nur dort und nicht mehr im
1299 Administrationsinterface selber geändert werden. Der Parameter dazu
1300 heißt <varname>admin_password</varname> im Abschnitt
1301 <varname>[authentication]</varname>.</para>
1304 <sect2 id="Authentifizierungsdatenbank">
1305 <title>Authentifizierungsdatenbank</title>
1307 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1308 Parametern in <varname>[authentication/database]</varname>
1309 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1313 <term><literal>host</literal></term>
1316 <para>Der Rechnername oder die IP-Adresse des
1317 Datenbankservers</para>
1322 <term><literal>port</literal></term>
1325 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1330 <term><literal>db</literal></term>
1333 <para>Der Name der Authentifizierungsdatenbank</para>
1338 <term><literal>user</literal></term>
1341 <para>Der Benutzername, mit dem sich kivitendo beim
1342 Datenbankserver anmeldet (z.B.
1343 "<literal>postgres</literal>")</para>
1348 <term><literal>password</literal></term>
1351 <para>Das Passwort für den Datenbankbenutzer</para>
1356 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1357 automatisch anlegen (mehr dazu siehe unten).</para>
1360 <sect2 id="Passwortüberprüfung">
1361 <title>Passwortüberprüfung</title>
1363 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1364 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1365 Active-Directory-Server. Welche davon benutzt wird, regelt der
1366 Parameter <varname>module</varname> im Abschnitt
1367 <varname>[authentication]</varname>.</para>
1369 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1370 gespeichert werden, so muss der Parameter <varname>module</varname>
1371 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1372 der Administrator als auch die Benutzer selber ihre Passwörter in
1373 kivitendo ändern.</para>
1375 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1376 benutzt werden, so muss der Parameter <varname>module</varname> auf
1377 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1378 zusätzliche Informationen über den LDAP-Server im Abschnitt
1379 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1383 <term><literal>host</literal></term>
1386 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1387 Active-Directory-Servers. Diese Angabe ist zwingend
1388 erforderlich.</para>
1393 <term><literal>port</literal></term>
1396 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1401 <term><literal>tls</literal></term>
1404 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1405 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1406 ‘<literal>0</literal>’ belassen</para>
1411 <term><literal>attribute</literal></term>
1414 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1415 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1416 meist ‘<literal>sAMAccountName</literal>’, für andere
1417 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1418 zwingend erforderlich.</para>
1423 <term><literal>base_dn</literal></term>
1426 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1427 Diese Angabe ist zwingend erforderlich.</para>
1432 <term><literal>filter</literal></term>
1435 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1436 <literal><%login%></literal>, so wird dieses durch den vom
1437 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1438 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1439 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1444 <term><literal>bind_dn</literal> und
1445 <literal>bind_password</literal></term>
1448 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1449 durchsucht werden kann (z.B. ist dies bei
1450 Active-Directory-Servern der Fall), so kann diese hier angegeben
1451 werden. Für Active-Directory-Server kann als
1452 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1453 z.B. ‘<literal>cn=Martin
1454 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1455 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1456 also ‘<literal>Martin Mustermann</literal>’.</para>
1462 <sect2 id="Name-des-Session-Cookies">
1463 <title>Name des Session-Cookies</title>
1465 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1466 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1467 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1468 Parameter <varname>cookie_name</varname> im Abschnitt
1469 <varname>[authentication]</varname>gesetzt.</para>
1471 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1472 Server existiert.</para>
1475 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1476 <title>Anlegen der Authentifizierungsdatenbank</title>
1478 <para>Nachdem alle Einstellungen in
1479 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1480 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1481 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1482 der folgenden URL erreichbar sein sollte:</para>
1485 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1489 <sect1 id="Benutzer--und-Gruppenverwaltung">
1490 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1492 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1493 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1494 das Sie unter folgender URL finden:</para>
1497 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1499 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1500 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1502 <sect2 id="Zusammenhänge">
1503 <title>Zusammenhänge</title>
1505 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1506 in einer oder zwei Datenbanken gespeichert werden.</para>
1508 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1509 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1510 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1511 Diese Informationen werden in der Authentifizierungsdatenbank
1512 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1513 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1514 gespeichert werden.</para>
1516 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1517 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1518 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1519 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1520 einer solchen Mandantendatenbank werden im Administrationsbereich
1521 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1522 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1524 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1525 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1526 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1527 mehr als einem Mandanten, wird empfohlen, für die
1528 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1529 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1532 <sect2 id="Mandanten-Benutzer-Gruppen">
1533 <title>Mandanten, Benutzer und Gruppen</title>
1535 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1536 die sich frei zueinander zuordnen lassen.</para>
1538 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1539 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1540 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1541 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1542 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1543 Diese sollte über die <link
1544 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1547 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1548 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1549 der Administrator fest, an welchen Mandanten sich ein Benutzer
1550 anmelden kann, was beim Login verifiziert wird.</para>
1552 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1553 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1554 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1555 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1556 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1557 dann an einem Mandanten an, so erhält er alle Rechte von allen
1558 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1559 denen der Benutzer zum Anderen Mitglied ist,</para>
1561 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1562 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1563 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1565 <orderedlist numeration="arabic">
1567 <para>Datenbank anlegen</para>
1571 <para>Gruppen anlegen</para>
1575 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1579 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1584 <sect2 id="Datenbanken-anlegen">
1585 <title>Datenbanken anlegen</title>
1587 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1588 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1589 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1592 <sect2 id="Gruppen-anlegen">
1593 <title>Gruppen anlegen</title>
1595 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1596 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1597 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1598 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1600 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1601 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1602 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1603 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1604 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1605 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1606 A, B und C gültig").</para>
1608 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1609 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1610 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1611 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1612 Gruppen A, B und C").</para>
1615 <sect2 id="Benutzer-anlegen">
1616 <title>Benutzer anlegen</title>
1618 <para>Beim Anlegen von Benutzern werden für viele Parameter
1619 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1620 deutschen Raumes entsprechen.</para>
1622 <para>Zwingend anzugeben ist der Loginname. Wenn die
1623 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
1624 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
1625 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1628 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
1629 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
1630 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
1631 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
1632 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
1633 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
1634 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
1635 sind Benutzer A, B und C Mitglieder").</para>
1638 <sect2 id="Mandanten-anlegen">
1639 <title>Mandanten anlegen</title>
1641 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
1642 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
1643 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
1644 einer der eben angelegten Datenbanken eingetragen werden.</para>
1646 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
1647 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
1648 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
1649 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
1650 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
1651 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
1652 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
1653 Gruppe ist für Mandanten A, B und C gültig").</para>
1657 <sect1 id="Drucker--Systemverwaltung">
1658 <title>Drucker- und Systemverwaltung</title>
1660 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
1661 Druckeradministration und System.</para>
1663 <sect2 id="Druckeradministration">
1664 <title>Druckeradministration</title>
1666 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
1667 viele "Druckbefehle" im System verwalten. Diese Befehle werden
1668 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
1669 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
1670 angezeigt wird.</para>
1672 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
1673 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
1674 meinDrucker' oder ein kompletter Pfad zu einem Skript
1675 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
1676 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
1677 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
1678 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
1679 Ausdruck eines Angebots folgende Vorlage geparst:
1680 sales_quotation_epson_drucker.tex.</para>
1684 <title>System sperren / entsperren</title>
1686 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
1687 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
1688 gesamten kivitendo Installation gesperrt.</para>
1690 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
1691 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
1692 Wartungsarbeiten nicht zugänglich.'.</para>
1694 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
1695 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
1696 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
1697 inkonsistenten Datenbestand weitergearbeitet werden.</para>
1701 <sect1 id="config.sending-email"
1702 xreflabel="E-Mail-Versand aus kivitendo heraus">
1703 <title>E-Mail-Versand aus kivitendo heraus</title>
1705 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
1706 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
1707 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
1708 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
1709 Versand über einen lokalen E-Mail-Server (z.B. mit
1710 <productname>Postfix</productname> oder <productname>Exim</productname>,
1711 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
1712 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
1714 <para>Welche Methode und welcher Server verwendet werden, wird über die
1715 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1716 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
1717 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1719 <sect2 id="config.sending-email.sendmail"
1720 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1721 <title>Versand über lokalen E-Mail-Server</title>
1723 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
1724 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
1725 <productname>Postfix</productname>, <productname>Exim</productname>
1726 oder <productname>Sendmail</productname> läuft.</para>
1728 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1729 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1730 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1732 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
1733 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
1734 Standardwert verweist auf das Programm
1735 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1736 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1738 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
1739 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
1743 <sect2 id="config.sending-email.smtp"
1744 xreflabel="E-Mail-Versand über einen SMTP-Server">
1745 <title>Versand über einen SMTP-Server</title>
1747 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
1748 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
1751 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1752 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1753 Parameter dienen dabei der weiteren Konfiguration:</para>
1757 <term><varname>hostname</varname></term>
1760 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
1761 '<literal>localhost</literal>'</para>
1766 <term><varname>port</varname></term>
1769 <para>Portnummer. Der Standardwert hängt von der verwendeten
1770 Verschlüsselungsmethode ab. Gilt '<literal>security =
1771 none</literal>' oder '<literal>security = tls</literal>', so ist
1772 25 die Standardportnummer. Für '<literal>security =
1773 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
1774 geändert werden.</para>
1779 <term><varname>security</varname></term>
1782 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
1783 mit dem Server. Standardwert ist '<literal>none</literal>',
1784 wodurch keine Verschlüsselung verwendet wird. Mit
1785 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
1786 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
1787 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
1788 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
1789 (siehe unten).</para>
1794 <term><varname>login</varname> und
1795 <varname>password</varname></term>
1798 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
1799 so können mit diesen zwei Parametern der Benutzername und das
1800 Passwort angegeben werden. Wird Authentifizierung verwendet, so
1801 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
1802 aktiviert werden.</para>
1809 <sect1 id="Drucken-mit-kivitendo">
1810 <title>Drucken mit kivitendo</title>
1812 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
1813 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1814 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1815 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
1817 <para><programlisting>apt-get install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1818 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1820 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
1822 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
1823 texlive-collection-latexrecommended texlive-collection-langgerman \
1824 texlive-collection-langenglish</programlisting></para>
1826 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
1828 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
1829 texlive-collection-latexrecommended texlive-collection-langgerman \
1830 texlive-collection-langenglish</programlisting></para>
1832 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1844 <para>rev-odt</para>
1848 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version
1849 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
1851 <sect2 id="Vorlagenverzeichnis-anlegen"
1852 xreflabel="Vorlagenverzeichnis anlegen">
1853 <title>Vorlagenverzeichnis anlegen</title>
1855 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
1856 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1858 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1860 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
1861 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
1862 <xref linkend="Gruppen-anlegen"/>.</para>
1864 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
1865 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
1866 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
1867 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1871 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
1872 Vorlagensatz aus, der kopiert werden soll
1873 (<filename>RB</filename>, <filename>f-tex</filename> oder
1874 <filename>odt-rev</filename>.)</para>
1878 <para><option>Neuer Name</option>: Der Verzeichnisname für den
1879 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
1880 für Verzeichnisnamen frei gewählt werden.</para>
1884 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
1885 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
1886 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1887 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
1888 vorgenommen werden. Den Ordner findet man im Dateisystem unter
1889 <filename>./templates/[Neuer Name]</filename></para>
1892 <sect2 id="Vorlagen-RB">
1893 <title>Der Druckvorlagensatz RB</title>
1895 <para>Hierbei handelt es sich um einen vollständigen LaTeX
1896 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
1897 sind nicht gepflegt.</para>
1899 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
1900 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1901 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
1902 eigenen Firmendaten finden sich in der Datei Readme.tex im
1903 Vorlagenverzeichnis.</para>
1905 <para>Eine kurze Übersicht der Features:</para>
1909 <para>Mehrsprachenfähig, mit Deutscher und Englischer
1914 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
1915 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
1920 <para>mehrere vordefinierte Varianten für
1921 Logos/Hintergrundbilder</para>
1925 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
1926 "Außerhalb EU"</para>
1932 <title>f-tex</title>
1934 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur
1935 Verfügung stellt.</para>
1937 <sect3 id="f-tex-Feature-Übersicht">
1938 <title>Feature-Übersicht</title>
1942 <para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage
1943 für alle briefartigen Dokumente verwendet. Also Angebot,
1944 Rechnung, Proformarechnung, Lieferschein, aber eben nicht für
1945 Paketaufkleber etc.</para>
1949 <para>Leichte Anpassung an das Firmen-Layout durch Verwendung
1950 eines Hintergrund-PDFs. Dieses kann leicht mit dem eigenen
1951 Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp,
1956 <para>Hintergrund-PDF umschaltbar auf "nur erste Seite"
1957 (Standard) oder "alle Seiten" (Option
1958 "<option>bgPdfFirstPageOnly</option>" in Datei
1959 <filename>letter.lco</filename>)</para>
1963 <para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem
1964 Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1965 versendeten Dokumenten eingebunden (Option
1966 "<option>bgPdfEmailOnly</option>" in Datei
1967 <filename>letter.lco</filename>).</para>
1971 <para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch,
1972 Wiederholung von Kopfzeilen, Zwischensummen etc. (danke an
1973 Kai-Martin Knaak für die Vorarbeit)</para>
1977 <para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom
1978 Land des eigenen Unternehmens abweicht (also die Rechnung das
1979 Land verlässt).</para>
1983 <para>Multisprachfähig leicht um weitere Sprachen zu erweitern,
1984 alle Übersetzungen in der Datei
1985 <filename>translatinos.tex</filename>.</para>
1989 <para>Auflistung von Bruttopreisen für Endverbraucher.</para>
1994 <sect3 id="f-tex-Installation">
1995 <title>Die Installation</title>
1999 <para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref
2000 linkend="Vorlagenverzeichnis-anlegen"/>. Das Vorlagensystem
2001 funktioniert jetzt schon, hat allerdings noch einen
2002 Beispiel-Briefkopf.</para>
2006 <para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
2007 <filename>./letter_head.pdf</filename>.</para>
2011 <para>Editiere den Bereich "<option>settings</option>" in der
2012 datei <filename>letter.lco</filename>.</para>
2016 <para>oder etwas detaillierter:</para>
2018 <para>Es wird eine Datei <filename>sample.lco</filename> erstellt
2019 und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
2020 ist dies die Datei die für die firmenspezifischen Anpassungen
2021 gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist,
2022 wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle
2023 über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und
2024 <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung
2025 über eine <filename>*.lco</filename>-Datei, die letztlich auf
2026 <filename>letter.lco</filename> verlinkt ist ist aber auch
2029 <para>Es wird eine Datei <filename>sample_head.pdf</filename> mit
2030 ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
2031 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage.
2032 Schau Dir nach Abschluss der Installation die Datei
2033 <filename>sample_head.pdf</filename> an und erstelle ein
2034 entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
2035 Template Verzeichniss ablegen und statt
2036 <filename>sample_head.pdf</filename> nach
2037 <filename>letter_head.pdf</filename> verlinken.</para>
2039 <para>Letzlich muss <filename>letter_head.pdf</filename> auf das
2040 passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
2043 <para>Es wird eine Datei <filename>mydata.tex.example</filename>
2044 ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
2045 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das
2046 Land verwendet. Die Datei muss also nicht angefasst werden. Die
2047 anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit
2048 nicht im öffentlichen Zweig).</para>
2050 <para>Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
2051 sollten über die Hintergrund-PDF-Datei oder die
2052 <filename>*.lco</filename>-Datei erfolgen.</para>
2055 <sect3 id="f-tex-Funktionsübersicht">
2056 <title>f-tex Funktionsübersicht</title>
2058 <para>Das Konzept von kivitendo sieht vor, für jedes Dokument
2059 (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
2060 LaTeX-Vorlage vorzuhalten, dies ist sehr wartungsunfreundlich. Auch
2061 das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
2062 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen
2063 aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
2064 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
2065 LaTeX-Vorlage verwendet, welche über Codeweichen die Besonderheiten
2066 der jeweiligen Dokumente berücksichtigt:</para>
2070 <para>Tabellen mit oder ohne Preis</para>
2074 <para>Sprache der Tabellenüberschriften etc.</para>
2078 <para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
2079 Angebotsnummer)</para>
2083 <para>Darstellung von Brutto oder Netto-Preisen in der
2084 Auflistung (Endverbraucher versus gewerblicher Kunde)</para>
2088 <para>Nachteil:</para>
2090 <para>LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei
2091 <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
2092 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder
2093 geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch
2094 innerhalb der Tabellendarstellung gut persönliche Anpassungen
2095 vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell
2096 heftig in den Fuss schiessen.</para>
2098 <para>Wer nicht so tief in die Materie einsteigen will oder leicht
2099 zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
2100 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen,
2101 und sich an der Form der dargestellten Tabellen, wie sie
2102 ausgeliefert werden, erfreuen.</para>
2104 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine,
2105 kontinuierliche Schritte gehen.</para>
2108 <sect3 id="f-tex-Bruttopreise">
2109 <title>Bruttopreise für Endverbraucher</title>
2111 <para>Der auszuweisende Bruttopreis wird innerhalb der
2112 LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen
2113 "alle Preise Brutto" auszuwählen, aber:</para>
2117 <para>hierfür müssen die Preise auch in Brutto in der Datenbank
2118 stehen (ja - das lässt sich über die Preisgruppen und die
2119 Zuordung einer Default-Preisgruppe handhaben)</para>
2123 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses
2124 Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
2125 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche
2130 <para>Es gibt mit f-tex eine weitere Alternative. Die Information ob
2131 Brutto oder Nettorechnung wird mit den Zahlarten verknüpft.
2132 Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben
2133 werden sollen, enden mit "_E" (für Endverbraucher). Falls identische
2134 Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt
2135 man diese einfach doppelt an (einmal mit der Namensendung "_E").
2140 <para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist
2141 nicht mehr fix mit einer Preisliste verbunden.</para>
2145 <para>Die Default-Zahlart kann im Kundendatensatz hinterlegt
2146 werden, und man muss nicht mehr daran denken, "alle Preise
2147 Netto" auszuwählen.</para>
2151 <para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen
2152 werden, kann direkt beim Drucken revidiert werden, ohne dass
2153 sich der Auftragswert ändert.</para>
2158 <sect3 id="f-tex-lieferadressen">
2159 <title>Lieferadressen</title>
2161 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen
2162 im Adressfeld zum Einsatz. Wenn die
2163 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende
2164 Adressvariable eingesetzt. Wenn also die Lieferadresse in Straße,
2165 Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
2166 Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert
2167 der Hauptadresse angezeigt.</para>
2171 <sect2 id="Vorlagen-rev-odt">
2172 <title>Der Druckvorlagensatz rev-odt</title>
2174 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2175 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2176 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2177 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2178 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2179 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2180 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2182 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2183 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2184 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2185 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2186 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2187 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2189 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2190 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2191 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2192 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2193 die vom Parser nicht korrekt gelesen werden kann.</para>
2195 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2196 odt-Vorlagen bei Mahnungen, Briefen und Pflichtenheften einzusetzen.
2197 Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2199 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2200 empfang@revamp-it.ch</para>
2203 <sect2 id="allgemeine-hinweise-zu-latex">
2204 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2206 <para>In den allermeisten Installationen sollte das Drucken jetzt
2207 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2208 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2209 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2210 sind zum Beispiel:</para>
2214 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2215 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2216 allem bei Vorlagen aus der Community auf. Installieren Sie die
2217 entsprechenden Pakete.</para>
2221 <para>! Package inputenc Error: Unicode char \u8:... set up for
2222 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2223 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2224 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2225 diversen Tricks dazu gebracht werden andere Zeichen zu
2226 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2231 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2232 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2233 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2234 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2235 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2238 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2239 verifizieren lässt:</para>
2243 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2244 "keep_temp_files" auf 1</para>
2246 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2250 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2254 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2258 <para>wechsel in das users Verzeichnis von kivitendo</para>
2260 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2264 <para>LaTeX Suchpfad anpassen:</para>
2266 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2270 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2273 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2275 <para>Es sollte die letzte Datei ganz unten sein</para>
2279 <para>für besseren Hinweis auf Fehler texdatei nochmals
2282 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2284 <para>in der *.tex datei nach dem Fehler suchen.</para>
2290 <sect1 id="OpenDocument-Vorlagen">
2291 <title>OpenDocument-Vorlagen</title>
2293 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2294 OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2) erzeugen.
2295 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
2296 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2297 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2298 <filename>config/kivitendo.conf</filename> die Variable
2299 <literal>opendocument</literal> im Abschnitt
2300 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2301 Dieses ist die Standardeinstellung.</para>
2303 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2304 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2305 LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt werden, so muss
2306 neben LibreOffice oder OpenOffice auch der “X virtual frame buffer”
2307 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
2308 Andere Distributionen enthalten ihn in anderen Paketen.</para>
2310 <para>Nach der Installation müssen in der Datei
2311 <filename>config/kivitendo.conf</filename> im Abschnitt
2312 <literal>applications</literal> zwei weitere Variablen
2313 angepasst werden:</para>
2314 <para><literal>openofficeorg_writer</literal> muss den
2315 vollständigen Pfad zu LibreOffice oder OpenOffice enthalten.
2316 Dabei dürfen keine Anführungszeichen eingesetzt werden.</para>
2317 <para>Beispiel für Debian oder Ubuntu:</para>
2318 <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2319 <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2322 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2323 LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die benutzt
2324 wird, wenn die Variable <literal>$openofficeorg_daemon</literal> gesetzt
2325 ist, startet ein LibreOffice oder OpenOffice, das auch nach der Umwandlung
2326 des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen wird dann diese
2327 laufende Instanz benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung
2328 deutlich reduziert wird, weil nicht für jedes Dokument ein LibreOffice bzw.
2329 OpenOffice gestartet werden muss. Der Nachteil ist, dass diese Methode
2330 Python und die Python-UNO-Bindings benötigt, die Bestandteil von LibreOffice
2331 bzw. OpenOffice sind.</para>
2334 <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2335 normalerweise der Python-Interpreter
2336 <filename>/usr/bin/python</filename> benutzt.
2337 Sollte dies nicht der richtige sein, so kann man mit zwei
2338 Konfigurationsvariablen entscheiden, welcher Python-Interpreter
2339 genutzt wird. Mit der Option <literal>python_uno</literal> aus dem
2340 Abschnitt <literal>applications</literal> wird der Interpreter selber
2341 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2342 <literal>/usr/bin/python</literal>.</para>
2344 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2345 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2346 z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2347 OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2348 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2349 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2350 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2351 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2352 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2356 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2357 wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet
2358 und die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses
2359 Makro muss in der Dokumentenvorlage enthalten sein und
2360 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2361 ‘<literal>templates/print/rev-odt/invoice.odt</literal>’
2362 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
2363 ebenfalls enthalten sein muss.</para>
2365 <para>Als letztes muss herausgefunden werden, welchen Namen
2366 OpenOffice bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen
2367 gibt. Unter Debian ist dies momentan
2368 <literal>~/.config/libreoffice</literal>. kivitendo verwendet das
2369 Verzeichnis <literal>users/.openoffice.org2</literal>.
2370 Eventuell muss dieses Verzeichnis umbenannt werden.</para>
2372 <para>Dieses Verzeichnis, wie auch das komplette
2373 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2374 sein. Dieses wurde bereits erledigt (siehe <xref
2375 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber
2376 erneut überprüft werden, wenn die Konvertierung nach PDF
2380 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2382 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2383 Aufgaben erfüllen.</para>
2385 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2386 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2387 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2388 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2389 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2390 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2391 Anpassungen aufgeführt</emphasis>):</para>
2394 <title>Bezeichnung der Vorlagen</title>
2396 <para>Rechnung: invoice_besr.odt, Auftrag:
2397 sales_order_besr.odt</para>
2401 <title>Vorbereitungen im Adminbereich</title>
2403 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2404 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2405 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2406 ein Drucker eingerichtet werden:</para>
2410 <para>Druckeradministration → Drucker hinzufügen</para>
2414 <para>Mandant wählen</para>
2418 <para>Druckerbeschreibung → aussagekräftiger Text: wird in
2419 der Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B.
2420 mit Einzahlungsschein Bank xy)</para>
2424 <para>Druckbefehl → beliebiger Text (hat für das Erzeugen
2425 von Aufträgen oder Rechnungen als odt-Datei keine Bedeutung,
2426 darf aber nicht leer sein)</para>
2430 <para>Vorlagenkürzel → besr bzw. selbst gewähltes
2431 Vorlagensuffix (muss genau der Zeichenfolge entsprechen, die
2432 zwischen "invoice_" bzw. "sales_order_" und ".odt"
2437 <para>speichern</para>
2443 <title>Benutzereinstellungen</title>
2445 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2446 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2447 dies persönlich für sich bei den Benutzereinstellungen
2448 konfigurieren:</para>
2452 <para>Programm → Benutzereinstellungen →
2453 Druckoptionen</para>
2457 <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2461 <para>Standardausgabekanal → Bildschirm</para>
2465 <para>Standarddrucker → gewünschte Druckerbeschreibung
2466 auswählen (z.B. mit Einzahlungsschein Bank xy)</para>
2470 <para>Anzahl Kopien → leer</para>
2474 <para>speichern</para>
2480 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2482 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2483 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2484 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2485 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2490 <para>Für den Einzahlungsschein ist die letzte Seite des
2491 Dokuments reserviert</para>
2495 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2496 Zeile mit folgenden Angaben (<emphasis
2497 role="bold">Bank-Konto-Identifikationsnummer und
2498 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2499 Bank angepasst werden</emphasis>):<itemizedlist>
2501 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2502 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2504 <para>erster Wert: <emphasis
2505 role="bold">Bank-Konto-Identifikation</emphasis>
2506 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2507 angepasst werden</emphasis>.</para>
2511 <para>zweiter Wert: <%customernumber%>
2512 (Kundennummer: nur Ziffern, maximal 6)</para>
2516 <para>dritter Wert: <%ordnumber%>
2517 (Auftragsnummer bei Auftragsvorlage
2518 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2519 führende Buchstaben werden vom Makro entfernt</para>
2523 <para>vierter Wert: <%invnumber%>
2524 (Rechnungsnummer bei Rechnungsvorlage
2525 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2526 führende Buchstaben werden vom Makro entfernt</para>
2528 </itemizedlist></para>
2532 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2533 Bank, muss angepasst werden</emphasis>.</para>
2537 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2538 falls Einzahlungsschein ohne Betrag</para>
2542 <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2544 </itemizedlist></para>
2548 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2549 der Name und die Adresse der Bank, die Postkonto-Nummer der
2550 Bank, sowie der eigene Firmenname und die Firmenadresse
2551 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2552 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2553 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2559 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2560 ändernde Einträge in rot</screeninfo>
2564 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2571 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2572 odt-Rechnung (analog bei Auftrag)</title>
2574 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2575 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2576 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2577 den Benutzereinstellungen als persönlicher Standard gewählt
2582 <title>Makroeinstellungen in LibreOffice anpassen</title>
2584 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2585 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2586 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2587 angepasst werden:</para>
2591 <para>Extras → Optionen → Sicherheit →
2592 Makrosicherheit</para>
2596 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2597 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2598 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2603 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2604 der entsprechenden Nachfrage "Makros ausführen" auswählen.
2607 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2608 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2609 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2610 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2618 <sect1 id="config.eur">
2619 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
2622 <sect2 id="config.eur.introduction"
2623 xreflabel="Einführung in die Konfiguration zur EUR">
2624 <title>Einführung</title>
2626 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
2627 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
2628 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
2629 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
2630 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
2632 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
2633 die Mandantendatenbank verschoben und dabei auch gleich in drei
2634 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
2635 steuern lässt.</para>
2638 <sect2 id="config.eur.parameters"
2639 xreflabel="Konfigurationsparameter für EUR">
2640 <title>Konfigurationsparameter</title>
2642 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
2643 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
2647 <term><varname>profit_determination</varname></term>
2650 <para>Dieser Parameter legt die Berechnungsmethode für die
2651 Gewinnermittlung fest. Er enthält entweder
2652 <literal>balance</literal> für
2653 Betriebsvermögensvergleich/Bilanzierung oder
2654 <literal>income</literal> für die
2655 Einnahmen-Überschuss-Rechnung.</para>
2660 <term><varname>accounting_method</varname></term>
2663 <para>Dieser Parameter steuert die Buchungs- und
2664 Berechnungsmethoden für die Versteuerungsart. Er enthält
2665 entweder <literal>accrual</literal> für die Soll-Versteuerung
2666 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
2671 <term><varname>inventory_system</varname></term>
2674 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
2675 enthält entweder <literal>perpetual</literal> für die
2676 Bestandsmethode oder <literal>periodic</literal> für die
2677 Aufwandsmethode.</para>
2682 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
2683 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
2684 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
2685 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
2686 Bestandsmethode.</para>
2688 <para>Die Konfiguration "<varname>eur</varname>" unter
2689 <varname>[system]</varname> in der <link
2690 linkend="config.config-file">Konfigurationsdatei</link>
2691 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
2692 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
2695 <sect2 id="config.eur.setting-parameters">
2696 <title>Festlegen der Parameter</title>
2698 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
2699 der Admininstration können diese Optionen nun unabhängig voneinander
2700 eingestellt werden.</para>
2702 <para>Für die Schweiz sind folgende Einstellungen üblich:
2705 <para>Sollversteuerung</para>
2708 <para>Aufwandsmethode</para>
2711 <para>Bilanzierung</para>
2714 Diese Einstellungen werden automatisch beim Erstellen einer neuen
2715 Datenbank vorausgewählt, wenn in <filename>config/kivitendo.conf</filename> unter
2716 <varname>[system]</varname> <literal>default_manager = swiss</literal> eingestellt ist.
2719 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
2720 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
2723 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
2724 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
2725 angezeigt. Unter <guimenu>System</guimenu> →
2726 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
2727 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
2728 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
2729 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
2730 auch <link linkend="config.eur.inventory-system-perpetual">
2731 Bemerkungen zur Bestandsmethode</link>).</para>
2734 <sect2 id="config.eur.inventory-system-perpetual">
2735 <title>Bemerkungen zur Bestandsmethode</title>
2737 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
2738 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
2739 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
2740 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
2741 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
2742 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
2743 Einkaufsrechnungen berechnet wird.</para>
2745 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
2746 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
2747 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
2751 <sect2 id="config.eur.knonw-issues">
2752 <title>Bekannte Probleme</title>
2754 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
2755 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
2756 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
2757 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
2758 die Konfigurationsvariable
2759 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
2762 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
2763 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
2767 <sect1 id="config.skr04-update-3804">
2768 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
2770 <sect2 id="config.skr04-update-3804.introduction">
2771 <title>Einführung</title>
2773 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
2774 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
2775 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
2776 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
2777 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
2778 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
2779 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
2780 vielleicht schon selbst geholfen hat und mit seinen Änderungen
2781 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
2782 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
2783 Screenshots dargestellt.</para>
2785 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
2786 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
2787 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
2788 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
2791 <sect2 id="config.skr04-update-3804.create-chart">
2792 <title>Konto 3804 manuell anlegen</title>
2794 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
2795 anzulegen und zu konfigurieren. Zuerst wird in
2796 <guimenu>System</guimenu> →
2797 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konto
2798 erfassen</guimenuitem> das Konto angelegt.</para>
2801 <screeninfo>Konto 3804 erfassen</screeninfo>
2805 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
2810 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
2811 werden. Dazu unter <guimenu>System</guimenu> →
2812 <guisubmenu>Steuern</guisubmenu> →
2813 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
2814 13 auswählen und ihn wie im folgenden Screenshot angezeigt
2818 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
2822 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
2827 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
2828 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
2829 <guisubmenu>Steuern</guisubmenu> →
2830 <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem
2831 Screenshot übernehmen.</para>
2834 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
2838 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
2843 <para>Als Nächstes sind alle Konten anzupassen, die als
2844 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
2845 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
2846 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
2847 müssen Sie dazu unter <guimenu>System</guimenu> →
2848 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
2849 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
2850 wie im Screenshot gezeigt vornehmen.</para>
2853 <screeninfo>Konto 4315 anpassen</screeninfo>
2857 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
2862 <para>Als Letztes sollte die Steuerliste unter
2863 <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
2864 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
2865 Vergleich der Screenshot.</para>
2868 <screeninfo>Steuerliste vergleichen</screeninfo>
2872 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
2879 <sect1 id="config.bilanz">
2880 <title>Verhalten des Bilanzberichts</title>
2882 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
2883 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
2884 monatsweise führt dies zu falschen Werten.</para>
2886 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
2887 einstellen indem man:</para>
2891 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
2896 <para>immer den Jahresanfang nimmt (1.1. relativ zum
2901 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
2903 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
2906 <para>- oder mit "alle Buchungen" als Alternative"</para>
2910 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
2915 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
2919 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
2920 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
2921 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
2922 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
2923 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
2924 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
2925 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
2926 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
2927 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
2928 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
2929 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
2930 Erfolgsrechnung.</para>
2933 <sect1 id="config.erfolgsrechnung">
2934 <title>Erfolgsrechnung</title>
2936 <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht <emphasis role="bold">
2937 Erfolgsrechnung</emphasis>.</para>
2939 <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter Features
2940 an- oder abgeschaltet werden. Mit der Einstellung <varname>default_manager = swiss
2941 </varname> in der <filename>config/kivitendo.conf</filename> wird beim neu Erstellen
2942 einer Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü <guimenu>Berichte
2943 </guimenu> ausgewählt und ersetzt dort die GUV.</para>
2945 <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche Aufwands- und
2946 Erlöskonten einzeln aufgelistet (analog zur Bilanz), sortiert nach ERTRAG und AUFWAND.</para>
2948 <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der Erfolgsrechnung
2949 erscheinen soll, unter <varname>Sonstige Einstellungen/Erfolgsrechnung</varname>
2950 entweder <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal> ausgewählt
2953 <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal> ausgewählt,
2954 so wird dieses Konto als Aufwandsminderung unter AUFWAND aufgelistet.</para>
2956 <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal> ausgewählt,
2957 so wird dieses Konto als Ertragsminderung unter ERTRAG aufgelistet.</para>
2959 <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft zusätzlich
2960 die Erfolgsrechnung als Bericht verwendet werden, so müssen die Einstellungen
2961 zu allen Erlös- und Aufwandskonten unter <varname>Sonstige
2962 Einstellungen/Erfolgsrechnung</varname> überprüft und allenfalls neu gesetzt werden.</para>
2965 <sect1 id="config.rounding">
2966 <title>Rundung in Verkaufsbelegen</title>
2968 <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert von 5 Rappen (0.05 CHF).</para>
2970 <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer Genauigkeit
2971 von 0.01 CHF verwendet werden können, ist es trotzdem nach wie vor üblich,
2972 Rechnungen mit auf 0.05 CHF gerundeten Beträgen auszustellen.</para>
2974 <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine solche
2975 Rundung pro Mandant / Datenbank festgelegt werden.</para>
2977 <para>Die Einstellung wird beim Erstellen der Datenbank bei <literal>Genauigkeit</literal>
2978 festgelegt. Sie kann anschliessend über das Webinterface von kivitendo nicht mehr
2979 verändert werden.</para>
2981 <para>Abhängig vom Wert für <varname>default_manager</varname> in
2982 <filename>config/kivitendo.conf</filename> werden dabei folgende
2983 Werte voreingestellt:</para>
2986 <para>0.05 (default_manager = swiss)</para>
2989 <para>0.01 (default_manager = german)</para>
2992 <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
2993 </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
2995 <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
2996 und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet,
2997 wenn dieser nicht der eingestellten Genauigkeit entspricht.</para>
2999 <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
3000 automatisch auf die in der Mandantenkonfiguration festgelegten
3001 Standardkonten für Rundungserträge bzw. Rundungsaufwendungen gebucht.</para>
3003 <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr verändert.)</para>
3005 <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
3006 <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
3007 <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
3009 <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege
3010 in anderen Währungen als der Standardwährung erstellt, so muss in
3011 kivitendo ab Version 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
3012 <para>Das heisst, Firmen in der Schweiz, die teilweise Verkaufsrechnungen
3013 in Euro oder anderen Währungen erstellen wollen, müssen beim Erstellen
3014 der Datenbank als Genauigkeit 0.01 wählen und können zur Zeit die
3015 5er Rundung noch nicht nutzen.</para>
3018 <sect1 id="config.client">
3019 <title>Einstellungen pro Mandant</title>
3021 <para>Einige Einstellungen können von einem Benutzer mit dem <link
3022 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
3023 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
3024 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3025 Die Einstellungen sind unter <guimenu>System</guimenu> →
3026 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3028 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3029 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3030 geändert werden (siehe auch <link
3031 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3032 Bestandsmethode</link>).</para>
3034 <para>Die Einstellungen <literal>show_bestbefore</literal> und
3035 <literal>payments_changeable</literal> aus dem Abschnitt
3036 <literal>features</literal> und die Einstellungen im Abschnitt
3037 <literal>datev_check</literal> (sofern schon vorhanden) der <link
3038 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3039 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3040 Diese Einträge können danach aus der Konfigurationsdatei entfernt
3044 <sect1 id="kivitendo-ERP-verwenden">
3045 <title>kivitendo ERP verwenden</title>
3047 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3048 folgender URL erreichbar:</para>
3051 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3053 <para>Die Administrationsseite erreichen Sie unter:</para>
3056 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3060 <chapter id="features" xreflabel="Features und Funktionen">
3061 <title>Features und Funktionen</title>
3063 <sect1 id="features.periodic-invoices"
3064 xreflabel="Wiederkehrende Rechnungen">
3065 <title>Wiederkehrende Rechnungen</title>
3067 <sect2 id="features.periodic-invoices.introduction"
3068 xreflabel="Einführung in wiederkehrende Rechnungen">
3069 <title>Einführung</title>
3071 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3072 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3073 Die konfigurierten Aufträge werden später automatisch in Rechnungen
3074 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3075 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3076 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3077 wiederzufinden sind.</para>
3080 <sect2 id="features.periodic-invoices.configuration"
3081 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3082 <title>Konfiguration</title>
3084 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3085 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3086 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3087 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3088 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3091 <para>Folgende Parameter kann man konfigurieren:</para>
3098 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3099 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3100 eines neuen Monats).</para>
3102 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3103 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3104 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3105 nächsten Periodenwechsel für alle Perioden, seit der letzten
3106 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3107 verhindern, muss man vorher das Startdatum neu setzen.</para>
3109 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3110 erstellt. Man kann sich diese Aufträge aber gesondert in den
3111 Berichten anzeigen lassen.</para>
3116 <term>Periodizität</term>
3119 <para>Ob monatlich, quartalsweise oder jährlich auf neue
3120 Rechnungen überprüft werden soll. Für jede Periode seit dem
3121 Startdatum wird überprüft, ob für die Periode (beginnend immer
3122 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3123 wurde. Unter Umständen können bei einem Startdatum in der
3124 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3129 <term>Buchen auf</term>
3132 <para>Das Forderungskonto, in der Regel "Forderungen aus
3133 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3134 Buchungsgruppen der betreffenden Waren.</para>
3139 <term>Startdatum</term>
3142 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3148 <term>Enddatum</term>
3151 <para>ab wann keine Rechnungen mehr erstellt werden
3157 <term>Automatische Verlängerung um x Monate</term>
3160 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3161 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3162 hier die Anzahl der Monate eingeben, um die das Enddatum
3163 automatisch nach hinten geschoben wird.</para>
3168 <term>Drucken</term>
3171 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3172 Rechnungen auch gleich ausdrucken lassen.</para>
3177 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3178 Informationen zu den erstellten Rechnungen verschickt werden.
3179 Konfiguriert wird dies in der <link
3180 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3181 <filename>config/kivitendo.conf</filename> im Abschnitt
3182 <varname>[periodic_invoices]</varname>.</para>
3185 <sect2 id="features.periodic-invoices.variables">
3186 <title>Spezielle Variablen</title>
3188 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3189 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3190 formatierte Variablen durch für die jeweils aktuelle
3191 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3192 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3193 die Syntax <literal><%variablenname%></literal>.</para>
3195 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3196 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3197 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3198 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3199 Die zur verfügung stehenden Formatinformationen werden unten genauer
3202 <para>Diese Variablen können auch beim automatischen Versand der
3203 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3204 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3206 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3211 <para>Bemerkungen</para>
3215 <para>Interne Bemerkungen</para>
3219 <para>Vorgangsbezeichnung</para>
3223 <para>In den Beschreibungs- und Langtextfeldern aller
3228 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3232 <term><varname><%current_quarter%></varname>,
3233 <varname><%previous_quarter%></varname>,
3234 <varname><%next_quarter%></varname></term>
3237 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3238 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3243 <term><varname><%current_month%></varname>,
3244 <varname><%previous_month%></varname>,
3245 <varname><%next_month%></varname></term>
3248 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3249 <literal>1</literal> und <literal>12</literal>.</para>
3254 <term><varname><%current_month_long%></varname>,
3255 <varname><%previous_month_long%></varname>,
3256 <varname><%next_month_long%></varname></term>
3259 <para>Aktueller, vorheriger und nächster Monat als Name
3260 (<literal>Januar</literal>, <literal>Februar</literal>
3266 <term><varname><%current_year%></varname>,
3267 <varname><%previous_year%></varname>,
3268 <varname><%next_year%></varname></term>
3271 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3272 Jahreszahl (<literal>2013</literal> etc.).</para>
3277 <term><varname><%period_start_date%></varname>,
3278 <varname><%period_end_date%></varname></term>
3281 <para>Formatiertes Datum des ersten und letzten Tages im
3282 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3283 ersten Quartal von 2013 wären dies der
3284 <literal>01.01.2013</literal> und
3285 <literal>31.03.2013</literal>).</para>
3290 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3291 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3292 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3293 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3298 <term><varname>%a</varname></term>
3301 <para>Der abgekürzte Wochentagsname.</para>
3306 <term><varname>%A</varname></term>
3309 <para>Der ausgeschriebene Wochentagsname.</para>
3314 <term><varname>%b</varname></term>
3317 <para>Der abgekürzte Monatsname.</para>
3322 <term><varname>%B</varname></term>
3325 <para>Der ausgeschriebene Monatsname.</para>
3330 <term><varname>%C</varname></term>
3333 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3339 <term><varname>%d</varname></term>
3342 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3347 <term><varname>%D</varname></term>
3350 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3355 <term><varname>%e</varname></term>
3358 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3359 werden führende Nullen durch Leerzeichen ersetzt.</para>
3364 <term><varname>%F</varname></term>
3367 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3372 <term><varname>%j</varname></term>
3375 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3381 <term><varname>%m</varname></term>
3384 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3389 <term><varname>%u</varname></term>
3392 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3393 die 1 dem Montag entspricht.</para>
3398 <term><varname>%U</varname></term>
3401 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3402 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3408 <term><varname>%V</varname></term>
3411 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3412 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3413 vier Tage im Jahr liegen; Montag ist erster Tag der
3419 <term><varname>%w</varname></term>
3422 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3423 die 0 dem Sonntag entspricht.</para>
3428 <term><varname>%W</varname></term>
3431 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3432 wobei der erste Montag im Jahr das Startdatum von Woche 01
3438 <term><varname>%y</varname></term>
3441 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3447 <term><varname>%Y</varname></term>
3450 <para>Das Jahr als vierstellige Zahl.</para>
3455 <term><varname>%%</varname></term>
3458 <para>Das Prozentzeichen selber.</para>
3463 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3464 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3465 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3466 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3469 <sect2 id="features.periodic-invoices.reports">
3470 <title>Auflisten</title>
3472 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3473 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3474 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3475 wiederkehrenden Rechnungen verschaffen kann.</para>
3478 <sect2 id="features.periodic-invoices.task-server">
3479 <title>Erzeugung der eigentlichen Rechnungen</title>
3481 <para>Die zeitliche und periodische Überprüfung, ob eine
3482 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3483 durch den <link linkend="config.task-server">Taskserver</link>, einen
3484 externen Dienst, der automatisch beim Start des Servers gestartet
3485 werden sollte.</para>
3488 <sect2 id="features.periodic-invoices.create-for-current-month">
3489 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3491 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3492 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3493 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
3494 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3495 generiert hat. Alternativ setzt man das Startdatum auf den
3496 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3497 manuell über den Workflow.</para>
3501 <sect1 id="features.bank" xreflabel="bankerweiterung">
3502 <title>Bankerweiterung</title>
3504 <sect2 id="features.bank.introduction"
3505 xreflabel="Einführung in die Bankerweiterung">
3506 <title>Einführung</title>
3508 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3509 im Wiki und soll von dort später hierhin übernommen werden:</para>
3512 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3516 <sect1 id="dokumentenvorlagen-und-variablen">
3517 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3519 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3520 <title>Einführung</title>
3522 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3523 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3524 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3525 <function><%variablenname%></function> verwendet wird. Für
3526 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3528 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3530 <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3531 Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im
3532 Folgenden gesagte für alle Vorlagenarten.</para>
3534 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3535 verfügbar als hier aufgelistet werden. Die meisten davon können
3536 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3537 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3538 diese wie folgt erhalten werden:</para>
3542 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3543 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3547 <para>In <filename>Form.pm</filename> die Funktion
3548 <function>parse_template</function> suchen und hier die Zeile
3549 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3553 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3554 ein PDF für eine Rechnung erzeugen.</para>
3558 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3559 der Variablen <varname>$self</varname> in der Form <varname>'key'
3560 => 'value',</varname>. Alle <varname>key</varname>s sind
3566 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3567 <title>Variablen ausgeben</title>
3569 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3570 Tags geschrieben werden, also z.B.
3571 <varname><%variablenname%></varname>.</para>
3573 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3574 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3575 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
3576 werden die folgenden Flags unterstützt:</para>
3580 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3581 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3582 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3583 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3587 <para><option>NOESCAPE</option> unterdrückt das Escapen von
3588 Sonderzeichen für die Vorlagensprache. Wenn also in einer
3589 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
3590 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
3591 ist dieses Flag sinnvoll.</para>
3595 <para>Beispiel:</para>
3597 <programlisting><%quototal NOFORMAT%></programlisting>
3600 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
3601 <title>Verwendung in Druckbefehlen</title>
3603 <para>In der Admininstration können Drucker definiert werden. Auch im
3604 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
3605 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
3606 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
3607 <function>`...`</function> nicht zu unerwünschtem Verhalten
3610 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
3611 für das die Telefonnummer eines Ansprechpartners als Teil der
3612 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
3613 z.B. wie folgt aussehen:</para>
3615 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
3618 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
3619 xreflabel="Anfang und Ende der Tags verändern">
3620 <title>Anfang und Ende der Tags verändern</title>
3622 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
3623 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
3624 Prozentzeichen und dem Größerzeichen endet, beispielsweise
3625 <function><%customer%></function>. Da diese Form aber z.B. in
3626 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
3627 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
3628 Stil umgestellt werden.</para>
3630 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
3631 Format gültigen Kommentarzeichen anfangen, dann
3632 <function>config:</function> enthalten, die entsprechende Option
3633 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
3634 enden. Beispiel für LaTeX:</para>
3636 <programlisting>% config: tag-style=($ $)</programlisting>
3638 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
3639 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
3640 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
3642 <programlisting><!-- config: tag-style=($ $) --></programlisting>
3645 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
3646 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
3648 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
3649 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
3650 "<filename>.ext</filename>" geeignet zu ersetzen:
3651 "<filename>.tex</filename>" für LaTeX-Vorlagen und
3652 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
3656 <term><filename>bin_list.ext</filename></term>
3659 <para>Lagerliste</para>
3664 <term><filename>check.ext</filename></term>
3672 <term><filename>invoice.ext</filename></term>
3675 <para>Rechnung</para>
3680 <term><filename>packing_list.ext</filename></term>
3683 <para>Packliste</para>
3688 <term><filename>pick_list.ext</filename></term>
3691 <para>Sammelliste</para>
3696 <term><filename>purchase_delivery_order.ext</filename></term>
3699 <para>Lieferschein (Einkauf)</para>
3704 <term><filename>purcharse_order.ext</filename></term>
3707 <para>Bestellung an Lieferanten</para>
3712 <term><filename>request_quotation.ext</filename></term>
3715 <para>Anfrage an Lieferanten</para>
3720 <term><filename>sales_delivery_order.ext</filename></term>
3723 <para>Lieferschein (Verkauf)</para>
3728 <term><filename>sales_order.ext</filename></term>
3731 <para>Bestellung</para>
3736 <term><filename>sales_quotation.ext</filename></term>
3739 <para>Angebot an Kunden</para>
3744 <term><filename>zahlungserinnerung.ext</filename></term>
3747 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
3752 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
3755 <para>Rechnung über Mahngebühren (Dateiname im Programm
3756 konfigurierbar)</para>
3762 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
3763 <title>Sprache, Drucker und E-Mail</title>
3765 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
3766 eingearbeitet. So wird aus der Vorlage
3767 <filename>sales_order.ext</filename> bei Sprache
3768 <function>de</function> und Druckerkürzel <function>lpr2</function>
3769 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
3770 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
3771 bekommen dann noch das Kürzel <filename>_email</filename>, der
3772 vollständige Vorlagenname wäre dann
3773 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
3774 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
3775 werden. Diese wird verwendet, wenn keine der anderen Varianten
3776 gefunden wird.</para>
3778 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
3779 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
3780 verschickt wird, ist:</para>
3784 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
3788 <para><filename>sales_order_de_lpr2.tex</filename></para>
3792 <para><filename>sales_order.tex</filename></para>
3796 <para><filename>default.tex</filename></para>
3800 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
3801 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
3803 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
3806 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
3807 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
3810 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
3811 xreflabel="Metainformationen zur angeforderten Vorlage">
3812 <title>Metainformationen zur angeforderten Vorlage</title>
3814 <para>Diese Variablen liefern Informationen darüber welche Variante
3815 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
3816 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
3817 Formulare einbinden möchten.</para>
3821 <term><varname>template_meta.formname</varname></term>
3824 <para>Basisname der Vorlage. Identisch mit der <link
3825 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
3826 zu den Dateinamen</link> ohne die Erweiterung. Ein
3827 Verkaufsauftrag enthält hier
3828 <constant>sales_order</constant>.</para>
3833 <term><varname>template_meta.language.description</varname></term>
3836 <para>Beschreibung der verwendeten Sprache</para>
3841 <term><varname>template_meta.language.template_code</varname></term>
3844 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
3845 dem Kürzel das im Dateinamen verwendetet wird.</para>
3850 <term><varname>template_meta.language.output_numberformat</varname></term>
3853 <para>Zahlenformat der verwendeten Sprache in der Form
3854 "<constant>1.000,00</constant>". Experimentell! Nur
3855 interessant für Vorlagen die mit unformatierten Werten
3861 <term><varname>template_meta.language.output_dateformat</varname></term>
3864 <para>Datumsformat der verwendeten Sprache in der Form
3865 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
3866 interessant für Vorlagen die mit unformatierten Werten
3872 <term><varname>template_meta.format</varname></term>
3875 <para>Das angeforderte Format. Kann im Moment die Werte
3876 <constant>pdf</constant>, <constant>postscript</constant>,
3877 <constant>html</constant>, <constant>opendocument</constant>,
3878 <constant>opendocument_pdf</constant> und
3879 <constant>excel</constant> enthalten.</para>
3884 <term><varname>template_meta.extension</varname></term>
3887 <para>Dateierweiterung, wie im Dateinamen. Wird aus
3888 <constant>format</constant> entschieden.</para>
3893 <term><varname>template_meta.media</varname></term>
3896 <para>Ausgabemedium. Kann zur Zeit die Werte
3897 <constant>screen</constant> für Bildschirm,
3898 <constant>email</constant> für E-Mail (triggert das
3899 <constant>_email</constant> Kürzel im Dateinamen),
3900 <constant>printer</constant> für Drucker, und
3901 <constant>queue</constant> für Warteschlange enthalten.</para>
3906 <term><varname>template_meta.printer.description</varname></term>
3909 <para>Beschreibung des ausgewählten Druckers</para>
3914 <term><varname>template_meta.printer.template_code</varname></term>
3917 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
3918 dem Kürzel das im Dateinamen verwendetet wird.</para>
3923 <term><varname>template_meta.tmpfile</varname></term>
3926 <para>Datei-Prefix für temporäre Dateien.</para>
3932 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
3933 <title>Stammdaten von Kunden und Lieferanten</title>
3937 <term><varname>account_number</varname></term>
3940 <para>Kontonummer</para>
3945 <term><varname>bank</varname></term>
3948 <para>Name der Bank</para>
3953 <term><varname>bank_code</varname></term>
3956 <para>Bankleitzahl</para>
3961 <term><varname>bic</varname></term>
3964 <para>Bank-Identifikations-Code (Bank Identifier Code,
3970 <term><varname>business</varname></term>
3973 <para>Kunden-/Lieferantentyp</para>
3978 <term><varname>city</varname></term>
3986 <term><varname>contact</varname></term>
3989 <para>Kontakt</para>
3994 <term><varname>country</varname></term>
4002 <term><varname>c_vendor_id</varname></term>
4005 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
4010 <term><varname>v_customer_id</varname></term>
4013 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
4018 <term><varname>cp_email</varname></term>
4021 <para>Email des Ansprechpartners</para>
4026 <term><varname>cp_givenname</varname></term>
4029 <para>Vorname des Ansprechpartners</para>
4034 <term><varname>cp_greeting</varname></term>
4037 <para>Anrede des Ansprechpartners</para>
4042 <term><varname>cp_name</varname></term>
4045 <para>Name des Ansprechpartners</para>
4050 <term><varname>cp_phone1</varname></term>
4053 <para>Telefonnummer 1 des Ansprechpartners</para>
4058 <term><varname>cp_phone2</varname></term>
4061 <para>Telefonnummer 2 des Ansprechpartners</para>
4066 <term><varname>cp_title</varname></term>
4069 <para>Titel des Ansprechpartners</para>
4074 <term><varname>creditlimit</varname></term>
4077 <para>Kreditlimit</para>
4082 <term><varname>customeremail</varname></term>
4085 <para>Email des Kunden; nur für Kunden</para>
4090 <term><varname>customerfax</varname></term>
4093 <para>Faxnummer des Kunden; nur für Kunden</para>
4098 <term><varname>customernotes</varname></term>
4101 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4106 <term><varname>customernumber</varname></term>
4109 <para>Kundennummer; nur für Kunden</para>
4114 <term><varname>customerphone</varname></term>
4117 <para>Telefonnummer des Kunden; nur für Kunden</para>
4122 <term><varname>discount</varname></term>
4130 <term><varname>email</varname></term>
4133 <para>Emailadresse</para>
4138 <term><varname>fax</varname></term>
4141 <para>Faxnummer</para>
4146 <term><varname>gln</varname></term>
4149 <para>GLN (Globale Lokationsnummer)</para>
4154 <term><varname>greeting</varname></term>
4162 <term><varname>homepage</varname></term>
4165 <para>Homepage</para>
4170 <term><varname>iban</varname></term>
4173 <para>Internationale Kontonummer (International Bank Account
4174 Number, IBAN)</para>
4179 <term><varname>language</varname></term>
4182 <para>Sprache</para>
4187 <term><varname>name</varname></term>
4190 <para>Firmenname</para>
4195 <term><varname>payment_description</varname></term>
4198 <para>Name der Zahlart</para>
4203 <term><varname>payment_terms</varname></term>
4206 <para>Zahlungskonditionen</para>
4211 <term><varname>phone</varname></term>
4214 <para>Telefonnummer</para>
4219 <term><varname>shiptocity</varname></term>
4222 <para>Stadt (Lieferadresse) <link
4223 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4228 <term><varname>shiptocontact</varname></term>
4231 <para>Kontakt (Lieferadresse) <link
4232 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4237 <term><varname>shiptocountry</varname></term>
4240 <para>Land (Lieferadresse) <link
4241 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4246 <term><varname>shiptodepartment_1</varname></term>
4249 <para>Abteilung 1 (Lieferadresse) <link
4250 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4255 <term><varname>shiptodepartment_2</varname></term>
4258 <para>Abteilung 2 (Lieferadresse) <link
4259 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4264 <term><varname>shiptoemail</varname></term>
4267 <para>Email (Lieferadresse) <link
4268 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4273 <term><varname>shiptofax</varname></term>
4276 <para>Fax (Lieferadresse) <link
4277 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4282 <term><varname>shiptogln</varname></term>
4285 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4286 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4291 <term><varname>shiptoname</varname></term>
4294 <para>Firmenname (Lieferadresse) <link
4295 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4300 <term><varname>shiptophone</varname></term>
4303 <para>Telefonnummer (Lieferadresse) <link
4304 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4309 <term><varname>shiptostreet</varname></term>
4312 <para>Straße und Hausnummer (Lieferadresse) <link
4313 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4318 <term><varname>shiptozipcode</varname></term>
4321 <para>Postleitzahl (Lieferadresse) <link
4322 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4327 <term><varname>street</varname></term>
4330 <para>Straße und Hausnummer</para>
4335 <term><varname>taxnumber</varname></term>
4338 <para>Steuernummer</para>
4343 <term><varname>ustid</varname></term>
4346 <para>Umsatzsteuer-Identifikationsnummer</para>
4351 <term><varname>vendoremail</varname></term>
4354 <para>Email des Lieferanten; nur für Lieferanten</para>
4359 <term><varname>vendorfax</varname></term>
4362 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4367 <term><varname>vendornotes</varname></term>
4370 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4375 <term><varname>vendornumber</varname></term>
4378 <para>Lieferantennummer; nur für Lieferanten</para>
4383 <term><varname>vendorphone</varname></term>
4386 <para>Telefonnummer des Lieferanten; nur für
4392 <term><varname>zipcode</varname></term>
4395 <para>Postleitzahl</para>
4400 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4401 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4402 Stammdaten nicht eingetragen, so haben die Variablen
4403 <varname>shipto*</varname> den gleichen Wert wie die die
4404 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4405 einige <varname>shipto*</varname>-Variablen so nicht in den
4406 Stammdaten wiederfinden sondern schlicht Kopien der
4407 Lieferdatenvariablen sind (z.B.
4408 <varname>shiptocontact</varname>).</para>
4412 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4413 <title>Informationen über den Bearbeiter</title>
4417 <term><varname>employee_address</varname></term>
4420 <para>Adressfeld</para>
4425 <term><varname>employee_businessnumber</varname></term>
4428 <para>Firmennummer</para>
4433 <term><varname>employee_company</varname></term>
4436 <para>Firmenname</para>
4441 <term><varname>employee_co_ustid</varname></term>
4444 <para>Usatzsteuer-Identifikationsnummer</para>
4449 <term><varname>employee_duns</varname></term>
4452 <para>DUNS-Nummer</para>
4457 <term><varname>employee_email</varname></term>
4465 <term><varname>employee_fax</varname></term>
4473 <term><varname>employee_name</varname></term>
4476 <para>voller Name</para>
4481 <term><varname>employee_signature</varname></term>
4484 <para>Signatur</para>
4489 <term><varname>employee_taxnumber</varname></term>
4492 <para>Steuernummer</para>
4497 <term><varname>employee_tel</varname></term>
4500 <para>Telefonnummer</para>
4506 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4507 <title>Informationen über den Verkäufer</title>
4511 <term><varname>salesman_address</varname></term>
4514 <para>Adressfeld</para>
4519 <term><varname>salesman_businessnumber</varname></term>
4522 <para>Firmennummer</para>
4527 <term><varname>salesman_company</varname></term>
4530 <para>Firmenname</para>
4535 <term><varname>salesman_co_ustid</varname></term>
4538 <para>Usatzsteuer-Identifikationsnummer</para>
4543 <term><varname>salesman_duns</varname></term>
4546 <para>DUNS-Nummer</para>
4551 <term><varname>salesman_email</varname></term>
4559 <term><varname>salesman_fax</varname></term>
4567 <term><varname>salesman_name</varname></term>
4570 <para>voller Name</para>
4575 <term><varname>salesman_signature</varname></term>
4578 <para>Signatur</para>
4583 <term><varname>salesman_taxnumber</varname></term>
4586 <para>Steuernummer</para>
4591 <term><varname>salesman_tel</varname></term>
4594 <para>Telefonnummer</para>
4600 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
4601 <title>Variablen für die einzelnen Steuern</title>
4605 <term><varname>tax</varname></term>
4613 <term><varname>taxbase</varname></term>
4616 <para>zu versteuernder Betrag</para>
4621 <term><varname>taxdescription</varname></term>
4624 <para>Name der Steuer</para>
4629 <term><varname>taxrate</varname></term>
4632 <para>Steuersatz</para>
4638 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
4639 <title>Variablen für Lieferbedingungen</title>
4643 <term><varname>delivery_term</varname></term>
4646 <para>Datenbank-Objekt der Lieferbedingung</para>
4651 <term><varname>delivery_term.description</varname></term>
4654 <para>Beschreibung der Lieferbedingung</para>
4659 <term><varname>delivery_term.description_long</varname></term>
4662 <para>Langtext bzw. übersetzter Langtext der
4663 Lieferbedingung</para>
4670 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
4671 <title>Variablen in Rechnungen</title>
4673 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
4674 <title>Allgemeine Variablen</title>
4678 <term><varname>creditremaining</varname></term>
4681 <para>Verbleibender Kredit</para>
4686 <term><varname>currency</varname></term>
4689 <para>Währung</para>
4694 <term><varname>cusordnumber</varname></term>
4697 <para>Bestellnummer beim Kunden</para>
4702 <term><varname>deliverydate</varname></term>
4705 <para>Lieferdatum</para>
4710 <term><varname>duedate</varname></term>
4713 <para>Fälligkeitsdatum</para>
4718 <term><varname>globalprojectnumber</varname></term>
4721 <para>Projektnummer des ganzen Beleges</para>
4726 <term><varname>globalprojectdescription</varname></term>
4729 <para>Projekbeschreibung des ganzen Beleges</para>
4734 <term><varname>intnotes</varname></term>
4737 <para>Interne Bemerkungen</para>
4742 <term><varname>invdate</varname></term>
4745 <para>Rechnungsdatum</para>
4750 <term><varname>invnumber</varname></term>
4753 <para>Rechnungsnummer</para>
4758 <term><varname>invtotal</varname></term>
4761 <para>gesamter Rechnungsbetrag</para>
4766 <term><varname>notes</varname></term>
4769 <para>Bemerkungen der Rechnung</para>
4774 <term><varname>orddate</varname></term>
4777 <para>Auftragsdatum</para>
4782 <term><varname>ordnumber</varname></term>
4785 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
4786 erstellt wurde</para>
4791 <term><varname>payment_description</varname></term>
4794 <para>Name der Zahlart</para>
4799 <term><varname>payment_terms</varname></term>
4802 <para>Zahlungskonditionen</para>
4807 <term><varname>quodate</varname></term>
4810 <para>Angebotsdatum</para>
4815 <term><varname>quonumber</varname></term>
4818 <para>Angebotsnummer</para>
4823 <term><varname>rounding</varname></term>
4826 <para>Betrag, um den <varname>invtotal</varname> gerundet wurde
4827 (kann positiv oder negativ sein)</para>
4832 <term><varname>shippingpoint</varname></term>
4835 <para>Versandort</para>
4840 <term><varname>shipvia</varname></term>
4843 <para>Transportmittel</para>
4848 <term><varname>subtotal</varname></term>
4851 <para>Zwischensumme aller Posten ohne Steuern</para>
4856 <term><varname>total</varname></term>
4859 <para>Restsumme der Rechnung (Summe abzüglich bereits
4860 bezahlter Posten)</para>
4865 <term><varname>transaction_description</varname></term>
4868 <para>Vorgangsbezeichnung</para>
4873 <term><varname>transdate</varname></term>
4876 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
4877 erstellt wurde</para>
4883 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
4884 <title>Variablen für jeden Posten auf der Rechnung</title>
4888 <term><varname>bin</varname></term>
4891 <para>Stellage</para>
4896 <term><varname>description</varname></term>
4899 <para>Artikelbeschreibung</para>
4904 <term><varname>cusordnumber_oe</varname></term>
4907 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
4908 Posten ursprünglich stammt (nur Verkauf)</para>
4913 <term><varname>discount</varname></term>
4916 <para>Rabatt als Betrag</para>
4921 <term><varname>discount_sub</varname></term>
4924 <para>Zwischensumme mit Rabatt</para>
4929 <term><varname>donumber_do</varname></term>
4932 <para>Lieferscheinnummer des Lieferscheins, aus dem die
4933 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
4934 Workflows aus einem Lieferschein erstellt wurde.</para>
4939 <term><varname>drawing</varname></term>
4942 <para>Zeichnung</para>
4947 <term><varname>ean</varname></term>
4950 <para>EAN-Code</para>
4955 <term><varname>image</varname></term>
4963 <term><varname>linetotal</varname></term>
4966 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
4971 <term><varname>longdescription</varname></term>
4974 <para>Langtext</para>
4979 <term><varname>microfiche</varname></term>
4982 <para>Mikrofilm</para>
4987 <term><varname>netprice</varname></term>
4990 <para>Alternative zu <varname>sellprice</varname>, aber
4991 <varname>netprice</varname> entspricht dem effektiven
4992 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
4993 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
4994 / Menge. Diese Variable ist nützlich, wenn man den gewährten
4995 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
4996 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
4997 <varname>netprice</varname> hat nichts mit Netto/Brutto im
4998 Sinne von Steuern zu tun.</para>
5003 <term><varname>nodiscount_linetotal</varname></term>
5006 <para>Zeilensumme ohne Rabatt</para>
5011 <term><varname>nodiscount_sub</varname></term>
5014 <para>Zwischensumme ohne Rabatt</para>
5019 <term><varname>number</varname></term>
5022 <para>Artikelnummer</para>
5027 <term><varname>ordnumber_oe</varname></term>
5030 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5031 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5032 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5033 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5034 letzterem Fall wird die unsprüngliche Auftragsnummer
5040 <term><varname>p_discount</varname></term>
5043 <para>Rabatt in Prozent</para>
5048 <term><varname>partnotes</varname></term>
5051 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5056 <term><varname>partsgroup</varname></term>
5059 <para>Warengruppe</para>
5064 <term><varname>price_factor</varname></term>
5067 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5073 <term><varname>price_factor_name</varname></term>
5076 <para>Der Name des Preisfaktors, sofern einer eingestellt
5082 <term><varname>projectnumber</varname></term>
5085 <para>Projektnummer</para>
5090 <term><varname>projectdescription</varname></term>
5093 <para>Projektbeschreibung</para>
5098 <term><varname>qty</varname></term>
5106 <term><varname>reqdate</varname></term>
5109 <para>Lieferdatum</para>
5114 <term><varname>runningnumber</varname></term>
5117 <para>Position auf der Rechnung (1, 2, 3...)</para>
5122 <term><varname>sellprice</varname></term>
5125 <para>Verkaufspreis</para>
5130 <term><varname>serialnumber</varname></term>
5133 <para>Seriennummer</para>
5138 <term><varname>tax_rate</varname></term>
5141 <para>Steuersatz</para>
5146 <term><varname>transdate_do</varname></term>
5149 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5150 Workflows aus einem Lieferschein stammte.</para>
5155 <term><varname>transdate_oe</varname></term>
5158 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5159 Workflows aus einem Auftrag erstellt wurde. Wenn es
5160 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5166 <term><varname>transdate_quo</varname></term>
5169 <para>Datum des Angebots, wenn die Position im Rahmen des
5170 Workflows aus einem Angebot stammte.</para>
5175 <term><varname>unit</varname></term>
5178 <para>Einheit</para>
5183 <term><varname>weight</varname></term>
5186 <para>Gewicht</para>
5191 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5192 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5193 einer <function>foreach</function>-Schleife ausgegeben werden, da
5194 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5195 können. Die Variablen dafür lauten:</para>
5199 <term><varname>make</varname></term>
5202 <para>Lieferant</para>
5207 <term><varname>model</varname></term>
5210 <para>Lieferantenartikelnummer</para>
5216 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5217 <title>Variablen für die einzelnen Zahlungseingänge</title>
5221 <term><varname>payment</varname></term>
5229 <term><varname>paymentaccount</varname></term>
5237 <term><varname>paymentdate</varname></term>
5245 <term><varname>paymentmemo</varname></term>
5253 <term><varname>paymentsource</varname></term>
5262 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5263 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5265 <para>Die vom Benutzer definierten Variablen für Kunden und
5266 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5267 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5268 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5269 Variablennamen zusammen.</para>
5271 <para>Beispiel: Der Benutzer hat eine Variable namens
5272 <varname>number_of_employees</varname> definiert, die die Anzahl der
5273 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5274 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5277 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5278 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5279 Präfix <varname>shiptocvar_</varname>.</para>
5283 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5284 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5286 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5287 <title>Namen der Vorlagen</title>
5289 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5290 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5291 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5292 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5293 Vorlagenname für diese Mahnstufe mit dem Zusatz
5294 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5295 für die ausgewählte Sprache und den ausgewählten Drucker
5299 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5300 <title>Allgemeine Variablen in Mahnungen</title>
5302 <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie gewohnt als
5303 <varname>employee_...</varname> bzw. <varname>salesman_...</varname> zur Verfügung.
5304 Werden mehrere Rechnungen in einer Mahnung zusammengefasst, so werden
5305 die Metadaten (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung
5306 im Ausdruck genommen.</para>
5307 <para>Die Adressdaten des Kunden stehen als Variablen <varname>name</varname>,
5308 <varname>street</varname>, <varname>zipcode</varname>,
5309 <varname>city</varname>, <varname>country</varname>,
5310 <varname>department_1</varname>, <varname>department_2</varname>,
5311 und <varname>email</varname> zur Verfügung. Der Ansprechpartner <varname>cp_...</varname>
5312 steht auch zu Verfügung, wird allerdings auch nur von der ersten angemahnten Rechnung (s.o.)
5315 <para>Weitere Variablen beinhalten:</para>
5319 <term><varname>dunning_date</varname></term>
5322 <para>Datum der Mahnung</para>
5327 <term><varname>dunning_duedate</varname></term>
5330 <para>Fälligkeitsdatum für diese Mahhnung</para>
5335 <term><varname>dunning_id</varname></term>
5338 <para>Mahnungsnummer</para>
5343 <term><varname>fee</varname></term>
5346 <para>Kumulative Mahngebühren</para>
5351 <term><varname>interest_rate</varname></term>
5354 <para>Zinssatz per anno in Prozent</para>
5359 <term><varname>total_amount</varname></term>
5362 <para>Gesamter noch zu zahlender Betrag als
5363 <function>fee</function> + <function>total_interest</function>
5364 + <function>total_open_amount</function></para>
5369 <term><varname>total_interest</varname></term>
5372 <para>Zinsen per anno über alle Rechnungen</para>
5377 <term><varname>total_open_amount</varname></term>
5380 <para>Summe über alle offene Beträge der Rechnungen</para>
5386 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5387 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5391 <term><varname>dn_amount</varname></term>
5394 <para>Rechnungssumme (brutto)</para>
5399 <term><varname>dn_duedate</varname></term>
5402 <para>Originales Fälligkeitsdatum der Rechnung</para>
5407 <term><varname>dn_dunning_date</varname></term>
5410 <para>Datum der Mahnung</para>
5415 <term><varname>dn_dunning_duedate</varname></term>
5418 <para>Fälligkeitsdatum der Mahnung</para>
5423 <term><varname>dn_fee</varname></term>
5426 <para>Kummulative Mahngebühr</para>
5431 <term><varname>dn_interest</varname></term>
5434 <para>Zinsen per anno für diese Rechnung</para>
5439 <term><varname>dn_invnumber</varname></term>
5442 <para>Rechnungsnummer</para>
5447 <term><varname>dn_linetotal</varname></term>
5450 <para>Noch zu zahlender Betrag (ergibt sich aus
5451 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5452 + <varname>dn_interest</varname>)</para>
5457 <term><varname>dn_netamount</varname></term>
5460 <para>Rechnungssumme (netto)</para>
5465 <term><varname>dn_open_amount</varname></term>
5468 <para>Offener Rechnungsbetrag</para>
5473 <term><varname>dn_ordnumber</varname></term>
5476 <para>Bestellnummer</para>
5481 <term><varname>dn_transdate</varname></term>
5484 <para>Rechnungsdatum</para>
5489 <term><varname>dn_curr</varname></term>
5492 <para>Währung, in der die Rechnung erstellt wurde. (Die
5493 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5499 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5500 <title>Variablen in automatisch erzeugten Rechnungen über
5501 Mahngebühren</title>
5503 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5504 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5505 Kunden stehen als Variablen <varname>name</varname>,
5506 <varname>street</varname>, <varname>zipcode</varname>,
5507 <varname>city</varname>, <varname>country</varname>,
5508 <varname>department_1</varname>, <varname>department_2</varname>,
5509 und <varname>email</varname> zur Verfügung.</para>
5511 <para>Weitere Variablen beinhalten:</para>
5515 <term><varname>duedate</varname></term>
5518 <para>Fälligkeitsdatum der Rechnung</para>
5523 <term><varname>dunning_id</varname></term>
5526 <para>Mahnungsnummer</para>
5531 <term><varname>fee</varname></term>
5534 <para>Mahngebühren</para>
5539 <term><varname>interest</varname></term>
5547 <term><varname>invamount</varname></term>
5550 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
5551 <varname>interest</varname>)</para>
5556 <term><varname>invdate</varname></term>
5559 <para>Rechnungsdatum</para>
5564 <term><varname>invnumber</varname></term>
5567 <para>Rechnungsnummer</para>
5574 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
5575 <title>Variablen in anderen Vorlagen</title>
5578 <title>Einführung</title>
5580 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
5581 Rechnung. Allerdings heißen die Variablen, die mit
5582 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
5583 fangen sie mit <varname>quo</varname> für "quotation" an:
5584 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
5585 wiederum fangen sie mit <varname>ord</varname> für "order" an:
5586 <varname>ordnumber</varname> für Bestellnummer etc.</para>
5588 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
5589 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
5590 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
5591 Vorlage keine Bedeutung haben oder noch nicht belegt sein
5594 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
5595 in Rechnungen aufgeführt.</para>
5598 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
5599 <title>Angebote und Preisanfragen</title>
5603 <term><varname>quonumber</varname></term>
5606 <para>Angebots- bzw. Anfragenummer</para>
5611 <term><varname>reqdate</varname></term>
5614 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
5615 Preisanfragen)</para>
5620 <term><varname>transdate</varname></term>
5623 <para>Angebots- bzw. Anfragedatum</para>
5629 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
5630 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
5634 <term><varname>ordnumber</varname></term>
5637 <para>Auftragsnummer</para>
5642 <term><varname>reqdate</varname></term>
5645 <para>Lieferdatum</para>
5650 <term><varname>transdate</varname></term>
5653 <para>Auftragsdatum</para>
5659 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
5660 <title>Lieferscheine (Verkauf und Einkauf)</title>
5664 <term><varname>cusordnumber</varname></term>
5667 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
5668 des Lieferanten (im Einkauf)</para>
5673 <term><varname>donumber</varname></term>
5676 <para>Lieferscheinnummer</para>
5681 <term><varname>transdate</varname></term>
5684 <para>Lieferscheindatum</para>
5689 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
5690 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
5691 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
5692 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
5693 <function>foreach</function>-Schleife ausgegeben werden. Diese
5694 Variablen sind:</para>
5698 <term><varname>si_bin</varname></term>
5701 <para>Lagerplatz</para>
5706 <term><varname>si_chargenumber</varname></term>
5709 <para>Chargennummer</para>
5714 <term><varname>si_bestbefore</varname></term>
5717 <para>Mindesthaltbarkeit</para>
5722 <term><varname>si_number</varname></term>
5725 <para>Artikelnummer</para>
5730 <term><varname>si_qty</varname></term>
5733 <para>Anzahl bzw. Menge</para>
5738 <term><varname>si_runningnumber</varname></term>
5741 <para>Positionsnummer (1, 2, 3 etc)</para>
5746 <term><varname>si_unit</varname></term>
5749 <para>Einheit</para>
5754 <term><varname>si_warehouse</varname></term>
5763 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
5764 <title>Variablen für Sammelrechnung</title>
5768 <term><varname>c0total</varname></term>
5771 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
5777 <term><varname>c30total</varname></term>
5780 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
5781 und < 60 Tage</para>
5786 <term><varname>c60total</varname></term>
5789 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
5790 und < 90 Tage</para>
5795 <term><varname>c90total</varname></term>
5798 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
5804 <term><varname>total</varname></term>
5807 <para>Gesamtbetrag aller Rechnungen</para>
5812 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
5816 <term><varname>invnumber</varname></term>
5819 <para>Rechnungsnummer</para>
5824 <term><varname>invdate</varname></term>
5827 <para>Rechnungsdatum</para>
5832 <term><varname>duedate</varname></term>
5835 <para>Fälligkeitsdatum</para>
5840 <term><varname>amount</varname></term>
5843 <para>Summe der Rechnung</para>
5848 <term><varname>open</varname></term>
5851 <para>Noch offener Betrag der Rechnung</para>
5856 <term><varname>c0</varname></term>
5859 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
5865 <term><varname>c30</varname></term>
5868 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
5874 <term><varname>c60</varname></term>
5877 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
5883 <term><varname>c90</varname></term>
5886 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
5894 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
5895 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
5897 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
5898 <title>Einführung</title>
5900 <para>Der Parser kennt neben den Variablen einige weitere
5901 Konstrukte, die gesondert behandelt werden. Diese sind wie
5902 Variablennamen in spezieller Weise markiert:
5903 <command><%anweisung%> ... <%end%></command></para>
5905 <para>Anmerkung zum <command><%end%></command>: Der besseren
5906 Verständlichkeit halber kann man nach dem <command>end</command>
5907 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
5908 Anweisung (z.B. <command>if</command> oder
5909 <command>foreach</command>) damit abgeschlossen wird.</para>
5911 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
5912 <command><%if type == "sales_quotation"%></command>, so könnte
5913 er mit <command><%end%></command> genauso abgeschlossen werden
5914 wie mit <command><%end if%></command> oder auch
5915 <command><%end type == "sales_quotation"%></command>.</para>
5918 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
5919 <title>Der if-Block</title>
5921 <programlisting><%if variablenname%>
5923 <%end%></programlisting>
5925 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
5926 und dem "end" werden nur ausgegeben, wenn die Variable
5927 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
5929 <para>Handelt es sich bei der benannten Variable um ein Array, also
5930 um einen Variablennamen, über den man mit <command><%foreach
5931 variablenname%></command> iteriert, so wird mit diesem Konstrukt
5932 darauf getestet, ob das Array Elemente enthält. Somit würde im
5933 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
5934 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
5935 welche getätigt wurden:</para>
5937 <programlisting><%if payment%>
5939 <%foreach payment%>
5940 Am <%paymentdate%>: <%payment%> €
5941 <%end foreach%>
5942 <%end if%></programlisting>
5944 <para>Die Bedingung kann auch negiert werden, indem das Wort
5945 <function>not</function> nach dem <filename>if</filename> verwendet
5946 wird. Beispiel:</para>
5948 <programlisting><%if not cp_greeting%>
5950 <%end%></programlisting>
5952 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
5953 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
5954 einer Variablen mit einer festen Zeichenkette oder einer anderen
5955 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
5956 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
5957 die rechte Seite des Vergleichsoperators in Anführungszeichen
5958 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
5959 anderer Variablen). Zwei Beispiele, die beide Vergleiche
5962 <programlisting><%if var1 == "Wert"%></programlisting>
5964 <para>Testet die Variable <varname>var1</varname> auf
5965 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
5966 Mittels <function>!=</function> anstelle von <function>==</function>
5967 würde auf Ungleichheit getestet.</para>
5969 <programlisting><%if var1 == var2%></programlisting>
5971 <para>Testet die Variable <varname>var1</varname> auf
5972 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
5973 <function>!=</function> anstelle von <function>==</function> würde
5974 auf Ungleichheit getestet.</para>
5976 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
5977 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
5978 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
5979 dieselbe Syntax wie oben nur mit <function>=~</function> und
5980 <function>!~</function> als Vergleichsoperatoren.</para>
5982 <para>Beispiel für einen Test, ob die Variable
5983 <varname>intnotes</varname> (interne Bemerkungen) das Wort
5984 <constant>schwierig</constant> enthält:</para>
5986 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
5989 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
5990 <title>Der foreach-Block</title>
5992 <programlisting><%foreach variablenname%>
5994 <%end%></programlisting>
5996 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
5997 wie das Perl-Array der Variablen <varname>variablenname</varname>
5998 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
5999 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
6000 benutzt. In jedem Durchlauf werden die <link
6001 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
6002 Variablen</link> jeweils auf den Wert für die aktuelle Position
6005 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
6007 <programlisting><%foreach number%>
6008 Position: <%runningnumber%>
6009 Anzahl: <%qty%>
6010 Artikelnummer: <%number%>
6011 Beschreibung: <%description%>
6013 <%end%></programlisting>
6015 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
6016 <function><%foreach%></function>-Block innerhalb einer
6017 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
6018 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
6019 Inhalt zwischen <function><%foreach%></function> und
6020 <function><%end%></function> wiederholt, nicht aber die
6021 komplette Zeile, in der er steht.</para>
6025 <sect2 id="dokumentenvorlagen-und-variablen.markup">
6026 <title>Markup-Code zur Textformatierung innerhalb von
6029 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6030 anders formatiert haben möchte, so ist dies begrenzt möglich.
6031 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6032 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6033 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6034 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6035 (HTML oder PDF über LaTeX) umgesetzt.</para>
6037 <para>Die unterstützen Formatierungen sind:</para>
6041 <term><b>Text</b></term>
6044 <para>Text wird in Fettdruck gesetzt.</para>
6049 <term><i>Text</i></term>
6052 <para>Text wird kursiv gesetzt.</para>
6057 <term><u>Text</u></term>
6060 <para>Text wird unterstrichen.</para>
6065 <term><s>Text</s></term>
6068 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6069 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6074 <term><bullet></term>
6077 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6083 <para>Der Befehl <command><bullet></command> funktioniert
6084 momentan auch nur in Latex-Vorlagen.</para>
6088 <sect1 id="excel-templates">
6089 <title>Excel-Vorlagen</title>
6091 <sect2 id="excel-templates.summary">
6092 <title>Zusammenfassung</title>
6094 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6095 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6099 <sect2 id="excel-templates.usage">
6100 <title>Bedienung</title>
6102 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6103 werden. Die Konfigurationsoption heißt <varname>excel_templates =
6104 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6106 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6107 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6108 werden. In den normalen Verkaufsmasken taucht nun
6109 <constant>Excel</constant> als auswählbares Format auf und kann von da
6110 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6112 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6113 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6114 <filename>sales_quotation.xls</filename> gespeichert.</para>
6117 <sect2 id="excel-templates.syntax">
6118 <title>Variablensyntax</title>
6120 <para>Einfache Syntax:
6121 <command><<varname>></command></para>
6123 <para>Dabei sind <constant><<</constant> und
6124 <constant>>></constant> die Delimiter. Da Excel auf festen
6125 Breiten besteht, kann der Tag künstlich verlängert werden, indem
6126 weitere <constant><</constant> oder <constant>></constant>
6127 eingefügt werden. Der Tag muss nicht symmetrisch sein.
6130 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6132 <para>Um die Limitierung der festen Breite zu reduzieren, können
6133 weitere Variablen in einem Block interpoliert werden. Whitespace wird
6134 dazwishen dann erhalten. Beispiel:</para>
6136 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6138 <para>Die Variablen werden interpoliert, und linksbündig mit
6139 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6140 lang, werden überzählige Zeichen abgeschnitten.</para>
6142 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6143 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6145 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6147 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6148 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6152 <sect2 id="excel-templates.limitations">
6153 <title>Einschränkungen</title>
6155 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6156 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6157 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6158 Text zu ersetzen.</para>
6160 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6161 <command><%if%></command> und
6162 <command><%foreach%></command> nicht vorhanden. Der Delimiter
6163 <constant><% %></constant> kommt in den Headerinformationen
6164 evtl. vor. Deshalb wurde auf den sichereren Delimiter
6165 <constant><<</constant> und <constant>>></constant>
6170 <sect1 id="features.warehouse">
6173 <title>Mandantenkonfiguration Lager</title>
6176 Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6177 Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. Ferner kann jede Position eines Lieferscheins
6178 ein-, bzw. ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele Lager mit beliebig vielen Lagerplätzen abgebildet
6179 werden. Die Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder Einzelposition und das Auswählen dieser Position zu
6180 einem Lager mit Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je nachdem wie die Einstellungen in der
6181 Mandatenkonfiguration gesetzt werden.
6186 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6187 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6188 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6189 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6193 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6194 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6195 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6196 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6197 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6198 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6203 Zusätzliche Funktionshinweise:
6208 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6209 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6210 Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6214 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6215 Stammdaten definiert</option> Wird beim 'Auslagern über
6216 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6217 so wird mit dieser Option einfach der Standardlagerplatz
6225 <sect1 id="features.swiss-charts-of-accounts">
6226 <title>Schweizer Kontenpläne</title>
6228 <para>Seit der Version 3.4.1 stehen in kivitendo 2 Kontenpläne für
6229 den Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6230 Organisationen, die nicht mehrwertsteuerpflichtig sind, und einer
6231 für Firmen, die mehrwertsteuerpflichtig sind.</para>
6233 <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6234 verwendeten KMU-Kontenrahmen und sind mit der Revision des Schweizerischen
6235 Obligationenrechts (OR) vom 1.1.2013 kompatibel, insbesondere
6236 <literal>Art.957a Abs.2</literal>.</para>
6238 <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der aktuellen
6239 Version von kivitendo noch nicht integriert.</para>
6241 <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6242 Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6243 Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen
6244 alle Aufwandskonten editiert werden und dort der Steuersatz auf 0%
6245 gesetzt werden.</para>
6247 <para>So werden bei Kreditorenbuchungen keine Vorsteuern verbucht.</para>
6249 <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6250 Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne
6251 bitte an <literal>empfang@revamp-it.ch</literal> senden.</para>
6254 <sect1 id="features.part_classification">
6255 <title>Artikelklassifizierung</title>
6258 <title>Übersicht</title>
6260 <para>Die Klassifizierung von Artikeln dient einer weiteren Gliederung
6261 um zum Beispiel den Einkauf vom Verkauf zu trennen, gekennzeichnet
6262 durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel (z.B. "E").
6263 Für jede Klassifizierung besteht eine Beschreibung und eine Abkürzung
6264 die normalerweise aus einem Zeichen besteht, kann aber auf mehrere
6265 Zeichen erweitert werden, falls zur Unterscheidung notwendig, sinnvoll
6266 sind jedoch nur maximal 2 Zeichen.</para>
6270 <title>Basisklassifizierung</title>
6272 <para>Als Basisklassifizierungen gibt es</para>
6276 <para>Einkauf</para>
6280 <para>Verkauf</para>
6284 <para>Handelsware</para>
6288 <para>Produktion</para>
6292 <para>- keine - (diese wird bei einer Aktualisierung für alle
6293 existierenden Artikel genommen, gültig für Verkauf und
6298 <para>Es können weitere Klassifizierungen angelegt werden. So kann es
6299 z.B. für separat auszuweisende Artikel folgened Klassen geben:</para>
6303 <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
6307 <para>Material (Verpackungsmaterial) mit Kürzel M</para>
6313 <title>Attribute</title>
6315 <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
6316 alle gleichzeitg gültig sein können</para>
6320 <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
6325 <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
6330 <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
6331 (LaTeX) zusätzliche Variable</para>
6335 <para>Beim separat ausweisen stehen im LaTeX die Variable <emphasis
6336 role="bold"><%non_separate_subtotal%> </emphasis>zur Verfügung,
6337 die alle nicht separat auszuweisenden Artikelkosten saldiert, sowie
6338 pro separat auszuweisenden Klassifizierungen die Variable<emphasis
6339 role="bold"> <%separate_X_subtotal%></emphasis> wobei X das
6340 Kürzel der Klassifizierung ist.</para>
6342 <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
6343 role="bold"><%separate_L_subtotal%></emphasis> und für
6344 Verpackungsmaterial <emphasis
6345 role="bold"><%separate_M_subtotal%> </emphasis>.</para>
6349 <title>Zwei-Zeichen Abkürzung</title>
6351 <para>Der Typ des Artikel und die Klassifizierung werden durch zwei
6352 Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
6353 Typs des Artikel ('P','A','S') , deutch 'W', 'E', und 'D' für Ware
6354 Erzeugnis oder Dienstleistung, ggf. weitere Typen.</para>
6356 <para>Der zweite (und ggf. auch ein dritter Buchstabe, falls nötig)
6357 entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
6359 <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
6360 Erleichterung mit dargestellt.</para>
6364 <sect1 id="features.file_managment">
6365 <title>Dateiverwaltung (Mini-DMS)</title>
6368 <title>Übersicht</title>
6369 <para>Parallel zum alten WebDAV gibt es eine Datei-Management-Sytem, daß Dateien
6370 verschiedenen Typs verwaltet. Dies können</para>
6373 <para>aus ERP-Daten per LaTeX Template erzeugte PDF-Dokumente,</para>
6376 <para>zu bestimmten ERP-Daten gehörende Anhangdateien unterschiedlichen Formats,</para>
6379 <para>per Scanner eingelesene PDF-Dateien,</para>
6382 <para>per Email empfangene Dateianhänge unterschiedlichen Formats,</para>
6385 <para>sowie speziel an Artikel hochgeladene Bilder sein.</para>
6389 <screeninfo>Übersicht</screeninfo>
6392 <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
6399 <title>Struktur</title>
6401 <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:
6405 <para>Dateisystem,</para>
6408 <para>WebDAV,</para>
6411 <para>Schnittstelle zu externem Dokumenten-Management-System,</para>
6414 <para>andere Datenbank,</para>
6417 <para>etc ...</para>
6420 <para>Es gibt unterschiedliche Typen von Dateien, jedem Typ läßt sich in der
6421 Mandantenkonfigurierung ein bestimmtes Backend zuordnen.
6425 <para>"document", das sind entweder generierte,eingescannte oder hochgeladene PDF-Dateien,
6426 die zu bestimmten ERP-Daten (ERP-Objekte, wi z.B. Rechnung, Lieferschein) gehören.</para>
6429 <para>"attachment", zusätzlich hochgeladene Dokumente, die an bestimmte ERP-Objekte angehängt werden,
6430 z.B. technische Zeichnungen,Aufmaße. Diese können auch an Artikeln,
6431 Lieferanten und Kunden hinterlegt sein</para>
6434 <para>"image", Bilder an Artikeln. Diese können auch verkleinert in einer Vorschau (Thumbnail)
6435 angezeigt werden.</para>
6438 <para>Zusätzlich werden in der Datenbank zu den Dateien neben der Zuordnung zu ERP-Objekten, des Dateityps
6439 des Dateinamens und des Backends in dem die Datei gespeichert ist auch die Quelle der Datei notiert:
6443 <para> "created" , vom System erzeugte Dokumente"</para>
6446 <para> "uploaded", hochgeladene Dokumente</para>
6449 <para> "email", vom Mailsystem empfangene Dateien</para>
6452 <para> "scanner[1]", von einem oder mehreren Scannern erzeugte Dateien. Existieren mehrere Scanner,
6453 so sind diese durch unterschiedliche Quellennamen zu definieren</para>
6456 <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es für "attachment" und "image" nur
6457 die Quelle "uploaded". Für "document" gibt es auf jeden Fall die Quelle "created".
6458 Die Quellen "scanner" und "email" müssen derzeit in der Datenbank konfiguriert werden (siehe <xref linkend="file_management.dbconfig"/>.</para>
6462 <title>Anwendung</title>
6463 <para>Die Daten werden bei den ERP-Objekten als extra Reiter dargestellt.
6464 Eine Verkaufsrechnung z.B. hat die
6465 Reiter "Dokumente" und "Dateianhänge.</para>
6467 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6470 <imagedata scale="50" fileref="images/DMS-Anhaenge.png"/>
6474 <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer Datei angezeigt.
6475 Wird eine Datei mit gleichem Namen hochgeladen, so wird eine neue Version der Datei erstellt.
6476 Vorher wird der Anwender durch einen Dialog ob er eine neue Version anlegen will oder
6477 ob er die Datei umbenennen will, falls es eine neue Datei sein soll.</para>
6479 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6482 <imagedata width="100" contentwidth="40" fileref="images/DMS-Anhaenge-hochladen.png"/>
6486 <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
6487 solange in Summe die maximale Größe nicht überschritten wird.
6488 (siehe <xref linkend="file_management.clientconfig"/></para>
6490 <screeninfo>Reiter "Dokumente"</screeninfo>
6493 <imagedata width="500" fileref="images/DMS-Dokumente.png"/>
6497 <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt es nur "erzeugte Dokumente".
6498 Es werden alle Versionen der generierten Datei angezeigt. Für Verkaufsrechnungen kommen keine
6499 anderen Quellen zur Geltung. Werden entsprechend
6500 <xref linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert, so sind diese z.B. bei
6501 Einkaufsrechnungen sichtbar:</para>
6503 <screeninfo>Reiter "Dokumente"</screeninfo>
6506 <imagedata contentwidth="600" fileref="images/DMS-Dokumente-Scanner.png"/>
6510 <para>Statt des Löschens wird hier die Datei zurück zur Quelle verschoben. Somit kann die Datei anschließend
6511 an ein anderes ERP-Objekt angehängt werden.</para>
6512 <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie sind bisher nur bei Bildern relevant.</para>
6516 <title>Konfigurierung</title>
6517 <sect3 id="file_management.clientconfig" xreflabel="Mandantenkonfigurierung">
6518 <title>Mandantenkonfigurierung</title>
6520 <title>Reiter "Features"</title>
6521 <para>Unter dem Reiter <emphasis role="bold">Features</emphasis> im Abschnit Dateimanagement ist
6522 neben dem "alten" WebDAV das Dateimangement general zu- und abschaltbar, sowie die Zuordnung der
6523 Dateitypen zu Backends. Die Löschbarkeit von Dateien sowie die maximale Uploadgröße sind Backend-unabhängig</para>
6525 <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
6528 <imagedata width="500" fileref="images/DMS-ClientConfig.png"/>
6532 <para>Die einzelnen Backends sind einzeln einschaltbar. Spezifische Backend-Konfigurierungen sind hier
6533 noch ergänzbar. Für das Backend Dateisystem ist das Wurzelverzeichnis für den Mandanten einzugeben.</para>
6536 <title>Reiter "Allgemeine Dokumentenanhänge"</title>
6537 <para>Unter dem Reiter <emphasis role="bold">Allgemeine Dokumentenanhänge</emphasis>
6538 kann für alle ERP-Dokumente ( Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und Einkauf )
6539 allgemeingültige Anhänge hochgeladen werden.</para>
6541 <screeninfo>Mandantenkonfig Reiter "Allgemeine Dokumentenanhänge"</screeninfo>
6544 <imagedata width="500" fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"/>
6548 <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die ERP-Dokumente angehängt,
6549 z.B. AGBs oder aktuelle Angebote. Es werden in dem Fall die Daten kopiert, sodaß an den ERP-Dokumenten immer
6550 die Anhänge zum Generierungszeitpunkt eingebettet sind.
6554 <sect3 id="file_management.dbconfig" xreflabel="Datenbank-Konfigurierung">
6555 <title>Datenbank-Konfigurierung</title>
6556 <para>Die zusätzlichen Quellen für email oder ein oder mehrere Scanner sind derzeit vom Administrator
6557 direkt in der Datenbanktablle "user_preferences" einzurichten. Die "value" ist im JSON-Format
6558 mit den jeweiligen Werten des Verzeichnisses und der Beschreibung der Quelle.</para>
6560 id | login | namespace | version | key | value
6561 ----+-----------+--------------+---------+----------+---------------------------
6562 1 | #default# | file_sources | 0.00000 | scanner1 |
6563 {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
6564 2 | #default# | file_sources | 0.00000 | scanner2 |
6565 {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
6566 3 | #default# | file_sources | 0.00000 | emails |
6567 {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
6569 <para>Es ist daran gedacht, statt dem default Eintrag später für bestimmte Benutzer ('login') bestimmte Quellen zuzulassen,
6570 dies wird nach Bedarf implementiert.</para>
6577 <title>Entwicklerdokumentation</title>
6579 <sect1 id="devel.globals" xreflabel="Globale Variablen">
6580 <title>Globale Variablen</title>
6583 <title>Wie sehen globale Variablen in Perl aus?</title>
6585 <para>Globale Variablen liegen in einem speziellen namespace namens
6586 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
6587 globs global und die meisten speziellen Variablen sind...
6590 <para>Daraus ergeben sich folgende Formen:</para>
6594 <term><literal>$main::form</literal></term>
6597 <para>expliziter Namespace "main"</para>
6602 <term><literal>$::form</literal></term>
6605 <para>impliziter Namespace "main"</para>
6610 <term><literal>open FILE, "file.txt"</literal></term>
6613 <para><varname>FILE</varname> ist global</para>
6618 <term><literal>$_</literal></term>
6621 <para>speziell</para>
6626 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
6627 Schlüsselwort wie "<function>global</function>", mit dem man
6628 importieren kann. <function>my</function>, <function>our</function>
6629 und <function>local</function> machen was anderes.</para>
6633 <term><literal>my $form</literal></term>
6636 <para>lexikalische Variable, gültig bis zum Ende des
6642 <term><literal>our $form</literal></term>
6645 <para><varname>$form</varname> referenziert ab hier
6646 <varname>$PACKAGE::form</varname>.</para>
6651 <term><literal>local $form</literal></term>
6654 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
6655 des scopes zurückgesetzt</para>
6662 <title>Warum sind globale Variablen ein Problem?</title>
6664 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
6666 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
6667 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
6668 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
6669 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
6670 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
6671 Datenbankverbindungen, weil die sehr lange zum Initialisieren
6674 <para>Das zweite Problem ist <function>strict</function>. Unter
6675 <function>strict</function> werden alle Variablen die nicht explizit
6676 mit <function>Package</function>, <function>my</function> oder
6677 <function>our</function> angegeben werden als Tippfehler angemarkert,
6678 dies hat, seit der Einführung, u.a. schon so manche langwierige
6679 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
6680 angegeben werden, werden die nicht geprüft, und somit kann sich
6681 schnell ein Tippfehler einschleichen.</para>
6685 <title>Kanonische globale Variablen</title>
6687 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
6688 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
6689 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
6690 umhergereicht werden.</para>
6692 <para>Diese Variablen sind im Moment die folgenden neun:</para>
6696 <para><varname>$::form</varname></para>
6700 <para><varname>%::myconfig</varname></para>
6704 <para><varname>$::locale</varname></para>
6708 <para><varname>$::lxdebug</varname></para>
6712 <para><varname>$::auth</varname></para>
6716 <para><varname>$::lx_office_conf</varname></para>
6720 <para><varname>$::instance_conf</varname></para>
6724 <para><varname>$::dispatcher</varname></para>
6728 <para><varname>$::request</varname></para>
6732 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
6733 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
6734 Eigenschaften (Konventionen):</para>
6737 <title>$::form</title>
6741 <para>Ist ein Objekt der Klasse
6742 "<classname>Form</classname>"</para>
6746 <para>Wird nach jedem Request gelöscht</para>
6750 <para>Muss auch in Tests und Konsolenscripts vorhanden
6755 <para>Enthält am Anfang eines Requests die Requestparameter vom
6760 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
6761 cachen, das wird aber momentan absichtlich zerstört</para>
6765 <para><varname>$::form</varname> wurde unter <productname>SQL
6766 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
6767 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
6768 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
6769 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
6770 <function>IS->retrieve_customer()</function> in Sicherheit
6773 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
6774 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
6775 3552, Stand version 2.7beta), um dies hinterher wieder auf den
6776 richtigen Wert zu setzen:</para>
6778 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
6779 $::myconfig{numberformat} = $numberformat;
6780 # (...) div Berechnungen
6781 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
6783 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
6784 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
6785 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
6786 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
6787 Es geht ziemlich sicher etwas kaputt.</para>
6789 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
6790 in den <productname>Template::Toolkit</productname> Templates
6791 außerhalb der Controller: der Ausdruck <function>[% var
6792 %]</function> greift auf <varname>$::form->{var}</varname> zu.
6793 Unter Controllern ist der Standard Scope anders, da lautet der
6794 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
6795 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
6796 <function><%var%></function> zeigt auf
6797 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
6798 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
6801 <programlisting>[%- IF business %]
6802 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
6803 [%- END %]</programlisting>
6805 <para>Entweder wird hier dann $::form->{business} ausgewertet
6806 oder aber der Funktion
6807 <function>$form->parse_html_template</function> wird explizit
6808 noch ein zusätzlicher Hash übergeben, der dann auch in den
6809 (Web-)Templates zu Verfügung steht, bspw. so:</para>
6811 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
6813 <para>Innerhalb von Schleifen wird
6814 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
6815 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
6816 welches über alle Positionen eines Lieferscheins in Schleife
6819 <programlisting>for $i (1 .. $form->{rowcount}) {
6821 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
6822 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
6823 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
6829 <title>%::myconfig</title>
6833 <para>Das einzige Hash unter den globalen Variablen</para>
6837 <para>Wird spätestens benötigt wenn auf die Datenbank
6838 zugegriffen wird</para>
6842 <para>Wird bei jedem Request neu erstellt.</para>
6846 <para>Enthält die Userdaten des aktuellen Logins</para>
6850 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
6851 extern serialisiert werden, weil da auch der Datenbankzugriff
6852 für diesen user drinsteht.</para>
6856 <para>Enthält unter anderem Datumsformat dateformat und Nummernformat numberformat</para>
6860 <para>Enthält Datenbankzugriffinformationen</para>
6864 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
6865 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
6866 aktuellen Users entscheiden müssen, befragen
6867 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
6868 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
6869 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
6870 Informationen über den Benutzer die über die
6871 Administrator-Schnittstelle eingegeben wurden.</para>
6875 <title>$::locale</title>
6879 <para>Objekt der Klasse "Locale"</para>
6883 <para>Wird pro Request erstellt</para>
6887 <para>Muss auch für Tests und Scripte immer verfügbar
6892 <para>Cached intern über Requestgrenzen hinweg benutzte
6897 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
6898 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
6902 <title>$::lxdebug</title>
6906 <para>Objekt der Klasse "LXDebug"</para>
6910 <para>Wird global gecached</para>
6914 <para>Muss immer verfügbar sein, in nahezu allen
6919 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
6920 bereit, wie "<function>enter_sub</function>" und
6921 "<function>leave_sub</function>", mit denen in den alten Modulen ein
6922 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
6923 der man die Wallclockzeit seit Requeststart loggen kann, sowie
6924 "<function>message</function>" und "<function>dump</function>" mit
6925 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
6928 <para>Beispielsweise so:</para>
6930 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
6931 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
6935 <title>$::auth</title>
6939 <para>Objekt der Klasse "SL::Auth"</para>
6943 <para>Wird global gecached</para>
6947 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
6951 <para>Wird nach jedem Request resettet.</para>
6955 <para><varname>$::auth</varname> stellt Funktionen bereit um die
6956 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
6957 vom aktuellen User abhängen wird das Objekt aus
6958 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
6959 Request kurz resettet.</para>
6961 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
6962 Dessen Einstellungen können über
6963 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
6964 ist ein Hash mit den Werten aus der Tabelle
6965 <literal>auth.clients</literal>.</para>
6969 <title>$::lx_office_conf</title>
6973 <para>Objekt der Klasse
6974 "<classname>SL::LxOfficeConf</classname>"</para>
6978 <para>Global gecached</para>
6982 <para>Repräsentation der
6983 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
6987 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
6988 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
6989 das Programm die Konfiguration ändern kann oder sollte.</para>
6991 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
6992 Debug- und Trace-Log-Datei wie folgt konfiguriert und
6995 <programlisting>[debug]
6996 file_name = /tmp/kivitendo-debug.log</programlisting>
6998 <para>ist der Key <varname>file</varname> im Programm als
6999 <varname>$::lx_office_conf->{debug}{file}</varname>
7003 <para>Zugriff auf die Konfiguration erfolgt im Moment über
7004 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
7009 <title>$::instance_conf</title>
7013 <para>Objekt der Klasse
7014 "<classname>SL::InstanceConfiguration</classname>"</para>
7018 <para>wird pro Request neu erstellt</para>
7022 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
7023 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
7024 ist hier eine Mandantendatenbank. Beispielsweise überprüft
7025 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
7026 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
7030 <title>$::dispatcher</title>
7034 <para>Objekt der Klasse
7035 "<varname>SL::Dispatcher</varname>"</para>
7039 <para>wird pro Serverprozess erstellt.</para>
7043 <para>enthält Informationen über die technische Verbindung zum
7048 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
7049 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
7050 Objekt untergebracht.</para>
7054 <title>$::request</title>
7058 <para>Hashref (evtl später Objekt)</para>
7062 <para>Wird pro Request neu initialisiert.</para>
7066 <para>Keine Unterstruktur garantiert.</para>
7070 <para><varname>$::request</varname> ist ein generischer Platz um
7071 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
7072 at a distance benutzt werden, sondern um lokales memoizing zu
7073 ermöglichen, das garantiert am Ende des Requests zerstört
7076 <para>Vieles von dem, was im moment in <varname>$::form</varname>
7077 liegt, sollte eigentlich hier liegen. Die groben
7078 Differentialkriterien sind:</para>
7082 <para>Kommt es vom User, und soll unverändert wieder an den
7083 User? Dann <varname>$::form</varname>, steht da eh schon</para>
7087 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
7088 Requests gebraucht werden? Dann
7089 <varname>$::request</varname></para>
7093 <para>Muss ich von anderen Teilen des Programms lesend drauf
7094 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
7095 Wrappermethode</para>
7102 <title>Ehemalige globale Variablen</title>
7104 <para>Die folgenden Variablen waren einmal im Programm, und wurden
7108 <title>$::cgi</title>
7112 <para>war nötig, weil cookie Methoden nicht als
7113 Klassenfunktionen funktionieren</para>
7117 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
7118 Klassennamespace gehalten wird und über Requestgrenzen
7123 <para>liegt jetzt unter
7124 <varname>$::request->{cgi}</varname></para>
7130 <title>$::all_units</title>
7134 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
7135 ein paar hundert mal pro Request eine Liste der Einheiten
7136 brauchen, und de als Parameter durch einen Riesenstack von
7137 Funktionen geschleift werden müssten.</para>
7141 <para>Liegt jetzt unter
7142 <varname>$::request->{cache}{all_units}</varname></para>
7147 <function>AM->retrieve_all_units()</function> gesetzt oder
7154 <title>%::called_subs</title>
7158 <para>wurde benutzt um callsub deep recursions
7163 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
7164 möglichen Rekursioenen darstellt, und da nie welche
7169 <para>komplette recursion protection wurde entfernt.</para>
7176 <sect1 id="devel.fcgi">
7177 <title>Entwicklung unter FastCGI</title>
7179 <sect2 id="devel.fcgi.general">
7180 <title>Allgemeines</title>
7182 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
7183 werden, muss der Webserver neu gestartet werden.</para>
7185 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
7186 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
7187 müssen folgende Aspekte beachtet werden.</para>
7190 <sect2 id="devel.fcgi.exiting">
7191 <title>Programmende und Ausnahmen</title>
7193 <para>Betrifft die Funktionen <function>warn</function>,
7194 <function>die</function>, <function>exit</function>,
7195 <function>carp</function> und <function>confess</function>.</para>
7197 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
7198 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
7199 am Laufen zu halten. Man kann mit <function>die</function>,
7200 <function>confess</function> oder <function>carp</function> Fehler
7201 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
7202 eigene <function>$::form-</function>error()> tut im Prinzip das
7203 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
7204 <function>exit</function> hingegen werden nicht abgefangen.
7205 <function>warn</function> wird direkt nach STDERR, also in Server Log
7206 eine Nachricht schreiben (sofern in der Konfiguration nicht die
7207 Warnungen in das kivitendo Log umgeleitet wurden), und
7208 <function>exit</function> wird die Ausführung beenden.</para>
7210 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
7211 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
7212 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
7213 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
7216 <sect2 id="devel.fcgi.globals">
7217 <title>Globale Variablen</title>
7219 <para>Um zu vermeiden, dass Informationen von einem Request in einen
7220 anderen gelangen, müssen alle globalen Variablen vor einem Request
7221 sauber initialisiert werden. Das ist besonders wichtig im
7222 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
7223 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
7226 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
7227 abgetrennten Block, der alle kanonischen globalen Variablen listet und
7228 erklärt. Bitte keine anderen einführen ohne das sauber zu
7229 dokumentieren.</para>
7231 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
7232 man sicher geht, dass man die richtige erwischt.</para>
7235 <sect2 id="devel.fcgi.performance">
7236 <title>Performance und Statistiken</title>
7238 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
7239 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
7240 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
7241 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
7242 sind es je nach Menge der definierten Variablen 1-2s. Ab der
7243 Moose/Rose::DB Version sind es 5-6s.</para>
7245 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
7246 den kritischen Pfaden, unter 0,15 sonst.</para>
7250 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
7251 <title>SQL-Upgradedateien</title>
7253 <sect2 id="db-upgrade-files.introduction"
7254 xreflabel="Einführung in die Datenbank-Upgradedateien">
7255 <title>Einführung</title>
7257 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
7258 gesteuert, die sich im Verzeichnis
7259 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
7260 muss pro Datenbankupgrade eine Datei existieren, die neben den
7261 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
7262 Kontrollinformationen enthält.</para>
7264 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
7265 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
7266 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
7267 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
7268 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
7269 Versionsnummern braucht.</para>
7271 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
7272 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
7273 führt diese nicht erneut aus. Dazu dient die Tabelle
7274 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
7275 angelegt wird.</para>
7278 <sect2 id="db-upgrade-files.format"
7279 xreflabel="Format der Upgradedateien">
7280 <title>Format der Kontrollinformationen</title>
7282 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
7283 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
7284 hat dabei das folgende Format:</para>
7286 <para>Für SQL-Upgradedateien:</para>
7288 <programlisting>-- @key: value</programlisting>
7290 <para>Für Perl-Upgradedateien:</para>
7292 <programlisting># @key: value</programlisting>
7294 <para>Leerzeichen vor "<varname>value</varname>" werden
7297 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
7301 <term><varname>tag</varname></term>
7304 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
7305 Dieser "tag" kann von anderen Kontrolldateien in ihren
7306 Abhängigkeiten verwendet werden (Schlüsselwort
7307 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
7308 in der Datenbank eingetragen wird.</para>
7310 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
7311 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
7313 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
7314 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
7315 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
7321 <term><varname>charset</varname></term>
7324 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
7325 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
7326 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
7327 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
7328 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
7329 hingegen müssen immer in UTF-8 encodiert sein und sollten
7330 demnach auch ein "<literal>use utf8;</literal>"
7336 <term><varname>description</varname></term>
7339 <para>Benötigt. Eine Beschreibung, was in diesem Update
7340 passiert. Diese wird dem Benutzer beim eigentlichen
7341 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
7342 sein sollte, sollte die Beschreibung auf Deutsch
7348 <term><varname>depends</varname></term>
7351 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
7352 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
7353 dass die in dieser Liste aufgeführten Scripte bereits
7354 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
7356 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
7357 Script "b" existiert, das von Änderungen in "a" abhängt, und
7358 eine neue Kontrolldatei für "c" erstellt wird, die von
7359 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
7360 Tag "b" als Abhängigkeit zu definieren.</para>
7362 <para>Es ist nicht erlaubt, sich selbst referenzierende
7363 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
7364 und "c" -> "a").</para>
7369 <term><varname>priority</varname></term>
7372 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
7373 der Scripte ausgeführt werden, die die gleichen
7374 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
7375 der Wert 1000 benutzt.</para>
7377 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
7378 "depends" benutzt werden. kivitendo sortiert die auszuführenden
7379 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
7380 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
7381 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
7382 dann "y", dann "z"), dann nach der Priorität und bei gleicher
7383 Priorität alphabetisch nach dem "tag".</para>
7388 <term><varname>ignore</varname></term>
7391 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
7392 Skript bei der Anmeldung ignoriert und entsprechend nicht
7399 <sect2 id="db-upgrade-files.format-perl-files"
7400 xreflabel="Format von Perl-Upgradedateien">
7401 <title>Format von in Perl geschriebenen
7402 Datenbankupgradescripten</title>
7404 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
7405 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
7406 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
7408 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
7409 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
7410 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
7411 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
7412 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
7413 aufgerufen wird.</para>
7415 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
7416 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
7417 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
7418 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
7419 "<literal>SL::DBUpgrade2::tag</literal>".</para>
7421 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
7422 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
7423 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
7425 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
7428 <programlisting># @tag: beispiel-upgrade-file42
7429 # @description: Ein schönes Beispielscript
7430 # @depends: release_3_1_0
7431 package SL::DBUpgrade2::beispiel_upgrade_file42;
7436 use parent qw(SL::DBUpgrade2::Base);
7441 # hier Aktionen ausführen
7450 <sect2 id="db-upgrade-files.dbupgrade-tool"
7451 xreflabel="Hilfsscript dbupgrade2_tool.pl">
7452 <title>Hilfsscript dbupgrade2_tool.pl</title>
7454 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
7455 existiert ein Hilfsscript namens
7456 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
7457 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
7458 liest alle Datenbankupgradescripte aus dem Verzeichnis
7459 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
7460 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
7461 von der Kommandozeile überprüft werden können.</para>
7463 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
7464 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
7465 sich aber auch Informationen auf verschiedene Art ausgeben
7470 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
7471 --list</command>"</para>
7473 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
7474 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
7475 würde. Es werden neben der Listenposition der Tag, die
7476 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
7480 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
7481 --tree</command>"</para>
7483 <para>Listet alle Tags in Baumform basierend auf den
7484 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
7485 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
7486 beim übergeordneten Script als Abhängigkeit eingetragen
7490 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
7491 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
7492 --rtree</command>"</para>
7494 <para>Listet alle Tags in Baumform basierend auf den
7495 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
7496 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
7497 die das übergeordnete Script als Abhängigkeit eingetragen
7502 <para>Baumform mit Postscriptausgabe:
7503 "<command>./scripts/dbupgrade2_tool.pl
7504 --graphviz</command>"</para>
7506 <para>Benötigt das Tool "<command>graphviz</command>", um mit
7507 seiner Hilfe die <link
7508 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
7509 Baumform</link> in eine Postscriptdatei namens
7510 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
7511 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
7512 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
7513 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
7518 <para>Scripte, von denen kein anderes Script abhängt:
7519 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
7521 <para>Listet die Tags aller Scripte auf, von denen keine anderen
7522 Scripte abhängen.</para>
7528 <sect1 id="translations-languages" xreflabel="Translations and languages">
7529 <title>Translations and languages</title>
7531 <sect2 id="translations-languages.introduction"
7532 xreflabel="Introduction to translations and languages">
7533 <title>Introduction</title>
7536 <para>Dieser Abschnitt ist in Englisch geschrieben, um
7537 internationalen Übersetzern die Arbeit zu erleichtern.</para>
7540 <para>This section describes how localization packages in kivitendo
7541 are built. Currently the only language fully supported is German, and
7542 since most of the internal messages are held in English the English
7543 version is usable too.</para>
7546 <sect2 id="translations-languages.character-set"
7547 xreflabel="Character set">
7548 <title>Character set</title>
7550 <para>All files included in a language pack must use UTF-8 as their
7554 <sect2 id="translations-languages.file-structure"
7555 xreflabel="File structure">
7556 <title>File structure</title>
7558 <para>The structure of locales in kivitendo is:</para>
7560 <programlisting>kivitendo/locale/<langcode>/</programlisting>
7562 <para>where <langcode> stands for an abbreviation of the
7563 language package. The builtin packages use two letter <ulink
7564 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
7565 but the actual name is not relevant for the program and can easily be
7567 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
7568 tags</ulink> (i.e. "en_GB"). In fact the original language packages
7569 from SQL Ledger are named in this way.</para>
7571 <para>In such a language directory the following files are
7576 <term>LANGUAGE</term>
7579 <para>This file is mandatory.</para>
7581 <para>The <filename>LANGUAGE</filename> file contains the self
7582 descripted name of the language. It should contain a native
7583 representation first, and in parenthesis an english translation
7584 after that. Example:</para>
7586 <programlisting>Deutsch (German)</programlisting>
7594 <para>This file is mandatory.</para>
7596 <para>The central translation file. It is essentially an inline
7597 Perl script autogenerated by <command>locales.pl</command>. To
7598 generate it, generate the directory and the two files mentioned
7599 above, and execute the following command:</para>
7601 <programlisting>scripts/locales.pl <langcode></programlisting>
7603 <para>Otherwise you can simply copy one of the other languages.
7604 You will be told how many are missing like this:</para>
7606 <programlisting>$ scripts/locales.pl en
7607 English - 0.6% - 2015/2028 missing</programlisting>
7609 <para>A file named "<filename>missing</filename>" will be
7610 generated and can be edited. You can also edit the
7611 "<filename>all</filename>" file directly. Edit everything you
7612 like to fit the target language and execute
7613 <command>locales.pl</command> again. See how the missing words
7619 <term>Num2text</term>
7622 <para>Legacy code from SQL Ledger. It provides a means for
7623 numbers to be converted into natural language, like
7624 <literal>1523 => one thousand five hundred twenty
7625 three</literal>. If you want to provide it, it must be inlinable
7626 Perl code which provides a <function>num2text</function> sub. If
7627 an <function>init</function> sub exists it will be executed
7630 <para>Only used in the check and receipt printing module.</para>
7635 <term>special_chars</term>
7638 <para>kivitendo comes with a lot of interfaces to different
7639 formats, some of which are rather picky with their accepted
7640 charset. The <filename>special_chars</filename> file contains a
7641 listing of chars not suited for different file format and
7642 provides substitutions. It is written in "Simple Ini" style,
7643 containing a block for every file format.</para>
7645 <para>First entry should be the order of substitution for
7646 entries as a whitespace separated list. All entries are
7647 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
7648 and <literal>\\</literal> all work.</para>
7650 <para>After that every entry is a special char that should be
7651 translated when writing text into such a file.</para>
7653 <para>Example:</para>
7655 <programlisting>[Template/XML]
7656 order=& < > \n
7660 \n=<br></programlisting>
7662 <para>Note the importance of the order in this example.
7663 Substituting < and > befor & would lead to $gt; become
7666 <para>For a list of valid formats, see the German
7667 <filename>special_chars</filename> entry. As of this writing the
7668 following are recognized:</para>
7670 <programlisting>HTML
7675 Template/OpenDocument
7676 filenames</programlisting>
7678 <para>The last of which is very machine dependant. Remember that
7679 a lot of characters are forbidden by some filesystems, for
7680 example MS Windows doesn't like ':' in its files where Linux
7681 doesn't mind that. If you want the files created with your
7682 language pack to be portable, find all chars that could cause
7688 <term>missing</term>
7691 <para>This file is not a part of the language package
7694 <para>This is a file generated by
7695 <command>scripts/locales.pl</command> while processing your
7696 locales. It's only to have the missing entries singled out and
7697 does not belong to a language package.</para>
7705 <para>This file is not a part of the language package
7708 <para>Another file generated by
7709 <command>scripts/locales.pl</command>. If for any reason a
7710 translation does not appear anymore and can be deleted, it gets
7711 moved here. The last 50 or so entries deleted are saved here in
7712 case you made a typo, so that you don't have to translate
7713 everything again. If a tranlsation is missing, the lost file is
7714 checked first. If you maintain a language package, you might
7715 want to keep this safe somewhere.</para>
7720 <term>more/all</term>
7723 <para>This subdir and file is not a part of the language package
7726 <para>If the directory more exists and contains a file called
7727 all it will be parsed in addition to the mandatory all (see
7728 above). The file is useful if you want to change some
7729 translations for the current installation without conflicting
7730 further upgrades. The file is not autogenerated and has the same
7731 format as the all, but needs another key (more_texts). See the
7732 german translation for an example or copy the following code:
7735 # -*- coding: utf-8; -*-
7740 # These are additional texts for custom translations.
7741 # The format is the same as for the normal file all, only
7742 # with another key (more_texts instead of texts).
7743 # The file has the form of 'english text' => 'foreign text',
7745 $self->{more_texts} = {
7747 'Ship via' => 'Terms of delivery',
7748 'Shipping Point' => 'Delivery time',
7750 </programlisting></para>
7757 <sect1 id="devel.testsuite">
7758 <title>Die kivitendo-Test-Suite</title>
7760 <sect2 id="devel.testsuite.intro">
7761 <title>Einführung</title>
7763 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
7764 basiert auf dem Standard-Perl-Modul
7765 <literal>Test::More</literal>.</para>
7767 <para>Die grundlegenden Fakten sind:</para>
7771 <para>Alle Tests liegen im Unterverzeichnis
7772 <filename>t/</filename>.</para>
7776 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
7777 enthält einen oder mehrere Testfälle.</para>
7781 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
7782 Es sind selbstständig ausführbare Perl-Scripte.</para>
7786 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
7787 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
7788 auf <literal>.t</literal> endet.</para>
7793 <sect2 id="devel.testsuite.prerequisites">
7794 <title>Voraussetzungen</title>
7796 <para>Für die Ausführung werden neben den für kivitendo eh schon
7797 benötigten Module noch weitere Perl-Module benötigt. Diese
7802 <para><literal>Test::Deep</literal> (Debian-Paketname:
7803 <literal>libtest-deep-perl</literal>; Fedora:
7804 <literal>perl-Test-Deep</literal>; openSUSE:
7805 <literal>perl-Test-Deep</literal>)</para>
7809 <para><literal>Test::Exception</literal> (Debian-Paketname:
7810 <literal>libtest-exception-perl</literal>; Fedora:
7811 <literal>perl-Test-Exception</literal>; openSUSE:
7812 <literal>perl-Test-Exception</literal>)</para>
7816 <para><literal>Test::Output</literal> (Debian-Paketname:
7817 <literal>libtest-output-perl</literal>; Fedora:
7818 <literal>perl-Test-Output</literal>; openSUSE:
7819 <literal>perl-Test-Output</literal>)</para>
7823 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
7824 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
7825 kann für frühere Versionen aus dem <ulink
7826 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
7830 <para><literal>LWP::Simple</literal> aus dem Paket
7831 <literal>libwww-perl</literal> (Debian-Panetname:
7832 <literal>libwww-perl</literal>; Fedora:
7833 <literal>perl-libwww-perl</literal>; openSUSE:
7834 <literal>perl-libwww-perl</literal>)</para>
7838 <para><literal>URI::Find</literal> (Debian-Panetname:
7839 <literal>liburi-find-perl</literal>; Fedora:
7840 <literal>perl-URI-Find</literal>; openSUSE:
7841 <literal>perl-URI-Find</literal>)</para>
7845 <para><literal>Sys::CPU</literal> (Debian-Panetname: <literal>libsys-cpu-perl</literal>; Fedora und openSUSE: nicht
7850 <para><literal>Thread::Pool::Simple</literal> (Debian-Panetname: <literal>libthread-pool-simple-perl</literal>; Fedora und
7851 openSUSE: nicht vorhanden)</para>
7855 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
7856 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
7857 müssen in der Konfigurationsdatei im Abschnit
7858 <literal>testing/database</literal> Datenbankverbindungsparameter
7859 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
7860 Recht haben, Datenbanken anzulegen und zu löschen.</para>
7863 <sect2 id="devel.testsuite.execution">
7864 <title>Existierende Tests ausführen</title>
7866 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
7867 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
7868 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
7869 <filename>t/test.pl</filename>.</para>
7871 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
7872 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
7873 kivitendo-Basisverzeichnis heraus ausführen.</para>
7875 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
7876 an <filename>t/test.pl</filename>. Beispielsweise:</para>
7878 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
7881 <sect2 id="devel.testsuite.meaning_of_scripts">
7882 <title>Bedeutung der verschiedenen Test-Scripte</title>
7884 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
7885 Programmierstil. Einige besonders zu erwähnende, weil auch während der
7886 Entwicklung nützliche Tests sind:</para>
7890 <para><filename>t/001compile.t</filename> -- compiliert alle
7891 Quelldateien und bricht bei Fehlern sofort ab</para>
7895 <para><filename>t/002goodperl.t</filename> -- überprüft alle
7896 Perl-Dateien auf Anwesenheit von '<literal>use
7897 strict</literal>'-Anweisungen</para>
7901 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
7902 <function>system()</function> und <function>exec()</function> auf
7907 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
7908 Tab-Zeichen enthalten</para>
7912 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
7913 Rechtschreibfehlern</para>
7917 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
7918 Dokumentation im POD-Format auf Gültigkeit</para>
7922 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
7923 einzelner Funktionen und Module.</para>
7926 <sect2 id="devel.testsuite.create_new">
7927 <title>Neue Test-Scripte erstellen</title>
7929 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
7930 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
7931 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
7934 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
7935 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
7938 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
7943 <para>Überprüfung auf fehlende symbolische Links</para>
7947 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
7948 gewissen Einschränkungen wie das Erlauben von deutschen
7953 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
7957 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
7961 <para>Test, ob alle zu übersetzenden Strings in
7962 <filename>locale/de/all</filename> vorhanden sind</para>
7966 <para>Test, ob alle Webseiten-Templates in
7967 <filename>templates/webpages</filename> mit vom Perl-Modul
7968 <literal>Template</literal> compiliert werden können</para>
7973 <sect3 id="devel.testsuite.directory_and_test_names">
7974 <title>Konvention für Verzeichnis- und Dateinamen</title>
7976 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
7977 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
7978 und ihnen soweit es geht folgen:</para>
7982 <para>Die Dateiendung muss <filename>.t</filename>
7987 <para>Namen sind englisch, komplett klein geschrieben und
7988 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
7989 <filename>bad_function_params.t</filename>).</para>
7993 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
7994 benannt sein, mit dem sich die Scripte darin befassen
7995 (beispielsweise <filename>background_jobs</filename> für Tests
7996 rund um Hintergrund-Jobs).</para>
8000 <para>Test-Scripte sollten einen überschaubaren Bereich von
8001 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
8002 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
8003 Test-Scripte schreiben.</para>
8008 <sect3 id="devel.testsuite.minimal_example">
8009 <title>Minimales Skelett für eigene Scripte</title>
8011 <para>Der folgenden Programmcode enthält das kleinstmögliche
8012 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
8015 <programlisting>use Test::More tests => 0;
8019 use Support::TestSetup;
8021 Support::TestSetup::login();</programlisting>
8023 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
8024 benötigt (Stichwort: alle globalen Variablen wie
8025 <varname>$::auth</varname>, <varname>$::form</varname> oder
8026 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
8027 <filename>config/kivitendo.conf</filename> im Abschnitt
8028 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
8029 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
8031 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
8032 kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
8033 weggelassen werden, was die Ausführungszeit des Scripts leicht
8039 <sect1 id="devel.style-guide">
8040 <title>Stil-Richtlinien</title>
8042 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
8043 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
8044 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
8045 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
8047 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
8050 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
8051 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
8056 <para>Es werden keine echten Tabs sondern Leerzeichen
8061 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
8063 <programlisting>foreach my $row (@data) {
8065 # do something with $row
8069 $row->{modules} = MODULE->retrieve(
8070 id => $row->{id},
8071 date => $use_now ? localtime() : $row->{time},
8075 $report->add($row);
8080 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
8081 Zeile wie der letzte Befehl. Beispiele:</para>
8083 <programlisting>sub debug {
8089 <programlisting>if ($form->{item_rows} > 0) {
8095 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
8096 der Befehl / die öffnende schließende Klammer, die den Block
8097 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
8098 Beispiele wie bei 3. gelten.</para>
8102 <para>Die Wörter "<function>else</function>",
8103 "<function>elsif</function>", "<function>while</function>" befinden
8104 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
8107 <programlisting>if ($form->{sum} > 1000) {
8109 } elsif ($form->{sum} > 0) {
8117 } until ($a > 0);</programlisting>
8121 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
8122 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
8123 und grep-ähnliche Operatoren. Beispiel:</para>
8125 <programlisting>$main::lxdebug->message("Could not find file.");
8126 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
8130 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
8132 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
8133 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
8134 Blöcke schon. Beispiel:</para>
8136 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
8141 $form->{sum} += $form->{"row_$i"};
8142 $form->{ $form->{index} } += 1;
8144 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
8148 <para>Mehrzeilige Befehle</para>
8152 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
8153 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
8154 werden, in der die ersten Funktionsparameter in der ersten Zeile
8155 stehen. Beispiel:</para>
8157 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
8158 $form->{some_col_value});</programlisting>
8162 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
8163 besten in einer übersichtlichen Tabellenstruktur organisiert
8164 wird. Beispiel:</para>
8166 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
8167 : $form->{oldcount} ? $form->{oldcount} + 1
8168 : $form->{rowcount} - $form->{rowbase};</programlisting>
8174 <para>Kommentare</para>
8178 <para>Kommentare, die alleine in einer Zeile stehen, sollten
8179 soweit wie der Code eingerückt sein.</para>
8183 <para>Seitliche hängende Kommentare sollten einheitlich
8184 formatiert werden.</para>
8188 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
8189 auf Englisch zu verfassen. So wie ich keine Lust habe,
8190 französischen Quelltext zu lesen, sollte auch der kivitendo
8191 Quelltext für nicht-Deutschsprachige lesbar sein.
8194 <programlisting>my $found = 0;
8202 $i = 0 # initialize $i
8204 $i *= $const; # do something crazy
8205 $i = $n; # recover $i</programlisting>
8211 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
8212 Interpolation gewünscht ist. Beispiel:</para>
8214 <programlisting>$form->{sum} = 0;
8215 $form->{"row_$i"} = $form->{"row_$i"} - 5;
8216 $some_hash{42} = 54;</programlisting>
8220 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
8221 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
8222 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
8223 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
8225 <para>Als Beispiel sei die Funktion
8226 <function>print_options</function> aus
8227 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
8231 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
8232 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
8235 <para>Emacs und vim haben beide recht einfache Methoden zur
8236 Entfernung von trailing whitespace. Emacs kennt das Kommande
8237 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
8238 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
8239 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
8244 <para>Es wird kein <command>perltidy</command> verwendet.</para>
8246 <para>In der Vergangenheit wurde versucht,
8247 <command>perltidy</command> zu verwenden, um einen einheitlichen
8248 Stil zu erlangen. Es hat sich aber gezeigt, dass
8249 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
8250 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
8251 den Interessierten sind hier die
8252 <command>perltidy</command>-Optionen, die grob den beschriebenen
8253 Richtlinien entsprechen:</para>
8255 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
8256 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
8257 -lp -vt=1 -vtc=1</programlisting>
8261 <para><varname>STDERR</varname> ist tabu. Unkonditionale
8262 Debugmeldungen auch.</para>
8264 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
8265 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
8266 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
8268 <para>Die <classname>LXDebug</classname>-Methode
8269 "<function>message</function>" nimmt als ersten Paramter außerdem
8270 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
8271 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
8272 und werden in den meisten Fällen auch vom Repository
8273 zurückgewiesen.</para>
8277 <para>Alle neuen Module müssen use strict verwenden.</para>
8279 <para><varname>$form</varname>, <varname>$auth</varname>,
8280 <varname>$locale</varname>, <varname>$lxdebug</varname> und
8281 <varname>%myconfig</varname> werden derzeit aus dem main package
8282 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
8283 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
8288 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
8289 <title>Dokumentation erstellen</title>
8291 <sect2 id="devel.build-doc.introduction">
8292 <title>Einführung</title>
8294 <para>Diese Dokumentation ist in <productname>DocBook</productname>
8295 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
8296 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
8297 Editor nutzt, der spezielle Unterstützung für
8298 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
8299 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
8300 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
8304 <sect2 id="devel.build-doc.required-software">
8305 <title>Benötigte Software</title>
8307 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
8308 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
8309 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
8310 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
8311 <command>scripts/build_doc.sh</command>.</para>
8313 <para>Das Script benötigt zur Konvertierung verschiedene
8314 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
8320 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
8321 in einer halbwegs aktuellen Version</para>
8325 <para>Das Java-Build-System <ulink
8326 url="http://ant.apache.org/">Apache Ant</ulink></para>
8330 <para>Das Dokumentations-System Dobudish für
8331 <productname>DocBook</productname> 4.5, eine Zusammenstellung
8332 diverser Stylesheets und Grafiken zur Konvertierung von
8333 <productname>DocBook</productname> XML in andere Formate. Das
8334 Paket, das benötigt wird, ist zum Zeitpunkt der
8335 Dokumentationserstellung
8336 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
8337 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
8342 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
8343 sind auf allen gängigen Plattformen verfügbar. Beispiel für
8344 Debian/Ubuntu:</para>
8346 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
8348 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
8349 <filename>doc/build</filename> entpackt werden. Beispiel unter der
8350 Annahme, das <productname>Dobudish</productname> in
8351 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
8353 <programlisting>cd doc/build
8354 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
8357 <sect2 id="devel.build-doc.build">
8358 <title>PDFs und HTML-Seiten erstellen</title>
8360 <para>Die eigentliche Konvertierung erfolgt nach Installation der
8361 benötigten Software mit einem einfachen Aufruf direkt aus dem
8362 kivitendo-Installationsverzeichnis heraus:</para>
8364 <programlisting>./scripts/build_doc.sh</programlisting>
8367 <sect2 id="devel.build-doc.repository">
8368 <title>Einchecken in das Git-Repository</title>
8370 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
8371 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
8372 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
8373 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
8375 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
8376 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob