1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <book id="kivitendo-documentation" lang="de">
5 <title>kivitendo 3.5.0-beta: Installation, Konfiguration, Entwicklung</title>
7 <chapter id="Aktuelle-Hinweise">
8 <title>Aktuelle Hinweise</title>
10 <para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>
14 <para>im Community-Forum: <ulink
15 url="https://forum.kivitendo.de:32443">https://forum.kivitendo.de:32443</ulink></para>
19 <para>im Kunden-Forum: <ulink
20 url="http://redmine.kivitendo-premium.de/projects/forum/boards/">http://redmine.kivitendo-premium.de/projects/forum/boards/</ulink></para>
24 <para>in der doc/UPGRADE Datei im doc-Verzeichnis der
29 <para>Im Schulungs- und Dienstleistungsangebot der entsprechenden
30 kivitendo-Partner: <ulink
31 url="http://www.kivitendo.de/partner.html">http://www.kivitendo.de/partner.html</ulink></para>
37 <title>Installation und Grundkonfiguration</title>
39 <sect1 id="Installation-Übersicht">
40 <title>Übersicht</title>
42 <para>Die Installation von kivitendo umfasst mehrere Schritte. Die
43 folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
44 Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit
45 minimalen Features möglichst schnell zum Laufen zu kriegen.</para>
49 <para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo
50 benötigt gewisse Ressourcen und benutzt weitere Programme. Das
51 Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert
52 diese. Auch die Liste der benötigten Perl-Module befindet sich
57 <para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst
58 die "<xref linkend="Manuelle-Installation-des-Programmpaketes"/>"
59 sowie grundlegende Einstellungen, die der "<xref
60 linkend="config.config-file"/>" erläutert.</para>
64 <para><emphasis>Konfiguration externer Programme</emphasis>: hierzu
65 gehören die Datenbank ("<xref
66 linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der
67 Webserver ("<xref linkend="Apache-Konfiguration"/>").</para>
71 <para><emphasis>Benutzerinformationen speichern können</emphasis>:
72 man benötigt mindestens eine Datenbank, in der Informationen zur
73 Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man
74 das als Administrator macht, verrät "<xref
75 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para>
79 <para><emphasis>Benutzer, Gruppen und Datenbanken
80 anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
81 linkend="Benutzer--und-Gruppenverwaltung"/>".</para>
85 <para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann
86 kann es losgehen: "<xref linkend="kivitendo-ERP-verwenden"/>"</para>
90 <para>Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls
91 wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen
95 <sect1 id="Benötigte-Software-und-Pakete">
96 <title>Benötigte Software und Pakete</title>
98 <sect2 id="Betriebssystem">
99 <title>Betriebssystem</title>
101 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
102 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
103 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
104 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
105 ohne große Probleme auf den derzeit aktuellen verbreiteten
106 Distributionen läuft.</para>
108 <para>Anfang 2016 sind das folgende Systeme, von denen bekannt ist,
109 dass kivitendo auf ihnen läuft:</para>
117 <para>7.0 "Wheezy"</para>
121 <para>8.0 "Jessie"</para>
127 <para>Ubuntu 12.04 LTS "Precise Pangolin", 14.04 "Trusty Tahr"
128 LTS, 15.10 "Wily Werewolf" und 16.04 "Xenial Xerus" LTS
133 <para>openSUSE LEAP 42.1</para>
137 <para>Fedora 22</para>
142 <sect2 id="Pakete" xreflabel="Pakete">
143 <title>Benötigte Perl-Pakete installieren</title>
145 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
146 Apache) und ein Datenbankserver (PostgreSQL) in einer aktuellen Version
147 (s.a. Liste der unterstützten Betriebssysteme) benötigt.</para>
149 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht
150 Bestandteil einer Standard-Perl-Installation sind. Um zu überprüfen,
151 ob die erforderlichen Pakete installiert und aktuell genug sind, wird
152 ein Script mitgeliefert, das wie folgt aufgerufen wird:</para>
154 <programlisting>./scripts/installation_check.pl</programlisting>
156 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
160 <para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para>
164 <para><literal>Archive::Zip</literal></para>
168 <para><literal>Algorithm::CheckDigits</literal></para>
172 <para><literal>CGI</literal></para>
176 <para><literal>Clone</literal></para>
180 <para><literal>Config::Std</literal></para>
184 <para><literal>DateTime</literal></para>
188 <para><literal>DateTime::Format::Strptime</literal></para>
192 <para><literal>DBI</literal></para>
196 <para><literal>DBD::Pg</literal></para>
200 <para><literal>Email::Address</literal></para>
204 <para><literal>Email::MIME</literal></para>
208 <para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71
209 inklusive; siehe <xref
210 linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para>
214 <para><literal>File::Copy::Recursive</literal></para>
218 <para><literal>File::MimeInfo</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>Debian und Ubuntu: <programlisting>apt install aqbanking-tools
432 </programlisting></para>
434 <para>OpenSuSE: <programlisting>zypper install aqbanking-tools</programlisting></para>
436 <para>Seit Version v3.4.1 wird generell zum Feststellen der
437 Seitenanzahl von PDF_Dokumenten 'pdfinfo' benötigt was im Paket
438 'poppler-utils' enthalten ist.</para>
440 <para>Debian und Ubuntu: <programlisting>apt install poppler-utils
441 </programlisting></para>
443 <para>OpenSuSE: <programlisting>zypper install poppler-tools</programlisting></para>
448 <sect1 id="Manuelle-Installation-des-Programmpaketes"
449 xreflabel="Manuelle Installation des Programmpaketes">
450 <title>Manuelle Installation des Programmpaketes</title>
452 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github
453 gehostet und kann <ulink
454 url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
455 heruntergeladen werden.</para>
457 <para>Die kivitendo ERP Installationsdatei
458 (<filename>kivitendo-erp-3.4.1.tgz</filename>) wird im
459 Dokumentenverzeichnis des Webservers (z.B.
460 <filename>/var/www/html/</filename>,
461 <filename>/srv/www/htdocs</filename> oder
462 <filename>/var/www/</filename>) entpackt:</para>
464 <programlisting>cd /var/www
465 tar xvzf kivitendo-erp-3.4.1.tgz</programlisting>
467 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
469 <programlisting>cd kivitendo-erp</programlisting>
471 <para>Alternativ können Sie auch einen Alias in der
472 Webserverkonfiguration benutzen, um auf das tatsächliche
473 Installationsverzeichnis zu verweisen.</para>
475 <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
476 WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
478 <programlisting>mkdir webdav</programlisting>
480 <para>Die Verzeichnisse <filename>users</filename>,
481 <filename>spool</filename> und <filename>webdav</filename> müssen für
482 den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
483 restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer-
484 und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich
485 (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
486 <constant>apache</constant> oder bei OpenSUSE
487 <constant>wwwrun</constant>).</para>
489 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
490 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
492 <programlisting>chown -R www-data users spool webdav</programlisting>
494 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen
495 <filename>templates</filename> und <filename>users</filename>
496 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in
497 kivitendo angelegt wird:</para>
499 <programlisting>chown www-data templates users</programlisting>
502 <para>Wir empfehlen eine Installation mittels des Versionsmanagager
503 git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr
504 viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte
505 die Pfade anpassen) bspw. wie folgt: <programlisting>cd /usr/local/src/
506 git clone https://github.com/kivitendo/kivitendo-erp.git
508 git checkout `git tag -l | egrep -ve "(beta|rc)" | tail -1`</programlisting>
509 Sehr sinnvoll ist es, direkt im Anschluss einen eigenen Branch zu
510 erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen damit zu
511 verwalten. Hierfür reicht ein simples <programlisting> git checkout -b meine_eigenen_änderungen</programlisting>
512 nach dem letzten Kommando (weiterführende Informationen <ulink
513 url="http://git-scm.com/book/en/v2/Getting-Started-Git-Basics">getting
514 started with git</ulink>).</para>
518 <sect1 id="config.config-file">
519 <title>kivitendo-Konfigurationsdatei</title>
521 <sect2 id="config.config-file.introduction"
522 xreflabel="Einführung in die Konfigurationsdatei">
523 <title>Einführung</title>
525 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
526 benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die
527 Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von
528 kivitendo bzw. der Migration von älteren Versionen angelegt
531 <para>Als Vorlage dient die Datei
532 <filename>config/kivitendo.conf.default</filename> (kurz: "die
533 Default-Datei"):</para>
535 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
537 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
538 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
539 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
540 Abschnitte und Werte enthalten, die von denen der Default-Datei
544 <para>Vor der Umbenennung in kivitendo hieß diese Datei noch
545 <filename>config/lx_office.conf</filename>. Aus Gründen der
546 Kompatibilität wird diese Datei eingelesen, sofern die Datei
547 <filename>config/kivitendo.conf</filename> nicht existiert.</para>
550 <para>Diese Hauptkonfigurationsdatei ist dann eine
551 installationsspezifische Datei, d.h. sie enthält bspw. lokale
552 Passwörter und wird auch nicht im Versionsmanagement (git)
555 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
556 Mandaten, bzw. Datenbanken gleich.</para>
559 <sect2 id="config.config-file.sections-parameters">
560 <title>Abschnitte und Parameter</title>
562 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
563 entsprechend kommentiert sind:</para>
567 <para><literal>authentication</literal> (siehe Abschnitt "<xref
568 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
569 in diesem Kapitel)</para>
573 <para><literal>authentication/database</literal></para>
577 <para><literal>authentication/ldap</literal></para>
581 <para><literal>system</literal></para>
585 <para><literal>paths</literal></para>
589 <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
590 linkend="config.sending-email.smtp"/>)</para>
594 <para><literal>applications</literal></para>
598 <para><literal>environment</literal></para>
602 <para><literal>print_templates</literal></para>
606 <para><literal>task_server</literal></para>
610 <para><literal>periodic_invoices</literal></para>
614 <para><literal>self_tests</literal></para>
618 <para><literal>console</literal></para>
622 <para><literal>testing</literal></para>
626 <para><literal>testing/database</literal></para>
630 <para><literal>debug</literal></para>
634 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
635 einzustellen oder zu kontrollieren sind, sind:</para>
637 <programlisting>[authentication]
638 admin_password = geheim
640 [authentication/database]
648 default_manager = german</programlisting>
650 <para>Für kivitendo Installationen in der Schweiz sollte hier <varname>german</varname>
651 durch <varname>swiss</varname> ersetzt werden.</para>
652 <para>Die Einstellung <varname>default_manager = swiss</varname> bewirkt:</para>
655 <para>Beim Erstellen einer neuen Datenbank in der kivitendo Administration
656 werden automatisch die Standard-Werte für die Schweiz voreingestellt:
657 Währung CHF, 5er-Rundung, Schweizer KMU-Kontenplan, Sollversteuerung,
658 Aufwandsmethode, Bilanzierung (die Werte können aber manuell angepasst werden).</para>
661 <para>Einstellen der Standardkonten für Rundungserträge und -aufwendungen
662 (unter Mandantenkonfiguration → Standardkonten veränderbar)</para>
665 <para>das verwendete Zahlenformat wird auf <varname>1'000.00</varname> eingestellt
666 (unter Programm → Benutzereinstellungen veränderbar)</para>
669 <para>DATEV-Automatik und UStVA werden nicht angezeigt, Erfolgsrechnung
670 ersetzt GUV ( unter Mandantenkonfiguration → Features veränderbar)</para>
674 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
675 <varname>[periodic_invoices]</varname> den Login eines Benutzers
676 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
677 mit Informationen über die erstellten Rechnungen bekommt.</para>
679 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
680 Ausführung bestimmter Aufgaben mit, den <link
681 linkend="config.task-server">Taskserver</link>. Er wird u.a. für
682 Features wie die <link
683 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
684 benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
685 daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
686 <link linkend="config.task-server">Task-Server</link> genauer
689 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
690 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
693 <sect2 id="config.config-file.prior-versions">
694 <title>Versionen vor 2.6.3</title>
696 <para>In älteren kivitendo Versionen gab es im Verzeichnis
697 <filename>config</filename> die Dateien
698 <filename>authentication.pl</filename> und
699 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
700 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
701 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
702 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
704 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
705 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
706 manuell übertragen und die alten Konfigurationsdateien anschließend
707 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
708 entsprechende Fehlermeldung an.</para>
712 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
713 <title>Anpassung der PostgreSQL-Konfiguration</title>
715 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
717 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
718 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
720 <para>kivitendo setzt zwingend voraus, dass die Datenbank
721 Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
722 Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
724 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
725 Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
726 man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
728 <programlisting>su postgres
730 exit </programlisting>
732 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
733 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
734 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
737 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
739 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
740 Versionsnummer angepasst werden.</para>
742 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
744 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
745 <literal>\l</literal> geprüft werden.</para>
748 <sect2 id="Änderungen-an-Konfigurationsdateien">
749 <title>Änderungen an Konfigurationsdateien</title>
751 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
752 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
753 <filename>/var/lib/pgsql/data/</filename> oder
754 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
755 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
756 Parameter <varname>listen_address</varname> gesteuert. Laufen
757 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
758 <literal>localhost</literal> verwendet werden. Andernfalls müssen
759 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
760 was mit dem Wert <literal>*</literal> geschieht.</para>
762 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
763 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
764 sein sollte, müssen die Berechtigungen für den Zugriff geändert
765 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
766 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
767 Datenbank zum Beispiel:</para>
769 <programlisting>local all kivitendo password
770 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
773 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
774 <title>Erweiterung für servergespeicherte Prozeduren</title>
776 <para>In der Datenbank <literal>template1</literal> muss die
777 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
778 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
779 <programlisting>su - postgres
780 psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
782 <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
786 <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
787 bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
788 anzulegen. In diesen Versionen ist die Extension meist auch schon
789 vorhanden. Sollten Sie eine ältere Version von Postgres haben,
790 benutzen Sie stattdessen den folgenden Befehl.</para>
792 <programlisting>CREATE LANGUAGE 'plpgsql';
797 <sect2 id="Datenbankbenutzer-anlegen">
798 <title>Datenbankbenutzer anlegen</title>
800 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
801 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
802 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
805 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
806 nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
807 generieren nicht nötig.</para>
809 <programlisting>su - postgres
810 createuser -d -P kivitendo
811 exit</programlisting>
813 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
814 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
815 bzw. den hier gewählten Benutzernamen.</para>
819 <sect1 id="Apache-Konfiguration">
820 <title>Webserver-Konfiguration</title>
823 <title>Grundkonfiguration mittels CGI</title>
826 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
827 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
828 <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
831 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
832 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
833 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
834 anderen Datei hinzu, die beim Starten des Webservers eingelesen
837 <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
838 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
840 <Directory /var/www/kivitendo-erp>
841 AddHandler cgi-script .pl
842 Options ExecCGI Includes FollowSymlinks
845 <Directory /var/www/kivitendo-erp/users>
847 </Directory></programlisting>
849 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
850 das kivitendo-Archiv entpacket haben.</para>
853 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
854 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
856 <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
857 noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
858 aktiviert werden.</para>
861 <para>Auf einigen Webservern werden manchmal die Grafiken und
862 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
863 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
865 <programlisting>EnableSendfile Off</programlisting>
868 <sect2 id="Apache-Konfiguration.FCGI"
869 xreflabel="Konfiguration für FastCGI/FCGI">
870 <title>Konfiguration für FastCGI/FCGI</title>
872 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
873 <title>Was ist FastCGI?</title>
875 <para>Direkt aus <ulink
876 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
879 <para><citation> FastCGI ist ein Standard für die Einbindung
880 externer Software zur Generierung dynamischer Webseiten in einem
881 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
882 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
883 umgehen. </citation></para>
886 <sect3 id="Apache-Konfiguration.FCGI.Warum">
887 <title>Warum FastCGI?</title>
889 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
890 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
891 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
892 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
893 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
894 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
895 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
896 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
897 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
898 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
899 deutlich länger dauert als früher, und dass davon 90% für das Laden
900 der Module verwendet wird.</para>
902 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
903 wird nur die eigentliche Programmlogik ausgeführt.</para>
906 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
907 <title>Getestete Kombinationen aus Webservern und Plugin</title>
909 <para>Folgende Kombinationen sind getestet:</para>
913 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
917 <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
921 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
925 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
926 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
927 mod_fastcgi nicht mehr explizit eingegangen.</para>
929 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
933 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
934 strict in der Behandlung von Unicode, und verweigern bestimmte
935 Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
936 Installation gibt, muss zwingend Version 0.68 oder aber Version
937 0.72 und neuer eingesetzt werden.</para>
939 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
940 sich die Vorgängerversion wie folgt installieren:</para>
942 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
946 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
947 <title>Konfiguration des Webservers</title>
949 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
950 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
951 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
952 debuggen die beim ersten aufsetzen auftreten können. Sollte die
953 Installation schon funktionieren, lesen Sie weiter.</para>
955 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
956 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
958 <programlisting>a2enmod fcgid</programlisting>
960 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
961 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
962 und <function>Directory</function>-Direktiven. Dabei wird zwischen
963 dem Installationspfad von kivitendo im Dateisystem
964 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
965 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
966 ("<filename>/url/for/kivitendo-erp</filename>").</para>
968 <para>Folgender Konfigurationsschnipsel funktioniert mit
971 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
972 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
974 <Directory /path/to/kivitendo-erp>
976 Options ExecCGI Includes FollowSymlinks
980 <DirectoryMatch /path/to/kivitendo-erp/users>
982 </DirectoryMatch></programlisting>
985 <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
986 muss entsprechend die Syntax der Directorydirektiven verändert.
989 <programlisting>Require all granted</programlisting>
991 <para>muß man Folgendes einstellen:</para>
995 Allow from All </programlisting>
997 <para>und statt</para>
999 <programlisting>Require all denied</programlisting>
1001 <para>muss stehen:</para>
1005 Deny from All </programlisting>
1009 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
1010 die maximale Größe eines Requests. Diese sollte wie folgt
1011 hochgesetzt werden:</para>
1013 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
1015 <para>Das Ganze sollte dann so aussehen:</para>
1017 <programlisting>AddHandler fcgid-script .fpl
1018 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1019 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1020 FcgidMaxRequestLen 10485760
1022 <Directory /path/to/kivitendo-erp>
1024 Options ExecCGI Includes FollowSymlinks
1029 <DirectoryMatch /path/to/kivitendo-erp/users>
1032 </DirectoryMatch></programlisting>
1034 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
1035 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
1036 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
1037 gibt es hier kleine Performance-Einbußen.</para>
1039 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
1040 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
1041 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
1043 <programlisting># Zugriff über CGI
1044 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
1046 # Zugriff mit mod_fcgid:
1047 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1048 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
1050 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
1051 die normale Version erreichbar, und unter
1052 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
1053 FastCGI-Version.</para>
1058 <title>Weitergehende Konfiguration</title>
1060 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
1061 von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1062 weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1063 Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1064 Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1065 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1066 (Stand Sept. 2015)</ulink> und einen aktuellen (Stand Mai 2017)
1067 <ulink url="https://mozilla.github.io/server-side-tls/ssl-config-generator/">
1068 SSL-Konfigurations-Generator</ulink>.</para>
1072 <sect1 id="config.task-server">
1073 <title>Der Task-Server</title>
1075 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1076 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1077 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1078 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1079 essenzielle Aufgaben benutzt.</para>
1081 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1082 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1083 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1085 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1086 Servers integriert werden muss, damit er automatisch gestartet wird.
1087 Dies kann kivitendo nicht für Sie erledigen.</para>
1089 <para>Da der Taskserver als Perlscript läuft, wird Arbeitsspeicher,
1090 der einmal benötigt wurde, nicht mehr an das Betriebssystem zurückgegeben,
1091 solange der Taskserver läuft. Dies kann dazu führen, dass ein länger
1092 laufender Taskserver mit der Zeit immer mehr Arbeitsspeicher für sich
1093 beansprucht. Es ist deshalb sinnvoll, dass der Taskserver in regelmässigen
1094 Abständen neu gestartet wird.</para>
1096 <sect2 id="Konfiguration-des-Task-Servers">
1097 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1099 <para>Die Konfiguration erfolgt über den Abschnitt
1100 <literal>[task_server]</literal> in der Datei
1101 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1102 Optionen sind:</para>
1106 <term><varname>run_as</varname></term>
1109 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1110 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1111 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1112 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1114 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1115 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1116 unter dem auch der Webserver läuft.</para>
1121 <term><varname>debug</varname></term>
1124 <para>Schaltet Debug-Informationen an und aus.</para>
1130 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1131 <title>Konfiguration der Mandanten für den Task-Server</title>
1133 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1134 anschließend jeder Mandant, für den der Task-Server laufen soll,
1135 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1136 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1137 ausgewählt werden, unter der der Task-Server seine Arbeit
1140 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1141 wird der Task-Server für diesen Mandanten keine Aufgaben
1145 <sect2 id="Einbinden-in-den-Boot-Prozess">
1146 <title>Automatisches Starten des Task-Servers beim Booten</title>
1148 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1149 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1150 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1152 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1153 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1154 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1155 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1156 anstelle eines symbolischen Links verwendet werden können.</para>
1159 <title>SystemV-basierende Systeme (z.B. ältere Debian, ältere OpenSUSE,
1160 ältere Fedora)</title>
1162 <para>Kopieren Sie die Datei
1163 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1164 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1165 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1166 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1167 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1171 <para>Debian-basierende Systeme:</para>
1173 <programlisting>update-rc.d kivitendo-task-server defaults
1174 insserv kivitendo-task-server</programlisting>
1178 <para>Ältere OpenSUSE und ältere Fedora:</para>
1180 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1184 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1187 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1191 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1193 <para>Kopieren Sie die Datei
1194 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1195 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1196 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1197 <literal>exec ....</literal>).</para>
1199 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1202 <programlisting>service kivitendo-task-server start</programlisting>
1206 <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1207 Fedora, neuere Ubuntu und neuere Debians)</title>
1209 <para>Kopieren Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
1210 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeilen
1211 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>).</para>
1213 <para>Machen Sie anschließend das Script systemd bekannt, und binden Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden
1216 <programlisting>systemctl daemon-reload
1217 systemctl enable kivitendo-task-server.service</programlisting>
1219 <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt den Server neu zu starten, so können Sie das mit dem
1220 folgenden Befehl tun:</para>
1222 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1226 <sect2 id="Prozesskontrolle">
1227 <title>Wie der Task-Server gestartet und beendet wird</title>
1229 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1231 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1233 <para><literal>Befehl</literal> ist dabei eine der folgenden
1238 <para><literal>start</literal> startet eine neue Instanz des
1239 Task-Servers. Die Prozess-ID wird innerhalb des
1240 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1244 <para><literal>stop</literal> beendet einen laufenden
1249 <para><literal>restart</literal> beendet und startet ihn
1254 <para><literal>status</literal> berichtet, ob der Task-Server
1259 <para>Der Task-Server wechselt beim Starten automatisch in das
1260 kivitendo-Installationsverzeichnis.</para>
1262 <para>Dieselben Optionen können auch für die SystemV-basierenden
1263 Runlevel-Scripte benutzt werden (siehe oben).</para>
1267 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1268 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1270 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1271 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1273 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1274 <title>Grundlagen zur Benutzerauthentifizierung</title>
1276 <para>kivitendo verwaltet die Benutzerinformationen in einer
1277 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1278 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1279 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1280 können, müssen aber nicht unterschiedlich sein.</para>
1282 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1283 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1284 abgelegt werden.</para>
1286 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
1287 entweder gegen die Authentifizierungsdatenbank oder gegen einen
1288 LDAP-Server überprüft werden.</para>
1290 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1291 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1292 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1293 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1294 einer Version vor v2.6.0 angelegt werden. Eine
1295 Beispielkonfigurationsdatei
1296 <filename>config/kivitendo.conf.default</filename> existiert, die als
1297 Vorlage benutzt werden kann.</para>
1300 <sect2 id="Administratorpasswort">
1301 <title>Administratorpasswort</title>
1303 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1304 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1305 gespeichert. Es kann auch nur dort und nicht mehr im
1306 Administrationsinterface selber geändert werden. Der Parameter dazu
1307 heißt <varname>admin_password</varname> im Abschnitt
1308 <varname>[authentication]</varname>.</para>
1311 <sect2 id="Authentifizierungsdatenbank">
1312 <title>Authentifizierungsdatenbank</title>
1314 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1315 Parametern in <varname>[authentication/database]</varname>
1316 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1320 <term><literal>host</literal></term>
1323 <para>Der Rechnername oder die IP-Adresse des
1324 Datenbankservers</para>
1329 <term><literal>port</literal></term>
1332 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1337 <term><literal>db</literal></term>
1340 <para>Der Name der Authentifizierungsdatenbank</para>
1345 <term><literal>user</literal></term>
1348 <para>Der Benutzername, mit dem sich kivitendo beim
1349 Datenbankserver anmeldet (z.B.
1350 "<literal>postgres</literal>")</para>
1355 <term><literal>password</literal></term>
1358 <para>Das Passwort für den Datenbankbenutzer</para>
1363 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1364 automatisch anlegen (mehr dazu siehe unten).</para>
1367 <sect2 id="Passwortüberprüfung">
1368 <title>Passwortüberprüfung</title>
1370 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1371 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1372 Active-Directory-Server. Welche davon benutzt wird, regelt der
1373 Parameter <varname>module</varname> im Abschnitt
1374 <varname>[authentication]</varname>.</para>
1376 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1377 gespeichert werden, so muss der Parameter <varname>module</varname>
1378 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1379 der Administrator als auch die Benutzer selber ihre Passwörter in
1380 kivitendo ändern.</para>
1382 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1383 benutzt werden, so muss der Parameter <varname>module</varname> auf
1384 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1385 zusätzliche Informationen über den LDAP-Server im Abschnitt
1386 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1390 <term><literal>host</literal></term>
1393 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1394 Active-Directory-Servers. Diese Angabe ist zwingend
1395 erforderlich.</para>
1400 <term><literal>port</literal></term>
1403 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1408 <term><literal>tls</literal></term>
1411 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1412 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1413 ‘<literal>0</literal>’ belassen</para>
1418 <term><literal>attribute</literal></term>
1421 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1422 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1423 meist ‘<literal>sAMAccountName</literal>’, für andere
1424 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1425 zwingend erforderlich.</para>
1430 <term><literal>base_dn</literal></term>
1433 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1434 Diese Angabe ist zwingend erforderlich.</para>
1439 <term><literal>filter</literal></term>
1442 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1443 <literal><%login%></literal>, so wird dieses durch den vom
1444 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1445 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1446 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1451 <term><literal>bind_dn</literal> und
1452 <literal>bind_password</literal></term>
1455 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1456 durchsucht werden kann (z.B. ist dies bei
1457 Active-Directory-Servern der Fall), so kann diese hier angegeben
1458 werden. Für Active-Directory-Server kann als
1459 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1460 z.B. ‘<literal>cn=Martin
1461 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1462 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1463 also ‘<literal>Martin Mustermann</literal>’.</para>
1469 <sect2 id="Name-des-Session-Cookies">
1470 <title>Name des Session-Cookies</title>
1472 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1473 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1474 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1475 Parameter <varname>cookie_name</varname> im Abschnitt
1476 <varname>[authentication]</varname>gesetzt.</para>
1478 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1479 Server existiert.</para>
1482 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1483 <title>Anlegen der Authentifizierungsdatenbank</title>
1485 <para>Nachdem alle Einstellungen in
1486 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1487 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1488 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1489 der folgenden URL erreichbar sein sollte:</para>
1492 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1496 <sect1 id="Benutzer--und-Gruppenverwaltung">
1497 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1499 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1500 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1501 das Sie unter folgender URL finden:</para>
1504 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1506 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1507 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1509 <sect2 id="Zusammenhänge">
1510 <title>Zusammenhänge</title>
1512 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1513 in einer oder zwei Datenbanken gespeichert werden.</para>
1515 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1516 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1517 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1518 Diese Informationen werden in der Authentifizierungsdatenbank
1519 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1520 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1521 gespeichert werden.</para>
1523 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1524 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1525 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1526 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1527 einer solchen Mandantendatenbank werden im Administrationsbereich
1528 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1529 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1531 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1532 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1533 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1534 mehr als einem Mandanten, wird empfohlen, für die
1535 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1536 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1539 <sect2 id="Mandanten-Benutzer-Gruppen">
1540 <title>Mandanten, Benutzer und Gruppen</title>
1542 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1543 die sich frei zueinander zuordnen lassen.</para>
1545 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1546 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1547 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1548 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1549 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1550 Diese sollte über die <link
1551 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1554 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1555 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1556 der Administrator fest, an welchen Mandanten sich ein Benutzer
1557 anmelden kann, was beim Login verifiziert wird.</para>
1559 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1560 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1561 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1562 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1563 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1564 dann an einem Mandanten an, so erhält er alle Rechte von allen
1565 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1566 denen der Benutzer zum Anderen Mitglied ist,</para>
1568 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1569 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1570 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1572 <orderedlist numeration="arabic">
1574 <para>Datenbank anlegen</para>
1578 <para>Gruppen anlegen</para>
1582 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1586 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1591 <sect2 id="Datenbanken-anlegen">
1592 <title>Datenbanken anlegen</title>
1594 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1595 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1596 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1599 <sect2 id="Gruppen-anlegen">
1600 <title>Gruppen anlegen</title>
1602 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1603 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1604 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1605 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1607 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1608 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1609 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1610 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1611 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1612 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1613 A, B und C gültig").</para>
1615 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1616 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1617 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1618 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1619 Gruppen A, B und C").</para>
1622 <sect2 id="Benutzer-anlegen">
1623 <title>Benutzer anlegen</title>
1625 <para>Beim Anlegen von Benutzern werden für viele Parameter
1626 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1627 deutschen Raumes entsprechen.</para>
1629 <para>Zwingend anzugeben ist der Loginname. Wenn die
1630 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
1631 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
1632 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1635 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
1636 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
1637 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
1638 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
1639 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
1640 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
1641 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
1642 sind Benutzer A, B und C Mitglieder").</para>
1645 <sect2 id="Mandanten-anlegen">
1646 <title>Mandanten anlegen</title>
1648 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
1649 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
1650 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
1651 einer der eben angelegten Datenbanken eingetragen werden.</para>
1653 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
1654 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
1655 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
1656 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
1657 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
1658 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
1659 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
1660 Gruppe ist für Mandanten A, B und C gültig").</para>
1664 <sect1 id="Drucker--Systemverwaltung">
1665 <title>Drucker- und Systemverwaltung</title>
1667 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
1668 Druckeradministration und System.</para>
1670 <sect2 id="Druckeradministration">
1671 <title>Druckeradministration</title>
1673 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
1674 viele "Druckbefehle" im System verwalten. Diese Befehle werden
1675 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
1676 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
1677 angezeigt wird.</para>
1679 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
1680 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
1681 meinDrucker' oder ein kompletter Pfad zu einem Skript
1682 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
1683 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
1684 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
1685 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
1686 Ausdruck eines Angebots folgende Vorlage geparst:
1687 sales_quotation_epson_drucker.tex.</para>
1691 <title>System sperren / entsperren</title>
1693 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
1694 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
1695 gesamten kivitendo Installation gesperrt.</para>
1697 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
1698 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
1699 Wartungsarbeiten nicht zugänglich.'.</para>
1701 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
1702 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
1703 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
1704 inkonsistenten Datenbestand weitergearbeitet werden.</para>
1708 <sect1 id="config.sending-email"
1709 xreflabel="E-Mail-Versand aus kivitendo heraus">
1710 <title>E-Mail-Versand aus kivitendo heraus</title>
1712 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
1713 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
1714 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
1715 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
1716 Versand über einen lokalen E-Mail-Server (z.B. mit
1717 <productname>Postfix</productname> oder <productname>Exim</productname>,
1718 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
1719 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
1721 <para>Welche Methode und welcher Server verwendet werden, wird über die
1722 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1723 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
1724 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1726 <sect2 id="config.sending-email.sendmail"
1727 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1728 <title>Versand über lokalen E-Mail-Server</title>
1730 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
1731 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
1732 <productname>Postfix</productname>, <productname>Exim</productname>
1733 oder <productname>Sendmail</productname> läuft.</para>
1735 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1736 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1737 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1739 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
1740 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
1741 Standardwert verweist auf das Programm
1742 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1743 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1745 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
1746 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
1750 <sect2 id="config.sending-email.smtp"
1751 xreflabel="E-Mail-Versand über einen SMTP-Server">
1752 <title>Versand über einen SMTP-Server</title>
1754 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
1755 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
1758 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1759 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1760 Parameter dienen dabei der weiteren Konfiguration:</para>
1764 <term><varname>hostname</varname></term>
1767 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
1768 '<literal>localhost</literal>'</para>
1773 <term><varname>port</varname></term>
1776 <para>Portnummer. Der Standardwert hängt von der verwendeten
1777 Verschlüsselungsmethode ab. Gilt '<literal>security =
1778 none</literal>' oder '<literal>security = tls</literal>', so ist
1779 25 die Standardportnummer. Für '<literal>security =
1780 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
1781 geändert werden.</para>
1786 <term><varname>security</varname></term>
1789 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
1790 mit dem Server. Standardwert ist '<literal>none</literal>',
1791 wodurch keine Verschlüsselung verwendet wird. Mit
1792 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
1793 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
1794 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
1795 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
1796 (siehe unten).</para>
1801 <term><varname>login</varname> und
1802 <varname>password</varname></term>
1805 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
1806 so können mit diesen zwei Parametern der Benutzername und das
1807 Passwort angegeben werden. Wird Authentifizierung verwendet, so
1808 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
1809 aktiviert werden.</para>
1816 <sect1 id="Drucken-mit-kivitendo">
1817 <title>Drucken mit kivitendo</title>
1819 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
1820 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1821 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1822 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
1824 <para><programlisting>apt-get install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1825 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1827 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
1829 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
1830 texlive-collection-latexrecommended texlive-collection-langgerman \
1831 texlive-collection-langenglish</programlisting></para>
1833 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
1835 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
1836 texlive-collection-latexrecommended texlive-collection-langgerman \
1837 texlive-collection-langenglish</programlisting></para>
1839 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1851 <para>rev-odt</para>
1855 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version
1856 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
1858 <sect2 id="Vorlagenverzeichnis-anlegen"
1859 xreflabel="Vorlagenverzeichnis anlegen">
1860 <title>Vorlagenverzeichnis anlegen</title>
1862 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
1863 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1865 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1867 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
1868 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
1869 <xref linkend="Gruppen-anlegen"/>.</para>
1871 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
1872 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
1873 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
1874 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1878 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
1879 Vorlagensatz aus, der kopiert werden soll
1880 (<filename>RB</filename>, <filename>f-tex</filename> oder
1881 <filename>odt-rev</filename>.)</para>
1885 <para><option>Neuer Name</option>: Der Verzeichnisname für den
1886 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
1887 für Verzeichnisnamen frei gewählt werden.</para>
1891 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
1892 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
1893 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1894 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
1895 vorgenommen werden. Den Ordner findet man im Dateisystem unter
1896 <filename>./templates/[Neuer Name]</filename></para>
1899 <sect2 id="Vorlagen-RB">
1900 <title>Der Druckvorlagensatz RB</title>
1902 <para>Hierbei handelt es sich um einen vollständigen LaTeX
1903 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
1904 sind nicht gepflegt.</para>
1906 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
1907 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1908 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
1909 eigenen Firmendaten finden sich in der Datei Readme.tex im
1910 Vorlagenverzeichnis.</para>
1912 <para>Eine kurze Übersicht der Features:</para>
1916 <para>Mehrsprachenfähig, mit Deutscher und Englischer
1921 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
1922 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
1927 <para>mehrere vordefinierte Varianten für
1928 Logos/Hintergrundbilder</para>
1932 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
1933 "Außerhalb EU"</para>
1939 <title>f-tex</title>
1941 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur
1942 Verfügung stellt.</para>
1944 <sect3 id="f-tex-Feature-Übersicht">
1945 <title>Feature-Übersicht</title>
1949 <para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage
1950 für alle briefartigen Dokumente verwendet. Also Angebot,
1951 Rechnung, Proformarechnung, Lieferschein, aber eben nicht für
1952 Paketaufkleber etc.</para>
1956 <para>Leichte Anpassung an das Firmen-Layout durch Verwendung
1957 eines Hintergrund-PDFs. Dieses kann leicht mit dem eigenen
1958 Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp,
1963 <para>Hintergrund-PDF umschaltbar auf "nur erste Seite"
1964 (Standard) oder "alle Seiten" (Option
1965 "<option>bgPdfFirstPageOnly</option>" in Datei
1966 <filename>letter.lco</filename>)</para>
1970 <para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem
1971 Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1972 versendeten Dokumenten eingebunden (Option
1973 "<option>bgPdfEmailOnly</option>" in Datei
1974 <filename>letter.lco</filename>).</para>
1978 <para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch,
1979 Wiederholung von Kopfzeilen, Zwischensummen etc. (danke an
1980 Kai-Martin Knaak für die Vorarbeit)</para>
1984 <para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom
1985 Land des eigenen Unternehmens abweicht (also die Rechnung das
1986 Land verlässt).</para>
1990 <para>Multisprachfähig leicht um weitere Sprachen zu erweitern,
1991 alle Übersetzungen in der Datei
1992 <filename>translatinos.tex</filename>.</para>
1996 <para>Auflistung von Bruttopreisen für Endverbraucher.</para>
2001 <sect3 id="f-tex-Installation">
2002 <title>Die Installation</title>
2006 <para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref
2007 linkend="Vorlagenverzeichnis-anlegen"/>. Das Vorlagensystem
2008 funktioniert jetzt schon, hat allerdings noch einen
2009 Beispiel-Briefkopf.</para>
2013 <para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
2014 <filename>./letter_head.pdf</filename>.</para>
2018 <para>Editiere den Bereich "<option>settings</option>" in der
2019 datei <filename>letter.lco</filename>.</para>
2023 <para>oder etwas detaillierter:</para>
2025 <para>Es wird eine Datei <filename>sample.lco</filename> erstellt
2026 und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
2027 ist dies die Datei die für die firmenspezifischen Anpassungen
2028 gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist,
2029 wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle
2030 über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und
2031 <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung
2032 über eine <filename>*.lco</filename>-Datei, die letztlich auf
2033 <filename>letter.lco</filename> verlinkt ist ist aber auch
2036 <para>Es wird eine Datei <filename>sample_head.pdf</filename> mit
2037 ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
2038 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage.
2039 Schau Dir nach Abschluss der Installation die Datei
2040 <filename>sample_head.pdf</filename> an und erstelle ein
2041 entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
2042 Template Verzeichniss ablegen und statt
2043 <filename>sample_head.pdf</filename> nach
2044 <filename>letter_head.pdf</filename> verlinken.</para>
2046 <para>Letzlich muss <filename>letter_head.pdf</filename> auf das
2047 passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
2050 <para>Es wird eine Datei <filename>mydata.tex.example</filename>
2051 ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
2052 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das
2053 Land verwendet. Die Datei muss also nicht angefasst werden. Die
2054 anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit
2055 nicht im öffentlichen Zweig).</para>
2057 <para>Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
2058 sollten über die Hintergrund-PDF-Datei oder die
2059 <filename>*.lco</filename>-Datei erfolgen.</para>
2062 <sect3 id="f-tex-Funktionsübersicht">
2063 <title>f-tex Funktionsübersicht</title>
2065 <para>Das Konzept von kivitendo sieht vor, für jedes Dokument
2066 (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
2067 LaTeX-Vorlage vorzuhalten, dies ist sehr wartungsunfreundlich. Auch
2068 das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
2069 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen
2070 aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
2071 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
2072 LaTeX-Vorlage verwendet, welche über Codeweichen die Besonderheiten
2073 der jeweiligen Dokumente berücksichtigt:</para>
2077 <para>Tabellen mit oder ohne Preis</para>
2081 <para>Sprache der Tabellenüberschriften etc.</para>
2085 <para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
2086 Angebotsnummer)</para>
2090 <para>Darstellung von Brutto oder Netto-Preisen in der
2091 Auflistung (Endverbraucher versus gewerblicher Kunde)</para>
2095 <para>Nachteil:</para>
2097 <para>LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei
2098 <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
2099 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder
2100 geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch
2101 innerhalb der Tabellendarstellung gut persönliche Anpassungen
2102 vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell
2103 heftig in den Fuss schiessen.</para>
2105 <para>Wer nicht so tief in die Materie einsteigen will oder leicht
2106 zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
2107 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen,
2108 und sich an der Form der dargestellten Tabellen, wie sie
2109 ausgeliefert werden, erfreuen.</para>
2111 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine,
2112 kontinuierliche Schritte gehen.</para>
2115 <sect3 id="f-tex-Bruttopreise">
2116 <title>Bruttopreise für Endverbraucher</title>
2118 <para>Der auszuweisende Bruttopreis wird innerhalb der
2119 LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen
2120 "alle Preise Brutto" auszuwählen, aber:</para>
2124 <para>hierfür müssen die Preise auch in Brutto in der Datenbank
2125 stehen (ja - das lässt sich über die Preisgruppen und die
2126 Zuordung einer Default-Preisgruppe handhaben)</para>
2130 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses
2131 Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
2132 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche
2137 <para>Es gibt mit f-tex eine weitere Alternative. Die Information ob
2138 Brutto oder Nettorechnung wird mit den Zahlarten verknüpft.
2139 Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben
2140 werden sollen, enden mit "_E" (für Endverbraucher). Falls identische
2141 Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt
2142 man diese einfach doppelt an (einmal mit der Namensendung "_E").
2147 <para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist
2148 nicht mehr fix mit einer Preisliste verbunden.</para>
2152 <para>Die Default-Zahlart kann im Kundendatensatz hinterlegt
2153 werden, und man muss nicht mehr daran denken, "alle Preise
2154 Netto" auszuwählen.</para>
2158 <para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen
2159 werden, kann direkt beim Drucken revidiert werden, ohne dass
2160 sich der Auftragswert ändert.</para>
2165 <sect3 id="f-tex-lieferadressen">
2166 <title>Lieferadressen</title>
2168 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen
2169 im Adressfeld zum Einsatz. Wenn die
2170 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende
2171 Adressvariable eingesetzt. Wenn also die Lieferadresse in Straße,
2172 Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
2173 Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert
2174 der Hauptadresse angezeigt.</para>
2178 <sect2 id="Vorlagen-rev-odt">
2179 <title>Der Druckvorlagensatz rev-odt</title>
2181 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2182 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2183 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2184 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2185 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2186 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2187 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2189 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2190 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2191 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2192 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2193 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2194 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2196 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2197 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2198 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2199 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2200 die vom Parser nicht korrekt gelesen werden kann.</para>
2202 <para>Mahnungen können unter folgenden Einschränkungen mit den odt-Vorlagen
2203 im Vorlagensatz rev-odt erzeugt werden:</para>
2207 <para>als Druckoption steht nur 'PDF(OpenDocument/OASIS)' zur
2208 Verfügung, das heisst, die Mahnungen werden als PDF-Datei ausgegeben.
2213 <para>für jede Rechnung muss eine eigene Mahnung erzeugt werden
2214 (auch wenn bei einzelnen KundInnen mehrere überfällige Rechnungen
2215 vorhanden sind).</para>
2219 <para>Mehrere Mahnungen für eine Kundin / einen Kunden werden zu einer
2220 PDF-Datei zusammengefasst</para>
2222 <para>Die Vorlagen zahlungserinnerung.odt sowie mahnung.odt sind für das
2223 Erstellen einer Zahlungserinnerung bzw. Mahnung selbst vorgesehen, die
2224 Vorlage mahnung_invoice.odt für das Erstellen einer Rechnung über die
2225 verrechneten Mahngebühren und Verzugszinsen.</para>
2227 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2228 odt-Vorlagen bei Briefen und Pflichtenheften einzusetzen.
2229 Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2231 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2232 empfang@revamp-it.ch</para>
2235 <sect2 id="allgemeine-hinweise-zu-latex">
2236 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2238 <para>In den allermeisten Installationen sollte das Drucken jetzt
2239 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2240 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2241 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2242 sind zum Beispiel:</para>
2246 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2247 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2248 allem bei Vorlagen aus der Community auf. Installieren Sie die
2249 entsprechenden Pakete.</para>
2253 <para>! Package inputenc Error: Unicode char \u8:... set up for
2254 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2255 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2256 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2257 diversen Tricks dazu gebracht werden andere Zeichen zu
2258 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2263 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2264 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2265 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2266 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2267 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2270 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2271 verifizieren lässt:</para>
2275 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2276 "keep_temp_files" auf 1</para>
2278 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2282 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2286 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2290 <para>wechsel in das users Verzeichnis von kivitendo</para>
2292 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2296 <para>LaTeX Suchpfad anpassen:</para>
2298 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2302 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2305 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2307 <para>Es sollte die letzte Datei ganz unten sein</para>
2311 <para>für besseren Hinweis auf Fehler texdatei nochmals
2314 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2316 <para>in der *.tex datei nach dem Fehler suchen.</para>
2322 <sect1 id="OpenDocument-Vorlagen">
2323 <title>OpenDocument-Vorlagen</title>
2325 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2326 OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2) erzeugen.
2327 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
2328 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2329 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2330 <filename>config/kivitendo.conf</filename> die Variable
2331 <literal>opendocument</literal> im Abschnitt
2332 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2333 Dieses ist die Standardeinstellung.</para>
2335 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2336 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2337 LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt werden, so muss
2338 neben LibreOffice oder OpenOffice auch der “X virtual frame buffer”
2339 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
2340 Andere Distributionen enthalten ihn in anderen Paketen.</para>
2342 <para>Nach der Installation müssen in der Datei
2343 <filename>config/kivitendo.conf</filename> im Abschnitt
2344 <literal>applications</literal> zwei weitere Variablen
2345 angepasst werden:</para>
2346 <para><literal>openofficeorg_writer</literal> muss den
2347 vollständigen Pfad zu LibreOffice oder OpenOffice enthalten.
2348 Dabei dürfen keine Anführungszeichen eingesetzt werden.</para>
2349 <para>Beispiel für Debian oder Ubuntu:</para>
2350 <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2351 <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2354 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2355 LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die benutzt
2356 wird, wenn die Variable <literal>$openofficeorg_daemon</literal> gesetzt
2357 ist, startet ein LibreOffice oder OpenOffice, das auch nach der Umwandlung
2358 des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen wird dann diese
2359 laufende Instanz benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung
2360 deutlich reduziert wird, weil nicht für jedes Dokument ein LibreOffice bzw.
2361 OpenOffice gestartet werden muss. Der Nachteil ist, dass diese Methode
2362 Python und die Python-UNO-Bindings benötigt, die Bestandteil von LibreOffice
2363 bzw. OpenOffice sind.</para>
2366 <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2367 normalerweise der Python-Interpreter
2368 <filename>/usr/bin/python</filename> benutzt.
2369 Sollte dies nicht der richtige sein, so kann man mit zwei
2370 Konfigurationsvariablen entscheiden, welcher Python-Interpreter
2371 genutzt wird. Mit der Option <literal>python_uno</literal> aus dem
2372 Abschnitt <literal>applications</literal> wird der Interpreter selber
2373 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2374 <literal>/usr/bin/python</literal>.</para>
2376 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2377 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2378 z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2379 OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2380 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2381 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2382 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2383 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2384 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2388 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2389 wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet
2390 und die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses
2391 Makro muss in der Dokumentenvorlage enthalten sein und
2392 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2393 ‘<literal>templates/print/rev-odt/invoice.odt</literal>’
2394 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
2395 ebenfalls enthalten sein muss.</para>
2397 <para>Als letztes muss herausgefunden werden, welchen Namen
2398 OpenOffice bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen
2399 gibt. Unter Debian ist dies momentan
2400 <literal>~/.config/libreoffice</literal>. kivitendo verwendet das
2401 Verzeichnis <literal>users/.openoffice.org2</literal>.
2402 Eventuell muss dieses Verzeichnis umbenannt werden.</para>
2404 <para>Dieses Verzeichnis, wie auch das komplette
2405 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2406 sein. Dieses wurde bereits erledigt (siehe <xref
2407 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber
2408 erneut überprüft werden, wenn die Konvertierung nach PDF
2412 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2414 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2415 Aufgaben erfüllen.</para>
2417 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2418 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2419 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2420 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2421 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2422 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2423 Anpassungen aufgeführt</emphasis>):</para>
2426 <title>Bezeichnung der Vorlagen</title>
2428 <para>Rechnung: invoice_besr.odt, Auftrag:
2429 sales_order_besr.odt</para>
2433 <title>Vorbereitungen im Adminbereich</title>
2435 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2436 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2437 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2438 ein Drucker eingerichtet werden:</para>
2442 <para>Druckeradministration → Drucker hinzufügen</para>
2446 <para>Mandant wählen</para>
2450 <para>Druckerbeschreibung → aussagekräftiger Text: wird in
2451 der Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B.
2452 mit Einzahlungsschein Bank xy)</para>
2456 <para>Druckbefehl → beliebiger Text (hat für das Erzeugen
2457 von Aufträgen oder Rechnungen als odt-Datei keine Bedeutung,
2458 darf aber nicht leer sein)</para>
2462 <para>Vorlagenkürzel → besr bzw. selbst gewähltes
2463 Vorlagensuffix (muss genau der Zeichenfolge entsprechen, die
2464 zwischen "invoice_" bzw. "sales_order_" und ".odt"
2469 <para>speichern</para>
2475 <title>Benutzereinstellungen</title>
2477 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2478 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2479 dies persönlich für sich bei den Benutzereinstellungen
2480 konfigurieren:</para>
2484 <para>Programm → Benutzereinstellungen →
2485 Druckoptionen</para>
2489 <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2493 <para>Standardausgabekanal → Bildschirm</para>
2497 <para>Standarddrucker → gewünschte Druckerbeschreibung
2498 auswählen (z.B. mit Einzahlungsschein Bank xy)</para>
2502 <para>Anzahl Kopien → leer</para>
2506 <para>speichern</para>
2512 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2514 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2515 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2516 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2517 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2522 <para>Für den Einzahlungsschein ist die letzte Seite des
2523 Dokuments reserviert</para>
2527 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2528 Zeile mit folgenden Angaben (<emphasis
2529 role="bold">Bank-Konto-Identifikationsnummer und
2530 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2531 Bank angepasst werden</emphasis>):<itemizedlist>
2533 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2534 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2536 <para>erster Wert: <emphasis
2537 role="bold">Bank-Konto-Identifikation</emphasis>
2538 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2539 angepasst werden</emphasis>.</para>
2543 <para>zweiter Wert: <%customernumber%>
2544 (Kundennummer: nur Ziffern, maximal 6)</para>
2548 <para>dritter Wert: <%ordnumber%>
2549 (Auftragsnummer bei Auftragsvorlage
2550 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2551 führende Buchstaben werden vom Makro entfernt</para>
2555 <para>vierter Wert: <%invnumber%>
2556 (Rechnungsnummer bei Rechnungsvorlage
2557 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2558 führende Buchstaben werden vom Makro entfernt</para>
2560 </itemizedlist></para>
2564 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2565 Bank, muss angepasst werden</emphasis>.</para>
2569 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2570 falls Einzahlungsschein ohne Betrag</para>
2574 <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2576 </itemizedlist></para>
2580 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2581 der Name und die Adresse der Bank, die Postkonto-Nummer der
2582 Bank, sowie der eigene Firmenname und die Firmenadresse
2583 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2584 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2585 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2591 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2592 ändernde Einträge in rot</screeninfo>
2596 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2603 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2604 odt-Rechnung (analog bei Auftrag)</title>
2606 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2607 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2608 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2609 den Benutzereinstellungen als persönlicher Standard gewählt
2614 <title>Makroeinstellungen in LibreOffice anpassen</title>
2616 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2617 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2618 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2619 angepasst werden:</para>
2623 <para>Extras → Optionen → Sicherheit →
2624 Makrosicherheit</para>
2628 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2629 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2630 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2635 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2636 der entsprechenden Nachfrage "Makros ausführen" auswählen.
2639 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2640 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2641 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2642 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2650 <sect1 id="nomenclature">
2651 <title>Nomenklatur</title>
2653 <sect2 id="booking.dates">
2654 <title>Datum bei Buchungen</title>
2656 <para>Seit der Version 3.5 werden für Buchungen in kivitendo einheitlich
2657 folgende Bezeichnungen verwendet:</para>
2661 <para><option>Erfassungsdatum</option> (en: <option>Entry Date</option>,
2662 code: <option>Gldate</option>)</para>
2664 <para>bezeichnet das Datum, an dem die Buchung in kivitendo erfasst wurde.
2669 <para><option>Buchungsdatum</option> (en: <option>Booking Date</option>,
2670 code: <option>Transdate</option>)</para>
2672 <para>bezeichnet das buchhaltungstechnisch für eine Buchung relevante
2675 <para>Das <option>Rechnungsdatum</option> bei Verkaufs- und
2676 Einkaufsrechnungen entspricht dem Buchungsdatum. Das heisst, in
2677 Berichten wie dem Buchungsjournal, in denen eine Spalte
2678 <option>Buchungsdatum</option> angezeigt werden kann, erscheint hier
2679 im Fall von Rechnungen das Rechnungsdatum.</para>
2683 <para>Bezieht sich ein verbuchter Beleg auf einen Zeitpunkt, der nicht mit
2684 dem Buchungsdatum übereinstimmt, so kann dieses Datum momentan in kivitendo
2685 nur unter Bemerkungen erfasst werden.</para>
2687 <para>Möglicherweise wird für solche Fälle in einer späteren Version von
2688 kivitendo ein dritter Datumswert für Buchungen erstellt. (Beispiel:
2689 Einkaufsbeleg stammt aus einem früheren Jahr, das bereits
2690 buchhaltungstechnisch abgeschlossen wurde, und muss deshalb später
2691 verbucht werden.)</para>
2697 <sect1 id="config.eur">
2698 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
2701 <sect2 id="config.eur.introduction"
2702 xreflabel="Einführung in die Konfiguration zur EUR">
2703 <title>Einführung</title>
2705 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
2706 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
2707 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
2708 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
2709 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
2711 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
2712 die Mandantendatenbank verschoben und dabei auch gleich in drei
2713 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
2714 steuern lässt.</para>
2717 <sect2 id="config.eur.parameters"
2718 xreflabel="Konfigurationsparameter für EUR">
2719 <title>Konfigurationsparameter</title>
2721 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
2722 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
2726 <term><varname>profit_determination</varname></term>
2729 <para>Dieser Parameter legt die Berechnungsmethode für die
2730 Gewinnermittlung fest. Er enthält entweder
2731 <literal>balance</literal> für
2732 Betriebsvermögensvergleich/Bilanzierung oder
2733 <literal>income</literal> für die
2734 Einnahmen-Überschuss-Rechnung.</para>
2739 <term><varname>accounting_method</varname></term>
2742 <para>Dieser Parameter steuert die Buchungs- und
2743 Berechnungsmethoden für die Versteuerungsart. Er enthält
2744 entweder <literal>accrual</literal> für die Soll-Versteuerung
2745 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
2750 <term><varname>inventory_system</varname></term>
2753 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
2754 enthält entweder <literal>perpetual</literal> für die
2755 Bestandsmethode oder <literal>periodic</literal> für die
2756 Aufwandsmethode.</para>
2761 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
2762 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
2763 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
2764 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
2765 Bestandsmethode.</para>
2767 <para>Die Konfiguration "<varname>eur</varname>" unter
2768 <varname>[system]</varname> in der <link
2769 linkend="config.config-file">Konfigurationsdatei</link>
2770 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
2771 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
2774 <sect2 id="config.eur.setting-parameters">
2775 <title>Festlegen der Parameter</title>
2777 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
2778 der Admininstration können diese Optionen nun unabhängig voneinander
2779 eingestellt werden.</para>
2781 <para>Für die Schweiz sind folgende Einstellungen üblich:
2784 <para>Sollversteuerung</para>
2787 <para>Aufwandsmethode</para>
2790 <para>Bilanzierung</para>
2793 Diese Einstellungen werden automatisch beim Erstellen einer neuen
2794 Datenbank vorausgewählt, wenn in <filename>config/kivitendo.conf</filename> unter
2795 <varname>[system]</varname> <literal>default_manager = swiss</literal> eingestellt ist.
2798 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
2799 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
2802 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
2803 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
2804 angezeigt. Unter <guimenu>System</guimenu> →
2805 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
2806 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
2807 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
2808 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
2809 auch <link linkend="config.eur.inventory-system-perpetual">
2810 Bemerkungen zur Bestandsmethode</link>).</para>
2813 <sect2 id="config.eur.inventory-system-perpetual">
2814 <title>Bemerkungen zur Bestandsmethode</title>
2816 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
2817 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
2818 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
2819 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
2820 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
2821 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
2822 Einkaufsrechnungen berechnet wird.</para>
2824 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
2825 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
2826 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
2830 <sect2 id="config.eur.knonw-issues">
2831 <title>Bekannte Probleme</title>
2833 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
2834 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
2835 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
2836 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
2837 die Konfigurationsvariable
2838 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
2841 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
2842 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
2846 <sect1 id="config.skr04-update-3804">
2847 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
2849 <sect2 id="config.skr04-update-3804.introduction">
2850 <title>Einführung</title>
2852 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
2853 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
2854 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
2855 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
2856 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
2857 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
2858 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
2859 vielleicht schon selbst geholfen hat und mit seinen Änderungen
2860 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
2861 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
2862 Screenshots dargestellt.</para>
2864 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
2865 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
2866 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
2867 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
2870 <sect2 id="config.skr04-update-3804.create-chart">
2871 <title>Konto 3804 manuell anlegen</title>
2873 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
2874 anzulegen und zu konfigurieren. Zuerst wird in
2875 <guimenu>System</guimenu> →
2876 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konto
2877 erfassen</guimenuitem> das Konto angelegt.</para>
2880 <screeninfo>Konto 3804 erfassen</screeninfo>
2884 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
2889 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
2890 werden. Dazu unter <guimenu>System</guimenu> →
2891 <guisubmenu>Steuern</guisubmenu> →
2892 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
2893 13 auswählen und ihn wie im folgenden Screenshot angezeigt
2897 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
2901 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
2906 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
2907 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
2908 <guisubmenu>Steuern</guisubmenu> →
2909 <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem
2910 Screenshot übernehmen.</para>
2913 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
2917 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
2922 <para>Als Nächstes sind alle Konten anzupassen, die als
2923 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
2924 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
2925 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
2926 müssen Sie dazu unter <guimenu>System</guimenu> →
2927 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
2928 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
2929 wie im Screenshot gezeigt vornehmen.</para>
2932 <screeninfo>Konto 4315 anpassen</screeninfo>
2936 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
2941 <para>Als Letztes sollte die Steuerliste unter
2942 <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
2943 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
2944 Vergleich der Screenshot.</para>
2947 <screeninfo>Steuerliste vergleichen</screeninfo>
2951 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
2958 <sect1 id="config.bilanz">
2959 <title>Verhalten des Bilanzberichts</title>
2961 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
2962 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
2963 monatsweise führt dies zu falschen Werten.</para>
2965 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
2966 einstellen indem man:</para>
2970 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
2975 <para>immer den Jahresanfang nimmt (1.1. relativ zum
2980 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
2982 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
2985 <para>- oder mit "alle Buchungen" als Alternative"</para>
2989 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
2994 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
2998 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
2999 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
3000 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
3001 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
3002 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
3003 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
3004 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
3005 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
3006 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
3007 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
3008 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
3009 Erfolgsrechnung.</para>
3012 <sect1 id="config.erfolgsrechnung">
3013 <title>Erfolgsrechnung</title>
3015 <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht <emphasis role="bold">
3016 Erfolgsrechnung</emphasis>.</para>
3018 <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter Features
3019 an- oder abgeschaltet werden. Mit der Einstellung <varname>default_manager = swiss
3020 </varname> in der <filename>config/kivitendo.conf</filename> wird beim neu Erstellen
3021 einer Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü <guimenu>Berichte
3022 </guimenu> ausgewählt und ersetzt dort die GUV.</para>
3024 <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche Aufwands- und
3025 Erlöskonten einzeln aufgelistet (analog zur Bilanz), sortiert nach ERTRAG und AUFWAND.</para>
3027 <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der Erfolgsrechnung
3028 erscheinen soll, unter <varname>Sonstige Einstellungen/Erfolgsrechnung</varname>
3029 entweder <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal> ausgewählt
3032 <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal> ausgewählt,
3033 so wird dieses Konto als Aufwandsminderung unter AUFWAND aufgelistet.</para>
3035 <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal> ausgewählt,
3036 so wird dieses Konto als Ertragsminderung unter ERTRAG aufgelistet.</para>
3038 <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft zusätzlich
3039 die Erfolgsrechnung als Bericht verwendet werden, so müssen die Einstellungen
3040 zu allen Erlös- und Aufwandskonten unter <varname>Sonstige
3041 Einstellungen/Erfolgsrechnung</varname> überprüft und allenfalls neu gesetzt werden.</para>
3044 <sect1 id="config.rounding">
3045 <title>Rundung in Verkaufsbelegen</title>
3047 <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert von 5 Rappen (0.05 CHF).</para>
3049 <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer Genauigkeit
3050 von 0.01 CHF verwendet werden können, ist es trotzdem nach wie vor üblich,
3051 Rechnungen mit auf 0.05 CHF gerundeten Beträgen auszustellen.</para>
3053 <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine solche
3054 Rundung pro Mandant / Datenbank festgelegt werden.</para>
3056 <para>Die Einstellung wird beim Erstellen der Datenbank bei <literal>Genauigkeit</literal>
3057 festgelegt. Sie kann anschliessend über das Webinterface von kivitendo nicht mehr
3058 verändert werden.</para>
3060 <para>Abhängig vom Wert für <varname>default_manager</varname> in
3061 <filename>config/kivitendo.conf</filename> werden dabei folgende
3062 Werte voreingestellt:</para>
3065 <para>0.05 (default_manager = swiss)</para>
3068 <para>0.01 (default_manager = german)</para>
3071 <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
3072 </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
3074 <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
3075 und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet,
3076 wenn dieser nicht der eingestellten Genauigkeit entspricht.</para>
3078 <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
3079 automatisch auf die in der Mandantenkonfiguration festgelegten
3080 Standardkonten für Rundungserträge bzw. Rundungsaufwendungen gebucht.</para>
3082 <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr verändert.)</para>
3084 <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
3085 <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
3086 <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
3088 <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege
3089 in anderen Währungen als der Standardwährung erstellt, so muss in
3090 kivitendo ab Version 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
3091 <para>Das heisst, Firmen in der Schweiz, die teilweise Verkaufsrechnungen
3092 in Euro oder anderen Währungen erstellen wollen, müssen beim Erstellen
3093 der Datenbank als Genauigkeit 0.01 wählen und können zur Zeit die
3094 5er Rundung noch nicht nutzen.</para>
3097 <sect1 id="config.client">
3098 <title>Einstellungen pro Mandant</title>
3100 <para>Einige Einstellungen können von einem Benutzer mit dem <link
3101 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
3102 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
3103 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3104 Die Einstellungen sind unter <guimenu>System</guimenu> →
3105 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3107 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3108 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3109 geändert werden (siehe auch <link
3110 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3111 Bestandsmethode</link>).</para>
3113 <para>Die Einstellungen <literal>show_bestbefore</literal> und
3114 <literal>payments_changeable</literal> aus dem Abschnitt
3115 <literal>features</literal> und die Einstellungen im Abschnitt
3116 <literal>datev_check</literal> (sofern schon vorhanden) der <link
3117 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3118 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3119 Diese Einträge können danach aus der Konfigurationsdatei entfernt
3123 <sect1 id="kivitendo-ERP-verwenden">
3124 <title>kivitendo ERP verwenden</title>
3126 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3127 folgender URL erreichbar:</para>
3130 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3132 <para>Die Administrationsseite erreichen Sie unter:</para>
3135 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3139 <chapter id="features" xreflabel="Features und Funktionen">
3140 <title>Features und Funktionen</title>
3142 <sect1 id="features.periodic-invoices"
3143 xreflabel="Wiederkehrende Rechnungen">
3144 <title>Wiederkehrende Rechnungen</title>
3146 <sect2 id="features.periodic-invoices.introduction"
3147 xreflabel="Einführung in wiederkehrende Rechnungen">
3148 <title>Einführung</title>
3150 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3151 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3152 Die konfigurierten Aufträge werden später automatisch in Rechnungen
3153 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3154 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3155 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3156 wiederzufinden sind.</para>
3159 <sect2 id="features.periodic-invoices.configuration"
3160 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3161 <title>Konfiguration</title>
3163 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3164 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3165 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3166 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3167 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3170 <para>Folgende Parameter kann man konfigurieren:</para>
3177 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3178 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3179 eines neuen Monats).</para>
3181 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3182 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3183 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3184 nächsten Periodenwechsel für alle Perioden, seit der letzten
3185 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3186 verhindern, muss man vorher das Startdatum neu setzen.</para>
3188 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3189 erstellt. Man kann sich diese Aufträge aber gesondert in den
3190 Berichten anzeigen lassen.</para>
3195 <term>Periodizität</term>
3198 <para>Ob monatlich, quartalsweise oder jährlich auf neue
3199 Rechnungen überprüft werden soll. Für jede Periode seit dem
3200 Startdatum wird überprüft, ob für die Periode (beginnend immer
3201 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3202 wurde. Unter Umständen können bei einem Startdatum in der
3203 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3208 <term>Buchen auf</term>
3211 <para>Das Forderungskonto, in der Regel "Forderungen aus
3212 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3213 Buchungsgruppen der betreffenden Waren.</para>
3218 <term>Startdatum</term>
3221 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3227 <term>Enddatum</term>
3230 <para>ab wann keine Rechnungen mehr erstellt werden
3236 <term>Automatische Verlängerung um x Monate</term>
3239 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3240 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3241 hier die Anzahl der Monate eingeben, um die das Enddatum
3242 automatisch nach hinten geschoben wird.</para>
3247 <term>Drucken</term>
3250 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3251 Rechnungen auch gleich ausdrucken lassen.</para>
3256 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3257 Informationen zu den erstellten Rechnungen verschickt werden.
3258 Konfiguriert wird dies in der <link
3259 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3260 <filename>config/kivitendo.conf</filename> im Abschnitt
3261 <varname>[periodic_invoices]</varname>.</para>
3264 <sect2 id="features.periodic-invoices.variables">
3265 <title>Spezielle Variablen</title>
3267 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3268 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3269 formatierte Variablen durch für die jeweils aktuelle
3270 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3271 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3272 die Syntax <literal><%variablenname%></literal>.</para>
3274 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3275 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3276 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3277 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3278 Die zur verfügung stehenden Formatinformationen werden unten genauer
3281 <para>Diese Variablen können auch beim automatischen Versand der
3282 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3283 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3285 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3290 <para>Bemerkungen</para>
3294 <para>Interne Bemerkungen</para>
3298 <para>Vorgangsbezeichnung</para>
3302 <para>In den Beschreibungs- und Langtextfeldern aller
3307 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3311 <term><varname><%current_quarter%></varname>,
3312 <varname><%previous_quarter%></varname>,
3313 <varname><%next_quarter%></varname></term>
3316 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3317 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3322 <term><varname><%current_month%></varname>,
3323 <varname><%previous_month%></varname>,
3324 <varname><%next_month%></varname></term>
3327 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3328 <literal>1</literal> und <literal>12</literal>.</para>
3333 <term><varname><%current_month_long%></varname>,
3334 <varname><%previous_month_long%></varname>,
3335 <varname><%next_month_long%></varname></term>
3338 <para>Aktueller, vorheriger und nächster Monat als Name
3339 (<literal>Januar</literal>, <literal>Februar</literal>
3345 <term><varname><%current_year%></varname>,
3346 <varname><%previous_year%></varname>,
3347 <varname><%next_year%></varname></term>
3350 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3351 Jahreszahl (<literal>2013</literal> etc.).</para>
3356 <term><varname><%period_start_date%></varname>,
3357 <varname><%period_end_date%></varname></term>
3360 <para>Formatiertes Datum des ersten und letzten Tages im
3361 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3362 ersten Quartal von 2013 wären dies der
3363 <literal>01.01.2013</literal> und
3364 <literal>31.03.2013</literal>).</para>
3369 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3370 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3371 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3372 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3377 <term><varname>%a</varname></term>
3380 <para>Der abgekürzte Wochentagsname.</para>
3385 <term><varname>%A</varname></term>
3388 <para>Der ausgeschriebene Wochentagsname.</para>
3393 <term><varname>%b</varname></term>
3396 <para>Der abgekürzte Monatsname.</para>
3401 <term><varname>%B</varname></term>
3404 <para>Der ausgeschriebene Monatsname.</para>
3409 <term><varname>%C</varname></term>
3412 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3418 <term><varname>%d</varname></term>
3421 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3426 <term><varname>%D</varname></term>
3429 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3434 <term><varname>%e</varname></term>
3437 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3438 werden führende Nullen durch Leerzeichen ersetzt.</para>
3443 <term><varname>%F</varname></term>
3446 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3451 <term><varname>%j</varname></term>
3454 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3460 <term><varname>%m</varname></term>
3463 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3468 <term><varname>%u</varname></term>
3471 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3472 die 1 dem Montag entspricht.</para>
3477 <term><varname>%U</varname></term>
3480 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3481 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3487 <term><varname>%V</varname></term>
3490 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3491 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3492 vier Tage im Jahr liegen; Montag ist erster Tag der
3498 <term><varname>%w</varname></term>
3501 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3502 die 0 dem Sonntag entspricht.</para>
3507 <term><varname>%W</varname></term>
3510 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3511 wobei der erste Montag im Jahr das Startdatum von Woche 01
3517 <term><varname>%y</varname></term>
3520 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3526 <term><varname>%Y</varname></term>
3529 <para>Das Jahr als vierstellige Zahl.</para>
3534 <term><varname>%%</varname></term>
3537 <para>Das Prozentzeichen selber.</para>
3542 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3543 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3544 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3545 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3548 <sect2 id="features.periodic-invoices.reports">
3549 <title>Auflisten</title>
3551 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3552 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3553 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3554 wiederkehrenden Rechnungen verschaffen kann.</para>
3557 <sect2 id="features.periodic-invoices.task-server">
3558 <title>Erzeugung der eigentlichen Rechnungen</title>
3560 <para>Die zeitliche und periodische Überprüfung, ob eine
3561 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3562 durch den <link linkend="config.task-server">Taskserver</link>, einen
3563 externen Dienst, der automatisch beim Start des Servers gestartet
3564 werden sollte.</para>
3567 <sect2 id="features.periodic-invoices.create-for-current-month">
3568 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3570 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3571 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3572 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
3573 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3574 generiert hat. Alternativ setzt man das Startdatum auf den
3575 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3576 manuell über den Workflow.</para>
3580 <sect1 id="features.bank" xreflabel="bankerweiterung">
3581 <title>Bankerweiterung</title>
3583 <sect2 id="features.bank.introduction"
3584 xreflabel="Einführung in die Bankerweiterung">
3585 <title>Einführung</title>
3587 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3588 im Wiki und soll von dort später hierhin übernommen werden:</para>
3591 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3595 <sect1 id="dokumentenvorlagen-und-variablen">
3596 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3598 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3599 <title>Einführung</title>
3601 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3602 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3603 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3604 <function><%variablenname%></function> verwendet wird. Für
3605 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3607 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3609 <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3610 Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im
3611 Folgenden gesagte für alle Vorlagenarten.</para>
3613 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3614 verfügbar als hier aufgelistet werden. Die meisten davon können
3615 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3616 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3617 diese wie folgt erhalten werden:</para>
3621 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3622 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3626 <para>In <filename>Form.pm</filename> die Funktion
3627 <function>parse_template</function> suchen und hier die Zeile
3628 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3632 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3633 ein PDF für eine Rechnung erzeugen.</para>
3637 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3638 der Variablen <varname>$self</varname> in der Form <varname>'key'
3639 => 'value',</varname>. Alle <varname>key</varname>s sind
3645 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3646 <title>Variablen ausgeben</title>
3648 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3649 Tags geschrieben werden, also z.B.
3650 <varname><%variablenname%></varname>.</para>
3652 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3653 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3654 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
3655 werden die folgenden Flags unterstützt:</para>
3659 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3660 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3661 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3662 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3666 <para><option>NOESCAPE</option> unterdrückt das Escapen von
3667 Sonderzeichen für die Vorlagensprache. Wenn also in einer
3668 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
3669 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
3670 ist dieses Flag sinnvoll.</para>
3674 <para>Beispiel:</para>
3676 <programlisting><%quototal NOFORMAT%></programlisting>
3679 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
3680 <title>Verwendung in Druckbefehlen</title>
3682 <para>In der Admininstration können Drucker definiert werden. Auch im
3683 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
3684 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
3685 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
3686 <function>`...`</function> nicht zu unerwünschtem Verhalten
3689 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
3690 für das die Telefonnummer eines Ansprechpartners als Teil der
3691 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
3692 z.B. wie folgt aussehen:</para>
3694 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
3697 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
3698 xreflabel="Anfang und Ende der Tags verändern">
3699 <title>Anfang und Ende der Tags verändern</title>
3701 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
3702 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
3703 Prozentzeichen und dem Größerzeichen endet, beispielsweise
3704 <function><%customer%></function>. Da diese Form aber z.B. in
3705 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
3706 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
3707 Stil umgestellt werden.</para>
3709 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
3710 Format gültigen Kommentarzeichen anfangen, dann
3711 <function>config:</function> enthalten, die entsprechende Option
3712 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
3713 enden. Beispiel für LaTeX:</para>
3715 <programlisting>% config: tag-style=($ $)</programlisting>
3717 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
3718 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
3719 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
3721 <programlisting><!-- config: tag-style=($ $) --></programlisting>
3724 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
3725 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
3727 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
3728 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
3729 "<filename>.ext</filename>" geeignet zu ersetzen:
3730 "<filename>.tex</filename>" für LaTeX-Vorlagen und
3731 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
3735 <term><filename>bin_list.ext</filename></term>
3738 <para>Lagerliste</para>
3743 <term><filename>check.ext</filename></term>
3751 <term><filename>invoice.ext</filename></term>
3754 <para>Rechnung</para>
3759 <term><filename>packing_list.ext</filename></term>
3762 <para>Packliste</para>
3767 <term><filename>pick_list.ext</filename></term>
3770 <para>Sammelliste</para>
3775 <term><filename>purchase_delivery_order.ext</filename></term>
3778 <para>Lieferschein (Einkauf)</para>
3783 <term><filename>purcharse_order.ext</filename></term>
3786 <para>Bestellung an Lieferanten</para>
3791 <term><filename>request_quotation.ext</filename></term>
3794 <para>Anfrage an Lieferanten</para>
3799 <term><filename>sales_delivery_order.ext</filename></term>
3802 <para>Lieferschein (Verkauf)</para>
3807 <term><filename>sales_order.ext</filename></term>
3810 <para>Bestellung</para>
3815 <term><filename>sales_quotation.ext</filename></term>
3818 <para>Angebot an Kunden</para>
3823 <term><filename>zahlungserinnerung.ext</filename></term>
3826 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
3831 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
3834 <para>Rechnung über Mahngebühren (Dateiname im Programm
3835 konfigurierbar)</para>
3841 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
3842 <title>Sprache, Drucker und E-Mail</title>
3844 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
3845 eingearbeitet. So wird aus der Vorlage
3846 <filename>sales_order.ext</filename> bei Sprache
3847 <function>de</function> und Druckerkürzel <function>lpr2</function>
3848 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
3849 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
3850 bekommen dann noch das Kürzel <filename>_email</filename>, der
3851 vollständige Vorlagenname wäre dann
3852 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
3853 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
3854 werden. Diese wird verwendet, wenn keine der anderen Varianten
3855 gefunden wird.</para>
3857 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
3858 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
3859 verschickt wird, ist:</para>
3863 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
3867 <para><filename>sales_order_de_lpr2.tex</filename></para>
3871 <para><filename>sales_order.tex</filename></para>
3875 <para><filename>default.tex</filename></para>
3879 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
3880 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
3882 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
3885 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
3886 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
3889 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
3890 xreflabel="Metainformationen zur angeforderten Vorlage">
3891 <title>Metainformationen zur angeforderten Vorlage</title>
3893 <para>Diese Variablen liefern Informationen darüber welche Variante
3894 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
3895 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
3896 Formulare einbinden möchten.</para>
3900 <term><varname>template_meta.formname</varname></term>
3903 <para>Basisname der Vorlage. Identisch mit der <link
3904 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
3905 zu den Dateinamen</link> ohne die Erweiterung. Ein
3906 Verkaufsauftrag enthält hier
3907 <constant>sales_order</constant>.</para>
3912 <term><varname>template_meta.language.description</varname></term>
3915 <para>Beschreibung der verwendeten Sprache</para>
3920 <term><varname>template_meta.language.template_code</varname></term>
3923 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
3924 dem Kürzel das im Dateinamen verwendetet wird.</para>
3929 <term><varname>template_meta.language.output_numberformat</varname></term>
3932 <para>Zahlenformat der verwendeten Sprache in der Form
3933 "<constant>1.000,00</constant>". Experimentell! Nur
3934 interessant für Vorlagen die mit unformatierten Werten
3940 <term><varname>template_meta.language.output_dateformat</varname></term>
3943 <para>Datumsformat der verwendeten Sprache in der Form
3944 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
3945 interessant für Vorlagen die mit unformatierten Werten
3951 <term><varname>template_meta.format</varname></term>
3954 <para>Das angeforderte Format. Kann im Moment die Werte
3955 <constant>pdf</constant>, <constant>postscript</constant>,
3956 <constant>html</constant>, <constant>opendocument</constant>,
3957 <constant>opendocument_pdf</constant> und
3958 <constant>excel</constant> enthalten.</para>
3963 <term><varname>template_meta.extension</varname></term>
3966 <para>Dateierweiterung, wie im Dateinamen. Wird aus
3967 <constant>format</constant> entschieden.</para>
3972 <term><varname>template_meta.media</varname></term>
3975 <para>Ausgabemedium. Kann zur Zeit die Werte
3976 <constant>screen</constant> für Bildschirm,
3977 <constant>email</constant> für E-Mail (triggert das
3978 <constant>_email</constant> Kürzel im Dateinamen),
3979 <constant>printer</constant> für Drucker, und
3980 <constant>queue</constant> für Warteschlange enthalten.</para>
3985 <term><varname>template_meta.printer.description</varname></term>
3988 <para>Beschreibung des ausgewählten Druckers</para>
3993 <term><varname>template_meta.printer.template_code</varname></term>
3996 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
3997 dem Kürzel das im Dateinamen verwendetet wird.</para>
4002 <term><varname>template_meta.tmpfile</varname></term>
4005 <para>Datei-Prefix für temporäre Dateien.</para>
4011 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
4012 <title>Stammdaten von Kunden und Lieferanten</title>
4016 <term><varname>account_number</varname></term>
4019 <para>Kontonummer</para>
4024 <term><varname>bank</varname></term>
4027 <para>Name der Bank</para>
4032 <term><varname>bank_code</varname></term>
4035 <para>Bankleitzahl</para>
4040 <term><varname>bic</varname></term>
4043 <para>Bank-Identifikations-Code (Bank Identifier Code,
4049 <term><varname>business</varname></term>
4052 <para>Kunden-/Lieferantentyp</para>
4057 <term><varname>city</varname></term>
4065 <term><varname>contact</varname></term>
4068 <para>Kontakt</para>
4073 <term><varname>country</varname></term>
4081 <term><varname>c_vendor_id</varname></term>
4084 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
4089 <term><varname>v_customer_id</varname></term>
4092 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
4097 <term><varname>cp_email</varname></term>
4100 <para>Email des Ansprechpartners</para>
4105 <term><varname>cp_givenname</varname></term>
4108 <para>Vorname des Ansprechpartners</para>
4113 <term><varname>cp_greeting</varname></term>
4116 <para>Anrede des Ansprechpartners</para>
4121 <term><varname>cp_name</varname></term>
4124 <para>Name des Ansprechpartners</para>
4129 <term><varname>cp_phone1</varname></term>
4132 <para>Telefonnummer 1 des Ansprechpartners</para>
4137 <term><varname>cp_phone2</varname></term>
4140 <para>Telefonnummer 2 des Ansprechpartners</para>
4145 <term><varname>cp_title</varname></term>
4148 <para>Titel des Ansprechpartners</para>
4153 <term><varname>creditlimit</varname></term>
4156 <para>Kreditlimit</para>
4161 <term><varname>customeremail</varname></term>
4164 <para>Email des Kunden; nur für Kunden</para>
4169 <term><varname>customerfax</varname></term>
4172 <para>Faxnummer des Kunden; nur für Kunden</para>
4177 <term><varname>customernotes</varname></term>
4180 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4185 <term><varname>customernumber</varname></term>
4188 <para>Kundennummer; nur für Kunden</para>
4193 <term><varname>customerphone</varname></term>
4196 <para>Telefonnummer des Kunden; nur für Kunden</para>
4201 <term><varname>discount</varname></term>
4209 <term><varname>email</varname></term>
4212 <para>Emailadresse</para>
4217 <term><varname>fax</varname></term>
4220 <para>Faxnummer</para>
4225 <term><varname>gln</varname></term>
4228 <para>GLN (Globale Lokationsnummer)</para>
4233 <term><varname>greeting</varname></term>
4241 <term><varname>homepage</varname></term>
4244 <para>Homepage</para>
4249 <term><varname>iban</varname></term>
4252 <para>Internationale Kontonummer (International Bank Account
4253 Number, IBAN)</para>
4258 <term><varname>language</varname></term>
4261 <para>Sprache</para>
4266 <term><varname>name</varname></term>
4269 <para>Firmenname</para>
4274 <term><varname>payment_description</varname></term>
4277 <para>Name der Zahlart</para>
4282 <term><varname>payment_terms</varname></term>
4285 <para>Zahlungskonditionen</para>
4290 <term><varname>phone</varname></term>
4293 <para>Telefonnummer</para>
4298 <term><varname>shiptocity</varname></term>
4301 <para>Stadt (Lieferadresse) <link
4302 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4307 <term><varname>shiptocontact</varname></term>
4310 <para>Kontakt (Lieferadresse) <link
4311 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4316 <term><varname>shiptocountry</varname></term>
4319 <para>Land (Lieferadresse) <link
4320 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4325 <term><varname>shiptodepartment_1</varname></term>
4328 <para>Abteilung 1 (Lieferadresse) <link
4329 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4334 <term><varname>shiptodepartment_2</varname></term>
4337 <para>Abteilung 2 (Lieferadresse) <link
4338 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4343 <term><varname>shiptoemail</varname></term>
4346 <para>Email (Lieferadresse) <link
4347 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4352 <term><varname>shiptofax</varname></term>
4355 <para>Fax (Lieferadresse) <link
4356 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4361 <term><varname>shiptogln</varname></term>
4364 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4365 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4370 <term><varname>shiptoname</varname></term>
4373 <para>Firmenname (Lieferadresse) <link
4374 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4379 <term><varname>shiptophone</varname></term>
4382 <para>Telefonnummer (Lieferadresse) <link
4383 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4388 <term><varname>shiptostreet</varname></term>
4391 <para>Straße und Hausnummer (Lieferadresse) <link
4392 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4397 <term><varname>shiptozipcode</varname></term>
4400 <para>Postleitzahl (Lieferadresse) <link
4401 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4406 <term><varname>street</varname></term>
4409 <para>Straße und Hausnummer</para>
4414 <term><varname>taxnumber</varname></term>
4417 <para>Steuernummer</para>
4422 <term><varname>ustid</varname></term>
4425 <para>Umsatzsteuer-Identifikationsnummer</para>
4430 <term><varname>vendoremail</varname></term>
4433 <para>Email des Lieferanten; nur für Lieferanten</para>
4438 <term><varname>vendorfax</varname></term>
4441 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4446 <term><varname>vendornotes</varname></term>
4449 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4454 <term><varname>vendornumber</varname></term>
4457 <para>Lieferantennummer; nur für Lieferanten</para>
4462 <term><varname>vendorphone</varname></term>
4465 <para>Telefonnummer des Lieferanten; nur für
4471 <term><varname>zipcode</varname></term>
4474 <para>Postleitzahl</para>
4479 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4480 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4481 Stammdaten nicht eingetragen, so haben die Variablen
4482 <varname>shipto*</varname> den gleichen Wert wie die die
4483 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4484 einige <varname>shipto*</varname>-Variablen so nicht in den
4485 Stammdaten wiederfinden sondern schlicht Kopien der
4486 Lieferdatenvariablen sind (z.B.
4487 <varname>shiptocontact</varname>).</para>
4491 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4492 <title>Informationen über den Bearbeiter</title>
4496 <term><varname>employee_address</varname></term>
4499 <para>Adressfeld</para>
4504 <term><varname>employee_businessnumber</varname></term>
4507 <para>Firmennummer</para>
4512 <term><varname>employee_company</varname></term>
4515 <para>Firmenname</para>
4520 <term><varname>employee_co_ustid</varname></term>
4523 <para>Usatzsteuer-Identifikationsnummer</para>
4528 <term><varname>employee_duns</varname></term>
4531 <para>DUNS-Nummer</para>
4536 <term><varname>employee_email</varname></term>
4544 <term><varname>employee_fax</varname></term>
4552 <term><varname>employee_name</varname></term>
4555 <para>voller Name</para>
4560 <term><varname>employee_signature</varname></term>
4563 <para>Signatur</para>
4568 <term><varname>employee_taxnumber</varname></term>
4571 <para>Steuernummer</para>
4576 <term><varname>employee_tel</varname></term>
4579 <para>Telefonnummer</para>
4585 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4586 <title>Informationen über den Verkäufer</title>
4590 <term><varname>salesman_address</varname></term>
4593 <para>Adressfeld</para>
4598 <term><varname>salesman_businessnumber</varname></term>
4601 <para>Firmennummer</para>
4606 <term><varname>salesman_company</varname></term>
4609 <para>Firmenname</para>
4614 <term><varname>salesman_co_ustid</varname></term>
4617 <para>Usatzsteuer-Identifikationsnummer</para>
4622 <term><varname>salesman_duns</varname></term>
4625 <para>DUNS-Nummer</para>
4630 <term><varname>salesman_email</varname></term>
4638 <term><varname>salesman_fax</varname></term>
4646 <term><varname>salesman_name</varname></term>
4649 <para>voller Name</para>
4654 <term><varname>salesman_signature</varname></term>
4657 <para>Signatur</para>
4662 <term><varname>salesman_taxnumber</varname></term>
4665 <para>Steuernummer</para>
4670 <term><varname>salesman_tel</varname></term>
4673 <para>Telefonnummer</para>
4679 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
4680 <title>Variablen für die einzelnen Steuern</title>
4684 <term><varname>tax</varname></term>
4692 <term><varname>taxbase</varname></term>
4695 <para>zu versteuernder Betrag</para>
4700 <term><varname>taxdescription</varname></term>
4703 <para>Name der Steuer</para>
4708 <term><varname>taxrate</varname></term>
4711 <para>Steuersatz</para>
4717 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
4718 <title>Variablen für Lieferbedingungen</title>
4722 <term><varname>delivery_term</varname></term>
4725 <para>Datenbank-Objekt der Lieferbedingung</para>
4730 <term><varname>delivery_term.description</varname></term>
4733 <para>Beschreibung der Lieferbedingung</para>
4738 <term><varname>delivery_term.description_long</varname></term>
4741 <para>Langtext bzw. übersetzter Langtext der
4742 Lieferbedingung</para>
4749 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
4750 <title>Variablen in Rechnungen</title>
4752 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
4753 <title>Allgemeine Variablen</title>
4757 <term><varname>creditremaining</varname></term>
4760 <para>Verbleibender Kredit</para>
4765 <term><varname>currency</varname></term>
4768 <para>Währung</para>
4773 <term><varname>cusordnumber</varname></term>
4776 <para>Bestellnummer beim Kunden</para>
4781 <term><varname>deliverydate</varname></term>
4784 <para>Lieferdatum</para>
4789 <term><varname>duedate</varname></term>
4792 <para>Fälligkeitsdatum</para>
4797 <term><varname>globalprojectnumber</varname></term>
4800 <para>Projektnummer des ganzen Beleges</para>
4805 <term><varname>globalprojectdescription</varname></term>
4808 <para>Projekbeschreibung des ganzen Beleges</para>
4813 <term><varname>intnotes</varname></term>
4816 <para>Interne Bemerkungen</para>
4821 <term><varname>invdate</varname></term>
4824 <para>Rechnungsdatum</para>
4829 <term><varname>invnumber</varname></term>
4832 <para>Rechnungsnummer</para>
4837 <term><varname>invtotal</varname></term>
4840 <para>gesamter Rechnungsbetrag</para>
4845 <term><varname>notes</varname></term>
4848 <para>Bemerkungen der Rechnung</para>
4853 <term><varname>orddate</varname></term>
4856 <para>Auftragsdatum</para>
4861 <term><varname>ordnumber</varname></term>
4864 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
4865 erstellt wurde</para>
4870 <term><varname>payment_description</varname></term>
4873 <para>Name der Zahlart</para>
4878 <term><varname>payment_terms</varname></term>
4881 <para>Zahlungskonditionen</para>
4886 <term><varname>quodate</varname></term>
4889 <para>Angebotsdatum</para>
4894 <term><varname>quonumber</varname></term>
4897 <para>Angebotsnummer</para>
4902 <term><varname>rounding</varname></term>
4905 <para>Betrag, um den <varname>invtotal</varname> gerundet wurde
4906 (kann positiv oder negativ sein)</para>
4911 <term><varname>shippingpoint</varname></term>
4914 <para>Versandort</para>
4919 <term><varname>shipvia</varname></term>
4922 <para>Transportmittel</para>
4927 <term><varname>subtotal</varname></term>
4930 <para>Zwischensumme aller Posten ohne Steuern</para>
4935 <term><varname>total</varname></term>
4938 <para>Restsumme der Rechnung (Summe abzüglich bereits
4939 bezahlter Posten)</para>
4944 <term><varname>transaction_description</varname></term>
4947 <para>Vorgangsbezeichnung</para>
4952 <term><varname>transdate</varname></term>
4955 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
4956 erstellt wurde</para>
4962 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
4963 <title>Variablen für jeden Posten auf der Rechnung</title>
4967 <term><varname>bin</varname></term>
4970 <para>Stellage</para>
4975 <term><varname>description</varname></term>
4978 <para>Artikelbeschreibung</para>
4983 <term><varname>cusordnumber_oe</varname></term>
4986 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
4987 Posten ursprünglich stammt (nur Verkauf)</para>
4992 <term><varname>discount</varname></term>
4995 <para>Rabatt als Betrag</para>
5000 <term><varname>discount_sub</varname></term>
5003 <para>Zwischensumme mit Rabatt</para>
5008 <term><varname>donumber_do</varname></term>
5011 <para>Lieferscheinnummer des Lieferscheins, aus dem die
5012 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
5013 Workflows aus einem Lieferschein erstellt wurde.</para>
5018 <term><varname>drawing</varname></term>
5021 <para>Zeichnung</para>
5026 <term><varname>ean</varname></term>
5029 <para>EAN-Code</para>
5034 <term><varname>image</varname></term>
5042 <term><varname>linetotal</varname></term>
5045 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
5050 <term><varname>longdescription</varname></term>
5053 <para>Langtext</para>
5058 <term><varname>microfiche</varname></term>
5061 <para>Mikrofilm</para>
5066 <term><varname>netprice</varname></term>
5069 <para>Alternative zu <varname>sellprice</varname>, aber
5070 <varname>netprice</varname> entspricht dem effektiven
5071 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
5072 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
5073 / Menge. Diese Variable ist nützlich, wenn man den gewährten
5074 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
5075 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
5076 <varname>netprice</varname> hat nichts mit Netto/Brutto im
5077 Sinne von Steuern zu tun.</para>
5082 <term><varname>nodiscount_linetotal</varname></term>
5085 <para>Zeilensumme ohne Rabatt</para>
5090 <term><varname>nodiscount_sub</varname></term>
5093 <para>Zwischensumme ohne Rabatt</para>
5098 <term><varname>number</varname></term>
5101 <para>Artikelnummer</para>
5106 <term><varname>ordnumber_oe</varname></term>
5109 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5110 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5111 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5112 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5113 letzterem Fall wird die unsprüngliche Auftragsnummer
5119 <term><varname>p_discount</varname></term>
5122 <para>Rabatt in Prozent</para>
5127 <term><varname>partnotes</varname></term>
5130 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5135 <term><varname>partsgroup</varname></term>
5138 <para>Warengruppe</para>
5143 <term><varname>price_factor</varname></term>
5146 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5152 <term><varname>price_factor_name</varname></term>
5155 <para>Der Name des Preisfaktors, sofern einer eingestellt
5161 <term><varname>projectnumber</varname></term>
5164 <para>Projektnummer</para>
5169 <term><varname>projectdescription</varname></term>
5172 <para>Projektbeschreibung</para>
5177 <term><varname>qty</varname></term>
5185 <term><varname>reqdate</varname></term>
5188 <para>Lieferdatum</para>
5193 <term><varname>runningnumber</varname></term>
5196 <para>Position auf der Rechnung (1, 2, 3...)</para>
5201 <term><varname>sellprice</varname></term>
5204 <para>Verkaufspreis</para>
5209 <term><varname>serialnumber</varname></term>
5212 <para>Seriennummer</para>
5217 <term><varname>tax_rate</varname></term>
5220 <para>Steuersatz</para>
5225 <term><varname>transdate_do</varname></term>
5228 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5229 Workflows aus einem Lieferschein stammte.</para>
5234 <term><varname>transdate_oe</varname></term>
5237 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5238 Workflows aus einem Auftrag erstellt wurde. Wenn es
5239 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5245 <term><varname>transdate_quo</varname></term>
5248 <para>Datum des Angebots, wenn die Position im Rahmen des
5249 Workflows aus einem Angebot stammte.</para>
5254 <term><varname>unit</varname></term>
5257 <para>Einheit</para>
5262 <term><varname>weight</varname></term>
5265 <para>Gewicht</para>
5270 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5271 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5272 einer <function>foreach</function>-Schleife ausgegeben werden, da
5273 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5274 können. Die Variablen dafür lauten:</para>
5278 <term><varname>make</varname></term>
5281 <para>Lieferant</para>
5286 <term><varname>model</varname></term>
5289 <para>Lieferantenartikelnummer</para>
5295 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5296 <title>Variablen für die einzelnen Zahlungseingänge</title>
5300 <term><varname>payment</varname></term>
5308 <term><varname>paymentaccount</varname></term>
5316 <term><varname>paymentdate</varname></term>
5324 <term><varname>paymentmemo</varname></term>
5332 <term><varname>paymentsource</varname></term>
5341 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5342 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5344 <para>Die vom Benutzer definierten Variablen für Kunden und
5345 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5346 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5347 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5348 Variablennamen zusammen.</para>
5350 <para>Beispiel: Der Benutzer hat eine Variable namens
5351 <varname>number_of_employees</varname> definiert, die die Anzahl der
5352 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5353 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5356 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5357 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5358 Präfix <varname>shiptocvar_</varname>.</para>
5362 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5363 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5365 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5366 <title>Namen der Vorlagen</title>
5368 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5369 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5370 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5371 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5372 Vorlagenname für diese Mahnstufe mit dem Zusatz
5373 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5374 für die ausgewählte Sprache und den ausgewählten Drucker
5378 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5379 <title>Allgemeine Variablen in Mahnungen</title>
5381 <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie gewohnt als
5382 <varname>employee_...</varname> bzw. <varname>salesman_...</varname> zur Verfügung.
5383 Werden mehrere Rechnungen in einer Mahnung zusammengefasst, so werden
5384 die Metadaten (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung
5385 im Ausdruck genommen.</para>
5386 <para>Die Adressdaten des Kunden stehen als Variablen <varname>name</varname>,
5387 <varname>street</varname>, <varname>zipcode</varname>,
5388 <varname>city</varname>, <varname>country</varname>,
5389 <varname>department_1</varname>, <varname>department_2</varname>,
5390 und <varname>email</varname> zur Verfügung. Der Ansprechpartner <varname>cp_...</varname>
5391 steht auch zu Verfügung, wird allerdings auch nur von der ersten angemahnten Rechnung (s.o.)
5394 <para>Weitere Variablen beinhalten:</para>
5398 <term><varname>dunning_date</varname></term>
5401 <para>Datum der Mahnung</para>
5406 <term><varname>dunning_duedate</varname></term>
5409 <para>Fälligkeitsdatum für diese Mahhnung</para>
5414 <term><varname>dunning_id</varname></term>
5417 <para>Mahnungsnummer</para>
5422 <term><varname>fee</varname></term>
5425 <para>Kumulative Mahngebühren</para>
5430 <term><varname>interest_rate</varname></term>
5433 <para>Zinssatz per anno in Prozent</para>
5438 <term><varname>total_amount</varname></term>
5441 <para>Gesamter noch zu zahlender Betrag als
5442 <function>fee</function> + <function>total_interest</function>
5443 + <function>total_open_amount</function></para>
5448 <term><varname>total_interest</varname></term>
5451 <para>Zinsen per anno über alle Rechnungen</para>
5456 <term><varname>total_open_amount</varname></term>
5459 <para>Summe über alle offene Beträge der Rechnungen</para>
5465 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5466 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5470 <term><varname>dn_amount</varname></term>
5473 <para>Rechnungssumme (brutto)</para>
5478 <term><varname>dn_duedate</varname></term>
5481 <para>Originales Fälligkeitsdatum der Rechnung</para>
5486 <term><varname>dn_dunning_date</varname></term>
5489 <para>Datum der Mahnung</para>
5494 <term><varname>dn_dunning_duedate</varname></term>
5497 <para>Fälligkeitsdatum der Mahnung</para>
5502 <term><varname>dn_fee</varname></term>
5505 <para>Kummulative Mahngebühr</para>
5510 <term><varname>dn_interest</varname></term>
5513 <para>Zinsen per anno für diese Rechnung</para>
5518 <term><varname>dn_invnumber</varname></term>
5521 <para>Rechnungsnummer</para>
5526 <term><varname>dn_linetotal</varname></term>
5529 <para>Noch zu zahlender Betrag (ergibt sich aus
5530 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5531 + <varname>dn_interest</varname>)</para>
5536 <term><varname>dn_netamount</varname></term>
5539 <para>Rechnungssumme (netto)</para>
5544 <term><varname>dn_open_amount</varname></term>
5547 <para>Offener Rechnungsbetrag</para>
5552 <term><varname>dn_ordnumber</varname></term>
5555 <para>Bestellnummer</para>
5560 <term><varname>dn_transdate</varname></term>
5563 <para>Rechnungsdatum</para>
5568 <term><varname>dn_curr</varname></term>
5571 <para>Währung, in der die Rechnung erstellt wurde. (Die
5572 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5578 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5579 <title>Variablen in automatisch erzeugten Rechnungen über
5580 Mahngebühren</title>
5582 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5583 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5584 Kunden stehen als Variablen <varname>name</varname>,
5585 <varname>street</varname>, <varname>zipcode</varname>,
5586 <varname>city</varname>, <varname>country</varname>,
5587 <varname>department_1</varname>, <varname>department_2</varname>,
5588 und <varname>email</varname> zur Verfügung.</para>
5590 <para>Weitere Variablen beinhalten:</para>
5594 <term><varname>duedate</varname></term>
5597 <para>Fälligkeitsdatum der Rechnung</para>
5602 <term><varname>dunning_id</varname></term>
5605 <para>Mahnungsnummer</para>
5610 <term><varname>fee</varname></term>
5613 <para>Mahngebühren</para>
5618 <term><varname>interest</varname></term>
5626 <term><varname>invamount</varname></term>
5629 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
5630 <varname>interest</varname>)</para>
5635 <term><varname>invdate</varname></term>
5638 <para>Rechnungsdatum</para>
5643 <term><varname>invnumber</varname></term>
5646 <para>Rechnungsnummer</para>
5653 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
5654 <title>Variablen in anderen Vorlagen</title>
5657 <title>Einführung</title>
5659 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
5660 Rechnung. Allerdings heißen die Variablen, die mit
5661 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
5662 fangen sie mit <varname>quo</varname> für "quotation" an:
5663 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
5664 wiederum fangen sie mit <varname>ord</varname> für "order" an:
5665 <varname>ordnumber</varname> für Bestellnummer etc.</para>
5667 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
5668 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
5669 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
5670 Vorlage keine Bedeutung haben oder noch nicht belegt sein
5673 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
5674 in Rechnungen aufgeführt.</para>
5677 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
5678 <title>Angebote und Preisanfragen</title>
5682 <term><varname>quonumber</varname></term>
5685 <para>Angebots- bzw. Anfragenummer</para>
5690 <term><varname>reqdate</varname></term>
5693 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
5694 Preisanfragen)</para>
5699 <term><varname>transdate</varname></term>
5702 <para>Angebots- bzw. Anfragedatum</para>
5708 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
5709 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
5713 <term><varname>ordnumber</varname></term>
5716 <para>Auftragsnummer</para>
5721 <term><varname>reqdate</varname></term>
5724 <para>Lieferdatum</para>
5729 <term><varname>transdate</varname></term>
5732 <para>Auftragsdatum</para>
5738 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
5739 <title>Lieferscheine (Verkauf und Einkauf)</title>
5743 <term><varname>cusordnumber</varname></term>
5746 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
5747 des Lieferanten (im Einkauf)</para>
5752 <term><varname>donumber</varname></term>
5755 <para>Lieferscheinnummer</para>
5760 <term><varname>transdate</varname></term>
5763 <para>Lieferscheindatum</para>
5768 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
5769 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
5770 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
5771 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
5772 <function>foreach</function>-Schleife ausgegeben werden. Diese
5773 Variablen sind:</para>
5777 <term><varname>si_bin</varname></term>
5780 <para>Lagerplatz</para>
5785 <term><varname>si_chargenumber</varname></term>
5788 <para>Chargennummer</para>
5793 <term><varname>si_bestbefore</varname></term>
5796 <para>Mindesthaltbarkeit</para>
5801 <term><varname>si_number</varname></term>
5804 <para>Artikelnummer</para>
5809 <term><varname>si_qty</varname></term>
5812 <para>Anzahl bzw. Menge</para>
5817 <term><varname>si_runningnumber</varname></term>
5820 <para>Positionsnummer (1, 2, 3 etc)</para>
5825 <term><varname>si_unit</varname></term>
5828 <para>Einheit</para>
5833 <term><varname>si_warehouse</varname></term>
5842 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
5843 <title>Variablen für Sammelrechnung</title>
5847 <term><varname>c0total</varname></term>
5850 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
5856 <term><varname>c30total</varname></term>
5859 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
5860 und < 60 Tage</para>
5865 <term><varname>c60total</varname></term>
5868 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
5869 und < 90 Tage</para>
5874 <term><varname>c90total</varname></term>
5877 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
5883 <term><varname>total</varname></term>
5886 <para>Gesamtbetrag aller Rechnungen</para>
5891 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
5895 <term><varname>invnumber</varname></term>
5898 <para>Rechnungsnummer</para>
5903 <term><varname>invdate</varname></term>
5906 <para>Rechnungsdatum</para>
5911 <term><varname>duedate</varname></term>
5914 <para>Fälligkeitsdatum</para>
5919 <term><varname>amount</varname></term>
5922 <para>Summe der Rechnung</para>
5927 <term><varname>open</varname></term>
5930 <para>Noch offener Betrag der Rechnung</para>
5935 <term><varname>c0</varname></term>
5938 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
5944 <term><varname>c30</varname></term>
5947 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
5953 <term><varname>c60</varname></term>
5956 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
5962 <term><varname>c90</varname></term>
5965 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
5973 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
5974 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
5976 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
5977 <title>Einführung</title>
5979 <para>Der Parser kennt neben den Variablen einige weitere
5980 Konstrukte, die gesondert behandelt werden. Diese sind wie
5981 Variablennamen in spezieller Weise markiert:
5982 <command><%anweisung%> ... <%end%></command></para>
5984 <para>Anmerkung zum <command><%end%></command>: Der besseren
5985 Verständlichkeit halber kann man nach dem <command>end</command>
5986 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
5987 Anweisung (z.B. <command>if</command> oder
5988 <command>foreach</command>) damit abgeschlossen wird.</para>
5990 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
5991 <command><%if type == "sales_quotation"%></command>, so könnte
5992 er mit <command><%end%></command> genauso abgeschlossen werden
5993 wie mit <command><%end if%></command> oder auch
5994 <command><%end type == "sales_quotation"%></command>.</para>
5997 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
5998 <title>Der if-Block</title>
6000 <programlisting><%if variablenname%>
6002 <%end%></programlisting>
6004 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
6005 und dem "end" werden nur ausgegeben, wenn die Variable
6006 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
6008 <para>Handelt es sich bei der benannten Variable um ein Array, also
6009 um einen Variablennamen, über den man mit <command><%foreach
6010 variablenname%></command> iteriert, so wird mit diesem Konstrukt
6011 darauf getestet, ob das Array Elemente enthält. Somit würde im
6012 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
6013 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
6014 welche getätigt wurden:</para>
6016 <programlisting><%if payment%>
6018 <%foreach payment%>
6019 Am <%paymentdate%>: <%payment%> €
6020 <%end foreach%>
6021 <%end if%></programlisting>
6023 <para>Die Bedingung kann auch negiert werden, indem das Wort
6024 <function>not</function> nach dem <filename>if</filename> verwendet
6025 wird. Beispiel:</para>
6027 <programlisting><%if not cp_greeting%>
6029 <%end%></programlisting>
6031 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
6032 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
6033 einer Variablen mit einer festen Zeichenkette oder einer anderen
6034 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
6035 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
6036 die rechte Seite des Vergleichsoperators in Anführungszeichen
6037 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
6038 anderer Variablen). Zwei Beispiele, die beide Vergleiche
6041 <programlisting><%if var1 == "Wert"%></programlisting>
6043 <para>Testet die Variable <varname>var1</varname> auf
6044 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
6045 Mittels <function>!=</function> anstelle von <function>==</function>
6046 würde auf Ungleichheit getestet.</para>
6048 <programlisting><%if var1 == var2%></programlisting>
6050 <para>Testet die Variable <varname>var1</varname> auf
6051 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
6052 <function>!=</function> anstelle von <function>==</function> würde
6053 auf Ungleichheit getestet.</para>
6055 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
6056 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
6057 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
6058 dieselbe Syntax wie oben nur mit <function>=~</function> und
6059 <function>!~</function> als Vergleichsoperatoren.</para>
6061 <para>Beispiel für einen Test, ob die Variable
6062 <varname>intnotes</varname> (interne Bemerkungen) das Wort
6063 <constant>schwierig</constant> enthält:</para>
6065 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
6068 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
6069 <title>Der foreach-Block</title>
6071 <programlisting><%foreach variablenname%>
6073 <%end%></programlisting>
6075 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
6076 wie das Perl-Array der Variablen <varname>variablenname</varname>
6077 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
6078 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
6079 benutzt. In jedem Durchlauf werden die <link
6080 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
6081 Variablen</link> jeweils auf den Wert für die aktuelle Position
6084 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
6086 <programlisting><%foreach number%>
6087 Position: <%runningnumber%>
6088 Anzahl: <%qty%>
6089 Artikelnummer: <%number%>
6090 Beschreibung: <%description%>
6092 <%end%></programlisting>
6094 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
6095 <function><%foreach%></function>-Block innerhalb einer
6096 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
6097 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
6098 Inhalt zwischen <function><%foreach%></function> und
6099 <function><%end%></function> wiederholt, nicht aber die
6100 komplette Zeile, in der er steht.</para>
6104 <sect2 id="dokumentenvorlagen-und-variablen.markup">
6105 <title>Markup-Code zur Textformatierung innerhalb von
6108 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6109 anders formatiert haben möchte, so ist dies begrenzt möglich.
6110 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6111 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6112 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6113 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6114 (HTML oder PDF über LaTeX) umgesetzt.</para>
6116 <para>Die unterstützen Formatierungen sind:</para>
6120 <term><b>Text</b></term>
6123 <para>Text wird in Fettdruck gesetzt.</para>
6128 <term><i>Text</i></term>
6131 <para>Text wird kursiv gesetzt.</para>
6136 <term><u>Text</u></term>
6139 <para>Text wird unterstrichen.</para>
6144 <term><s>Text</s></term>
6147 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6148 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6153 <term><bullet></term>
6156 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6162 <para>Der Befehl <command><bullet></command> funktioniert
6163 momentan auch nur in Latex-Vorlagen.</para>
6167 <sect1 id="excel-templates">
6168 <title>Excel-Vorlagen</title>
6170 <sect2 id="excel-templates.summary">
6171 <title>Zusammenfassung</title>
6173 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6174 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6178 <sect2 id="excel-templates.usage">
6179 <title>Bedienung</title>
6181 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6182 werden. Die Konfigurationsoption heißt <varname>excel_templates =
6183 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6185 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6186 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6187 werden. In den normalen Verkaufsmasken taucht nun
6188 <constant>Excel</constant> als auswählbares Format auf und kann von da
6189 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6191 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6192 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6193 <filename>sales_quotation.xls</filename> gespeichert.</para>
6196 <sect2 id="excel-templates.syntax">
6197 <title>Variablensyntax</title>
6199 <para>Einfache Syntax:
6200 <command><<varname>></command></para>
6202 <para>Dabei sind <constant><<</constant> und
6203 <constant>>></constant> die Delimiter. Da Excel auf festen
6204 Breiten besteht, kann der Tag künstlich verlängert werden, indem
6205 weitere <constant><</constant> oder <constant>></constant>
6206 eingefügt werden. Der Tag muss nicht symmetrisch sein.
6209 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6211 <para>Um die Limitierung der festen Breite zu reduzieren, können
6212 weitere Variablen in einem Block interpoliert werden. Whitespace wird
6213 dazwishen dann erhalten. Beispiel:</para>
6215 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6217 <para>Die Variablen werden interpoliert, und linksbündig mit
6218 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6219 lang, werden überzählige Zeichen abgeschnitten.</para>
6221 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6222 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6224 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6226 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6227 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6231 <sect2 id="excel-templates.limitations">
6232 <title>Einschränkungen</title>
6234 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6235 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6236 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6237 Text zu ersetzen.</para>
6239 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6240 <command><%if%></command> und
6241 <command><%foreach%></command> nicht vorhanden. Der Delimiter
6242 <constant><% %></constant> kommt in den Headerinformationen
6243 evtl. vor. Deshalb wurde auf den sichereren Delimiter
6244 <constant><<</constant> und <constant>>></constant>
6249 <sect1 id="features.warehouse">
6252 <title>Mandantenkonfiguration Lager</title>
6255 Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6256 Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. Ferner kann jede Position eines Lieferscheins
6257 ein-, bzw. ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele Lager mit beliebig vielen Lagerplätzen abgebildet
6258 werden. Die Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder Einzelposition und das Auswählen dieser Position zu
6259 einem Lager mit Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je nachdem wie die Einstellungen in der
6260 Mandatenkonfiguration gesetzt werden.
6265 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6266 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6267 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6268 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6272 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6273 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6274 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6275 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6276 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6277 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6282 Zusätzliche Funktionshinweise:
6287 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6288 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6289 Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6293 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6294 Stammdaten definiert</option> Wird beim 'Auslagern über
6295 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6296 so wird mit dieser Option einfach der Standardlagerplatz
6304 <sect1 id="features.swiss-charts-of-accounts">
6305 <title>Schweizer Kontenpläne</title>
6307 <para>Seit der Version 3.5 stehen in kivitendo 3 Kontenpläne für
6308 den Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6309 Organisationen, die nicht mehrwertsteuerpflichtig sind, einer
6310 für Firmen, die mehrwertsteuerpflichtig sind und einer speziell
6313 <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6314 verwendeten KMU-Kontenrahmen und sind mit der Revision des Schweizerischen
6315 Obligationenrechts (OR) vom 1.1.2013 kompatibel, insbesondere
6316 <literal>Art.957a Abs.2</literal>.</para>
6318 <para>Beim Vereinskontenplan sind standardmässig nur die Konten 1100
6319 (Debitoren CHF) und 1101 (Debitoren EUR) als Buchungskonten im Verkauf
6320 sowie die Konten 2000 (Kreditoren CHF) und 2001 (Kreditoren EUR) als
6321 Buchungskonten im Einkauf vorgesehen. Weitere Konten können bei Bedarf
6322 in den Konto-Detaileinstellungen als Einkaufs- oder Verkaufskonten
6323 konfiguriert werden.</para>
6325 <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der aktuellen
6326 Version von kivitendo noch nicht integriert.</para>
6328 <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6329 Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6330 Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen
6331 alle Aufwandskonten editiert werden und dort der Steuersatz auf 0%
6332 gesetzt werden.</para>
6334 <para>So werden bei Kreditorenbuchungen keine Vorsteuern verbucht.</para>
6336 <para>Bezugssteuern für aus dem Ausland bezogene Dienstleistungen müssen
6337 manuell verbucht werden.</para>
6339 <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6340 Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne
6341 bitte an <literal>empfang@revamp-it.ch</literal> senden.</para>
6344 <sect1 id="features.part_classification">
6345 <title>Artikelklassifizierung</title>
6348 <title>Übersicht</title>
6350 <para>Die Klassifizierung von Artikeln dient einer weiteren Gliederung
6351 um zum Beispiel den Einkauf vom Verkauf zu trennen, gekennzeichnet
6352 durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel (z.B. "E").
6353 Für jede Klassifizierung besteht eine Beschreibung und eine Abkürzung
6354 die normalerweise aus einem Zeichen besteht, kann aber auf mehrere
6355 Zeichen erweitert werden, falls zur Unterscheidung notwendig, sinnvoll
6356 sind jedoch nur maximal 2 Zeichen.</para>
6360 <title>Basisklassifizierung</title>
6362 <para>Als Basisklassifizierungen gibt es</para>
6366 <para>Einkauf</para>
6370 <para>Verkauf</para>
6374 <para>Handelsware</para>
6378 <para>Produktion</para>
6382 <para>- keine - (diese wird bei einer Aktualisierung für alle
6383 existierenden Artikel genommen, gültig für Verkauf und
6388 <para>Es können weitere Klassifizierungen angelegt werden. So kann es
6389 z.B. für separat auszuweisende Artikel folgened Klassen geben:</para>
6393 <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
6397 <para>Material (Verpackungsmaterial) mit Kürzel M</para>
6403 <title>Attribute</title>
6405 <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
6406 alle gleichzeitg gültig sein können</para>
6410 <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
6415 <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
6420 <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
6421 (LaTeX) zusätzliche Variable</para>
6425 <para>Beim separat ausweisen stehen im LaTeX die Variable <emphasis
6426 role="bold"><%non_separate_subtotal%> </emphasis>zur Verfügung,
6427 die alle nicht separat auszuweisenden Artikelkosten saldiert, sowie
6428 pro separat auszuweisenden Klassifizierungen die Variable<emphasis
6429 role="bold"> <%separate_X_subtotal%></emphasis> wobei X das
6430 Kürzel der Klassifizierung ist.</para>
6432 <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
6433 role="bold"><%separate_L_subtotal%></emphasis> und für
6434 Verpackungsmaterial <emphasis
6435 role="bold"><%separate_M_subtotal%> </emphasis>.</para>
6439 <title>Zwei-Zeichen Abkürzung</title>
6441 <para>Der Typ des Artikel und die Klassifizierung werden durch zwei
6442 Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
6443 Typs des Artikel ('P','A','S') , deutch 'W', 'E', und 'D' für Ware
6444 Erzeugnis oder Dienstleistung, ggf. weitere Typen.</para>
6446 <para>Der zweite (und ggf. auch ein dritter Buchstabe, falls nötig)
6447 entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
6449 <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
6450 Erleichterung mit dargestellt.</para>
6454 <sect1 id="features.file_managment">
6455 <title>Dateiverwaltung (Mini-DMS)</title>
6458 <title>Übersicht</title>
6459 <para>Parallel zum alten WebDAV gibt es eine Datei-Management-Sytem, daß Dateien
6460 verschiedenen Typs verwaltet. Dies können</para>
6463 <para>aus ERP-Daten per LaTeX Template erzeugte PDF-Dokumente,</para>
6466 <para>zu bestimmten ERP-Daten gehörende Anhangdateien unterschiedlichen Formats,</para>
6469 <para>per Scanner eingelesene PDF-Dateien,</para>
6472 <para>per Email empfangene Dateianhänge unterschiedlichen Formats,</para>
6475 <para>sowie speziel an Artikel hochgeladene Bilder sein.</para>
6479 <screeninfo>Übersicht</screeninfo>
6482 <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
6489 <title>Struktur</title>
6491 <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:
6495 <para>Dateisystem,</para>
6498 <para>WebDAV,</para>
6501 <para>Schnittstelle zu externem Dokumenten-Management-System,</para>
6504 <para>andere Datenbank,</para>
6507 <para>etc ...</para>
6510 <para>Es gibt unterschiedliche Typen von Dateien, jedem Typ läßt sich in der
6511 Mandantenkonfigurierung ein bestimmtes Backend zuordnen.
6515 <para>"document", das sind entweder generierte,eingescannte oder hochgeladene PDF-Dateien,
6516 die zu bestimmten ERP-Daten (ERP-Objekte, wi z.B. Rechnung, Lieferschein) gehören.</para>
6519 <para>"attachment", zusätzlich hochgeladene Dokumente, die an bestimmte ERP-Objekte angehängt werden,
6520 z.B. technische Zeichnungen,Aufmaße. Diese können auch an Artikeln,
6521 Lieferanten und Kunden hinterlegt sein</para>
6524 <para>"image", Bilder an Artikeln. Diese können auch verkleinert in einer Vorschau (Thumbnail)
6525 angezeigt werden.</para>
6528 <para>Zusätzlich werden in der Datenbank zu den Dateien neben der Zuordnung zu ERP-Objekten, des Dateityps
6529 des Dateinamens und des Backends in dem die Datei gespeichert ist auch die Quelle der Datei notiert:
6533 <para> "created" , vom System erzeugte Dokumente"</para>
6536 <para> "uploaded", hochgeladene Dokumente</para>
6539 <para> "email", vom Mailsystem empfangene Dateien</para>
6542 <para> "scanner[1]", von einem oder mehreren Scannern erzeugte Dateien. Existieren mehrere Scanner,
6543 so sind diese durch unterschiedliche Quellennamen zu definieren</para>
6546 <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es für "attachment" und "image" nur
6547 die Quelle "uploaded". Für "document" gibt es auf jeden Fall die Quelle "created".
6548 Die Quellen "scanner" und "email" müssen derzeit in der Datenbank konfiguriert werden (siehe <xref linkend="file_management.dbconfig"/>.</para>
6552 <title>Anwendung</title>
6553 <para>Die Daten werden bei den ERP-Objekten als extra Reiter dargestellt.
6554 Eine Verkaufsrechnung z.B. hat die
6555 Reiter "Dokumente" und "Dateianhänge.</para>
6557 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6560 <imagedata scale="50" fileref="images/DMS-Anhaenge.png"/>
6564 <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer Datei angezeigt.
6565 Wird eine Datei mit gleichem Namen hochgeladen, so wird eine neue Version der Datei erstellt.
6566 Vorher wird der Anwender durch einen Dialog ob er eine neue Version anlegen will oder
6567 ob er die Datei umbenennen will, falls es eine neue Datei sein soll.</para>
6569 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6572 <imagedata width="100" contentwidth="40" fileref="images/DMS-Anhaenge-hochladen.png"/>
6576 <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
6577 solange in Summe die maximale Größe nicht überschritten wird.
6578 (siehe <xref linkend="file_management.clientconfig"/></para>
6580 <screeninfo>Reiter "Dokumente"</screeninfo>
6583 <imagedata width="500" fileref="images/DMS-Dokumente.png"/>
6587 <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt es nur "erzeugte Dokumente".
6588 Es werden alle Versionen der generierten Datei angezeigt. Für Verkaufsrechnungen kommen keine
6589 anderen Quellen zur Geltung. Werden entsprechend
6590 <xref linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert, so sind diese z.B. bei
6591 Einkaufsrechnungen sichtbar:</para>
6593 <screeninfo>Reiter "Dokumente"</screeninfo>
6596 <imagedata contentwidth="600" fileref="images/DMS-Dokumente-Scanner.png"/>
6600 <para>Statt des Löschens wird hier die Datei zurück zur Quelle verschoben. Somit kann die Datei anschließend
6601 an ein anderes ERP-Objekt angehängt werden.</para>
6602 <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie sind bisher nur bei Bildern relevant.</para>
6606 <title>Konfigurierung</title>
6607 <sect3 id="file_management.clientconfig" xreflabel="Mandantenkonfigurierung">
6608 <title>Mandantenkonfigurierung</title>
6610 <title>Reiter "Features"</title>
6611 <para>Unter dem Reiter <emphasis role="bold">Features</emphasis> im Abschnit Dateimanagement ist
6612 neben dem "alten" WebDAV das Dateimangement general zu- und abschaltbar, sowie die Zuordnung der
6613 Dateitypen zu Backends. Die Löschbarkeit von Dateien sowie die maximale Uploadgröße sind Backend-unabhängig</para>
6615 <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
6618 <imagedata width="500" fileref="images/DMS-ClientConfig.png"/>
6622 <para>Die einzelnen Backends sind einzeln einschaltbar. Spezifische Backend-Konfigurierungen sind hier
6623 noch ergänzbar.</para>
6626 <title>Reiter "Allgemeine Dokumentenanhänge"</title>
6627 <para>Unter dem Reiter <emphasis role="bold">Allgemeine Dokumentenanhänge</emphasis>
6628 kann für alle ERP-Dokumente ( Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und Einkauf )
6629 allgemeingültige Anhänge hochgeladen werden.</para>
6631 <screeninfo>Mandantenkonfig Reiter "Allgemeine Dokumentenanhänge"</screeninfo>
6634 <imagedata width="500" fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"/>
6638 <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die ERP-Dokumente angehängt,
6639 z.B. AGBs oder aktuelle Angebote. Es werden in dem Fall die Daten kopiert, sodaß an den ERP-Dokumenten immer
6640 die Anhänge zum Generierungszeitpunkt eingebettet sind.
6644 <sect3 id="file_management.dbconfig" xreflabel="Datenbank-Konfigurierung">
6645 <title>Datenbank-Konfigurierung</title>
6646 <para>Die zusätzlichen Quellen für email oder ein oder mehrere Scanner sind derzeit vom Administrator
6647 direkt in der Datenbanktablle "user_preferences" einzurichten. Die "value" ist im JSON-Format
6648 mit den jeweiligen Werten des Verzeichnisses und der Beschreibung der Quelle.</para>
6650 id | login | namespace | version | key | value
6651 ----+-----------+--------------+---------+----------+---------------------------
6652 1 | #default# | file_sources | 0.00000 | scanner1 |
6653 {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
6654 2 | #default# | file_sources | 0.00000 | scanner2 |
6655 {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
6656 3 | #default# | file_sources | 0.00000 | emails |
6657 {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
6659 <para>Es ist daran gedacht, statt dem default Eintrag später für bestimmte Benutzer ('login') bestimmte Quellen zuzulassen,
6660 dies wird nach Bedarf implementiert.</para>
6662 <sect3 id="file_management.kiviconfig" xreflabel="kivitendo-Konfigurationsdatei">
6663 <title>kivitendo-Konfigurationsdatei</title>
6664 <para>Dort ist im Abschnitt [paths] der relative oder absolute Pfad zum Dokumentenwurzelverzeichnis einzutragen.
6665 Dieser muss für den Webserver schreib- und lesbar sein, jedoch nicht ausführbar.</para>
6668 document_path = /var/local/kivi_documents
6670 <para>Unter diesem Wurzelverzeichnis wird pro Mandant automatisch ein Unterverzeichnis mit der ID des Mandanten angelegt</para>
6677 <title>Entwicklerdokumentation</title>
6679 <sect1 id="devel.globals" xreflabel="Globale Variablen">
6680 <title>Globale Variablen</title>
6683 <title>Wie sehen globale Variablen in Perl aus?</title>
6685 <para>Globale Variablen liegen in einem speziellen namespace namens
6686 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
6687 globs global und die meisten speziellen Variablen sind...
6690 <para>Daraus ergeben sich folgende Formen:</para>
6694 <term><literal>$main::form</literal></term>
6697 <para>expliziter Namespace "main"</para>
6702 <term><literal>$::form</literal></term>
6705 <para>impliziter Namespace "main"</para>
6710 <term><literal>open FILE, "file.txt"</literal></term>
6713 <para><varname>FILE</varname> ist global</para>
6718 <term><literal>$_</literal></term>
6721 <para>speziell</para>
6726 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
6727 Schlüsselwort wie "<function>global</function>", mit dem man
6728 importieren kann. <function>my</function>, <function>our</function>
6729 und <function>local</function> machen was anderes.</para>
6733 <term><literal>my $form</literal></term>
6736 <para>lexikalische Variable, gültig bis zum Ende des
6742 <term><literal>our $form</literal></term>
6745 <para><varname>$form</varname> referenziert ab hier
6746 <varname>$PACKAGE::form</varname>.</para>
6751 <term><literal>local $form</literal></term>
6754 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
6755 des scopes zurückgesetzt</para>
6762 <title>Warum sind globale Variablen ein Problem?</title>
6764 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
6766 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
6767 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
6768 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
6769 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
6770 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
6771 Datenbankverbindungen, weil die sehr lange zum Initialisieren
6774 <para>Das zweite Problem ist <function>strict</function>. Unter
6775 <function>strict</function> werden alle Variablen die nicht explizit
6776 mit <function>Package</function>, <function>my</function> oder
6777 <function>our</function> angegeben werden als Tippfehler angemarkert,
6778 dies hat, seit der Einführung, u.a. schon so manche langwierige
6779 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
6780 angegeben werden, werden die nicht geprüft, und somit kann sich
6781 schnell ein Tippfehler einschleichen.</para>
6785 <title>Kanonische globale Variablen</title>
6787 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
6788 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
6789 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
6790 umhergereicht werden.</para>
6792 <para>Diese Variablen sind im Moment die folgenden neun:</para>
6796 <para><varname>$::form</varname></para>
6800 <para><varname>%::myconfig</varname></para>
6804 <para><varname>$::locale</varname></para>
6808 <para><varname>$::lxdebug</varname></para>
6812 <para><varname>$::auth</varname></para>
6816 <para><varname>$::lx_office_conf</varname></para>
6820 <para><varname>$::instance_conf</varname></para>
6824 <para><varname>$::dispatcher</varname></para>
6828 <para><varname>$::request</varname></para>
6832 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
6833 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
6834 Eigenschaften (Konventionen):</para>
6837 <title>$::form</title>
6841 <para>Ist ein Objekt der Klasse
6842 "<classname>Form</classname>"</para>
6846 <para>Wird nach jedem Request gelöscht</para>
6850 <para>Muss auch in Tests und Konsolenscripts vorhanden
6855 <para>Enthält am Anfang eines Requests die Requestparameter vom
6860 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
6861 cachen, das wird aber momentan absichtlich zerstört</para>
6865 <para><varname>$::form</varname> wurde unter <productname>SQL
6866 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
6867 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
6868 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
6869 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
6870 <function>IS->retrieve_customer()</function> in Sicherheit
6873 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
6874 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
6875 3552, Stand version 2.7beta), um dies hinterher wieder auf den
6876 richtigen Wert zu setzen:</para>
6878 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
6879 $::myconfig{numberformat} = $numberformat;
6880 # (...) div Berechnungen
6881 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
6883 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
6884 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
6885 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
6886 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
6887 Es geht ziemlich sicher etwas kaputt.</para>
6889 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
6890 in den <productname>Template::Toolkit</productname> Templates
6891 außerhalb der Controller: der Ausdruck <function>[% var
6892 %]</function> greift auf <varname>$::form->{var}</varname> zu.
6893 Unter Controllern ist der Standard Scope anders, da lautet der
6894 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
6895 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
6896 <function><%var%></function> zeigt auf
6897 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
6898 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
6901 <programlisting>[%- IF business %]
6902 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
6903 [%- END %]</programlisting>
6905 <para>Entweder wird hier dann $::form->{business} ausgewertet
6906 oder aber der Funktion
6907 <function>$form->parse_html_template</function> wird explizit
6908 noch ein zusätzlicher Hash übergeben, der dann auch in den
6909 (Web-)Templates zu Verfügung steht, bspw. so:</para>
6911 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
6913 <para>Innerhalb von Schleifen wird
6914 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
6915 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
6916 welches über alle Positionen eines Lieferscheins in Schleife
6919 <programlisting>for $i (1 .. $form->{rowcount}) {
6921 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
6922 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
6923 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
6929 <title>%::myconfig</title>
6933 <para>Das einzige Hash unter den globalen Variablen</para>
6937 <para>Wird spätestens benötigt wenn auf die Datenbank
6938 zugegriffen wird</para>
6942 <para>Wird bei jedem Request neu erstellt.</para>
6946 <para>Enthält die Userdaten des aktuellen Logins</para>
6950 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
6951 extern serialisiert werden, weil da auch der Datenbankzugriff
6952 für diesen user drinsteht.</para>
6956 <para>Enthält unter anderem Datumsformat dateformat und Nummernformat numberformat</para>
6960 <para>Enthält Datenbankzugriffinformationen</para>
6964 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
6965 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
6966 aktuellen Users entscheiden müssen, befragen
6967 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
6968 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
6969 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
6970 Informationen über den Benutzer die über die
6971 Administrator-Schnittstelle eingegeben wurden.</para>
6975 <title>$::locale</title>
6979 <para>Objekt der Klasse "Locale"</para>
6983 <para>Wird pro Request erstellt</para>
6987 <para>Muss auch für Tests und Scripte immer verfügbar
6992 <para>Cached intern über Requestgrenzen hinweg benutzte
6997 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
6998 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
7002 <title>$::lxdebug</title>
7006 <para>Objekt der Klasse "LXDebug"</para>
7010 <para>Wird global gecached</para>
7014 <para>Muss immer verfügbar sein, in nahezu allen
7019 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
7020 bereit, wie "<function>enter_sub</function>" und
7021 "<function>leave_sub</function>", mit denen in den alten Modulen ein
7022 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
7023 der man die Wallclockzeit seit Requeststart loggen kann, sowie
7024 "<function>message</function>" und "<function>dump</function>" mit
7025 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
7028 <para>Beispielsweise so:</para>
7030 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
7031 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
7035 <title>$::auth</title>
7039 <para>Objekt der Klasse "SL::Auth"</para>
7043 <para>Wird global gecached</para>
7047 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
7051 <para>Wird nach jedem Request resettet.</para>
7055 <para><varname>$::auth</varname> stellt Funktionen bereit um die
7056 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
7057 vom aktuellen User abhängen wird das Objekt aus
7058 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
7059 Request kurz resettet.</para>
7061 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
7062 Dessen Einstellungen können über
7063 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
7064 ist ein Hash mit den Werten aus der Tabelle
7065 <literal>auth.clients</literal>.</para>
7069 <title>$::lx_office_conf</title>
7073 <para>Objekt der Klasse
7074 "<classname>SL::LxOfficeConf</classname>"</para>
7078 <para>Global gecached</para>
7082 <para>Repräsentation der
7083 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
7087 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
7088 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
7089 das Programm die Konfiguration ändern kann oder sollte.</para>
7091 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
7092 Debug- und Trace-Log-Datei wie folgt konfiguriert und
7095 <programlisting>[debug]
7096 file_name = /tmp/kivitendo-debug.log</programlisting>
7098 <para>ist der Key <varname>file</varname> im Programm als
7099 <varname>$::lx_office_conf->{debug}{file}</varname>
7103 <para>Zugriff auf die Konfiguration erfolgt im Moment über
7104 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
7109 <title>$::instance_conf</title>
7113 <para>Objekt der Klasse
7114 "<classname>SL::InstanceConfiguration</classname>"</para>
7118 <para>wird pro Request neu erstellt</para>
7122 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
7123 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
7124 ist hier eine Mandantendatenbank. Beispielsweise überprüft
7125 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
7126 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
7130 <title>$::dispatcher</title>
7134 <para>Objekt der Klasse
7135 "<varname>SL::Dispatcher</varname>"</para>
7139 <para>wird pro Serverprozess erstellt.</para>
7143 <para>enthält Informationen über die technische Verbindung zum
7148 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
7149 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
7150 Objekt untergebracht.</para>
7154 <title>$::request</title>
7158 <para>Hashref (evtl später Objekt)</para>
7162 <para>Wird pro Request neu initialisiert.</para>
7166 <para>Keine Unterstruktur garantiert.</para>
7170 <para><varname>$::request</varname> ist ein generischer Platz um
7171 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
7172 at a distance benutzt werden, sondern um lokales memoizing zu
7173 ermöglichen, das garantiert am Ende des Requests zerstört
7176 <para>Vieles von dem, was im moment in <varname>$::form</varname>
7177 liegt, sollte eigentlich hier liegen. Die groben
7178 Differentialkriterien sind:</para>
7182 <para>Kommt es vom User, und soll unverändert wieder an den
7183 User? Dann <varname>$::form</varname>, steht da eh schon</para>
7187 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
7188 Requests gebraucht werden? Dann
7189 <varname>$::request</varname></para>
7193 <para>Muss ich von anderen Teilen des Programms lesend drauf
7194 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
7195 Wrappermethode</para>
7202 <title>Ehemalige globale Variablen</title>
7204 <para>Die folgenden Variablen waren einmal im Programm, und wurden
7208 <title>$::cgi</title>
7212 <para>war nötig, weil cookie Methoden nicht als
7213 Klassenfunktionen funktionieren</para>
7217 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
7218 Klassennamespace gehalten wird und über Requestgrenzen
7223 <para>liegt jetzt unter
7224 <varname>$::request->{cgi}</varname></para>
7230 <title>$::all_units</title>
7234 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
7235 ein paar hundert mal pro Request eine Liste der Einheiten
7236 brauchen, und de als Parameter durch einen Riesenstack von
7237 Funktionen geschleift werden müssten.</para>
7241 <para>Liegt jetzt unter
7242 <varname>$::request->{cache}{all_units}</varname></para>
7247 <function>AM->retrieve_all_units()</function> gesetzt oder
7254 <title>%::called_subs</title>
7258 <para>wurde benutzt um callsub deep recursions
7263 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
7264 möglichen Rekursioenen darstellt, und da nie welche
7269 <para>komplette recursion protection wurde entfernt.</para>
7276 <sect1 id="devel.fcgi">
7277 <title>Entwicklung unter FastCGI</title>
7279 <sect2 id="devel.fcgi.general">
7280 <title>Allgemeines</title>
7282 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
7283 werden, muss der Webserver neu gestartet werden.</para>
7285 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
7286 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
7287 müssen folgende Aspekte beachtet werden.</para>
7290 <sect2 id="devel.fcgi.exiting">
7291 <title>Programmende und Ausnahmen</title>
7293 <para>Betrifft die Funktionen <function>warn</function>,
7294 <function>die</function>, <function>exit</function>,
7295 <function>carp</function> und <function>confess</function>.</para>
7297 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
7298 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
7299 am Laufen zu halten. Man kann mit <function>die</function>,
7300 <function>confess</function> oder <function>carp</function> Fehler
7301 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
7302 eigene <function>$::form-</function>error()> tut im Prinzip das
7303 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
7304 <function>exit</function> hingegen werden nicht abgefangen.
7305 <function>warn</function> wird direkt nach STDERR, also in Server Log
7306 eine Nachricht schreiben (sofern in der Konfiguration nicht die
7307 Warnungen in das kivitendo Log umgeleitet wurden), und
7308 <function>exit</function> wird die Ausführung beenden.</para>
7310 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
7311 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
7312 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
7313 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
7316 <sect2 id="devel.fcgi.globals">
7317 <title>Globale Variablen</title>
7319 <para>Um zu vermeiden, dass Informationen von einem Request in einen
7320 anderen gelangen, müssen alle globalen Variablen vor einem Request
7321 sauber initialisiert werden. Das ist besonders wichtig im
7322 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
7323 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
7326 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
7327 abgetrennten Block, der alle kanonischen globalen Variablen listet und
7328 erklärt. Bitte keine anderen einführen ohne das sauber zu
7329 dokumentieren.</para>
7331 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
7332 man sicher geht, dass man die richtige erwischt.</para>
7335 <sect2 id="devel.fcgi.performance">
7336 <title>Performance und Statistiken</title>
7338 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
7339 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
7340 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
7341 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
7342 sind es je nach Menge der definierten Variablen 1-2s. Ab der
7343 Moose/Rose::DB Version sind es 5-6s.</para>
7345 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
7346 den kritischen Pfaden, unter 0,15 sonst.</para>
7350 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
7351 <title>SQL-Upgradedateien</title>
7353 <sect2 id="db-upgrade-files.introduction"
7354 xreflabel="Einführung in die Datenbank-Upgradedateien">
7355 <title>Einführung</title>
7357 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
7358 gesteuert, die sich im Verzeichnis
7359 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
7360 muss pro Datenbankupgrade eine Datei existieren, die neben den
7361 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
7362 Kontrollinformationen enthält.</para>
7364 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
7365 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
7366 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
7367 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
7368 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
7369 Versionsnummern braucht.</para>
7371 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
7372 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
7373 führt diese nicht erneut aus. Dazu dient die Tabelle
7374 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
7375 angelegt wird.</para>
7378 <sect2 id="db-upgrade-files.format"
7379 xreflabel="Format der Upgradedateien">
7380 <title>Format der Kontrollinformationen</title>
7382 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
7383 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
7384 hat dabei das folgende Format:</para>
7386 <para>Für SQL-Upgradedateien:</para>
7388 <programlisting>-- @key: value</programlisting>
7390 <para>Für Perl-Upgradedateien:</para>
7392 <programlisting># @key: value</programlisting>
7394 <para>Leerzeichen vor "<varname>value</varname>" werden
7397 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
7401 <term><varname>tag</varname></term>
7404 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
7405 Dieser "tag" kann von anderen Kontrolldateien in ihren
7406 Abhängigkeiten verwendet werden (Schlüsselwort
7407 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
7408 in der Datenbank eingetragen wird.</para>
7410 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
7411 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
7413 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
7414 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
7415 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
7421 <term><varname>charset</varname></term>
7424 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
7425 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
7426 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
7427 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
7428 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
7429 hingegen müssen immer in UTF-8 encodiert sein und sollten
7430 demnach auch ein "<literal>use utf8;</literal>"
7436 <term><varname>description</varname></term>
7439 <para>Benötigt. Eine Beschreibung, was in diesem Update
7440 passiert. Diese wird dem Benutzer beim eigentlichen
7441 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
7442 sein sollte, sollte die Beschreibung auf Deutsch
7448 <term><varname>depends</varname></term>
7451 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
7452 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
7453 dass die in dieser Liste aufgeführten Scripte bereits
7454 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
7456 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
7457 Script "b" existiert, das von Änderungen in "a" abhängt, und
7458 eine neue Kontrolldatei für "c" erstellt wird, die von
7459 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
7460 Tag "b" als Abhängigkeit zu definieren.</para>
7462 <para>Es ist nicht erlaubt, sich selbst referenzierende
7463 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
7464 und "c" -> "a").</para>
7469 <term><varname>priority</varname></term>
7472 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
7473 der Scripte ausgeführt werden, die die gleichen
7474 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
7475 der Wert 1000 benutzt.</para>
7477 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
7478 "depends" benutzt werden. kivitendo sortiert die auszuführenden
7479 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
7480 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
7481 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
7482 dann "y", dann "z"), dann nach der Priorität und bei gleicher
7483 Priorität alphabetisch nach dem "tag".</para>
7488 <term><varname>ignore</varname></term>
7491 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
7492 Skript bei der Anmeldung ignoriert und entsprechend nicht
7499 <sect2 id="db-upgrade-files.format-perl-files"
7500 xreflabel="Format von Perl-Upgradedateien">
7501 <title>Format von in Perl geschriebenen
7502 Datenbankupgradescripten</title>
7504 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
7505 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
7506 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
7508 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
7509 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
7510 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
7511 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
7512 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
7513 aufgerufen wird.</para>
7515 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
7516 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
7517 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
7518 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
7519 "<literal>SL::DBUpgrade2::tag</literal>".</para>
7521 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
7522 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
7523 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
7525 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
7528 <programlisting># @tag: beispiel-upgrade-file42
7529 # @description: Ein schönes Beispielscript
7530 # @depends: release_3_1_0
7531 package SL::DBUpgrade2::beispiel_upgrade_file42;
7536 use parent qw(SL::DBUpgrade2::Base);
7541 # hier Aktionen ausführen
7550 <sect2 id="db-upgrade-files.dbupgrade-tool"
7551 xreflabel="Hilfsscript dbupgrade2_tool.pl">
7552 <title>Hilfsscript dbupgrade2_tool.pl</title>
7554 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
7555 existiert ein Hilfsscript namens
7556 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
7557 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
7558 liest alle Datenbankupgradescripte aus dem Verzeichnis
7559 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
7560 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
7561 von der Kommandozeile überprüft werden können.</para>
7563 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
7564 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
7565 sich aber auch Informationen auf verschiedene Art ausgeben
7570 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
7571 --list</command>"</para>
7573 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
7574 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
7575 würde. Es werden neben der Listenposition der Tag, die
7576 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
7580 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
7581 --tree</command>"</para>
7583 <para>Listet alle Tags in Baumform basierend auf den
7584 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
7585 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
7586 beim übergeordneten Script als Abhängigkeit eingetragen
7590 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
7591 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
7592 --rtree</command>"</para>
7594 <para>Listet alle Tags in Baumform basierend auf den
7595 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
7596 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
7597 die das übergeordnete Script als Abhängigkeit eingetragen
7602 <para>Baumform mit Postscriptausgabe:
7603 "<command>./scripts/dbupgrade2_tool.pl
7604 --graphviz</command>"</para>
7606 <para>Benötigt das Tool "<command>graphviz</command>", um mit
7607 seiner Hilfe die <link
7608 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
7609 Baumform</link> in eine Postscriptdatei namens
7610 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
7611 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
7612 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
7613 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
7618 <para>Scripte, von denen kein anderes Script abhängt:
7619 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
7621 <para>Listet die Tags aller Scripte auf, von denen keine anderen
7622 Scripte abhängen.</para>
7628 <sect1 id="translations-languages" xreflabel="Translations and languages">
7629 <title>Translations and languages</title>
7631 <sect2 id="translations-languages.introduction"
7632 xreflabel="Introduction to translations and languages">
7633 <title>Introduction</title>
7636 <para>Dieser Abschnitt ist in Englisch geschrieben, um
7637 internationalen Übersetzern die Arbeit zu erleichtern.</para>
7640 <para>This section describes how localization packages in kivitendo
7641 are built. Currently the only language fully supported is German, and
7642 since most of the internal messages are held in English the English
7643 version is usable too.</para>
7646 <sect2 id="translations-languages.character-set"
7647 xreflabel="Character set">
7648 <title>Character set</title>
7650 <para>All files included in a language pack must use UTF-8 as their
7654 <sect2 id="translations-languages.file-structure"
7655 xreflabel="File structure">
7656 <title>File structure</title>
7658 <para>The structure of locales in kivitendo is:</para>
7660 <programlisting>kivitendo/locale/<langcode>/</programlisting>
7662 <para>where <langcode> stands for an abbreviation of the
7663 language package. The builtin packages use two letter <ulink
7664 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
7665 but the actual name is not relevant for the program and can easily be
7667 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
7668 tags</ulink> (i.e. "en_GB"). In fact the original language packages
7669 from SQL Ledger are named in this way.</para>
7671 <para>In such a language directory the following files are
7676 <term>LANGUAGE</term>
7679 <para>This file is mandatory.</para>
7681 <para>The <filename>LANGUAGE</filename> file contains the self
7682 descripted name of the language. It should contain a native
7683 representation first, and in parenthesis an english translation
7684 after that. Example:</para>
7686 <programlisting>Deutsch (German)</programlisting>
7694 <para>This file is mandatory.</para>
7696 <para>The central translation file. It is essentially an inline
7697 Perl script autogenerated by <command>locales.pl</command>. To
7698 generate it, generate the directory and the two files mentioned
7699 above, and execute the following command:</para>
7701 <programlisting>scripts/locales.pl <langcode></programlisting>
7703 <para>Otherwise you can simply copy one of the other languages.
7704 You will be told how many are missing like this:</para>
7706 <programlisting>$ scripts/locales.pl en
7707 English - 0.6% - 2015/2028 missing</programlisting>
7709 <para>A file named "<filename>missing</filename>" will be
7710 generated and can be edited. You can also edit the
7711 "<filename>all</filename>" file directly. Edit everything you
7712 like to fit the target language and execute
7713 <command>locales.pl</command> again. See how the missing words
7719 <term>Num2text</term>
7722 <para>Legacy code from SQL Ledger. It provides a means for
7723 numbers to be converted into natural language, like
7724 <literal>1523 => one thousand five hundred twenty
7725 three</literal>. If you want to provide it, it must be inlinable
7726 Perl code which provides a <function>num2text</function> sub. If
7727 an <function>init</function> sub exists it will be executed
7730 <para>Only used in the check and receipt printing module.</para>
7735 <term>special_chars</term>
7738 <para>kivitendo comes with a lot of interfaces to different
7739 formats, some of which are rather picky with their accepted
7740 charset. The <filename>special_chars</filename> file contains a
7741 listing of chars not suited for different file format and
7742 provides substitutions. It is written in "Simple Ini" style,
7743 containing a block for every file format.</para>
7745 <para>First entry should be the order of substitution for
7746 entries as a whitespace separated list. All entries are
7747 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
7748 and <literal>\\</literal> all work.</para>
7750 <para>After that every entry is a special char that should be
7751 translated when writing text into such a file.</para>
7753 <para>Example:</para>
7755 <programlisting>[Template/XML]
7756 order=& < > \n
7760 \n=<br></programlisting>
7762 <para>Note the importance of the order in this example.
7763 Substituting < and > befor & would lead to $gt; become
7766 <para>For a list of valid formats, see the German
7767 <filename>special_chars</filename> entry. As of this writing the
7768 following are recognized:</para>
7770 <programlisting>HTML
7775 Template/OpenDocument
7776 filenames</programlisting>
7778 <para>The last of which is very machine dependant. Remember that
7779 a lot of characters are forbidden by some filesystems, for
7780 example MS Windows doesn't like ':' in its files where Linux
7781 doesn't mind that. If you want the files created with your
7782 language pack to be portable, find all chars that could cause
7788 <term>missing</term>
7791 <para>This file is not a part of the language package
7794 <para>This is a file generated by
7795 <command>scripts/locales.pl</command> while processing your
7796 locales. It's only to have the missing entries singled out and
7797 does not belong to a language package.</para>
7805 <para>This file is not a part of the language package
7808 <para>Another file generated by
7809 <command>scripts/locales.pl</command>. If for any reason a
7810 translation does not appear anymore and can be deleted, it gets
7811 moved here. The last 50 or so entries deleted are saved here in
7812 case you made a typo, so that you don't have to translate
7813 everything again. If a tranlsation is missing, the lost file is
7814 checked first. If you maintain a language package, you might
7815 want to keep this safe somewhere.</para>
7820 <term>more/all</term>
7823 <para>This subdir and file is not a part of the language package
7826 <para>If the directory more exists and contains a file called
7827 all it will be parsed in addition to the mandatory all (see
7828 above). The file is useful if you want to change some
7829 translations for the current installation without conflicting
7830 further upgrades. The file is not autogenerated and has the same
7831 format as the all, but needs another key (more_texts). See the
7832 german translation for an example or copy the following code:
7835 # -*- coding: utf-8; -*-
7840 # These are additional texts for custom translations.
7841 # The format is the same as for the normal file all, only
7842 # with another key (more_texts instead of texts).
7843 # The file has the form of 'english text' => 'foreign text',
7845 $self->{more_texts} = {
7847 'Ship via' => 'Terms of delivery',
7848 'Shipping Point' => 'Delivery time',
7850 </programlisting></para>
7857 <sect1 id="devel.testsuite">
7858 <title>Die kivitendo-Test-Suite</title>
7860 <sect2 id="devel.testsuite.intro">
7861 <title>Einführung</title>
7863 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
7864 basiert auf dem Standard-Perl-Modul
7865 <literal>Test::More</literal>.</para>
7867 <para>Die grundlegenden Fakten sind:</para>
7871 <para>Alle Tests liegen im Unterverzeichnis
7872 <filename>t/</filename>.</para>
7876 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
7877 enthält einen oder mehrere Testfälle.</para>
7881 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
7882 Es sind selbstständig ausführbare Perl-Scripte.</para>
7886 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
7887 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
7888 auf <literal>.t</literal> endet.</para>
7893 <sect2 id="devel.testsuite.prerequisites">
7894 <title>Voraussetzungen</title>
7896 <para>Für die Ausführung werden neben den für kivitendo eh schon
7897 benötigten Module noch weitere Perl-Module benötigt. Diese
7902 <para><literal>Test::Deep</literal> (Debian-Paketname:
7903 <literal>libtest-deep-perl</literal>; Fedora:
7904 <literal>perl-Test-Deep</literal>; openSUSE:
7905 <literal>perl-Test-Deep</literal>)</para>
7909 <para><literal>Test::Exception</literal> (Debian-Paketname:
7910 <literal>libtest-exception-perl</literal>; Fedora:
7911 <literal>perl-Test-Exception</literal>; openSUSE:
7912 <literal>perl-Test-Exception</literal>)</para>
7916 <para><literal>Test::Output</literal> (Debian-Paketname:
7917 <literal>libtest-output-perl</literal>; Fedora:
7918 <literal>perl-Test-Output</literal>; openSUSE:
7919 <literal>perl-Test-Output</literal>)</para>
7923 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
7924 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
7925 kann für frühere Versionen aus dem <ulink
7926 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
7930 <para><literal>LWP::Simple</literal> aus dem Paket
7931 <literal>libwww-perl</literal> (Debian-Panetname:
7932 <literal>libwww-perl</literal>; Fedora:
7933 <literal>perl-libwww-perl</literal>; openSUSE:
7934 <literal>perl-libwww-perl</literal>)</para>
7938 <para><literal>URI::Find</literal> (Debian-Panetname:
7939 <literal>liburi-find-perl</literal>; Fedora:
7940 <literal>perl-URI-Find</literal>; openSUSE:
7941 <literal>perl-URI-Find</literal>)</para>
7945 <para><literal>Sys::CPU</literal> (Debian-Panetname: <literal>libsys-cpu-perl</literal>; Fedora und openSUSE: nicht
7950 <para><literal>Thread::Pool::Simple</literal> (Debian-Panetname: <literal>libthread-pool-simple-perl</literal>; Fedora und
7951 openSUSE: nicht vorhanden)</para>
7955 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
7956 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
7957 müssen in der Konfigurationsdatei im Abschnit
7958 <literal>testing/database</literal> Datenbankverbindungsparameter
7959 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
7960 Recht haben, Datenbanken anzulegen und zu löschen.</para>
7963 <sect2 id="devel.testsuite.execution">
7964 <title>Existierende Tests ausführen</title>
7966 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
7967 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
7968 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
7969 <filename>t/test.pl</filename>.</para>
7971 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
7972 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
7973 kivitendo-Basisverzeichnis heraus ausführen.</para>
7975 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
7976 an <filename>t/test.pl</filename>. Beispielsweise:</para>
7978 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
7981 <sect2 id="devel.testsuite.meaning_of_scripts">
7982 <title>Bedeutung der verschiedenen Test-Scripte</title>
7984 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
7985 Programmierstil. Einige besonders zu erwähnende, weil auch während der
7986 Entwicklung nützliche Tests sind:</para>
7990 <para><filename>t/001compile.t</filename> -- compiliert alle
7991 Quelldateien und bricht bei Fehlern sofort ab</para>
7995 <para><filename>t/002goodperl.t</filename> -- überprüft alle
7996 Perl-Dateien auf Anwesenheit von '<literal>use
7997 strict</literal>'-Anweisungen</para>
8001 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
8002 <function>system()</function> und <function>exec()</function> auf
8007 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
8008 Tab-Zeichen enthalten</para>
8012 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
8013 Rechtschreibfehlern</para>
8017 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
8018 Dokumentation im POD-Format auf Gültigkeit</para>
8022 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
8023 einzelner Funktionen und Module.</para>
8026 <sect2 id="devel.testsuite.create_new">
8027 <title>Neue Test-Scripte erstellen</title>
8029 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
8030 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
8031 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
8034 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
8035 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
8038 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
8043 <para>Überprüfung auf fehlende symbolische Links</para>
8047 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
8048 gewissen Einschränkungen wie das Erlauben von deutschen
8053 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
8057 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
8061 <para>Test, ob alle zu übersetzenden Strings in
8062 <filename>locale/de/all</filename> vorhanden sind</para>
8066 <para>Test, ob alle Webseiten-Templates in
8067 <filename>templates/webpages</filename> mit vom Perl-Modul
8068 <literal>Template</literal> compiliert werden können</para>
8073 <sect3 id="devel.testsuite.directory_and_test_names">
8074 <title>Konvention für Verzeichnis- und Dateinamen</title>
8076 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
8077 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
8078 und ihnen soweit es geht folgen:</para>
8082 <para>Die Dateiendung muss <filename>.t</filename>
8087 <para>Namen sind englisch, komplett klein geschrieben und
8088 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
8089 <filename>bad_function_params.t</filename>).</para>
8093 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
8094 benannt sein, mit dem sich die Scripte darin befassen
8095 (beispielsweise <filename>background_jobs</filename> für Tests
8096 rund um Hintergrund-Jobs).</para>
8100 <para>Test-Scripte sollten einen überschaubaren Bereich von
8101 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
8102 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
8103 Test-Scripte schreiben.</para>
8108 <sect3 id="devel.testsuite.minimal_example">
8109 <title>Minimales Skelett für eigene Scripte</title>
8111 <para>Der folgenden Programmcode enthält das kleinstmögliche
8112 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
8115 <programlisting>use Test::More tests => 0;
8119 use Support::TestSetup;
8121 Support::TestSetup::login();</programlisting>
8123 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
8124 benötigt (Stichwort: alle globalen Variablen wie
8125 <varname>$::auth</varname>, <varname>$::form</varname> oder
8126 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
8127 <filename>config/kivitendo.conf</filename> im Abschnitt
8128 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
8129 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
8131 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
8132 kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
8133 weggelassen werden, was die Ausführungszeit des Scripts leicht
8139 <sect1 id="devel.style-guide">
8140 <title>Stil-Richtlinien</title>
8142 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
8143 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
8144 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
8145 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
8147 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
8150 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
8151 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
8156 <para>Es werden keine echten Tabs sondern Leerzeichen
8161 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
8163 <programlisting>foreach my $row (@data) {
8165 # do something with $row
8169 $row->{modules} = MODULE->retrieve(
8170 id => $row->{id},
8171 date => $use_now ? localtime() : $row->{time},
8175 $report->add($row);
8180 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
8181 Zeile wie der letzte Befehl. Beispiele:</para>
8183 <programlisting>sub debug {
8189 <programlisting>if ($form->{item_rows} > 0) {
8195 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
8196 der Befehl / die öffnende schließende Klammer, die den Block
8197 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
8198 Beispiele wie bei 3. gelten.</para>
8202 <para>Die Wörter "<function>else</function>",
8203 "<function>elsif</function>", "<function>while</function>" befinden
8204 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
8207 <programlisting>if ($form->{sum} > 1000) {
8209 } elsif ($form->{sum} > 0) {
8217 } until ($a > 0);</programlisting>
8221 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
8222 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
8223 und grep-ähnliche Operatoren. Beispiel:</para>
8225 <programlisting>$main::lxdebug->message("Could not find file.");
8226 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
8230 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
8232 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
8233 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
8234 Blöcke schon. Beispiel:</para>
8236 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
8241 $form->{sum} += $form->{"row_$i"};
8242 $form->{ $form->{index} } += 1;
8244 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
8248 <para>Mehrzeilige Befehle</para>
8252 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
8253 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
8254 werden, in der die ersten Funktionsparameter in der ersten Zeile
8255 stehen. Beispiel:</para>
8257 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
8258 $form->{some_col_value});</programlisting>
8262 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
8263 besten in einer übersichtlichen Tabellenstruktur organisiert
8264 wird. Beispiel:</para>
8266 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
8267 : $form->{oldcount} ? $form->{oldcount} + 1
8268 : $form->{rowcount} - $form->{rowbase};</programlisting>
8274 <para>Kommentare</para>
8278 <para>Kommentare, die alleine in einer Zeile stehen, sollten
8279 soweit wie der Code eingerückt sein.</para>
8283 <para>Seitliche hängende Kommentare sollten einheitlich
8284 formatiert werden.</para>
8288 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
8289 auf Englisch zu verfassen. So wie ich keine Lust habe,
8290 französischen Quelltext zu lesen, sollte auch der kivitendo
8291 Quelltext für nicht-Deutschsprachige lesbar sein.
8294 <programlisting>my $found = 0;
8302 $i = 0 # initialize $i
8304 $i *= $const; # do something crazy
8305 $i = $n; # recover $i</programlisting>
8311 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
8312 Interpolation gewünscht ist. Beispiel:</para>
8314 <programlisting>$form->{sum} = 0;
8315 $form->{"row_$i"} = $form->{"row_$i"} - 5;
8316 $some_hash{42} = 54;</programlisting>
8320 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
8321 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
8322 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
8323 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
8325 <para>Als Beispiel sei die Funktion
8326 <function>print_options</function> aus
8327 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
8331 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
8332 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
8335 <para>Emacs und vim haben beide recht einfache Methoden zur
8336 Entfernung von trailing whitespace. Emacs kennt das Kommande
8337 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
8338 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
8339 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
8344 <para>Es wird kein <command>perltidy</command> verwendet.</para>
8346 <para>In der Vergangenheit wurde versucht,
8347 <command>perltidy</command> zu verwenden, um einen einheitlichen
8348 Stil zu erlangen. Es hat sich aber gezeigt, dass
8349 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
8350 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
8351 den Interessierten sind hier die
8352 <command>perltidy</command>-Optionen, die grob den beschriebenen
8353 Richtlinien entsprechen:</para>
8355 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
8356 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
8357 -lp -vt=1 -vtc=1</programlisting>
8361 <para><varname>STDERR</varname> ist tabu. Unkonditionale
8362 Debugmeldungen auch.</para>
8364 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
8365 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
8366 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
8368 <para>Die <classname>LXDebug</classname>-Methode
8369 "<function>message</function>" nimmt als ersten Paramter außerdem
8370 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
8371 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
8372 und werden in den meisten Fällen auch vom Repository
8373 zurückgewiesen.</para>
8377 <para>Alle neuen Module müssen use strict verwenden.</para>
8379 <para><varname>$form</varname>, <varname>$auth</varname>,
8380 <varname>$locale</varname>, <varname>$lxdebug</varname> und
8381 <varname>%myconfig</varname> werden derzeit aus dem main package
8382 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
8383 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
8388 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
8389 <title>Dokumentation erstellen</title>
8391 <sect2 id="devel.build-doc.introduction">
8392 <title>Einführung</title>
8394 <para>Diese Dokumentation ist in <productname>DocBook</productname>
8395 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
8396 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
8397 Editor nutzt, der spezielle Unterstützung für
8398 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
8399 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
8400 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
8404 <sect2 id="devel.build-doc.required-software">
8405 <title>Benötigte Software</title>
8407 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
8408 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
8409 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
8410 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
8411 <command>scripts/build_doc.sh</command>.</para>
8413 <para>Das Script benötigt zur Konvertierung verschiedene
8414 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
8420 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
8421 in einer halbwegs aktuellen Version</para>
8425 <para>Das Java-Build-System <ulink
8426 url="http://ant.apache.org/">Apache Ant</ulink></para>
8430 <para>Das Dokumentations-System Dobudish für
8431 <productname>DocBook</productname> 4.5, eine Zusammenstellung
8432 diverser Stylesheets und Grafiken zur Konvertierung von
8433 <productname>DocBook</productname> XML in andere Formate. Das
8434 Paket, das benötigt wird, ist zum Zeitpunkt der
8435 Dokumentationserstellung
8436 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
8437 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
8442 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
8443 sind auf allen gängigen Plattformen verfügbar. Beispiel für
8444 Debian/Ubuntu:</para>
8446 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
8448 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
8449 <filename>doc/build</filename> entpackt werden. Beispiel unter der
8450 Annahme, das <productname>Dobudish</productname> in
8451 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
8453 <programlisting>cd doc/build
8454 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
8457 <sect2 id="devel.build-doc.build">
8458 <title>PDFs und HTML-Seiten erstellen</title>
8460 <para>Die eigentliche Konvertierung erfolgt nach Installation der
8461 benötigten Software mit einem einfachen Aufruf direkt aus dem
8462 kivitendo-Installationsverzeichnis heraus:</para>
8464 <programlisting>./scripts/build_doc.sh</programlisting>
8467 <sect2 id="devel.build-doc.repository">
8468 <title>Einchecken in das Git-Repository</title>
8470 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
8471 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
8472 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
8473 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
8475 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
8476 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob