1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <book id="kivitendo-documentation" lang="de">
5 <title>kivitendo 3.4.1: Installation, Konfiguration, Entwicklung</title>
7 <chapter id="Aktuelle-Hinweise">
8 <title>Aktuelle Hinweise</title>
10 <para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>
14 <para>im Community-Forum: <ulink
15 url="https://forum.kivitendo.de:32443">https://forum.kivitendo.de:32443</ulink></para>
19 <para>im Kunden-Forum: <ulink
20 url="http://redmine.kivitendo-premium.de/projects/forum/boards/">http://redmine.kivitendo-premium.de/projects/forum/boards/</ulink></para>
24 <para>in der doc/UPGRADE Datei im doc-Verzeichnis der
29 <para>Im Schulungs- und Dienstleistungsangebot der entsprechenden
30 kivitendo-Partner: <ulink
31 url="http://www.kivitendo.de/partner.html">http://www.kivitendo.de/partner.html</ulink></para>
37 <title>Installation und Grundkonfiguration</title>
39 <sect1 id="Installation-Übersicht">
40 <title>Übersicht</title>
42 <para>Die Installation von kivitendo umfasst mehrere Schritte. Die
43 folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
44 Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit
45 minimalen Features möglichst schnell zum Laufen zu kriegen.</para>
49 <para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo
50 benötigt gewisse Ressourcen und benutzt weitere Programme. Das
51 Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert
52 diese. Auch die Liste der benötigten Perl-Module befindet sich
57 <para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst
58 die "<xref linkend="Manuelle-Installation-des-Programmpaketes"/>"
59 sowie grundlegende Einstellungen, die der "<xref
60 linkend="config.config-file"/>" erläutert.</para>
64 <para><emphasis>Konfiguration externer Programme</emphasis>: hierzu
65 gehören die Datenbank ("<xref
66 linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der
67 Webserver ("<xref linkend="Apache-Konfiguration"/>").</para>
71 <para><emphasis>Benutzerinformationen speichern können</emphasis>:
72 man benötigt mindestens eine Datenbank, in der Informationen zur
73 Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man
74 das als Administrator macht, verrät "<xref
75 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para>
79 <para><emphasis>Benutzer, Gruppen und Datenbanken
80 anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
81 linkend="Benutzer--und-Gruppenverwaltung"/>".</para>
85 <para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann
86 kann es losgehen: "<xref linkend="kivitendo-ERP-verwenden"/>"</para>
90 <para>Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls
91 wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen
95 <sect1 id="Benötigte-Software-und-Pakete">
96 <title>Benötigte Software und Pakete</title>
98 <sect2 id="Betriebssystem">
99 <title>Betriebssystem</title>
101 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
102 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
103 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
104 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
105 ohne große Probleme auf den derzeit aktuellen verbreiteten
106 Distributionen läuft.</para>
108 <para>Anfang 2016 sind das folgende Systeme, von denen bekannt ist,
109 dass kivitendo auf ihnen läuft:</para>
117 <para>7.0 "Wheezy"</para>
121 <para>8.0 "Jessie"</para>
127 <para>Ubuntu 12.04 LTS "Precise Pangolin", 14.04 "Trusty Tahr"
128 LTS, 15.10 "Wily Werewolf" und 16.04 "Xenial Xerus" LTS
133 <para>openSUSE LEAP 42.1</para>
137 <para>Fedora 22</para>
142 <sect2 id="Pakete" xreflabel="Pakete">
143 <title>Benötigte Perl-Pakete installieren</title>
145 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
146 Apache) und ein Datenbankserver (PostgreSQL) in einer aktuellen Version
147 (s.a. Liste der unterstützten Betriebssysteme) benötigt.</para>
149 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht
150 Bestandteil einer Standard-Perl-Installation sind. Um zu überprüfen,
151 ob die erforderlichen Pakete installiert und aktuell genug sind, wird
152 ein Script mitgeliefert, das wie folgt aufgerufen wird:</para>
154 <programlisting>./scripts/installation_check.pl</programlisting>
156 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
160 <para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para>
164 <para><literal>Archive::Zip</literal></para>
168 <para><literal>Algorithm::CheckDigits</literal></para>
172 <para><literal>CGI</literal></para>
176 <para><literal>Clone</literal></para>
180 <para><literal>Config::Std</literal></para>
184 <para><literal>DateTime</literal></para>
188 <para><literal>DateTime::Format::Strptime</literal></para>
192 <para><literal>DBI</literal></para>
196 <para><literal>DBD::Pg</literal></para>
200 <para><literal>Email::Address</literal></para>
204 <para><literal>Email::MIME</literal></para>
208 <para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71
209 inklusive; siehe <xref
210 linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para>
214 <para><literal>File::Copy::Recursive</literal></para>
218 <para><literal>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></para>
1069 <sect1 id="config.task-server">
1070 <title>Der Task-Server</title>
1072 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1073 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1074 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1075 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1076 essenzielle Aufgaben benutzt.</para>
1078 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1079 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1080 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1082 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1083 Servers integriert werden muss, damit er automatisch gestartet wird.
1084 Dies kann kivitendo nicht für Sie erledigen.</para>
1086 <sect2 id="Konfiguration-des-Task-Servers">
1087 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1089 <para>Die Konfiguration erfolgt über den Abschnitt
1090 <literal>[task_server]</literal> in der Datei
1091 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1092 Optionen sind:</para>
1096 <term><varname>run_as</varname></term>
1099 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1100 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1101 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1102 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1104 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1105 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1106 unter dem auch der Webserver läuft.</para>
1111 <term><varname>debug</varname></term>
1114 <para>Schaltet Debug-Informationen an und aus.</para>
1120 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1121 <title>Konfiguration der Mandanten für den Task-Server</title>
1123 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1124 anschließend jeder Mandant, für den der Task-Server laufen soll,
1125 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1126 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1127 ausgewählt werden, unter der der Task-Server seine Arbeit
1130 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1131 wird der Task-Server für diesen Mandanten keine Aufgaben
1135 <sect2 id="Einbinden-in-den-Boot-Prozess">
1136 <title>Automatisches Starten des Task-Servers beim Booten</title>
1138 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1139 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1140 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1142 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1143 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1144 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1145 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1146 anstelle eines symbolischen Links verwendet werden können.</para>
1149 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE,
1150 ältere Fedora)</title>
1152 <para>Kopieren Sie die Datei
1153 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1154 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1155 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1156 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1157 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1161 <para>Debian-basierende Systeme:</para>
1163 <programlisting>update-rc.d kivitendo-task-server defaults
1164 # Nur bei Debian Squeeze und neuer:
1165 insserv kivitendo-task-server</programlisting>
1169 <para>Ältere OpenSUSE und ältere Fedora:</para>
1171 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1175 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1178 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1182 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1184 <para>Kopieren Sie die Datei
1185 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1186 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1187 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1188 <literal>exec ....</literal>).</para>
1190 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1193 <programlisting>service kivitendo-task-server start</programlisting>
1197 <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1198 Fedora, neuere Ubuntu und Debians)</title>
1200 <para>Kopieren Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
1201 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeilen
1202 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>).</para>
1204 <para>Machen Sie anschließend das Script systemd bekannt, und binden Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden
1207 <programlisting>systemctl daemon-reload
1208 systemctl enable kivitendo-task-server.service</programlisting>
1210 <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt den Server neu zu starten, so können Sie das mit dem
1211 folgenden Befehl tun:</para>
1213 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1217 <sect2 id="Prozesskontrolle">
1218 <title>Wie der Task-Server gestartet und beendet wird</title>
1220 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1222 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1224 <para><literal>Befehl</literal> ist dabei eine der folgenden
1229 <para><literal>start</literal> startet eine neue Instanz des
1230 Task-Servers. Die Prozess-ID wird innerhalb des
1231 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1235 <para><literal>stop</literal> beendet einen laufenden
1240 <para><literal>restart</literal> beendet und startet ihn
1245 <para><literal>status</literal> berichtet, ob der Task-Server
1250 <para>Der Task-Server wechselt beim Starten automatisch in das
1251 kivitendo-Installationsverzeichnis.</para>
1253 <para>Dieselben Optionen können auch für die SystemV-basierenden
1254 Runlevel-Scripte benutzt werden (siehe oben).</para>
1258 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1259 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1261 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1262 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1264 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1265 <title>Grundlagen zur Benutzerauthentifizierung</title>
1267 <para>kivitendo verwaltet die Benutzerinformationen in einer
1268 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1269 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1270 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1271 können, müssen aber nicht unterschiedlich sein.</para>
1273 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1274 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1275 abgelegt werden.</para>
1277 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
1278 entweder gegen die Authentifizierungsdatenbank oder gegen einen
1279 LDAP-Server überprüft werden.</para>
1281 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1282 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1283 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1284 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1285 einer Version vor v2.6.0 angelegt werden. Eine
1286 Beispielkonfigurationsdatei
1287 <filename>config/kivitendo.conf.default</filename> existiert, die als
1288 Vorlage benutzt werden kann.</para>
1291 <sect2 id="Administratorpasswort">
1292 <title>Administratorpasswort</title>
1294 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1295 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1296 gespeichert. Es kann auch nur dort und nicht mehr im
1297 Administrationsinterface selber geändert werden. Der Parameter dazu
1298 heißt <varname>admin_password</varname> im Abschnitt
1299 <varname>[authentication]</varname>.</para>
1302 <sect2 id="Authentifizierungsdatenbank">
1303 <title>Authentifizierungsdatenbank</title>
1305 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1306 Parametern in <varname>[authentication/database]</varname>
1307 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1311 <term><literal>host</literal></term>
1314 <para>Der Rechnername oder die IP-Adresse des
1315 Datenbankservers</para>
1320 <term><literal>port</literal></term>
1323 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1328 <term><literal>db</literal></term>
1331 <para>Der Name der Authentifizierungsdatenbank</para>
1336 <term><literal>user</literal></term>
1339 <para>Der Benutzername, mit dem sich kivitendo beim
1340 Datenbankserver anmeldet (z.B.
1341 "<literal>postgres</literal>")</para>
1346 <term><literal>password</literal></term>
1349 <para>Das Passwort für den Datenbankbenutzer</para>
1354 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1355 automatisch anlegen (mehr dazu siehe unten).</para>
1358 <sect2 id="Passwortüberprüfung">
1359 <title>Passwortüberprüfung</title>
1361 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1362 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1363 Active-Directory-Server. Welche davon benutzt wird, regelt der
1364 Parameter <varname>module</varname> im Abschnitt
1365 <varname>[authentication]</varname>.</para>
1367 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1368 gespeichert werden, so muss der Parameter <varname>module</varname>
1369 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1370 der Administrator als auch die Benutzer selber ihre Passwörter in
1371 kivitendo ändern.</para>
1373 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1374 benutzt werden, so muss der Parameter <varname>module</varname> auf
1375 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1376 zusätzliche Informationen über den LDAP-Server im Abschnitt
1377 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1381 <term><literal>host</literal></term>
1384 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1385 Active-Directory-Servers. Diese Angabe ist zwingend
1386 erforderlich.</para>
1391 <term><literal>port</literal></term>
1394 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1399 <term><literal>tls</literal></term>
1402 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1403 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1404 ‘<literal>0</literal>’ belassen</para>
1409 <term><literal>attribute</literal></term>
1412 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1413 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1414 meist ‘<literal>sAMAccountName</literal>’, für andere
1415 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1416 zwingend erforderlich.</para>
1421 <term><literal>base_dn</literal></term>
1424 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1425 Diese Angabe ist zwingend erforderlich.</para>
1430 <term><literal>filter</literal></term>
1433 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1434 <literal><%login%></literal>, so wird dieses durch den vom
1435 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1436 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1437 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1442 <term><literal>bind_dn</literal> und
1443 <literal>bind_password</literal></term>
1446 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1447 durchsucht werden kann (z.B. ist dies bei
1448 Active-Directory-Servern der Fall), so kann diese hier angegeben
1449 werden. Für Active-Directory-Server kann als
1450 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1451 z.B. ‘<literal>cn=Martin
1452 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1453 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1454 also ‘<literal>Martin Mustermann</literal>’.</para>
1460 <sect2 id="Name-des-Session-Cookies">
1461 <title>Name des Session-Cookies</title>
1463 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1464 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1465 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1466 Parameter <varname>cookie_name</varname> im Abschnitt
1467 <varname>[authentication]</varname>gesetzt.</para>
1469 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1470 Server existiert.</para>
1473 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1474 <title>Anlegen der Authentifizierungsdatenbank</title>
1476 <para>Nachdem alle Einstellungen in
1477 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1478 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1479 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1480 der folgenden URL erreichbar sein sollte:</para>
1483 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1487 <sect1 id="Benutzer--und-Gruppenverwaltung">
1488 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1490 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1491 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1492 das Sie unter folgender URL finden:</para>
1495 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1497 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1498 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1500 <sect2 id="Zusammenhänge">
1501 <title>Zusammenhänge</title>
1503 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1504 in einer oder zwei Datenbanken gespeichert werden.</para>
1506 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1507 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1508 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1509 Diese Informationen werden in der Authentifizierungsdatenbank
1510 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1511 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1512 gespeichert werden.</para>
1514 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1515 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1516 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1517 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1518 einer solchen Mandantendatenbank werden im Administrationsbereich
1519 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1520 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1522 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1523 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1524 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1525 mehr als einem Mandanten, wird empfohlen, für die
1526 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1527 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1530 <sect2 id="Mandanten-Benutzer-Gruppen">
1531 <title>Mandanten, Benutzer und Gruppen</title>
1533 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1534 die sich frei zueinander zuordnen lassen.</para>
1536 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1537 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1538 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1539 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1540 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1541 Diese sollte über die <link
1542 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1545 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1546 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1547 der Administrator fest, an welchen Mandanten sich ein Benutzer
1548 anmelden kann, was beim Login verifiziert wird.</para>
1550 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1551 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1552 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1553 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1554 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1555 dann an einem Mandanten an, so erhält er alle Rechte von allen
1556 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1557 denen der Benutzer zum Anderen Mitglied ist,</para>
1559 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1560 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1561 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1563 <orderedlist numeration="arabic">
1565 <para>Datenbank anlegen</para>
1569 <para>Gruppen anlegen</para>
1573 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1577 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1582 <sect2 id="Datenbanken-anlegen">
1583 <title>Datenbanken anlegen</title>
1585 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1586 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1587 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1590 <sect2 id="Gruppen-anlegen">
1591 <title>Gruppen anlegen</title>
1593 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1594 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1595 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1596 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1598 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1599 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1600 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1601 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1602 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1603 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1604 A, B und C gültig").</para>
1606 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1607 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1608 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1609 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1610 Gruppen A, B und C").</para>
1613 <sect2 id="Benutzer-anlegen">
1614 <title>Benutzer anlegen</title>
1616 <para>Beim Anlegen von Benutzern werden für viele Parameter
1617 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1618 deutschen Raumes entsprechen.</para>
1620 <para>Zwingend anzugeben ist der Loginname. Wenn die
1621 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
1622 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
1623 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1626 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
1627 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
1628 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
1629 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
1630 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
1631 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
1632 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
1633 sind Benutzer A, B und C Mitglieder").</para>
1636 <sect2 id="Mandanten-anlegen">
1637 <title>Mandanten anlegen</title>
1639 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
1640 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
1641 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
1642 einer der eben angelegten Datenbanken eingetragen werden.</para>
1644 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
1645 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
1646 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
1647 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
1648 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
1649 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
1650 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
1651 Gruppe ist für Mandanten A, B und C gültig").</para>
1655 <sect1 id="Drucker--Systemverwaltung">
1656 <title>Drucker- und Systemverwaltung</title>
1658 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
1659 Druckeradministration und System.</para>
1661 <sect2 id="Druckeradministration">
1662 <title>Druckeradministration</title>
1664 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
1665 viele "Druckbefehle" im System verwalten. Diese Befehle werden
1666 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
1667 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
1668 angezeigt wird.</para>
1670 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
1671 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
1672 meinDrucker' oder ein kompletter Pfad zu einem Skript
1673 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
1674 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
1675 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
1676 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
1677 Ausdruck eines Angebots folgende Vorlage geparst:
1678 sales_quotation_epson_drucker.tex.</para>
1682 <title>System sperren / entsperren</title>
1684 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
1685 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
1686 gesamten kivitendo Installation gesperrt.</para>
1688 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
1689 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
1690 Wartungsarbeiten nicht zugänglich.'.</para>
1692 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
1693 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
1694 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
1695 inkonsistenten Datenbestand weitergearbeitet werden.</para>
1699 <sect1 id="config.sending-email"
1700 xreflabel="E-Mail-Versand aus kivitendo heraus">
1701 <title>E-Mail-Versand aus kivitendo heraus</title>
1703 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
1704 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
1705 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
1706 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
1707 Versand über einen lokalen E-Mail-Server (z.B. mit
1708 <productname>Postfix</productname> oder <productname>Exim</productname>,
1709 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
1710 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
1712 <para>Welche Methode und welcher Server verwendet werden, wird über die
1713 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1714 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
1715 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1717 <sect2 id="config.sending-email.sendmail"
1718 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1719 <title>Versand über lokalen E-Mail-Server</title>
1721 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
1722 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
1723 <productname>Postfix</productname>, <productname>Exim</productname>
1724 oder <productname>Sendmail</productname> läuft.</para>
1726 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1727 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1728 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1730 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
1731 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
1732 Standardwert verweist auf das Programm
1733 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1734 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1736 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
1737 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
1741 <sect2 id="config.sending-email.smtp"
1742 xreflabel="E-Mail-Versand über einen SMTP-Server">
1743 <title>Versand über einen SMTP-Server</title>
1745 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
1746 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
1749 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1750 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1751 Parameter dienen dabei der weiteren Konfiguration:</para>
1755 <term><varname>hostname</varname></term>
1758 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
1759 '<literal>localhost</literal>'</para>
1764 <term><varname>port</varname></term>
1767 <para>Portnummer. Der Standardwert hängt von der verwendeten
1768 Verschlüsselungsmethode ab. Gilt '<literal>security =
1769 none</literal>' oder '<literal>security = tls</literal>', so ist
1770 25 die Standardportnummer. Für '<literal>security =
1771 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
1772 geändert werden.</para>
1777 <term><varname>security</varname></term>
1780 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
1781 mit dem Server. Standardwert ist '<literal>none</literal>',
1782 wodurch keine Verschlüsselung verwendet wird. Mit
1783 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
1784 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
1785 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
1786 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
1787 (siehe unten).</para>
1792 <term><varname>login</varname> und
1793 <varname>password</varname></term>
1796 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
1797 so können mit diesen zwei Parametern der Benutzername und das
1798 Passwort angegeben werden. Wird Authentifizierung verwendet, so
1799 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
1800 aktiviert werden.</para>
1807 <sect1 id="Drucken-mit-kivitendo">
1808 <title>Drucken mit kivitendo</title>
1810 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
1811 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1812 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1813 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
1815 <para><programlisting>apt-get install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1816 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1818 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
1820 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
1821 texlive-collection-latexrecommended texlive-collection-langgerman \
1822 texlive-collection-langenglish</programlisting></para>
1824 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
1826 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
1827 texlive-collection-latexrecommended texlive-collection-langgerman \
1828 texlive-collection-langenglish</programlisting></para>
1830 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1842 <para>rev-odt</para>
1846 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version
1847 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
1849 <sect2 id="Vorlagenverzeichnis-anlegen"
1850 xreflabel="Vorlagenverzeichnis anlegen">
1851 <title>Vorlagenverzeichnis anlegen</title>
1853 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
1854 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1856 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1858 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
1859 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
1860 <xref linkend="Gruppen-anlegen"/>.</para>
1862 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
1863 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
1864 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
1865 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1869 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
1870 Vorlagensatz aus, der kopiert werden soll
1871 (<filename>RB</filename>, <filename>f-tex</filename> oder
1872 <filename>odt-rev</filename>.)</para>
1876 <para><option>Neuer Name</option>: Der Verzeichnisname für den
1877 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
1878 für Verzeichnisnamen frei gewählt werden.</para>
1882 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
1883 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
1884 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1885 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
1886 vorgenommen werden. Den Ordner findet man im Dateisystem unter
1887 <filename>./templates/[Neuer Name]</filename></para>
1890 <sect2 id="Vorlagen-RB">
1891 <title>Der Druckvorlagensatz RB</title>
1893 <para>Hierbei handelt es sich um einen vollständigen LaTeX
1894 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
1895 sind nicht gepflegt.</para>
1897 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
1898 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1899 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
1900 eigenen Firmendaten finden sich in der Datei Readme.tex im
1901 Vorlagenverzeichnis.</para>
1903 <para>Eine kurze Übersicht der Features:</para>
1907 <para>Mehrsprachenfähig, mit Deutscher und Englischer
1912 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
1913 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
1918 <para>mehrere vordefinierte Varianten für
1919 Logos/Hintergrundbilder</para>
1923 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
1924 "Außerhalb EU"</para>
1930 <title>f-tex</title>
1932 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur
1933 Verfügung stellt.</para>
1935 <sect3 id="f-tex-Feature-Übersicht">
1936 <title>Feature-Übersicht</title>
1940 <para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage
1941 für alle briefartigen Dokumente verwendet. Also Angebot,
1942 Rechnung, Proformarechnung, Lieferschein, aber eben nicht für
1943 Paketaufkleber etc.</para>
1947 <para>Leichte Anpassung an das Firmen-Layout durch Verwendung
1948 eines Hintergrund-PDFs. Dieses kann leicht mit dem eigenen
1949 Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp,
1954 <para>Hintergrund-PDF umschaltbar auf "nur erste Seite"
1955 (Standard) oder "alle Seiten" (Option
1956 "<option>bgPdfFirstPageOnly</option>" in Datei
1957 <filename>letter.lco</filename>)</para>
1961 <para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem
1962 Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1963 versendeten Dokumenten eingebunden (Option
1964 "<option>bgPdfEmailOnly</option>" in Datei
1965 <filename>letter.lco</filename>).</para>
1969 <para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch,
1970 Wiederholung von Kopfzeilen, Zwischensummen etc. (danke an
1971 Kai-Martin Knaak für die Vorarbeit)</para>
1975 <para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom
1976 Land des eigenen Unternehmens abweicht (also die Rechnung das
1977 Land verlässt).</para>
1981 <para>Multisprachfähig leicht um weitere Sprachen zu erweitern,
1982 alle Übersetzungen in der Datei
1983 <filename>translatinos.tex</filename>.</para>
1987 <para>Auflistung von Bruttopreisen für Endverbraucher.</para>
1992 <sect3 id="f-tex-Installation">
1993 <title>Die Installation</title>
1997 <para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref
1998 linkend="Vorlagenverzeichnis-anlegen"/>. Das Vorlagensystem
1999 funktioniert jetzt schon, hat allerdings noch einen
2000 Beispiel-Briefkopf.</para>
2004 <para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
2005 <filename>./letter_head.pdf</filename>.</para>
2009 <para>Editiere den Bereich "<option>settings</option>" in der
2010 datei <filename>letter.lco</filename>.</para>
2014 <para>oder etwas detaillierter:</para>
2016 <para>Es wird eine Datei <filename>sample.lco</filename> erstellt
2017 und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
2018 ist dies die Datei die für die firmenspezifischen Anpassungen
2019 gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist,
2020 wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle
2021 über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und
2022 <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung
2023 über eine <filename>*.lco</filename>-Datei, die letztlich auf
2024 <filename>letter.lco</filename> verlinkt ist ist aber auch
2027 <para>Es wird eine Datei <filename>sample_head.pdf</filename> mit
2028 ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
2029 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage.
2030 Schau Dir nach Abschluss der Installation die Datei
2031 <filename>sample_head.pdf</filename> an und erstelle ein
2032 entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
2033 Template Verzeichniss ablegen und statt
2034 <filename>sample_head.pdf</filename> nach
2035 <filename>letter_head.pdf</filename> verlinken.</para>
2037 <para>Letzlich muss <filename>letter_head.pdf</filename> auf das
2038 passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
2041 <para>Es wird eine Datei <filename>mydata.tex.example</filename>
2042 ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
2043 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das
2044 Land verwendet. Die Datei muss also nicht angefasst werden. Die
2045 anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit
2046 nicht im öffentlichen Zweig).</para>
2048 <para>Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
2049 sollten über die Hintergrund-PDF-Datei oder die
2050 <filename>*.lco</filename>-Datei erfolgen.</para>
2053 <sect3 id="f-tex-Funktionsübersicht">
2054 <title>f-tex Funktionsübersicht</title>
2056 <para>Das Konzept von kivitendo sieht vor, für jedes Dokument
2057 (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
2058 LaTeX-Vorlage vorzuhalten, dies ist sehr wartungsunfreundlich. Auch
2059 das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
2060 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen
2061 aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
2062 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
2063 LaTeX-Vorlage verwendet, welche über Codeweichen die Besonderheiten
2064 der jeweiligen Dokumente berücksichtigt:</para>
2068 <para>Tabellen mit oder ohne Preis</para>
2072 <para>Sprache der Tabellenüberschriften etc.</para>
2076 <para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
2077 Angebotsnummer)</para>
2081 <para>Darstellung von Brutto oder Netto-Preisen in der
2082 Auflistung (Endverbraucher versus gewerblicher Kunde)</para>
2086 <para>Nachteil:</para>
2088 <para>LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei
2089 <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
2090 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder
2091 geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch
2092 innerhalb der Tabellendarstellung gut persönliche Anpassungen
2093 vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell
2094 heftig in den Fuss schiessen.</para>
2096 <para>Wer nicht so tief in die Materie einsteigen will oder leicht
2097 zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
2098 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen,
2099 und sich an der Form der dargestellten Tabellen, wie sie
2100 ausgeliefert werden, erfreuen.</para>
2102 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine,
2103 kontinuierliche Schritte gehen.</para>
2106 <sect3 id="f-tex-Bruttopreise">
2107 <title>Bruttopreise für Endverbraucher</title>
2109 <para>Der auszuweisende Bruttopreis wird innerhalb der
2110 LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen
2111 "alle Preise Brutto" auszuwählen, aber:</para>
2115 <para>hierfür müssen die Preise auch in Brutto in der Datenbank
2116 stehen (ja - das lässt sich über die Preisgruppen und die
2117 Zuordung einer Default-Preisgruppe handhaben)</para>
2121 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses
2122 Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
2123 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche
2128 <para>Es gibt mit f-tex eine weitere Alternative. Die Information ob
2129 Brutto oder Nettorechnung wird mit den Zahlarten verknüpft.
2130 Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben
2131 werden sollen, enden mit "_E" (für Endverbraucher). Falls identische
2132 Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt
2133 man diese einfach doppelt an (einmal mit der Namensendung "_E").
2138 <para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist
2139 nicht mehr fix mit einer Preisliste verbunden.</para>
2143 <para>Die Default-Zahlart kann im Kundendatensatz hinterlegt
2144 werden, und man muss nicht mehr daran denken, "alle Preise
2145 Netto" auszuwählen.</para>
2149 <para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen
2150 werden, kann direkt beim Drucken revidiert werden, ohne dass
2151 sich der Auftragswert ändert.</para>
2156 <sect3 id="f-tex-lieferadressen">
2157 <title>Lieferadressen</title>
2159 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen
2160 im Adressfeld zum Einsatz. Wenn die
2161 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende
2162 Adressvariable eingesetzt. Wenn also die Lieferadresse in Straße,
2163 Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
2164 Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert
2165 der Hauptadresse angezeigt.</para>
2169 <sect2 id="Vorlagen-rev-odt">
2170 <title>Der Druckvorlagensatz rev-odt</title>
2172 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2173 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2174 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2175 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2176 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2177 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2178 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2180 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2181 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2182 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2183 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2184 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2185 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2187 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2188 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2189 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2190 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2191 die vom Parser nicht korrekt gelesen werden kann.</para>
2193 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2194 odt-Vorlagen bei Mahnungen, Briefen und Pflichtenheften einzusetzen.
2195 Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2197 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2198 empfang@revamp-it.ch</para>
2201 <sect2 id="allgemeine-hinweise-zu-latex">
2202 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2204 <para>In den allermeisten Installationen sollte das Drucken jetzt
2205 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2206 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2207 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2208 sind zum Beispiel:</para>
2212 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2213 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2214 allem bei Vorlagen aus der Community auf. Installieren Sie die
2215 entsprechenden Pakete.</para>
2219 <para>! Package inputenc Error: Unicode char \u8:... set up for
2220 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2221 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2222 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2223 diversen Tricks dazu gebracht werden andere Zeichen zu
2224 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2229 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2230 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2231 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2232 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2233 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2236 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2237 verifizieren lässt:</para>
2241 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2242 "keep_temp_files" auf 1</para>
2244 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2248 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2252 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2256 <para>wechsel in das users Verzeichnis von kivitendo</para>
2258 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2262 <para>LaTeX Suchpfad anpassen:</para>
2264 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2268 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2271 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2273 <para>Es sollte die letzte Datei ganz unten sein</para>
2277 <para>für besseren Hinweis auf Fehler texdatei nochmals
2280 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2282 <para>in der *.tex datei nach dem Fehler suchen.</para>
2288 <sect1 id="OpenDocument-Vorlagen">
2289 <title>OpenDocument-Vorlagen</title>
2291 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2292 OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2) erzeugen.
2293 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
2294 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2295 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2296 <filename>config/kivitendo.conf</filename> die Variable
2297 <literal>opendocument</literal> im Abschnitt
2298 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2299 Dieses ist die Standardeinstellung.</para>
2301 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2302 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2303 LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt werden, so muss
2304 neben LibreOffice oder OpenOffice auch der “X virtual frame buffer”
2305 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
2306 Andere Distributionen enthalten ihn in anderen Paketen.</para>
2308 <para>Nach der Installation müssen in der Datei
2309 <filename>config/kivitendo.conf</filename> im Abschnitt
2310 <literal>applications</literal> zwei weitere Variablen
2311 angepasst werden:</para>
2312 <para><literal>openofficeorg_writer</literal> muss den
2313 vollständigen Pfad zu LibreOffice oder OpenOffice enthalten.
2314 Dabei dürfen keine Anführungszeichen eingesetzt werden.</para>
2315 <para>Beispiel für Debian oder Ubuntu:</para>
2316 <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2317 <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2320 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2321 LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die benutzt
2322 wird, wenn die Variable <literal>$openofficeorg_daemon</literal> gesetzt
2323 ist, startet ein LibreOffice oder OpenOffice, das auch nach der Umwandlung
2324 des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen wird dann diese
2325 laufende Instanz benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung
2326 deutlich reduziert wird, weil nicht für jedes Dokument ein LibreOffice bzw.
2327 OpenOffice gestartet werden muss. Der Nachteil ist, dass diese Methode
2328 Python und die Python-UNO-Bindings benötigt, die Bestandteil von LibreOffice
2329 bzw. OpenOffice sind.</para>
2332 <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2333 normalerweise der Python-Interpreter
2334 <filename>/usr/bin/python</filename> benutzt.
2335 Sollte dies nicht der richtige sein, so kann man mit zwei
2336 Konfigurationsvariablen entscheiden, welcher Python-Interpreter
2337 genutzt wird. Mit der Option <literal>python_uno</literal> aus dem
2338 Abschnitt <literal>applications</literal> wird der Interpreter selber
2339 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2340 <literal>/usr/bin/python</literal>.</para>
2342 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2343 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2344 z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2345 OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2346 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2347 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2348 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2349 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2350 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2354 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2355 wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet
2356 und die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses
2357 Makro muss in der Dokumentenvorlage enthalten sein und
2358 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2359 ‘<literal>templates/print/rev-odt/invoice.odt</literal>’
2360 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
2361 ebenfalls enthalten sein muss.</para>
2363 <para>Als letztes muss herausgefunden werden, welchen Namen
2364 OpenOffice bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen
2365 gibt. Unter Debian ist dies momentan
2366 <literal>~/.config/libreoffice</literal>. kivitendo verwendet das
2367 Verzeichnis <literal>users/.openoffice.org2</literal>.
2368 Eventuell muss dieses Verzeichnis umbenannt werden.</para>
2370 <para>Dieses Verzeichnis, wie auch das komplette
2371 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2372 sein. Dieses wurde bereits erledigt (siehe <xref
2373 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber
2374 erneut überprüft werden, wenn die Konvertierung nach PDF
2378 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2380 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2381 Aufgaben erfüllen.</para>
2383 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2384 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2385 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2386 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2387 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2388 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2389 Anpassungen aufgeführt</emphasis>):</para>
2392 <title>Bezeichnung der Vorlagen</title>
2394 <para>Rechnung: invoice_besr.odt, Auftrag:
2395 sales_order_besr.odt</para>
2399 <title>Vorbereitungen im Adminbereich</title>
2401 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2402 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2403 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2404 ein Drucker eingerichtet werden:</para>
2408 <para>Druckeradministration → Drucker hinzufügen</para>
2412 <para>Mandant wählen</para>
2416 <para>Druckerbeschreibung → aussagekräftiger Text: wird in
2417 der Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B.
2418 mit Einzahlungsschein Bank xy)</para>
2422 <para>Druckbefehl → beliebiger Text (hat für das Erzeugen
2423 von Aufträgen oder Rechnungen als odt-Datei keine Bedeutung,
2424 darf aber nicht leer sein)</para>
2428 <para>Vorlagenkürzel → besr bzw. selbst gewähltes
2429 Vorlagensuffix (muss genau der Zeichenfolge entsprechen, die
2430 zwischen "invoice_" bzw. "sales_order_" und ".odt"
2435 <para>speichern</para>
2441 <title>Benutzereinstellungen</title>
2443 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2444 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2445 dies persönlich für sich bei den Benutzereinstellungen
2446 konfigurieren:</para>
2450 <para>Programm → Benutzereinstellungen →
2451 Druckoptionen</para>
2455 <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2459 <para>Standardausgabekanal → Bildschirm</para>
2463 <para>Standarddrucker → gewünschte Druckerbeschreibung
2464 auswählen (z.B. mit Einzahlungsschein Bank xy)</para>
2468 <para>Anzahl Kopien → leer</para>
2472 <para>speichern</para>
2478 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2480 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2481 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2482 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2483 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2488 <para>Für den Einzahlungsschein ist die letzte Seite des
2489 Dokuments reserviert</para>
2493 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2494 Zeile mit folgenden Angaben (<emphasis
2495 role="bold">Bank-Konto-Identifikationsnummer und
2496 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2497 Bank angepasst werden</emphasis>):<itemizedlist>
2499 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2500 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2502 <para>erster Wert: <emphasis
2503 role="bold">Bank-Konto-Identifikation</emphasis>
2504 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2505 angepasst werden</emphasis>.</para>
2509 <para>zweiter Wert: <%customernumber%>
2510 (Kundennummer: nur Ziffern, maximal 6)</para>
2514 <para>dritter Wert: <%ordnumber%>
2515 (Auftragsnummer bei Auftragsvorlage
2516 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2517 führende Buchstaben werden vom Makro entfernt</para>
2521 <para>vierter Wert: <%invnumber%>
2522 (Rechnungsnummer bei Rechnungsvorlage
2523 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2524 führende Buchstaben werden vom Makro entfernt</para>
2526 </itemizedlist></para>
2530 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2531 Bank, muss angepasst werden</emphasis>.</para>
2535 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2536 falls Einzahlungsschein ohne Betrag</para>
2540 <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2542 </itemizedlist></para>
2546 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2547 der Name und die Adresse der Bank, die Postkonto-Nummer der
2548 Bank, sowie der eigene Firmenname und die Firmenadresse
2549 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2550 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2551 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2557 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2558 ändernde Einträge in rot</screeninfo>
2562 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2569 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2570 odt-Rechnung (analog bei Auftrag)</title>
2572 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2573 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2574 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2575 den Benutzereinstellungen als persönlicher Standard gewählt
2580 <title>Makroeinstellungen in LibreOffice anpassen</title>
2582 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2583 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2584 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2585 angepasst werden:</para>
2589 <para>Extras → Optionen → Sicherheit →
2590 Makrosicherheit</para>
2594 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2595 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2596 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2601 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2602 der entsprechenden Nachfrage "Makros ausführen" auswählen.
2605 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2606 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2607 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2608 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2616 <sect1 id="config.eur">
2617 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
2620 <sect2 id="config.eur.introduction"
2621 xreflabel="Einführung in die Konfiguration zur EUR">
2622 <title>Einführung</title>
2624 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
2625 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
2626 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
2627 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
2628 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
2630 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
2631 die Mandantendatenbank verschoben und dabei auch gleich in drei
2632 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
2633 steuern lässt.</para>
2636 <sect2 id="config.eur.parameters"
2637 xreflabel="Konfigurationsparameter für EUR">
2638 <title>Konfigurationsparameter</title>
2640 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
2641 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
2645 <term><varname>profit_determination</varname></term>
2648 <para>Dieser Parameter legt die Berechnungsmethode für die
2649 Gewinnermittlung fest. Er enthält entweder
2650 <literal>balance</literal> für
2651 Betriebsvermögensvergleich/Bilanzierung oder
2652 <literal>income</literal> für die
2653 Einnahmen-Überschuss-Rechnung.</para>
2658 <term><varname>accounting_method</varname></term>
2661 <para>Dieser Parameter steuert die Buchungs- und
2662 Berechnungsmethoden für die Versteuerungsart. Er enthält
2663 entweder <literal>accrual</literal> für die Soll-Versteuerung
2664 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
2669 <term><varname>inventory_system</varname></term>
2672 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
2673 enthält entweder <literal>perpetual</literal> für die
2674 Bestandsmethode oder <literal>periodic</literal> für die
2675 Aufwandsmethode.</para>
2680 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
2681 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
2682 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
2683 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
2684 Bestandsmethode.</para>
2686 <para>Die Konfiguration "<varname>eur</varname>" unter
2687 <varname>[system]</varname> in der <link
2688 linkend="config.config-file">Konfigurationsdatei</link>
2689 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
2690 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
2693 <sect2 id="config.eur.setting-parameters">
2694 <title>Festlegen der Parameter</title>
2696 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
2697 der Admininstration können diese Optionen nun unabhängig voneinander
2698 eingestellt werden.</para>
2700 <para>Für die Schweiz sind folgende Einstellungen üblich:
2703 <para>Sollversteuerung</para>
2706 <para>Aufwandsmethode</para>
2709 <para>Bilanzierung</para>
2712 Diese Einstellungen werden automatisch beim Erstellen einer neuen
2713 Datenbank vorausgewählt, wenn in <filename>config/kivitendo.conf</filename> unter
2714 <varname>[system]</varname> <literal>default_manager = swiss</literal> eingestellt ist.
2717 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
2718 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
2721 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
2722 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
2723 angezeigt. Unter <guimenu>System</guimenu> →
2724 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
2725 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
2726 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
2727 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
2728 auch <link linkend="config.eur.inventory-system-perpetual">
2729 Bemerkungen zur Bestandsmethode</link>).</para>
2732 <sect2 id="config.eur.inventory-system-perpetual">
2733 <title>Bemerkungen zur Bestandsmethode</title>
2735 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
2736 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
2737 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
2738 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
2739 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
2740 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
2741 Einkaufsrechnungen berechnet wird.</para>
2743 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
2744 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
2745 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
2749 <sect2 id="config.eur.knonw-issues">
2750 <title>Bekannte Probleme</title>
2752 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
2753 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
2754 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
2755 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
2756 die Konfigurationsvariable
2757 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
2760 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
2761 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
2765 <sect1 id="config.skr04-update-3804">
2766 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
2768 <sect2 id="config.skr04-update-3804.introduction">
2769 <title>Einführung</title>
2771 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
2772 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
2773 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
2774 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
2775 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
2776 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
2777 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
2778 vielleicht schon selbst geholfen hat und mit seinen Änderungen
2779 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
2780 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
2781 Screenshots dargestellt.</para>
2783 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
2784 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
2785 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
2786 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
2789 <sect2 id="config.skr04-update-3804.create-chart">
2790 <title>Konto 3804 manuell anlegen</title>
2792 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
2793 anzulegen und zu konfigurieren. Zuerst wird in
2794 <guimenu>System</guimenu> →
2795 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konto
2796 erfassen</guimenuitem> das Konto angelegt.</para>
2799 <screeninfo>Konto 3804 erfassen</screeninfo>
2803 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
2808 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
2809 werden. Dazu unter <guimenu>System</guimenu> →
2810 <guisubmenu>Steuern</guisubmenu> →
2811 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
2812 13 auswählen und ihn wie im folgenden Screenshot angezeigt
2816 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
2820 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
2825 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
2826 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
2827 <guisubmenu>Steuern</guisubmenu> →
2828 <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem
2829 Screenshot übernehmen.</para>
2832 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
2836 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
2841 <para>Als Nächstes sind alle Konten anzupassen, die als
2842 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
2843 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
2844 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
2845 müssen Sie dazu unter <guimenu>System</guimenu> →
2846 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
2847 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
2848 wie im Screenshot gezeigt vornehmen.</para>
2851 <screeninfo>Konto 4315 anpassen</screeninfo>
2855 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
2860 <para>Als Letztes sollte die Steuerliste unter
2861 <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
2862 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
2863 Vergleich der Screenshot.</para>
2866 <screeninfo>Steuerliste vergleichen</screeninfo>
2870 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
2877 <sect1 id="config.bilanz">
2878 <title>Verhalten des Bilanzberichts</title>
2880 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
2881 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
2882 monatsweise führt dies zu falschen Werten.</para>
2884 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
2885 einstellen indem man:</para>
2889 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
2894 <para>immer den Jahresanfang nimmt (1.1. relativ zum
2899 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
2901 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
2904 <para>- oder mit "alle Buchungen" als Alternative"</para>
2908 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
2913 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
2917 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
2918 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
2919 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
2920 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
2921 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
2922 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
2923 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
2924 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
2925 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
2926 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
2927 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
2928 Erfolgsrechnung.</para>
2931 <sect1 id="config.erfolgsrechnung">
2932 <title>Erfolgsrechnung</title>
2934 <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht <emphasis role="bold">
2935 Erfolgsrechnung</emphasis>.</para>
2937 <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter Features
2938 an- oder abgeschaltet werden. Mit der Einstellung <varname>default_manager = swiss
2939 </varname> in der <filename>config/kivitendo.conf</filename> wird beim neu Erstellen
2940 einer Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü <guimenu>Berichte
2941 </guimenu> ausgewählt und ersetzt dort die GUV.</para>
2943 <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche Aufwands- und
2944 Erlöskonten einzeln aufgelistet (analog zur Bilanz), sortiert nach ERTRAG und AUFWAND.</para>
2946 <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der Erfolgsrechnung
2947 erscheinen soll, unter <varname>Sonstige Einstellungen/Erfolgsrechnung</varname>
2948 entweder <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal> ausgewählt
2951 <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal> ausgewählt,
2952 so wird dieses Konto als Aufwandsminderung unter AUFWAND aufgelistet.</para>
2954 <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal> ausgewählt,
2955 so wird dieses Konto als Ertragsminderung unter ERTRAG aufgelistet.</para>
2957 <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft zusätzlich
2958 die Erfolgsrechnung als Bericht verwendet werden, so müssen die Einstellungen
2959 zu allen Erlös- und Aufwandskonten unter <varname>Sonstige
2960 Einstellungen/Erfolgsrechnung</varname> überprüft und allenfalls neu gesetzt werden.</para>
2963 <sect1 id="config.rounding">
2964 <title>Rundung in Verkaufsbelegen</title>
2966 <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert von 5 Rappen (0.05 CHF).</para>
2968 <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer Genauigkeit
2969 von 0.01 CHF verwendet werden können, ist es trotzdem nach wie vor üblich,
2970 Rechnungen mit auf 0.05 CHF gerundeten Beträgen auszustellen.</para>
2972 <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine solche
2973 Rundung pro Mandant / Datenbank festgelegt werden.</para>
2975 <para>Die Einstellung wird beim Erstellen der Datenbank bei <literal>Genauigkeit</literal>
2976 festgelegt. Sie kann anschliessend über das Webinterface von kivitendo nicht mehr
2977 verändert werden.</para>
2979 <para>Abhängig vom Wert für <varname>default_manager</varname> in
2980 <filename>config/kivitendo.conf</filename> werden dabei folgende
2981 Werte voreingestellt:</para>
2984 <para>0.05 (default_manager = swiss)</para>
2987 <para>0.01 (default_manager = german)</para>
2990 <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
2991 </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
2993 <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
2994 und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet,
2995 wenn dieser nicht der eingestellten Genauigkeit entspricht.</para>
2997 <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
2998 automatisch auf die in der Mandantenkonfiguration festgelegten
2999 Standardkonten für Rundungserträge bzw. Rundungsaufwendungen gebucht.</para>
3001 <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr verändert.)</para>
3003 <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
3004 <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
3005 <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
3007 <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege
3008 in anderen Währungen als der Standardwährung erstellt, so muss in
3009 kivitendo 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
3010 <para>Das heisst, Firmen in der Schweiz, die teilweise Verkaufsrechnungen
3011 in Euro oder anderen Währungen erstellen wollen, müssen beim Erstellen
3012 der Datenbank als Genauigkeit 0.01 wählen und können zur Zeit die
3013 5er Rundung noch nicht nutzen.</para>
3016 <sect1 id="config.client">
3017 <title>Einstellungen pro Mandant</title>
3019 <para>Einige Einstellungen können von einem Benutzer mit dem <link
3020 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
3021 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
3022 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3023 Die Einstellungen sind unter <guimenu>System</guimenu> →
3024 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3026 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3027 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3028 geändert werden (siehe auch <link
3029 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3030 Bestandsmethode</link>).</para>
3032 <para>Die Einstellungen <literal>show_bestbefore</literal> und
3033 <literal>payments_changeable</literal> aus dem Abschnitt
3034 <literal>features</literal> und die Einstellungen im Abschnitt
3035 <literal>datev_check</literal> (sofern schon vorhanden) der <link
3036 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3037 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3038 Diese Einträge können danach aus der Konfigurationsdatei entfernt
3042 <sect1 id="kivitendo-ERP-verwenden">
3043 <title>kivitendo ERP verwenden</title>
3045 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3046 folgender URL erreichbar:</para>
3049 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3051 <para>Die Administrationsseite erreichen Sie unter:</para>
3054 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3058 <chapter id="features" xreflabel="Features und Funktionen">
3059 <title>Features und Funktionen</title>
3061 <sect1 id="features.periodic-invoices"
3062 xreflabel="Wiederkehrende Rechnungen">
3063 <title>Wiederkehrende Rechnungen</title>
3065 <sect2 id="features.periodic-invoices.introduction"
3066 xreflabel="Einführung in wiederkehrende Rechnungen">
3067 <title>Einführung</title>
3069 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3070 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3071 Die konfigurierten Aufträge werden später automatisch in Rechnungen
3072 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3073 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3074 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3075 wiederzufinden sind.</para>
3078 <sect2 id="features.periodic-invoices.configuration"
3079 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3080 <title>Konfiguration</title>
3082 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3083 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3084 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3085 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3086 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3089 <para>Folgende Parameter kann man konfigurieren:</para>
3096 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3097 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3098 eines neuen Monats).</para>
3100 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3101 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3102 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3103 nächsten Periodenwechsel für alle Perioden, seit der letzten
3104 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3105 verhindern, muss man vorher das Startdatum neu setzen.</para>
3107 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3108 erstellt. Man kann sich diese Aufträge aber gesondert in den
3109 Berichten anzeigen lassen.</para>
3114 <term>Periodizität</term>
3117 <para>Ob monatlich, quartalsweise oder jährlich auf neue
3118 Rechnungen überprüft werden soll. Für jede Periode seit dem
3119 Startdatum wird überprüft, ob für die Periode (beginnend immer
3120 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3121 wurde. Unter Umständen können bei einem Startdatum in der
3122 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3127 <term>Buchen auf</term>
3130 <para>Das Forderungskonto, in der Regel "Forderungen aus
3131 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3132 Buchungsgruppen der betreffenden Waren.</para>
3137 <term>Startdatum</term>
3140 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3146 <term>Enddatum</term>
3149 <para>ab wann keine Rechnungen mehr erstellt werden
3155 <term>Automatische Verlängerung um x Monate</term>
3158 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3159 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3160 hier die Anzahl der Monate eingeben, um die das Enddatum
3161 automatisch nach hinten geschoben wird.</para>
3166 <term>Drucken</term>
3169 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3170 Rechnungen auch gleich ausdrucken lassen.</para>
3175 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3176 Informationen zu den erstellten Rechnungen verschickt werden.
3177 Konfiguriert wird dies in der <link
3178 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3179 <filename>config/kivitendo.conf</filename> im Abschnitt
3180 <varname>[periodic_invoices]</varname>.</para>
3183 <sect2 id="features.periodic-invoices.variables">
3184 <title>Spezielle Variablen</title>
3186 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3187 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3188 formatierte Variablen durch für die jeweils aktuelle
3189 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3190 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3191 die Syntax <literal><%variablenname%></literal>.</para>
3193 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3194 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3195 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3196 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3197 Die zur verfügung stehenden Formatinformationen werden unten genauer
3200 <para>Diese Variablen können auch beim automatischen Versand der
3201 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3202 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3204 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3209 <para>Bemerkungen</para>
3213 <para>Interne Bemerkungen</para>
3217 <para>Vorgangsbezeichnung</para>
3221 <para>In den Beschreibungs- und Langtextfeldern aller
3226 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3230 <term><varname><%current_quarter%></varname>,
3231 <varname><%previous_quarter%></varname>,
3232 <varname><%next_quarter%></varname></term>
3235 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3236 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3241 <term><varname><%current_month%></varname>,
3242 <varname><%previous_month%></varname>,
3243 <varname><%next_month%></varname></term>
3246 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3247 <literal>1</literal> und <literal>12</literal>.</para>
3252 <term><varname><%current_month_long%></varname>,
3253 <varname><%previous_month_long%></varname>,
3254 <varname><%next_month_long%></varname></term>
3257 <para>Aktueller, vorheriger und nächster Monat als Name
3258 (<literal>Januar</literal>, <literal>Februar</literal>
3264 <term><varname><%current_year%></varname>,
3265 <varname><%previous_year%></varname>,
3266 <varname><%next_year%></varname></term>
3269 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3270 Jahreszahl (<literal>2013</literal> etc.).</para>
3275 <term><varname><%period_start_date%></varname>,
3276 <varname><%period_end_date%></varname></term>
3279 <para>Formatiertes Datum des ersten und letzten Tages im
3280 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3281 ersten Quartal von 2013 wären dies der
3282 <literal>01.01.2013</literal> und
3283 <literal>31.03.2013</literal>).</para>
3288 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3289 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3290 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3291 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3296 <term><varname>%a</varname></term>
3299 <para>Der abgekürzte Wochentagsname.</para>
3304 <term><varname>%A</varname></term>
3307 <para>Der ausgeschriebene Wochentagsname.</para>
3312 <term><varname>%b</varname></term>
3315 <para>Der abgekürzte Monatsname.</para>
3320 <term><varname>%B</varname></term>
3323 <para>Der ausgeschriebene Monatsname.</para>
3328 <term><varname>%C</varname></term>
3331 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3337 <term><varname>%d</varname></term>
3340 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3345 <term><varname>%D</varname></term>
3348 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3353 <term><varname>%e</varname></term>
3356 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3357 werden führende Nullen durch Leerzeichen ersetzt.</para>
3362 <term><varname>%F</varname></term>
3365 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3370 <term><varname>%j</varname></term>
3373 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3379 <term><varname>%m</varname></term>
3382 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3387 <term><varname>%u</varname></term>
3390 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3391 die 1 dem Montag entspricht.</para>
3396 <term><varname>%U</varname></term>
3399 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3400 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3406 <term><varname>%V</varname></term>
3409 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3410 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3411 vier Tage im Jahr liegen; Montag ist erster Tag der
3417 <term><varname>%w</varname></term>
3420 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3421 die 0 dem Sonntag entspricht.</para>
3426 <term><varname>%W</varname></term>
3429 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3430 wobei der erste Montag im Jahr das Startdatum von Woche 01
3436 <term><varname>%y</varname></term>
3439 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3445 <term><varname>%Y</varname></term>
3448 <para>Das Jahr als vierstellige Zahl.</para>
3453 <term><varname>%%</varname></term>
3456 <para>Das Prozentzeichen selber.</para>
3461 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3462 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3463 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3464 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3467 <sect2 id="features.periodic-invoices.reports">
3468 <title>Auflisten</title>
3470 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3471 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3472 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3473 wiederkehrenden Rechnungen verschaffen kann.</para>
3476 <sect2 id="features.periodic-invoices.task-server">
3477 <title>Erzeugung der eigentlichen Rechnungen</title>
3479 <para>Die zeitliche und periodische Überprüfung, ob eine
3480 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3481 durch den <link linkend="config.task-server">Taskserver</link>, einen
3482 externen Dienst, der automatisch beim Start des Servers gestartet
3483 werden sollte.</para>
3486 <sect2 id="features.periodic-invoices.create-for-current-month">
3487 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3489 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3490 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3491 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
3492 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3493 generiert hat. Alternativ setzt man das Startdatum auf den
3494 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3495 manuell über den Workflow.</para>
3499 <sect1 id="features.bank" xreflabel="bankerweiterung">
3500 <title>Bankerweiterung</title>
3502 <sect2 id="features.bank.introduction"
3503 xreflabel="Einführung in die Bankerweiterung">
3504 <title>Einführung</title>
3506 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3507 im Wiki und soll von dort später hierhin übernommen werden:</para>
3510 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3514 <sect1 id="dokumentenvorlagen-und-variablen">
3515 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3517 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3518 <title>Einführung</title>
3520 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3521 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3522 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3523 <function><%variablenname%></function> verwendet wird. Für
3524 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3526 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3528 <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3529 Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im
3530 Folgenden gesagte für alle Vorlagenarten.</para>
3532 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3533 verfügbar als hier aufgelistet werden. Die meisten davon können
3534 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3535 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3536 diese wie folgt erhalten werden:</para>
3540 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3541 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3545 <para>In <filename>Form.pm</filename> die Funktion
3546 <function>parse_template</function> suchen und hier die Zeile
3547 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3551 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3552 ein PDF für eine Rechnung erzeugen.</para>
3556 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3557 der Variablen <varname>$self</varname> in der Form <varname>'key'
3558 => 'value',</varname>. Alle <varname>key</varname>s sind
3564 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3565 <title>Variablen ausgeben</title>
3567 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3568 Tags geschrieben werden, also z.B.
3569 <varname><%variablenname%></varname>.</para>
3571 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3572 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3573 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
3574 werden die folgenden Flags unterstützt:</para>
3578 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3579 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3580 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3581 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3585 <para><option>NOESCAPE</option> unterdrückt das Escapen von
3586 Sonderzeichen für die Vorlagensprache. Wenn also in einer
3587 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
3588 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
3589 ist dieses Flag sinnvoll.</para>
3593 <para>Beispiel:</para>
3595 <programlisting><%quototal NOFORMAT%></programlisting>
3598 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
3599 <title>Verwendung in Druckbefehlen</title>
3601 <para>In der Admininstration können Drucker definiert werden. Auch im
3602 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
3603 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
3604 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
3605 <function>`...`</function> nicht zu unerwünschtem Verhalten
3608 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
3609 für das die Telefonnummer eines Ansprechpartners als Teil der
3610 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
3611 z.B. wie folgt aussehen:</para>
3613 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
3616 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
3617 xreflabel="Anfang und Ende der Tags verändern">
3618 <title>Anfang und Ende der Tags verändern</title>
3620 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
3621 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
3622 Prozentzeichen und dem Größerzeichen endet, beispielsweise
3623 <function><%customer%></function>. Da diese Form aber z.B. in
3624 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
3625 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
3626 Stil umgestellt werden.</para>
3628 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
3629 Format gültigen Kommentarzeichen anfangen, dann
3630 <function>config:</function> enthalten, die entsprechende Option
3631 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
3632 enden. Beispiel für LaTeX:</para>
3634 <programlisting>% config: tag-style=($ $)</programlisting>
3636 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
3637 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
3638 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
3640 <programlisting><!-- config: tag-style=($ $) --></programlisting>
3643 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
3644 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
3646 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
3647 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
3648 "<filename>.ext</filename>" geeignet zu ersetzen:
3649 "<filename>.tex</filename>" für LaTeX-Vorlagen und
3650 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
3654 <term><filename>bin_list.ext</filename></term>
3657 <para>Lagerliste</para>
3662 <term><filename>check.ext</filename></term>
3670 <term><filename>invoice.ext</filename></term>
3673 <para>Rechnung</para>
3678 <term><filename>packing_list.ext</filename></term>
3681 <para>Packliste</para>
3686 <term><filename>pick_list.ext</filename></term>
3689 <para>Sammelliste</para>
3694 <term><filename>purchase_delivery_order.ext</filename></term>
3697 <para>Lieferschein (Einkauf)</para>
3702 <term><filename>purcharse_order.ext</filename></term>
3705 <para>Bestellung an Lieferanten</para>
3710 <term><filename>request_quotation.ext</filename></term>
3713 <para>Anfrage an Lieferanten</para>
3718 <term><filename>sales_delivery_order.ext</filename></term>
3721 <para>Lieferschein (Verkauf)</para>
3726 <term><filename>sales_order.ext</filename></term>
3729 <para>Bestellung</para>
3734 <term><filename>sales_quotation.ext</filename></term>
3737 <para>Angebot an Kunden</para>
3742 <term><filename>zahlungserinnerung.ext</filename></term>
3745 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
3750 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
3753 <para>Rechnung über Mahngebühren (Dateiname im Programm
3754 konfigurierbar)</para>
3760 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
3761 <title>Sprache, Drucker und E-Mail</title>
3763 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
3764 eingearbeitet. So wird aus der Vorlage
3765 <filename>sales_order.ext</filename> bei Sprache
3766 <function>de</function> und Druckerkürzel <function>lpr2</function>
3767 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
3768 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
3769 bekommen dann noch das Kürzel <filename>_email</filename>, der
3770 vollständige Vorlagenname wäre dann
3771 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
3772 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
3773 werden. Diese wird verwendet, wenn keine der anderen Varianten
3774 gefunden wird.</para>
3776 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
3777 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
3778 verschickt wird, ist:</para>
3782 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
3786 <para><filename>sales_order_de_lpr2.tex</filename></para>
3790 <para><filename>sales_order.tex</filename></para>
3794 <para><filename>default.tex</filename></para>
3798 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
3799 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
3801 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
3804 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
3805 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
3808 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
3809 xreflabel="Metainformationen zur angeforderten Vorlage">
3810 <title>Metainformationen zur angeforderten Vorlage</title>
3812 <para>Diese Variablen liefern Informationen darüber welche Variante
3813 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
3814 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
3815 Formulare einbinden möchten.</para>
3819 <term><varname>template_meta.formname</varname></term>
3822 <para>Basisname der Vorlage. Identisch mit der <link
3823 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
3824 zu den Dateinamen</link> ohne die Erweiterung. Ein
3825 Verkaufsauftrag enthält hier
3826 <constant>sales_order</constant>.</para>
3831 <term><varname>template_meta.language.description</varname></term>
3834 <para>Beschreibung der verwendeten Sprache</para>
3839 <term><varname>template_meta.language.template_code</varname></term>
3842 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
3843 dem Kürzel das im Dateinamen verwendetet wird.</para>
3848 <term><varname>template_meta.language.output_numberformat</varname></term>
3851 <para>Zahlenformat der verwendeten Sprache in der Form
3852 "<constant>1.000,00</constant>". Experimentell! Nur
3853 interessant für Vorlagen die mit unformatierten Werten
3859 <term><varname>template_meta.language.output_dateformat</varname></term>
3862 <para>Datumsformat der verwendeten Sprache in der Form
3863 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
3864 interessant für Vorlagen die mit unformatierten Werten
3870 <term><varname>template_meta.format</varname></term>
3873 <para>Das angeforderte Format. Kann im Moment die Werte
3874 <constant>pdf</constant>, <constant>postscript</constant>,
3875 <constant>html</constant>, <constant>opendocument</constant>,
3876 <constant>opendocument_pdf</constant> und
3877 <constant>excel</constant> enthalten.</para>
3882 <term><varname>template_meta.extension</varname></term>
3885 <para>Dateierweiterung, wie im Dateinamen. Wird aus
3886 <constant>format</constant> entschieden.</para>
3891 <term><varname>template_meta.media</varname></term>
3894 <para>Ausgabemedium. Kann zur Zeit die Werte
3895 <constant>screen</constant> für Bildschirm,
3896 <constant>email</constant> für E-Mail (triggert das
3897 <constant>_email</constant> Kürzel im Dateinamen),
3898 <constant>printer</constant> für Drucker, und
3899 <constant>queue</constant> für Warteschlange enthalten.</para>
3904 <term><varname>template_meta.printer.description</varname></term>
3907 <para>Beschreibung des ausgewählten Druckers</para>
3912 <term><varname>template_meta.printer.template_code</varname></term>
3915 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
3916 dem Kürzel das im Dateinamen verwendetet wird.</para>
3921 <term><varname>template_meta.tmpfile</varname></term>
3924 <para>Datei-Prefix für temporäre Dateien.</para>
3930 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
3931 <title>Stammdaten von Kunden und Lieferanten</title>
3935 <term><varname>account_number</varname></term>
3938 <para>Kontonummer</para>
3943 <term><varname>bank</varname></term>
3946 <para>Name der Bank</para>
3951 <term><varname>bank_code</varname></term>
3954 <para>Bankleitzahl</para>
3959 <term><varname>bic</varname></term>
3962 <para>Bank-Identifikations-Code (Bank Identifier Code,
3968 <term><varname>business</varname></term>
3971 <para>Kunden-/Lieferantentyp</para>
3976 <term><varname>city</varname></term>
3984 <term><varname>contact</varname></term>
3987 <para>Kontakt</para>
3992 <term><varname>country</varname></term>
4000 <term><varname>c_vendor_id</varname></term>
4003 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
4008 <term><varname>v_customer_id</varname></term>
4011 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
4016 <term><varname>cp_email</varname></term>
4019 <para>Email des Ansprechpartners</para>
4024 <term><varname>cp_givenname</varname></term>
4027 <para>Vorname des Ansprechpartners</para>
4032 <term><varname>cp_greeting</varname></term>
4035 <para>Anrede des Ansprechpartners</para>
4040 <term><varname>cp_name</varname></term>
4043 <para>Name des Ansprechpartners</para>
4048 <term><varname>cp_phone1</varname></term>
4051 <para>Telefonnummer 1 des Ansprechpartners</para>
4056 <term><varname>cp_phone2</varname></term>
4059 <para>Telefonnummer 2 des Ansprechpartners</para>
4064 <term><varname>cp_title</varname></term>
4067 <para>Titel des Ansprechpartners</para>
4072 <term><varname>creditlimit</varname></term>
4075 <para>Kreditlimit</para>
4080 <term><varname>customeremail</varname></term>
4083 <para>Email des Kunden; nur für Kunden</para>
4088 <term><varname>customerfax</varname></term>
4091 <para>Faxnummer des Kunden; nur für Kunden</para>
4096 <term><varname>customernotes</varname></term>
4099 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4104 <term><varname>customernumber</varname></term>
4107 <para>Kundennummer; nur für Kunden</para>
4112 <term><varname>customerphone</varname></term>
4115 <para>Telefonnummer des Kunden; nur für Kunden</para>
4120 <term><varname>discount</varname></term>
4128 <term><varname>email</varname></term>
4131 <para>Emailadresse</para>
4136 <term><varname>fax</varname></term>
4139 <para>Faxnummer</para>
4144 <term><varname>gln</varname></term>
4147 <para>GLN (Globale Lokationsnummer)</para>
4152 <term><varname>greeting</varname></term>
4160 <term><varname>homepage</varname></term>
4163 <para>Homepage</para>
4168 <term><varname>iban</varname></term>
4171 <para>Internationale Kontonummer (International Bank Account
4172 Number, IBAN)</para>
4177 <term><varname>language</varname></term>
4180 <para>Sprache</para>
4185 <term><varname>name</varname></term>
4188 <para>Firmenname</para>
4193 <term><varname>payment_description</varname></term>
4196 <para>Name der Zahlart</para>
4201 <term><varname>payment_terms</varname></term>
4204 <para>Zahlungskonditionen</para>
4209 <term><varname>phone</varname></term>
4212 <para>Telefonnummer</para>
4217 <term><varname>shiptocity</varname></term>
4220 <para>Stadt (Lieferadresse) <link
4221 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4226 <term><varname>shiptocontact</varname></term>
4229 <para>Kontakt (Lieferadresse) <link
4230 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4235 <term><varname>shiptocountry</varname></term>
4238 <para>Land (Lieferadresse) <link
4239 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4244 <term><varname>shiptodepartment_1</varname></term>
4247 <para>Abteilung 1 (Lieferadresse) <link
4248 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4253 <term><varname>shiptodepartment_2</varname></term>
4256 <para>Abteilung 2 (Lieferadresse) <link
4257 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4262 <term><varname>shiptoemail</varname></term>
4265 <para>Email (Lieferadresse) <link
4266 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4271 <term><varname>shiptofax</varname></term>
4274 <para>Fax (Lieferadresse) <link
4275 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4280 <term><varname>shiptogln</varname></term>
4283 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4284 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4289 <term><varname>shiptoname</varname></term>
4292 <para>Firmenname (Lieferadresse) <link
4293 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4298 <term><varname>shiptophone</varname></term>
4301 <para>Telefonnummer (Lieferadresse) <link
4302 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4307 <term><varname>shiptostreet</varname></term>
4310 <para>Straße und Hausnummer (Lieferadresse) <link
4311 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4316 <term><varname>shiptozipcode</varname></term>
4319 <para>Postleitzahl (Lieferadresse) <link
4320 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4325 <term><varname>street</varname></term>
4328 <para>Straße und Hausnummer</para>
4333 <term><varname>taxnumber</varname></term>
4336 <para>Steuernummer</para>
4341 <term><varname>ustid</varname></term>
4344 <para>Umsatzsteuer-Identifikationsnummer</para>
4349 <term><varname>vendoremail</varname></term>
4352 <para>Email des Lieferanten; nur für Lieferanten</para>
4357 <term><varname>vendorfax</varname></term>
4360 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4365 <term><varname>vendornotes</varname></term>
4368 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4373 <term><varname>vendornumber</varname></term>
4376 <para>Lieferantennummer; nur für Lieferanten</para>
4381 <term><varname>vendorphone</varname></term>
4384 <para>Telefonnummer des Lieferanten; nur für
4390 <term><varname>zipcode</varname></term>
4393 <para>Postleitzahl</para>
4398 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4399 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4400 Stammdaten nicht eingetragen, so haben die Variablen
4401 <varname>shipto*</varname> den gleichen Wert wie die die
4402 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4403 einige <varname>shipto*</varname>-Variablen so nicht in den
4404 Stammdaten wiederfinden sondern schlicht Kopien der
4405 Lieferdatenvariablen sind (z.B.
4406 <varname>shiptocontact</varname>).</para>
4410 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4411 <title>Informationen über den Bearbeiter</title>
4415 <term><varname>employee_address</varname></term>
4418 <para>Adressfeld</para>
4423 <term><varname>employee_businessnumber</varname></term>
4426 <para>Firmennummer</para>
4431 <term><varname>employee_company</varname></term>
4434 <para>Firmenname</para>
4439 <term><varname>employee_co_ustid</varname></term>
4442 <para>Usatzsteuer-Identifikationsnummer</para>
4447 <term><varname>employee_duns</varname></term>
4450 <para>DUNS-Nummer</para>
4455 <term><varname>employee_email</varname></term>
4463 <term><varname>employee_fax</varname></term>
4471 <term><varname>employee_name</varname></term>
4474 <para>voller Name</para>
4479 <term><varname>employee_signature</varname></term>
4482 <para>Signatur</para>
4487 <term><varname>employee_taxnumber</varname></term>
4490 <para>Steuernummer</para>
4495 <term><varname>employee_tel</varname></term>
4498 <para>Telefonnummer</para>
4504 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4505 <title>Informationen über den Verkäufer</title>
4509 <term><varname>salesman_address</varname></term>
4512 <para>Adressfeld</para>
4517 <term><varname>salesman_businessnumber</varname></term>
4520 <para>Firmennummer</para>
4525 <term><varname>salesman_company</varname></term>
4528 <para>Firmenname</para>
4533 <term><varname>salesman_co_ustid</varname></term>
4536 <para>Usatzsteuer-Identifikationsnummer</para>
4541 <term><varname>salesman_duns</varname></term>
4544 <para>DUNS-Nummer</para>
4549 <term><varname>salesman_email</varname></term>
4557 <term><varname>salesman_fax</varname></term>
4565 <term><varname>salesman_name</varname></term>
4568 <para>voller Name</para>
4573 <term><varname>salesman_signature</varname></term>
4576 <para>Signatur</para>
4581 <term><varname>salesman_taxnumber</varname></term>
4584 <para>Steuernummer</para>
4589 <term><varname>salesman_tel</varname></term>
4592 <para>Telefonnummer</para>
4598 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
4599 <title>Variablen für die einzelnen Steuern</title>
4603 <term><varname>tax</varname></term>
4611 <term><varname>taxbase</varname></term>
4614 <para>zu versteuernder Betrag</para>
4619 <term><varname>taxdescription</varname></term>
4622 <para>Name der Steuer</para>
4627 <term><varname>taxrate</varname></term>
4630 <para>Steuersatz</para>
4636 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
4637 <title>Variablen für Lieferbedingungen</title>
4641 <term><varname>delivery_term</varname></term>
4644 <para>Datenbank-Objekt der Lieferbedingung</para>
4649 <term><varname>delivery_term.description</varname></term>
4652 <para>Beschreibung der Lieferbedingung</para>
4657 <term><varname>delivery_term.description_long</varname></term>
4660 <para>Langtext bzw. übersetzter Langtext der
4661 Lieferbedingung</para>
4668 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
4669 <title>Variablen in Rechnungen</title>
4671 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
4672 <title>Allgemeine Variablen</title>
4676 <term><varname>creditremaining</varname></term>
4679 <para>Verbleibender Kredit</para>
4684 <term><varname>currency</varname></term>
4687 <para>Währung</para>
4692 <term><varname>cusordnumber</varname></term>
4695 <para>Bestellnummer beim Kunden</para>
4700 <term><varname>deliverydate</varname></term>
4703 <para>Lieferdatum</para>
4708 <term><varname>duedate</varname></term>
4711 <para>Fälligkeitsdatum</para>
4716 <term><varname>globalprojectnumber</varname></term>
4719 <para>Projektnummer des ganzen Beleges</para>
4724 <term><varname>globalprojectdescription</varname></term>
4727 <para>Projekbeschreibung des ganzen Beleges</para>
4732 <term><varname>intnotes</varname></term>
4735 <para>Interne Bemerkungen</para>
4740 <term><varname>invdate</varname></term>
4743 <para>Rechnungsdatum</para>
4748 <term><varname>invnumber</varname></term>
4751 <para>Rechnungsnummer</para>
4756 <term><varname>invtotal</varname></term>
4759 <para>gesamter Rechnungsbetrag</para>
4764 <term><varname>notes</varname></term>
4767 <para>Bemerkungen der Rechnung</para>
4772 <term><varname>orddate</varname></term>
4775 <para>Auftragsdatum</para>
4780 <term><varname>ordnumber</varname></term>
4783 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
4784 erstellt wurde</para>
4789 <term><varname>payment_description</varname></term>
4792 <para>Name der Zahlart</para>
4797 <term><varname>payment_terms</varname></term>
4800 <para>Zahlungskonditionen</para>
4805 <term><varname>quodate</varname></term>
4808 <para>Angebotsdatum</para>
4813 <term><varname>quonumber</varname></term>
4816 <para>Angebotsnummer</para>
4821 <term><varname>rounding</varname></term>
4824 <para>Betrag, um den <varname>invtotal</varname> gerundet wurde
4825 (kann positiv oder negativ sein)</para>
4830 <term><varname>shippingpoint</varname></term>
4833 <para>Versandort</para>
4838 <term><varname>shipvia</varname></term>
4841 <para>Transportmittel</para>
4846 <term><varname>subtotal</varname></term>
4849 <para>Zwischensumme aller Posten ohne Steuern</para>
4854 <term><varname>total</varname></term>
4857 <para>Restsumme der Rechnung (Summe abzüglich bereits
4858 bezahlter Posten)</para>
4863 <term><varname>transaction_description</varname></term>
4866 <para>Vorgangsbezeichnung</para>
4871 <term><varname>transdate</varname></term>
4874 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
4875 erstellt wurde</para>
4881 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
4882 <title>Variablen für jeden Posten auf der Rechnung</title>
4886 <term><varname>bin</varname></term>
4889 <para>Stellage</para>
4894 <term><varname>description</varname></term>
4897 <para>Artikelbeschreibung</para>
4902 <term><varname>cusordnumber_oe</varname></term>
4905 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
4906 Posten ursprünglich stammt (nur Verkauf)</para>
4911 <term><varname>discount</varname></term>
4914 <para>Rabatt als Betrag</para>
4919 <term><varname>discount_sub</varname></term>
4922 <para>Zwischensumme mit Rabatt</para>
4927 <term><varname>donumber_do</varname></term>
4930 <para>Lieferscheinnummer des Lieferscheins, aus dem die
4931 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
4932 Workflows aus einem Lieferschein erstellt wurde.</para>
4937 <term><varname>drawing</varname></term>
4940 <para>Zeichnung</para>
4945 <term><varname>ean</varname></term>
4948 <para>EAN-Code</para>
4953 <term><varname>image</varname></term>
4961 <term><varname>linetotal</varname></term>
4964 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
4969 <term><varname>longdescription</varname></term>
4972 <para>Langtext</para>
4977 <term><varname>microfiche</varname></term>
4980 <para>Mikrofilm</para>
4985 <term><varname>netprice</varname></term>
4988 <para>Alternative zu <varname>sellprice</varname>, aber
4989 <varname>netprice</varname> entspricht dem effektiven
4990 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
4991 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
4992 / Menge. Diese Variable ist nützlich, wenn man den gewährten
4993 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
4994 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
4995 <varname>netprice</varname> hat nichts mit Netto/Brutto im
4996 Sinne von Steuern zu tun.</para>
5001 <term><varname>nodiscount_linetotal</varname></term>
5004 <para>Zeilensumme ohne Rabatt</para>
5009 <term><varname>nodiscount_sub</varname></term>
5012 <para>Zwischensumme ohne Rabatt</para>
5017 <term><varname>number</varname></term>
5020 <para>Artikelnummer</para>
5025 <term><varname>ordnumber_oe</varname></term>
5028 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5029 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5030 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5031 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5032 letzterem Fall wird die unsprüngliche Auftragsnummer
5038 <term><varname>p_discount</varname></term>
5041 <para>Rabatt in Prozent</para>
5046 <term><varname>partnotes</varname></term>
5049 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5054 <term><varname>partsgroup</varname></term>
5057 <para>Warengruppe</para>
5062 <term><varname>price_factor</varname></term>
5065 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5071 <term><varname>price_factor_name</varname></term>
5074 <para>Der Name des Preisfaktors, sofern einer eingestellt
5080 <term><varname>projectnumber</varname></term>
5083 <para>Projektnummer</para>
5088 <term><varname>projectdescription</varname></term>
5091 <para>Projektbeschreibung</para>
5096 <term><varname>qty</varname></term>
5104 <term><varname>reqdate</varname></term>
5107 <para>Lieferdatum</para>
5112 <term><varname>runningnumber</varname></term>
5115 <para>Position auf der Rechnung (1, 2, 3...)</para>
5120 <term><varname>sellprice</varname></term>
5123 <para>Verkaufspreis</para>
5128 <term><varname>serialnumber</varname></term>
5131 <para>Seriennummer</para>
5136 <term><varname>tax_rate</varname></term>
5139 <para>Steuersatz</para>
5144 <term><varname>transdate_do</varname></term>
5147 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5148 Workflows aus einem Lieferschein stammte.</para>
5153 <term><varname>transdate_oe</varname></term>
5156 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5157 Workflows aus einem Auftrag erstellt wurde. Wenn es
5158 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5164 <term><varname>transdate_quo</varname></term>
5167 <para>Datum des Angebots, wenn die Position im Rahmen des
5168 Workflows aus einem Angebot stammte.</para>
5173 <term><varname>unit</varname></term>
5176 <para>Einheit</para>
5181 <term><varname>weight</varname></term>
5184 <para>Gewicht</para>
5189 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5190 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5191 einer <function>foreach</function>-Schleife ausgegeben werden, da
5192 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5193 können. Die Variablen dafür lauten:</para>
5197 <term><varname>make</varname></term>
5200 <para>Lieferant</para>
5205 <term><varname>model</varname></term>
5208 <para>Lieferantenartikelnummer</para>
5214 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5215 <title>Variablen für die einzelnen Zahlungseingänge</title>
5219 <term><varname>payment</varname></term>
5227 <term><varname>paymentaccount</varname></term>
5235 <term><varname>paymentdate</varname></term>
5243 <term><varname>paymentmemo</varname></term>
5251 <term><varname>paymentsource</varname></term>
5260 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5261 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5263 <para>Die vom Benutzer definierten Variablen für Kunden und
5264 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5265 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5266 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5267 Variablennamen zusammen.</para>
5269 <para>Beispiel: Der Benutzer hat eine Variable namens
5270 <varname>number_of_employees</varname> definiert, die die Anzahl der
5271 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5272 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5275 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5276 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5277 Präfix <varname>shiptocvar_</varname>.</para>
5281 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5282 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5284 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5285 <title>Namen der Vorlagen</title>
5287 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5288 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5289 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5290 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5291 Vorlagenname für diese Mahnstufe mit dem Zusatz
5292 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5293 für die ausgewählte Sprache und den ausgewählten Drucker
5297 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5298 <title>Allgemeine Variablen in Mahnungen</title>
5300 <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie gewohnt als
5301 <varname>employee_...</varname> bzw. <varname>salesman_...</varname> zur Verfügung.
5302 Werden mehrere Rechnungen in einer Mahnung zusammengefasst, so werden
5303 die Metadaten (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung
5304 im Ausdruck genommen.</para>
5305 <para>Die Adressdaten des Kunden stehen als Variablen <varname>name</varname>,
5306 <varname>street</varname>, <varname>zipcode</varname>,
5307 <varname>city</varname>, <varname>country</varname>,
5308 <varname>department_1</varname>, <varname>department_2</varname>,
5309 und <varname>email</varname> zur Verfügung. Der Ansprechpartner <varname>cp_...</varname>
5310 steht auch zu Verfügung, wird allerdings auch nur von der ersten angemahnten Rechnung (s.o.)
5313 <para>Weitere Variablen beinhalten:</para>
5317 <term><varname>dunning_date</varname></term>
5320 <para>Datum der Mahnung</para>
5325 <term><varname>dunning_duedate</varname></term>
5328 <para>Fälligkeitsdatum für diese Mahhnung</para>
5333 <term><varname>dunning_id</varname></term>
5336 <para>Mahnungsnummer</para>
5341 <term><varname>fee</varname></term>
5344 <para>Kumulative Mahngebühren</para>
5349 <term><varname>interest_rate</varname></term>
5352 <para>Zinssatz per anno in Prozent</para>
5357 <term><varname>total_amount</varname></term>
5360 <para>Gesamter noch zu zahlender Betrag als
5361 <function>fee</function> + <function>total_interest</function>
5362 + <function>total_open_amount</function></para>
5367 <term><varname>total_interest</varname></term>
5370 <para>Zinsen per anno über alle Rechnungen</para>
5375 <term><varname>total_open_amount</varname></term>
5378 <para>Summe über alle offene Beträge der Rechnungen</para>
5384 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5385 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5389 <term><varname>dn_amount</varname></term>
5392 <para>Rechnungssumme (brutto)</para>
5397 <term><varname>dn_duedate</varname></term>
5400 <para>Originales Fälligkeitsdatum der Rechnung</para>
5405 <term><varname>dn_dunning_date</varname></term>
5408 <para>Datum der Mahnung</para>
5413 <term><varname>dn_dunning_duedate</varname></term>
5416 <para>Fälligkeitsdatum der Mahnung</para>
5421 <term><varname>dn_fee</varname></term>
5424 <para>Kummulative Mahngebühr</para>
5429 <term><varname>dn_interest</varname></term>
5432 <para>Zinsen per anno für diese Rechnung</para>
5437 <term><varname>dn_invnumber</varname></term>
5440 <para>Rechnungsnummer</para>
5445 <term><varname>dn_linetotal</varname></term>
5448 <para>Noch zu zahlender Betrag (ergibt sich aus
5449 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5450 + <varname>dn_interest</varname>)</para>
5455 <term><varname>dn_netamount</varname></term>
5458 <para>Rechnungssumme (netto)</para>
5463 <term><varname>dn_open_amount</varname></term>
5466 <para>Offener Rechnungsbetrag</para>
5471 <term><varname>dn_ordnumber</varname></term>
5474 <para>Bestellnummer</para>
5479 <term><varname>dn_transdate</varname></term>
5482 <para>Rechnungsdatum</para>
5487 <term><varname>dn_curr</varname></term>
5490 <para>Währung, in der die Rechnung erstellt wurde. (Die
5491 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5497 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5498 <title>Variablen in automatisch erzeugten Rechnungen über
5499 Mahngebühren</title>
5501 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5502 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5503 Kunden stehen als Variablen <varname>name</varname>,
5504 <varname>street</varname>, <varname>zipcode</varname>,
5505 <varname>city</varname>, <varname>country</varname>,
5506 <varname>department_1</varname>, <varname>department_2</varname>,
5507 und <varname>email</varname> zur Verfügung.</para>
5509 <para>Weitere Variablen beinhalten:</para>
5513 <term><varname>duedate</varname></term>
5516 <para>Fälligkeitsdatum der Rechnung</para>
5521 <term><varname>dunning_id</varname></term>
5524 <para>Mahnungsnummer</para>
5529 <term><varname>fee</varname></term>
5532 <para>Mahngebühren</para>
5537 <term><varname>interest</varname></term>
5545 <term><varname>invamount</varname></term>
5548 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
5549 <varname>interest</varname>)</para>
5554 <term><varname>invdate</varname></term>
5557 <para>Rechnungsdatum</para>
5562 <term><varname>invnumber</varname></term>
5565 <para>Rechnungsnummer</para>
5572 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
5573 <title>Variablen in anderen Vorlagen</title>
5576 <title>Einführung</title>
5578 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
5579 Rechnung. Allerdings heißen die Variablen, die mit
5580 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
5581 fangen sie mit <varname>quo</varname> für "quotation" an:
5582 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
5583 wiederum fangen sie mit <varname>ord</varname> für "order" an:
5584 <varname>ordnumber</varname> für Bestellnummer etc.</para>
5586 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
5587 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
5588 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
5589 Vorlage keine Bedeutung haben oder noch nicht belegt sein
5592 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
5593 in Rechnungen aufgeführt.</para>
5596 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
5597 <title>Angebote und Preisanfragen</title>
5601 <term><varname>quonumber</varname></term>
5604 <para>Angebots- bzw. Anfragenummer</para>
5609 <term><varname>reqdate</varname></term>
5612 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
5613 Preisanfragen)</para>
5618 <term><varname>transdate</varname></term>
5621 <para>Angebots- bzw. Anfragedatum</para>
5627 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
5628 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
5632 <term><varname>ordnumber</varname></term>
5635 <para>Auftragsnummer</para>
5640 <term><varname>reqdate</varname></term>
5643 <para>Lieferdatum</para>
5648 <term><varname>transdate</varname></term>
5651 <para>Auftragsdatum</para>
5657 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
5658 <title>Lieferscheine (Verkauf und Einkauf)</title>
5662 <term><varname>cusordnumber</varname></term>
5665 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
5666 des Lieferanten (im Einkauf)</para>
5671 <term><varname>donumber</varname></term>
5674 <para>Lieferscheinnummer</para>
5679 <term><varname>transdate</varname></term>
5682 <para>Lieferscheindatum</para>
5687 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
5688 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
5689 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
5690 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
5691 <function>foreach</function>-Schleife ausgegeben werden. Diese
5692 Variablen sind:</para>
5696 <term><varname>si_bin</varname></term>
5699 <para>Lagerplatz</para>
5704 <term><varname>si_chargenumber</varname></term>
5707 <para>Chargennummer</para>
5712 <term><varname>si_bestbefore</varname></term>
5715 <para>Mindesthaltbarkeit</para>
5720 <term><varname>si_number</varname></term>
5723 <para>Artikelnummer</para>
5728 <term><varname>si_qty</varname></term>
5731 <para>Anzahl bzw. Menge</para>
5736 <term><varname>si_runningnumber</varname></term>
5739 <para>Positionsnummer (1, 2, 3 etc)</para>
5744 <term><varname>si_unit</varname></term>
5747 <para>Einheit</para>
5752 <term><varname>si_warehouse</varname></term>
5761 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
5762 <title>Variablen für Sammelrechnung</title>
5766 <term><varname>c0total</varname></term>
5769 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
5775 <term><varname>c30total</varname></term>
5778 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
5779 und < 60 Tage</para>
5784 <term><varname>c60total</varname></term>
5787 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
5788 und < 90 Tage</para>
5793 <term><varname>c90total</varname></term>
5796 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
5802 <term><varname>total</varname></term>
5805 <para>Gesamtbetrag aller Rechnungen</para>
5810 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
5814 <term><varname>invnumber</varname></term>
5817 <para>Rechnungsnummer</para>
5822 <term><varname>invdate</varname></term>
5825 <para>Rechnungsdatum</para>
5830 <term><varname>duedate</varname></term>
5833 <para>Fälligkeitsdatum</para>
5838 <term><varname>amount</varname></term>
5841 <para>Summe der Rechnung</para>
5846 <term><varname>open</varname></term>
5849 <para>Noch offener Betrag der Rechnung</para>
5854 <term><varname>c0</varname></term>
5857 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
5863 <term><varname>c30</varname></term>
5866 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
5872 <term><varname>c60</varname></term>
5875 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
5881 <term><varname>c90</varname></term>
5884 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
5892 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
5893 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
5895 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
5896 <title>Einführung</title>
5898 <para>Der Parser kennt neben den Variablen einige weitere
5899 Konstrukte, die gesondert behandelt werden. Diese sind wie
5900 Variablennamen in spezieller Weise markiert:
5901 <command><%anweisung%> ... <%end%></command></para>
5903 <para>Anmerkung zum <command><%end%></command>: Der besseren
5904 Verständlichkeit halber kann man nach dem <command>end</command>
5905 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
5906 Anweisung (z.B. <command>if</command> oder
5907 <command>foreach</command>) damit abgeschlossen wird.</para>
5909 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
5910 <command><%if type == "sales_quotation"%></command>, so könnte
5911 er mit <command><%end%></command> genauso abgeschlossen werden
5912 wie mit <command><%end if%></command> oder auch
5913 <command><%end type == "sales_quotation"%></command>.</para>
5916 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
5917 <title>Der if-Block</title>
5919 <programlisting><%if variablenname%>
5921 <%end%></programlisting>
5923 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
5924 und dem "end" werden nur ausgegeben, wenn die Variable
5925 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
5927 <para>Handelt es sich bei der benannten Variable um ein Array, also
5928 um einen Variablennamen, über den man mit <command><%foreach
5929 variablenname%></command> iteriert, so wird mit diesem Konstrukt
5930 darauf getestet, ob das Array Elemente enthält. Somit würde im
5931 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
5932 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
5933 welche getätigt wurden:</para>
5935 <programlisting><%if payment%>
5937 <%foreach payment%>
5938 Am <%paymentdate%>: <%payment%> €
5939 <%end foreach%>
5940 <%end if%></programlisting>
5942 <para>Die Bedingung kann auch negiert werden, indem das Wort
5943 <function>not</function> nach dem <filename>if</filename> verwendet
5944 wird. Beispiel:</para>
5946 <programlisting><%if not cp_greeting%>
5948 <%end%></programlisting>
5950 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
5951 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
5952 einer Variablen mit einer festen Zeichenkette oder einer anderen
5953 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
5954 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
5955 die rechte Seite des Vergleichsoperators in Anführungszeichen
5956 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
5957 anderer Variablen). Zwei Beispiele, die beide Vergleiche
5960 <programlisting><%if var1 == "Wert"%></programlisting>
5962 <para>Testet die Variable <varname>var1</varname> auf
5963 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
5964 Mittels <function>!=</function> anstelle von <function>==</function>
5965 würde auf Ungleichheit getestet.</para>
5967 <programlisting><%if var1 == var2%></programlisting>
5969 <para>Testet die Variable <varname>var1</varname> auf
5970 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
5971 <function>!=</function> anstelle von <function>==</function> würde
5972 auf Ungleichheit getestet.</para>
5974 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
5975 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
5976 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
5977 dieselbe Syntax wie oben nur mit <function>=~</function> und
5978 <function>!~</function> als Vergleichsoperatoren.</para>
5980 <para>Beispiel für einen Test, ob die Variable
5981 <varname>intnotes</varname> (interne Bemerkungen) das Wort
5982 <constant>schwierig</constant> enthält:</para>
5984 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
5987 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
5988 <title>Der foreach-Block</title>
5990 <programlisting><%foreach variablenname%>
5992 <%end%></programlisting>
5994 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
5995 wie das Perl-Array der Variablen <varname>variablenname</varname>
5996 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
5997 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
5998 benutzt. In jedem Durchlauf werden die <link
5999 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
6000 Variablen</link> jeweils auf den Wert für die aktuelle Position
6003 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
6005 <programlisting><%foreach number%>
6006 Position: <%runningnumber%>
6007 Anzahl: <%qty%>
6008 Artikelnummer: <%number%>
6009 Beschreibung: <%description%>
6011 <%end%></programlisting>
6013 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
6014 <function><%foreach%></function>-Block innerhalb einer
6015 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
6016 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
6017 Inhalt zwischen <function><%foreach%></function> und
6018 <function><%end%></function> wiederholt, nicht aber die
6019 komplette Zeile, in der er steht.</para>
6023 <sect2 id="dokumentenvorlagen-und-variablen.markup">
6024 <title>Markup-Code zur Textformatierung innerhalb von
6027 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6028 anders formatiert haben möchte, so ist dies begrenzt möglich.
6029 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6030 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6031 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6032 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6033 (HTML oder PDF über LaTeX) umgesetzt.</para>
6035 <para>Die unterstützen Formatierungen sind:</para>
6039 <term><b>Text</b></term>
6042 <para>Text wird in Fettdruck gesetzt.</para>
6047 <term><i>Text</i></term>
6050 <para>Text wird kursiv gesetzt.</para>
6055 <term><u>Text</u></term>
6058 <para>Text wird unterstrichen.</para>
6063 <term><s>Text</s></term>
6066 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6067 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6072 <term><bullet></term>
6075 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6081 <para>Der Befehl <command><bullet></command> funktioniert
6082 momentan auch nur in Latex-Vorlagen.</para>
6086 <sect1 id="excel-templates">
6087 <title>Excel-Vorlagen</title>
6089 <sect2 id="excel-templates.summary">
6090 <title>Zusammenfassung</title>
6092 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6093 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6097 <sect2 id="excel-templates.usage">
6098 <title>Bedienung</title>
6100 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6101 werden. Die Konfigurationsoption heißt <varname>excel_templates =
6102 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6104 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6105 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6106 werden. In den normalen Verkaufsmasken taucht nun
6107 <constant>Excel</constant> als auswählbares Format auf und kann von da
6108 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6110 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6111 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6112 <filename>sales_quotation.xls</filename> gespeichert.</para>
6115 <sect2 id="excel-templates.syntax">
6116 <title>Variablensyntax</title>
6118 <para>Einfache Syntax:
6119 <command><<varname>></command></para>
6121 <para>Dabei sind <constant><<</constant> und
6122 <constant>>></constant> die Delimiter. Da Excel auf festen
6123 Breiten besteht, kann der Tag künstlich verlängert werden, indem
6124 weitere <constant><</constant> oder <constant>></constant>
6125 eingefügt werden. Der Tag muss nicht symmetrisch sein.
6128 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6130 <para>Um die Limitierung der festen Breite zu reduzieren, können
6131 weitere Variablen in einem Block interpoliert werden. Whitespace wird
6132 dazwishen dann erhalten. Beispiel:</para>
6134 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6136 <para>Die Variablen werden interpoliert, und linksbündig mit
6137 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6138 lang, werden überzählige Zeichen abgeschnitten.</para>
6140 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6141 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6143 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6145 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6146 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6150 <sect2 id="excel-templates.limitations">
6151 <title>Einschränkungen</title>
6153 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6154 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6155 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6156 Text zu ersetzen.</para>
6158 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6159 <command><%if%></command> und
6160 <command><%foreach%></command> nicht vorhanden. Der Delimiter
6161 <constant><% %></constant> kommt in den Headerinformationen
6162 evtl. vor. Deshalb wurde auf den sichereren Delimiter
6163 <constant><<</constant> und <constant>>></constant>
6168 <sect1 id="features.warehouse">
6171 <title>Mandantenkonfiguration Lager</title>
6174 Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6175 Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. Ferner kann jede Position eines Lieferscheins
6176 ein-, bzw. ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele Lager mit beliebig vielen Lagerplätzen abgebildet
6177 werden. Die Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder Einzelposition und das Auswählen dieser Position zu
6178 einem Lager mit Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je nachdem wie die Einstellungen in der
6179 Mandatenkonfiguration gesetzt werden.
6184 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6185 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6186 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6187 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6191 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6192 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6193 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6194 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6195 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6196 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6201 Zusätzliche Funktionshinweise:
6206 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6207 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6208 Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6212 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6213 Stammdaten definiert</option> Wird beim 'Auslagern über
6214 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6215 so wird mit dieser Option einfach der Standardlagerplatz
6223 <sect1 id="features.swiss-charts-of-accounts">
6224 <title>Schweizer Kontenpläne</title>
6226 <para>Seit der Version 3.4.1 stehen in kivitendo 2 Kontenpläne für
6227 den Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6228 Organisationen, die nicht mehrwertsteuerpflichtig sind, und einer
6229 für Firmen, die mehrwertsteuerpflichtig sind.</para>
6231 <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6232 verwendeten KMU-Kontenrahmen und sind mit der Revision des Schweizerischen
6233 Obligationenrechts (OR) vom 1.1.2013 kompatibel, insbesondere
6234 <literal>Art.957a Abs.2</literal>.</para>
6236 <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der aktuellen
6237 Version von kivitendo noch nicht integriert.</para>
6239 <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6240 Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6241 Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen
6242 alle Aufwandskonten editiert werden und dort der Steuersatz auf 0%
6243 gesetzt werden.</para>
6245 <para>So werden bei Kreditorenbuchungen keine Vorsteuern verbucht.</para>
6247 <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6248 Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne
6249 bitte an <literal>empfang@revamp-it.ch</literal> senden.</para>
6252 <sect1 id="features.part_classification">
6253 <title>Artikelklassifizierung</title>
6256 <title>Übersicht</title>
6258 <para>Die Klassifizierung von Artikeln dient einer weiteren Gliederung
6259 um zum Beispiel den Einkauf vom Verkauf zu trennen, gekennzeichnet
6260 durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel (z.B. "E").
6261 Für jede Klassifizierung besteht eine Beschreibung und eine Abkürzung
6262 die normalerweise aus einem Zeichen besteht, kann aber auf mehrere
6263 Zeichen erweitert werden, falls zur Unterscheidung notwendig, sinnvoll
6264 sind jedoch nur maximal 2 Zeichen.</para>
6268 <title>Basisklassifizierung</title>
6270 <para>Als Basisklassifizierungen gibt es</para>
6274 <para>Einkauf</para>
6278 <para>Verkauf</para>
6282 <para>Handelsware</para>
6286 <para>Produktion</para>
6290 <para>- keine - (diese wird bei einer Aktualisierung für alle
6291 existierenden Artikel genommen, gültig für Verkauf und
6296 <para>Es können weitere Klassifizierungen angelegt werden. So kann es
6297 z.B. für separat auszuweisende Artikel folgened Klassen geben:</para>
6301 <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
6305 <para>Material (Verpackungsmaterial) mit Kürzel M</para>
6311 <title>Attribute</title>
6313 <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
6314 alle gleichzeitg gültig sein können</para>
6318 <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
6323 <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
6328 <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
6329 (LaTeX) zusätzliche Variable</para>
6333 <para>Beim separat ausweisen stehen im LaTeX die Variable <emphasis
6334 role="bold"><%non_separate_subtotal%> </emphasis>zur Verfügung,
6335 die alle nicht separat auszuweisenden Artikelkosten saldiert, sowie
6336 pro separat auszuweisenden Klassifizierungen die Variable<emphasis
6337 role="bold"> <%separate_X_subtotal%></emphasis> wobei X das
6338 Kürzel der Klassifizierung ist.</para>
6340 <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
6341 role="bold"><%separate_L_subtotal%></emphasis> und für
6342 Verpackungsmaterial <emphasis
6343 role="bold"><%separate_M_subtotal%> </emphasis>.</para>
6347 <title>Zwei-Zeichen Abkürzung</title>
6349 <para>Der Typ des Artikel und die Klassifizierung werden durch zwei
6350 Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
6351 Typs des Artikel ('P','A','S') , deutch 'W', 'E', und 'D' für Ware
6352 Erzeugnis oder Dienstleistung, ggf. weitere Typen.</para>
6354 <para>Der zweite (und ggf. auch ein dritter Buchstabe, falls nötig)
6355 entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
6357 <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
6358 Erleichterung mit dargestellt.</para>
6362 <sect1 id="features.file_managment">
6363 <title>Dateiverwaltung (Mini-DMS)</title>
6366 <title>Übersicht</title>
6367 <para>Parallel zum alten WebDAV gibt es eine Datei-Management-Sytem, daß Dateien
6368 verschiedenen Typs verwaltet. Dies können</para>
6371 <para>aus ERP-Daten per LaTeX Template erzeugte PDF-Dokumente,</para>
6374 <para>zu bestimmten ERP-Daten gehörende Anhangdateien unterschiedlichen Formats,</para>
6377 <para>per Scanner eingelesene PDF-Dateien,</para>
6380 <para>per Email empfangene Dateianhänge unterschiedlichen Formats,</para>
6383 <para>sowie speziel an Artikel hochgeladene Bilder sein.</para>
6387 <screeninfo>Übersicht</screeninfo>
6390 <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
6397 <title>Struktur</title>
6399 <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:
6403 <para>Dateisystem,</para>
6406 <para>WebDAV,</para>
6409 <para>Schnittstelle zu externem Dokumenten-Management-System,</para>
6412 <para>andere Datenbank,</para>
6415 <para>etc ...</para>
6418 <para>Es gibt unterschiedliche Typen von Dateien, jedem Typ läßt sich in der
6419 Mandantenkonfigurierung ein bestimmtes Backend zuordnen.
6423 <para>"document", das sind entweder generierte,eingescannte oder hochgeladene PDF-Dateien,
6424 die zu bestimmten ERP-Daten (ERP-Objekte, wi z.B. Rechnung, Lieferschein) gehören.</para>
6427 <para>"attachment", zusätzlich hochgeladene Dokumente, die an bestimmte ERP-Objekte angehängt werden,
6428 z.B. technische Zeichnungen,Aufmaße. Diese können auch an Artikeln,
6429 Lieferanten und Kunden hinterlegt sein</para>
6432 <para>"image", Bilder an Artikeln. Diese können auch verkleinert in einer Vorschau (Thumbnail)
6433 angezeigt werden.</para>
6436 <para>Zusätzlich werden in der Datenbank zu den Dateien neben der Zuordnung zu ERP-Objekten, des Dateityps
6437 des Dateinamens und des Backends in dem die Datei gespeichert ist auch die Quelle der Datei notiert:
6441 <para> "created" , vom System erzeugte Dokumente"</para>
6444 <para> "uploaded", hochgeladene Dokumente</para>
6447 <para> "email", vom Mailsystem empfangene Dateien</para>
6450 <para> "scanner[1]", von einem oder mehreren Scannern erzeugte Dateien. Existieren mehrere Scanner,
6451 so sind diese durch unterschiedliche Quellennamen zu definieren</para>
6454 <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es für "attachment" und "image" nur
6455 die Quelle "uploaded". Für "document" gibt es auf jeden Fall die Quelle "created".
6456 Die Quellen "scanner" und "email" müssen derzeit in der Datenbank konfiguriert werden (siehe <xref linkend="file_management.dbconfig"/>.</para>
6460 <title>Anwendung</title>
6461 <para>Die Daten werden bei den ERP-Objekten als extra Reiter dargestellt.
6462 Eine Verkaufsrechnung z.B. hat die
6463 Reiter "Dokumente" und "Dateianhänge.</para>
6465 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6468 <imagedata scale="50" fileref="images/DMS-Anhaenge.png"/>
6472 <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer Datei angezeigt.
6473 Wird eine Datei mit gleichem Namen hochgeladen, so wird eine neue Version der Datei erstellt.
6474 Vorher wird der Anwender durch einen Dialog ob er eine neue Version anlegen will oder
6475 ob er die Datei umbenennen will, falls es eine neue Datei sein soll.</para>
6477 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6480 <imagedata width="100" contentwidth="40" fileref="images/DMS-Anhaenge-hochladen.png"/>
6484 <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
6485 solange in Summe die maximale Größe nicht überschritten wird.
6486 (siehe <xref linkend="file_management.clientconfig"/></para>
6488 <screeninfo>Reiter "Dokumente"</screeninfo>
6491 <imagedata width="500" fileref="images/DMS-Dokumente.png"/>
6495 <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt es nur "erzeugte Dokumente".
6496 Es werden alle Versionen der generierten Datei angezeigt. Für Verkaufsrechnungen kommen keine
6497 anderen Quellen zur Geltung. Werden entsprechend
6498 <xref linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert, so sind diese z.B. bei
6499 Einkaufsrechnungen sichtbar:</para>
6501 <screeninfo>Reiter "Dokumente"</screeninfo>
6504 <imagedata contentwidth="600" fileref="images/DMS-Dokumente-Scanner.png"/>
6508 <para>Statt des Löschens wird hier die Datei zurück zur Quelle verschoben. Somit kann die Datei anschließend
6509 an ein anderes ERP-Objekt angehängt werden.</para>
6510 <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie sind bisher nur bei Bildern relevant.</para>
6514 <title>Konfigurierung</title>
6515 <sect3 id="file_management.clientconfig" xreflabel="Mandantenkonfigurierung">
6516 <title>Mandantenkonfigurierung</title>
6518 <title>Reiter "Features"</title>
6519 <para>Unter dem Reiter <emphasis role="bold">Features</emphasis> im Abschnit Dateimanagement ist
6520 neben dem "alten" WebDAV das Dateimangement general zu- und abschaltbar, sowie die Zuordnung der
6521 Dateitypen zu Backends. Die Löschbarkeit von Dateien sowie die maximale Uploadgröße sind Backend-unabhängig</para>
6523 <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
6526 <imagedata width="500" fileref="images/DMS-ClientConfig.png"/>
6530 <para>Die einzelnen Backends sind einzeln einschaltbar. Spezifische Backend-Konfigurierungen sind hier
6531 noch ergänzbar. Für das Backend Dateisystem ist das Wurzelverzeichnis für den Mandanten einzugeben.</para>
6534 <title>Reiter "Allgemeine Dokumentenanhänge"</title>
6535 <para>Unter dem Reiter <emphasis role="bold">Allgemeine Dokumentenanhänge</emphasis>
6536 kann für alle ERP-Dokumente ( Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und Einkauf )
6537 allgemeingültige Anhänge hochgeladen werden.</para>
6539 <screeninfo>Mandantenkonfig Reiter "Allgemeine Dokumentenanhänge"</screeninfo>
6542 <imagedata width="500" fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"/>
6546 <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die ERP-Dokumente angehängt,
6547 z.B. AGBs oder aktuelle Angebote. Es werden in dem Fall die Daten kopiert, sodaß an den ERP-Dokumenten immer
6548 die Anhänge zum Generierungszeitpunkt eingebettet sind.
6552 <sect3 id="file_management.dbconfig" xreflabel="Datenbank-Konfigurierung">
6553 <title>Datenbank-Konfigurierung</title>
6554 <para>Die zusätzlichen Quellen für email oder ein oder mehrere Scanner sind derzeit vom Administrator
6555 direkt in der Datenbanktablle "user_preferences" einzurichten. Die "value" ist im JSON-Format
6556 mit den jeweiligen Werten des Verzeichnisses und der Beschreibung der Quelle.</para>
6558 id | login | namespace | version | key | value
6559 ----+-----------+--------------+---------+----------+---------------------------
6560 1 | #default# | file_sources | 0.00000 | scanner1 |
6561 {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
6562 2 | #default# | file_sources | 0.00000 | scanner2 |
6563 {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
6564 3 | #default# | file_sources | 0.00000 | emails |
6565 {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
6567 <para>Es ist daran gedacht, statt dem default Eintrag später für bestimmte Benutzer ('login') bestimmte Quellen zuzulassen,
6568 dies wird nach Bedarf implementiert.</para>
6575 <title>Entwicklerdokumentation</title>
6577 <sect1 id="devel.globals" xreflabel="Globale Variablen">
6578 <title>Globale Variablen</title>
6581 <title>Wie sehen globale Variablen in Perl aus?</title>
6583 <para>Globale Variablen liegen in einem speziellen namespace namens
6584 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
6585 globs global und die meisten speziellen Variablen sind...
6588 <para>Daraus ergeben sich folgende Formen:</para>
6592 <term><literal>$main::form</literal></term>
6595 <para>expliziter Namespace "main"</para>
6600 <term><literal>$::form</literal></term>
6603 <para>impliziter Namespace "main"</para>
6608 <term><literal>open FILE, "file.txt"</literal></term>
6611 <para><varname>FILE</varname> ist global</para>
6616 <term><literal>$_</literal></term>
6619 <para>speziell</para>
6624 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
6625 Schlüsselwort wie "<function>global</function>", mit dem man
6626 importieren kann. <function>my</function>, <function>our</function>
6627 und <function>local</function> machen was anderes.</para>
6631 <term><literal>my $form</literal></term>
6634 <para>lexikalische Variable, gültig bis zum Ende des
6640 <term><literal>our $form</literal></term>
6643 <para><varname>$form</varname> referenziert ab hier
6644 <varname>$PACKAGE::form</varname>.</para>
6649 <term><literal>local $form</literal></term>
6652 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
6653 des scopes zurückgesetzt</para>
6660 <title>Warum sind globale Variablen ein Problem?</title>
6662 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
6664 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
6665 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
6666 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
6667 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
6668 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
6669 Datenbankverbindungen, weil die sehr lange zum Initialisieren
6672 <para>Das zweite Problem ist <function>strict</function>. Unter
6673 <function>strict</function> werden alle Variablen die nicht explizit
6674 mit <function>Package</function>, <function>my</function> oder
6675 <function>our</function> angegeben werden als Tippfehler angemarkert,
6676 dies hat, seit der Einführung, u.a. schon so manche langwierige
6677 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
6678 angegeben werden, werden die nicht geprüft, und somit kann sich
6679 schnell ein Tippfehler einschleichen.</para>
6683 <title>Kanonische globale Variablen</title>
6685 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
6686 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
6687 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
6688 umhergereicht werden.</para>
6690 <para>Diese Variablen sind im Moment die folgenden neun:</para>
6694 <para><varname>$::form</varname></para>
6698 <para><varname>%::myconfig</varname></para>
6702 <para><varname>$::locale</varname></para>
6706 <para><varname>$::lxdebug</varname></para>
6710 <para><varname>$::auth</varname></para>
6714 <para><varname>$::lx_office_conf</varname></para>
6718 <para><varname>$::instance_conf</varname></para>
6722 <para><varname>$::dispatcher</varname></para>
6726 <para><varname>$::request</varname></para>
6730 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
6731 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
6732 Eigenschaften (Konventionen):</para>
6735 <title>$::form</title>
6739 <para>Ist ein Objekt der Klasse
6740 "<classname>Form</classname>"</para>
6744 <para>Wird nach jedem Request gelöscht</para>
6748 <para>Muss auch in Tests und Konsolenscripts vorhanden
6753 <para>Enthält am Anfang eines Requests die Requestparameter vom
6758 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
6759 cachen, das wird aber momentan absichtlich zerstört</para>
6763 <para><varname>$::form</varname> wurde unter <productname>SQL
6764 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
6765 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
6766 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
6767 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
6768 <function>IS->retrieve_customer()</function> in Sicherheit
6771 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
6772 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
6773 3552, Stand version 2.7beta), um dies hinterher wieder auf den
6774 richtigen Wert zu setzen:</para>
6776 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
6777 $::myconfig{numberformat} = $numberformat;
6778 # (...) div Berechnungen
6779 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
6781 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
6782 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
6783 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
6784 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
6785 Es geht ziemlich sicher etwas kaputt.</para>
6787 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
6788 in den <productname>Template::Toolkit</productname> Templates
6789 außerhalb der Controller: der Ausdruck <function>[% var
6790 %]</function> greift auf <varname>$::form->{var}</varname> zu.
6791 Unter Controllern ist der Standard Scope anders, da lautet der
6792 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
6793 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
6794 <function><%var%></function> zeigt auf
6795 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
6796 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
6799 <programlisting>[%- IF business %]
6800 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
6801 [%- END %]</programlisting>
6803 <para>Entweder wird hier dann $::form->{business} ausgewertet
6804 oder aber der Funktion
6805 <function>$form->parse_html_template</function> wird explizit
6806 noch ein zusätzlicher Hash übergeben, der dann auch in den
6807 (Web-)Templates zu Verfügung steht, bspw. so:</para>
6809 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
6811 <para>Innerhalb von Schleifen wird
6812 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
6813 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
6814 welches über alle Positionen eines Lieferscheins in Schleife
6817 <programlisting>for $i (1 .. $form->{rowcount}) {
6819 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
6820 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
6821 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
6827 <title>%::myconfig</title>
6831 <para>Das einzige Hash unter den globalen Variablen</para>
6835 <para>Wird spätestens benötigt wenn auf die Datenbank
6836 zugegriffen wird</para>
6840 <para>Wird bei jedem Request neu erstellt.</para>
6844 <para>Enthält die Userdaten des aktuellen Logins</para>
6848 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
6849 extern serialisiert werden, weil da auch der Datenbankzugriff
6850 für diesen user drinsteht.</para>
6854 <para>Enthält unter anderem Datumsformat dateformat und Nummernformat numberformat</para>
6858 <para>Enthält Datenbankzugriffinformationen</para>
6862 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
6863 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
6864 aktuellen Users entscheiden müssen, befragen
6865 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
6866 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
6867 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
6868 Informationen über den Benutzer die über die
6869 Administrator-Schnittstelle eingegeben wurden.</para>
6873 <title>$::locale</title>
6877 <para>Objekt der Klasse "Locale"</para>
6881 <para>Wird pro Request erstellt</para>
6885 <para>Muss auch für Tests und Scripte immer verfügbar
6890 <para>Cached intern über Requestgrenzen hinweg benutzte
6895 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
6896 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
6900 <title>$::lxdebug</title>
6904 <para>Objekt der Klasse "LXDebug"</para>
6908 <para>Wird global gecached</para>
6912 <para>Muss immer verfügbar sein, in nahezu allen
6917 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
6918 bereit, wie "<function>enter_sub</function>" und
6919 "<function>leave_sub</function>", mit denen in den alten Modulen ein
6920 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
6921 der man die Wallclockzeit seit Requeststart loggen kann, sowie
6922 "<function>message</function>" und "<function>dump</function>" mit
6923 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
6926 <para>Beispielsweise so:</para>
6928 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
6929 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
6933 <title>$::auth</title>
6937 <para>Objekt der Klasse "SL::Auth"</para>
6941 <para>Wird global gecached</para>
6945 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
6949 <para>Wird nach jedem Request resettet.</para>
6953 <para><varname>$::auth</varname> stellt Funktionen bereit um die
6954 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
6955 vom aktuellen User abhängen wird das Objekt aus
6956 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
6957 Request kurz resettet.</para>
6959 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
6960 Dessen Einstellungen können über
6961 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
6962 ist ein Hash mit den Werten aus der Tabelle
6963 <literal>auth.clients</literal>.</para>
6967 <title>$::lx_office_conf</title>
6971 <para>Objekt der Klasse
6972 "<classname>SL::LxOfficeConf</classname>"</para>
6976 <para>Global gecached</para>
6980 <para>Repräsentation der
6981 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
6985 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
6986 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
6987 das Programm die Konfiguration ändern kann oder sollte.</para>
6989 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
6990 Debug- und Trace-Log-Datei wie folgt konfiguriert und
6993 <programlisting>[debug]
6994 file_name = /tmp/kivitendo-debug.log</programlisting>
6996 <para>ist der Key <varname>file</varname> im Programm als
6997 <varname>$::lx_office_conf->{debug}{file}</varname>
7001 <para>Zugriff auf die Konfiguration erfolgt im Moment über
7002 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
7007 <title>$::instance_conf</title>
7011 <para>Objekt der Klasse
7012 "<classname>SL::InstanceConfiguration</classname>"</para>
7016 <para>wird pro Request neu erstellt</para>
7020 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
7021 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
7022 ist hier eine Mandantendatenbank. Beispielsweise überprüft
7023 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
7024 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
7028 <title>$::dispatcher</title>
7032 <para>Objekt der Klasse
7033 "<varname>SL::Dispatcher</varname>"</para>
7037 <para>wird pro Serverprozess erstellt.</para>
7041 <para>enthält Informationen über die technische Verbindung zum
7046 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
7047 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
7048 Objekt untergebracht.</para>
7052 <title>$::request</title>
7056 <para>Hashref (evtl später Objekt)</para>
7060 <para>Wird pro Request neu initialisiert.</para>
7064 <para>Keine Unterstruktur garantiert.</para>
7068 <para><varname>$::request</varname> ist ein generischer Platz um
7069 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
7070 at a distance benutzt werden, sondern um lokales memoizing zu
7071 ermöglichen, das garantiert am Ende des Requests zerstört
7074 <para>Vieles von dem, was im moment in <varname>$::form</varname>
7075 liegt, sollte eigentlich hier liegen. Die groben
7076 Differentialkriterien sind:</para>
7080 <para>Kommt es vom User, und soll unverändert wieder an den
7081 User? Dann <varname>$::form</varname>, steht da eh schon</para>
7085 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
7086 Requests gebraucht werden? Dann
7087 <varname>$::request</varname></para>
7091 <para>Muss ich von anderen Teilen des Programms lesend drauf
7092 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
7093 Wrappermethode</para>
7100 <title>Ehemalige globale Variablen</title>
7102 <para>Die folgenden Variablen waren einmal im Programm, und wurden
7106 <title>$::cgi</title>
7110 <para>war nötig, weil cookie Methoden nicht als
7111 Klassenfunktionen funktionieren</para>
7115 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
7116 Klassennamespace gehalten wird und über Requestgrenzen
7121 <para>liegt jetzt unter
7122 <varname>$::request->{cgi}</varname></para>
7128 <title>$::all_units</title>
7132 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
7133 ein paar hundert mal pro Request eine Liste der Einheiten
7134 brauchen, und de als Parameter durch einen Riesenstack von
7135 Funktionen geschleift werden müssten.</para>
7139 <para>Liegt jetzt unter
7140 <varname>$::request->{cache}{all_units}</varname></para>
7145 <function>AM->retrieve_all_units()</function> gesetzt oder
7152 <title>%::called_subs</title>
7156 <para>wurde benutzt um callsub deep recursions
7161 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
7162 möglichen Rekursioenen darstellt, und da nie welche
7167 <para>komplette recursion protection wurde entfernt.</para>
7174 <sect1 id="devel.fcgi">
7175 <title>Entwicklung unter FastCGI</title>
7177 <sect2 id="devel.fcgi.general">
7178 <title>Allgemeines</title>
7180 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
7181 werden, muss der Webserver neu gestartet werden.</para>
7183 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
7184 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
7185 müssen folgende Aspekte beachtet werden.</para>
7188 <sect2 id="devel.fcgi.exiting">
7189 <title>Programmende und Ausnahmen</title>
7191 <para>Betrifft die Funktionen <function>warn</function>,
7192 <function>die</function>, <function>exit</function>,
7193 <function>carp</function> und <function>confess</function>.</para>
7195 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
7196 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
7197 am Laufen zu halten. Man kann mit <function>die</function>,
7198 <function>confess</function> oder <function>carp</function> Fehler
7199 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
7200 eigene <function>$::form-</function>error()> tut im Prinzip das
7201 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
7202 <function>exit</function> hingegen werden nicht abgefangen.
7203 <function>warn</function> wird direkt nach STDERR, also in Server Log
7204 eine Nachricht schreiben (sofern in der Konfiguration nicht die
7205 Warnungen in das kivitendo Log umgeleitet wurden), und
7206 <function>exit</function> wird die Ausführung beenden.</para>
7208 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
7209 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
7210 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
7211 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
7214 <sect2 id="devel.fcgi.globals">
7215 <title>Globale Variablen</title>
7217 <para>Um zu vermeiden, dass Informationen von einem Request in einen
7218 anderen gelangen, müssen alle globalen Variablen vor einem Request
7219 sauber initialisiert werden. Das ist besonders wichtig im
7220 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
7221 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
7224 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
7225 abgetrennten Block, der alle kanonischen globalen Variablen listet und
7226 erklärt. Bitte keine anderen einführen ohne das sauber zu
7227 dokumentieren.</para>
7229 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
7230 man sicher geht, dass man die richtige erwischt.</para>
7233 <sect2 id="devel.fcgi.performance">
7234 <title>Performance und Statistiken</title>
7236 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
7237 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
7238 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
7239 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
7240 sind es je nach Menge der definierten Variablen 1-2s. Ab der
7241 Moose/Rose::DB Version sind es 5-6s.</para>
7243 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
7244 den kritischen Pfaden, unter 0,15 sonst.</para>
7248 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
7249 <title>SQL-Upgradedateien</title>
7251 <sect2 id="db-upgrade-files.introduction"
7252 xreflabel="Einführung in die Datenbank-Upgradedateien">
7253 <title>Einführung</title>
7255 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
7256 gesteuert, die sich im Verzeichnis
7257 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
7258 muss pro Datenbankupgrade eine Datei existieren, die neben den
7259 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
7260 Kontrollinformationen enthält.</para>
7262 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
7263 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
7264 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
7265 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
7266 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
7267 Versionsnummern braucht.</para>
7269 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
7270 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
7271 führt diese nicht erneut aus. Dazu dient die Tabelle
7272 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
7273 angelegt wird.</para>
7276 <sect2 id="db-upgrade-files.format"
7277 xreflabel="Format der Upgradedateien">
7278 <title>Format der Kontrollinformationen</title>
7280 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
7281 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
7282 hat dabei das folgende Format:</para>
7284 <para>Für SQL-Upgradedateien:</para>
7286 <programlisting>-- @key: value</programlisting>
7288 <para>Für Perl-Upgradedateien:</para>
7290 <programlisting># @key: value</programlisting>
7292 <para>Leerzeichen vor "<varname>value</varname>" werden
7295 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
7299 <term><varname>tag</varname></term>
7302 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
7303 Dieser "tag" kann von anderen Kontrolldateien in ihren
7304 Abhängigkeiten verwendet werden (Schlüsselwort
7305 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
7306 in der Datenbank eingetragen wird.</para>
7308 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
7309 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
7311 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
7312 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
7313 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
7319 <term><varname>charset</varname></term>
7322 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
7323 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
7324 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
7325 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
7326 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
7327 hingegen müssen immer in UTF-8 encodiert sein und sollten
7328 demnach auch ein "<literal>use utf8;</literal>"
7334 <term><varname>description</varname></term>
7337 <para>Benötigt. Eine Beschreibung, was in diesem Update
7338 passiert. Diese wird dem Benutzer beim eigentlichen
7339 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
7340 sein sollte, sollte die Beschreibung auf Deutsch
7346 <term><varname>depends</varname></term>
7349 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
7350 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
7351 dass die in dieser Liste aufgeführten Scripte bereits
7352 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
7354 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
7355 Script "b" existiert, das von Änderungen in "a" abhängt, und
7356 eine neue Kontrolldatei für "c" erstellt wird, die von
7357 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
7358 Tag "b" als Abhängigkeit zu definieren.</para>
7360 <para>Es ist nicht erlaubt, sich selbst referenzierende
7361 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
7362 und "c" -> "a").</para>
7367 <term><varname>priority</varname></term>
7370 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
7371 der Scripte ausgeführt werden, die die gleichen
7372 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
7373 der Wert 1000 benutzt.</para>
7375 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
7376 "depends" benutzt werden. kivitendo sortiert die auszuführenden
7377 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
7378 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
7379 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
7380 dann "y", dann "z"), dann nach der Priorität und bei gleicher
7381 Priorität alphabetisch nach dem "tag".</para>
7386 <term><varname>ignore</varname></term>
7389 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
7390 Skript bei der Anmeldung ignoriert und entsprechend nicht
7397 <sect2 id="db-upgrade-files.format-perl-files"
7398 xreflabel="Format von Perl-Upgradedateien">
7399 <title>Format von in Perl geschriebenen
7400 Datenbankupgradescripten</title>
7402 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
7403 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
7404 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
7406 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
7407 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
7408 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
7409 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
7410 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
7411 aufgerufen wird.</para>
7413 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
7414 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
7415 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
7416 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
7417 "<literal>SL::DBUpgrade2::tag</literal>".</para>
7419 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
7420 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
7421 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
7423 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
7426 <programlisting># @tag: beispiel-upgrade-file42
7427 # @description: Ein schönes Beispielscript
7428 # @depends: release_3_1_0
7429 package SL::DBUpgrade2::beispiel_upgrade_file42;
7434 use parent qw(SL::DBUpgrade2::Base);
7439 # hier Aktionen ausführen
7448 <sect2 id="db-upgrade-files.dbupgrade-tool"
7449 xreflabel="Hilfsscript dbupgrade2_tool.pl">
7450 <title>Hilfsscript dbupgrade2_tool.pl</title>
7452 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
7453 existiert ein Hilfsscript namens
7454 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
7455 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
7456 liest alle Datenbankupgradescripte aus dem Verzeichnis
7457 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
7458 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
7459 von der Kommandozeile überprüft werden können.</para>
7461 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
7462 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
7463 sich aber auch Informationen auf verschiedene Art ausgeben
7468 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
7469 --list</command>"</para>
7471 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
7472 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
7473 würde. Es werden neben der Listenposition der Tag, die
7474 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
7478 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
7479 --tree</command>"</para>
7481 <para>Listet alle Tags in Baumform basierend auf den
7482 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
7483 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
7484 beim übergeordneten Script als Abhängigkeit eingetragen
7488 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
7489 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
7490 --rtree</command>"</para>
7492 <para>Listet alle Tags in Baumform basierend auf den
7493 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
7494 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
7495 die das übergeordnete Script als Abhängigkeit eingetragen
7500 <para>Baumform mit Postscriptausgabe:
7501 "<command>./scripts/dbupgrade2_tool.pl
7502 --graphviz</command>"</para>
7504 <para>Benötigt das Tool "<command>graphviz</command>", um mit
7505 seiner Hilfe die <link
7506 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
7507 Baumform</link> in eine Postscriptdatei namens
7508 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
7509 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
7510 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
7511 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
7516 <para>Scripte, von denen kein anderes Script abhängt:
7517 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
7519 <para>Listet die Tags aller Scripte auf, von denen keine anderen
7520 Scripte abhängen.</para>
7526 <sect1 id="translations-languages" xreflabel="Translations and languages">
7527 <title>Translations and languages</title>
7529 <sect2 id="translations-languages.introduction"
7530 xreflabel="Introduction to translations and languages">
7531 <title>Introduction</title>
7534 <para>Dieser Abschnitt ist in Englisch geschrieben, um
7535 internationalen Übersetzern die Arbeit zu erleichtern.</para>
7538 <para>This section describes how localization packages in kivitendo
7539 are built. Currently the only language fully supported is German, and
7540 since most of the internal messages are held in English the English
7541 version is usable too.</para>
7544 <sect2 id="translations-languages.character-set"
7545 xreflabel="Character set">
7546 <title>Character set</title>
7548 <para>All files included in a language pack must use UTF-8 as their
7552 <sect2 id="translations-languages.file-structure"
7553 xreflabel="File structure">
7554 <title>File structure</title>
7556 <para>The structure of locales in kivitendo is:</para>
7558 <programlisting>kivitendo/locale/<langcode>/</programlisting>
7560 <para>where <langcode> stands for an abbreviation of the
7561 language package. The builtin packages use two letter <ulink
7562 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
7563 but the actual name is not relevant for the program and can easily be
7565 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
7566 tags</ulink> (i.e. "en_GB"). In fact the original language packages
7567 from SQL Ledger are named in this way.</para>
7569 <para>In such a language directory the following files are
7574 <term>LANGUAGE</term>
7577 <para>This file is mandatory.</para>
7579 <para>The <filename>LANGUAGE</filename> file contains the self
7580 descripted name of the language. It should contain a native
7581 representation first, and in parenthesis an english translation
7582 after that. Example:</para>
7584 <programlisting>Deutsch (German)</programlisting>
7592 <para>This file is mandatory.</para>
7594 <para>The central translation file. It is essentially an inline
7595 Perl script autogenerated by <command>locales.pl</command>. To
7596 generate it, generate the directory and the two files mentioned
7597 above, and execute the following command:</para>
7599 <programlisting>scripts/locales.pl <langcode></programlisting>
7601 <para>Otherwise you can simply copy one of the other languages.
7602 You will be told how many are missing like this:</para>
7604 <programlisting>$ scripts/locales.pl en
7605 English - 0.6% - 2015/2028 missing</programlisting>
7607 <para>A file named "<filename>missing</filename>" will be
7608 generated and can be edited. You can also edit the
7609 "<filename>all</filename>" file directly. Edit everything you
7610 like to fit the target language and execute
7611 <command>locales.pl</command> again. See how the missing words
7617 <term>Num2text</term>
7620 <para>Legacy code from SQL Ledger. It provides a means for
7621 numbers to be converted into natural language, like
7622 <literal>1523 => one thousand five hundred twenty
7623 three</literal>. If you want to provide it, it must be inlinable
7624 Perl code which provides a <function>num2text</function> sub. If
7625 an <function>init</function> sub exists it will be executed
7628 <para>Only used in the check and receipt printing module.</para>
7633 <term>special_chars</term>
7636 <para>kivitendo comes with a lot of interfaces to different
7637 formats, some of which are rather picky with their accepted
7638 charset. The <filename>special_chars</filename> file contains a
7639 listing of chars not suited for different file format and
7640 provides substitutions. It is written in "Simple Ini" style,
7641 containing a block for every file format.</para>
7643 <para>First entry should be the order of substitution for
7644 entries as a whitespace separated list. All entries are
7645 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
7646 and <literal>\\</literal> all work.</para>
7648 <para>After that every entry is a special char that should be
7649 translated when writing text into such a file.</para>
7651 <para>Example:</para>
7653 <programlisting>[Template/XML]
7654 order=& < > \n
7658 \n=<br></programlisting>
7660 <para>Note the importance of the order in this example.
7661 Substituting < and > befor & would lead to $gt; become
7664 <para>For a list of valid formats, see the German
7665 <filename>special_chars</filename> entry. As of this writing the
7666 following are recognized:</para>
7668 <programlisting>HTML
7673 Template/OpenDocument
7674 filenames</programlisting>
7676 <para>The last of which is very machine dependant. Remember that
7677 a lot of characters are forbidden by some filesystems, for
7678 example MS Windows doesn't like ':' in its files where Linux
7679 doesn't mind that. If you want the files created with your
7680 language pack to be portable, find all chars that could cause
7686 <term>missing</term>
7689 <para>This file is not a part of the language package
7692 <para>This is a file generated by
7693 <command>scripts/locales.pl</command> while processing your
7694 locales. It's only to have the missing entries singled out and
7695 does not belong to a language package.</para>
7703 <para>This file is not a part of the language package
7706 <para>Another file generated by
7707 <command>scripts/locales.pl</command>. If for any reason a
7708 translation does not appear anymore and can be deleted, it gets
7709 moved here. The last 50 or so entries deleted are saved here in
7710 case you made a typo, so that you don't have to translate
7711 everything again. If a tranlsation is missing, the lost file is
7712 checked first. If you maintain a language package, you might
7713 want to keep this safe somewhere.</para>
7718 <term>more/all</term>
7721 <para>This subdir and file is not a part of the language package
7724 <para>If the directory more exists and contains a file called
7725 all it will be parsed in addition to the mandatory all (see
7726 above). The file is useful if you want to change some
7727 translations for the current installation without conflicting
7728 further upgrades. The file is not autogenerated and has the same
7729 format as the all, but needs another key (more_texts). See the
7730 german translation for an example or copy the following code:
7733 # -*- coding: utf-8; -*-
7738 # These are additional texts for custom translations.
7739 # The format is the same as for the normal file all, only
7740 # with another key (more_texts instead of texts).
7741 # The file has the form of 'english text' => 'foreign text',
7743 $self->{more_texts} = {
7745 'Ship via' => 'Terms of delivery',
7746 'Shipping Point' => 'Delivery time',
7748 </programlisting></para>
7755 <sect1 id="devel.testsuite">
7756 <title>Die kivitendo-Test-Suite</title>
7758 <sect2 id="devel.testsuite.intro">
7759 <title>Einführung</title>
7761 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
7762 basiert auf dem Standard-Perl-Modul
7763 <literal>Test::More</literal>.</para>
7765 <para>Die grundlegenden Fakten sind:</para>
7769 <para>Alle Tests liegen im Unterverzeichnis
7770 <filename>t/</filename>.</para>
7774 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
7775 enthält einen oder mehrere Testfälle.</para>
7779 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
7780 Es sind selbstständig ausführbare Perl-Scripte.</para>
7784 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
7785 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
7786 auf <literal>.t</literal> endet.</para>
7791 <sect2 id="devel.testsuite.prerequisites">
7792 <title>Voraussetzungen</title>
7794 <para>Für die Ausführung werden neben den für kivitendo eh schon
7795 benötigten Module noch weitere Perl-Module benötigt. Diese
7800 <para><literal>Test::Deep</literal> (Debian-Paketname:
7801 <literal>libtest-deep-perl</literal>; Fedora:
7802 <literal>perl-Test-Deep</literal>; openSUSE:
7803 <literal>perl-Test-Deep</literal>)</para>
7807 <para><literal>Test::Exception</literal> (Debian-Paketname:
7808 <literal>libtest-exception-perl</literal>; Fedora:
7809 <literal>perl-Test-Exception</literal>; openSUSE:
7810 <literal>perl-Test-Exception</literal>)</para>
7814 <para><literal>Test::Output</literal> (Debian-Paketname:
7815 <literal>libtest-output-perl</literal>; Fedora:
7816 <literal>perl-Test-Output</literal>; openSUSE:
7817 <literal>perl-Test-Output</literal>)</para>
7821 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
7822 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
7823 kann für frühere Versionen aus dem <ulink
7824 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
7828 <para><literal>LWP::Simple</literal> aus dem Paket
7829 <literal>libwww-perl</literal> (Debian-Panetname:
7830 <literal>libwww-perl</literal>; Fedora:
7831 <literal>perl-libwww-perl</literal>; openSUSE:
7832 <literal>perl-libwww-perl</literal>)</para>
7836 <para><literal>URI::Find</literal> (Debian-Panetname:
7837 <literal>liburi-find-perl</literal>; Fedora:
7838 <literal>perl-URI-Find</literal>; openSUSE:
7839 <literal>perl-URI-Find</literal>)</para>
7843 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
7844 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
7845 müssen in der Konfigurationsdatei im Abschnit
7846 <literal>testing/database</literal> Datenbankverbindungsparameter
7847 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
7848 Recht haben, Datenbanken anzulegen und zu löschen.</para>
7851 <sect2 id="devel.testsuite.execution">
7852 <title>Existierende Tests ausführen</title>
7854 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
7855 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
7856 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
7857 <filename>t/test.pl</filename>.</para>
7859 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
7860 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
7861 kivitendo-Basisverzeichnis heraus ausführen.</para>
7863 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
7864 an <filename>t/test.pl</filename>. Beispielsweise:</para>
7866 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
7869 <sect2 id="devel.testsuite.meaning_of_scripts">
7870 <title>Bedeutung der verschiedenen Test-Scripte</title>
7872 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
7873 Programmierstil. Einige besonders zu erwähnende, weil auch während der
7874 Entwicklung nützliche Tests sind:</para>
7878 <para><filename>t/001compile.t</filename> -- compiliert alle
7879 Quelldateien und bricht bei Fehlern sofort ab</para>
7883 <para><filename>t/002goodperl.t</filename> -- überprüft alle
7884 Perl-Dateien auf Anwesenheit von '<literal>use
7885 strict</literal>'-Anweisungen</para>
7889 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
7890 <function>system()</function> und <function>exec()</function> auf
7895 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
7896 Tab-Zeichen enthalten</para>
7900 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
7901 Rechtschreibfehlern</para>
7905 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
7906 Dokumentation im POD-Format auf Gültigkeit</para>
7910 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
7911 einzelner Funktionen und Module.</para>
7914 <sect2 id="devel.testsuite.create_new">
7915 <title>Neue Test-Scripte erstellen</title>
7917 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
7918 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
7919 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
7922 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
7923 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
7926 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
7931 <para>Überprüfung auf fehlende symbolische Links</para>
7935 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
7936 gewissen Einschränkungen wie das Erlauben von deutschen
7941 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
7945 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
7949 <para>Test, ob alle zu übersetzenden Strings in
7950 <filename>locale/de/all</filename> vorhanden sind</para>
7954 <para>Test, ob alle Webseiten-Templates in
7955 <filename>templates/webpages</filename> mit vom Perl-Modul
7956 <literal>Template</literal> compiliert werden können</para>
7961 <sect3 id="devel.testsuite.directory_and_test_names">
7962 <title>Konvention für Verzeichnis- und Dateinamen</title>
7964 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
7965 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
7966 und ihnen soweit es geht folgen:</para>
7970 <para>Die Dateiendung muss <filename>.t</filename>
7975 <para>Namen sind englisch, komplett klein geschrieben und
7976 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
7977 <filename>bad_function_params.t</filename>).</para>
7981 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
7982 benannt sein, mit dem sich die Scripte darin befassen
7983 (beispielsweise <filename>background_jobs</filename> für Tests
7984 rund um Hintergrund-Jobs).</para>
7988 <para>Test-Scripte sollten einen überschaubaren Bereich von
7989 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
7990 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
7991 Test-Scripte schreiben.</para>
7996 <sect3 id="devel.testsuite.minimal_example">
7997 <title>Minimales Skelett für eigene Scripte</title>
7999 <para>Der folgenden Programmcode enthält das kleinstmögliche
8000 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
8003 <programlisting>use Test::More tests => 0;
8007 use Support::TestSetup;
8009 Support::TestSetup::login();</programlisting>
8011 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
8012 benötigt (Stichwort: alle globalen Variablen wie
8013 <varname>$::auth</varname>, <varname>$::form</varname> oder
8014 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
8015 <filename>config/kivitendo.conf</filename> im Abschnitt
8016 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
8017 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
8019 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
8020 kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
8021 weggelassen werden, was die Ausführungszeit des Scripts leicht
8027 <sect1 id="devel.style-guide">
8028 <title>Stil-Richtlinien</title>
8030 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
8031 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
8032 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
8033 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
8035 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
8038 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
8039 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
8044 <para>Es werden keine echten Tabs sondern Leerzeichen
8049 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
8051 <programlisting>foreach my $row (@data) {
8053 # do something with $row
8057 $row->{modules} = MODULE->retrieve(
8058 id => $row->{id},
8059 date => $use_now ? localtime() : $row->{time},
8063 $report->add($row);
8068 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
8069 Zeile wie der letzte Befehl. Beispiele:</para>
8071 <programlisting>sub debug {
8077 <programlisting>if ($form->{item_rows} > 0) {
8083 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
8084 der Befehl / die öffnende schließende Klammer, die den Block
8085 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
8086 Beispiele wie bei 3. gelten.</para>
8090 <para>Die Wörter "<function>else</function>",
8091 "<function>elsif</function>", "<function>while</function>" befinden
8092 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
8095 <programlisting>if ($form->{sum} > 1000) {
8097 } elsif ($form->{sum} > 0) {
8105 } until ($a > 0);</programlisting>
8109 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
8110 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
8111 und grep-ähnliche Operatoren. Beispiel:</para>
8113 <programlisting>$main::lxdebug->message("Could not find file.");
8114 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
8118 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
8120 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
8121 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
8122 Blöcke schon. Beispiel:</para>
8124 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
8129 $form->{sum} += $form->{"row_$i"};
8130 $form->{ $form->{index} } += 1;
8132 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
8136 <para>Mehrzeilige Befehle</para>
8140 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
8141 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
8142 werden, in der die ersten Funktionsparameter in der ersten Zeile
8143 stehen. Beispiel:</para>
8145 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
8146 $form->{some_col_value});</programlisting>
8150 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
8151 besten in einer übersichtlichen Tabellenstruktur organisiert
8152 wird. Beispiel:</para>
8154 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
8155 : $form->{oldcount} ? $form->{oldcount} + 1
8156 : $form->{rowcount} - $form->{rowbase};</programlisting>
8162 <para>Kommentare</para>
8166 <para>Kommentare, die alleine in einer Zeile stehen, sollten
8167 soweit wie der Code eingerückt sein.</para>
8171 <para>Seitliche hängende Kommentare sollten einheitlich
8172 formatiert werden.</para>
8176 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
8177 auf Englisch zu verfassen. So wie ich keine Lust habe,
8178 französischen Quelltext zu lesen, sollte auch der kivitendo
8179 Quelltext für nicht-Deutschsprachige lesbar sein.
8182 <programlisting>my $found = 0;
8190 $i = 0 # initialize $i
8192 $i *= $const; # do something crazy
8193 $i = $n; # recover $i</programlisting>
8199 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
8200 Interpolation gewünscht ist. Beispiel:</para>
8202 <programlisting>$form->{sum} = 0;
8203 $form->{"row_$i"} = $form->{"row_$i"} - 5;
8204 $some_hash{42} = 54;</programlisting>
8208 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
8209 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
8210 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
8211 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
8213 <para>Als Beispiel sei die Funktion
8214 <function>print_options</function> aus
8215 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
8219 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
8220 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
8223 <para>Emacs und vim haben beide recht einfache Methoden zur
8224 Entfernung von trailing whitespace. Emacs kennt das Kommande
8225 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
8226 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
8227 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
8232 <para>Es wird kein <command>perltidy</command> verwendet.</para>
8234 <para>In der Vergangenheit wurde versucht,
8235 <command>perltidy</command> zu verwenden, um einen einheitlichen
8236 Stil zu erlangen. Es hat sich aber gezeigt, dass
8237 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
8238 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
8239 den Interessierten sind hier die
8240 <command>perltidy</command>-Optionen, die grob den beschriebenen
8241 Richtlinien entsprechen:</para>
8243 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
8244 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
8245 -lp -vt=1 -vtc=1</programlisting>
8249 <para><varname>STDERR</varname> ist tabu. Unkonditionale
8250 Debugmeldungen auch.</para>
8252 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
8253 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
8254 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
8256 <para>Die <classname>LXDebug</classname>-Methode
8257 "<function>message</function>" nimmt als ersten Paramter außerdem
8258 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
8259 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
8260 und werden in den meisten Fällen auch vom Repository
8261 zurückgewiesen.</para>
8265 <para>Alle neuen Module müssen use strict verwenden.</para>
8267 <para><varname>$form</varname>, <varname>$auth</varname>,
8268 <varname>$locale</varname>, <varname>$lxdebug</varname> und
8269 <varname>%myconfig</varname> werden derzeit aus dem main package
8270 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
8271 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
8276 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
8277 <title>Dokumentation erstellen</title>
8279 <sect2 id="devel.build-doc.introduction">
8280 <title>Einführung</title>
8282 <para>Diese Dokumentation ist in <productname>DocBook</productname>
8283 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
8284 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
8285 Editor nutzt, der spezielle Unterstützung für
8286 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
8287 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
8288 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
8292 <sect2 id="devel.build-doc.required-software">
8293 <title>Benötigte Software</title>
8295 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
8296 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
8297 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
8298 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
8299 <command>scripts/build_doc.sh</command>.</para>
8301 <para>Das Script benötigt zur Konvertierung verschiedene
8302 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
8308 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
8309 in einer halbwegs aktuellen Version</para>
8313 <para>Das Java-Build-System <ulink
8314 url="http://ant.apache.org/">Apache Ant</ulink></para>
8318 <para>Das Dokumentations-System Dobudish für
8319 <productname>DocBook</productname> 4.5, eine Zusammenstellung
8320 diverser Stylesheets und Grafiken zur Konvertierung von
8321 <productname>DocBook</productname> XML in andere Formate. Das
8322 Paket, das benötigt wird, ist zum Zeitpunkt der
8323 Dokumentationserstellung
8324 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
8325 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
8330 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
8331 sind auf allen gängigen Plattformen verfügbar. Beispiel für
8332 Debian/Ubuntu:</para>
8334 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
8336 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
8337 <filename>doc/build</filename> entpackt werden. Beispiel unter der
8338 Annahme, das <productname>Dobudish</productname> in
8339 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
8341 <programlisting>cd doc/build
8342 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
8345 <sect2 id="devel.build-doc.build">
8346 <title>PDFs und HTML-Seiten erstellen</title>
8348 <para>Die eigentliche Konvertierung erfolgt nach Installation der
8349 benötigten Software mit einem einfachen Aufruf direkt aus dem
8350 kivitendo-Installationsverzeichnis heraus:</para>
8352 <programlisting>./scripts/build_doc.sh</programlisting>
8355 <sect2 id="devel.build-doc.repository">
8356 <title>Einchecken in das Git-Repository</title>
8358 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
8359 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
8360 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
8361 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
8363 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
8364 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob