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: 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 kivitendo-Forum: <ulink
15 url="https://forum.kivitendo.org/">https://forum.kivitendo.org/</ulink></para>
19 <para>im alten Lx-Office-Wiki unter Dokumentation (<ulink
20 url="http://wiki.lx-office.org/index.php?title=Installation_Lx-Office_ERP">http://wiki.lx-office.org/index.php?title=Installation_Lx-Office_ERP</ulink>)</para>
26 <title>Installation und Grundkonfiguration</title>
28 <sect1 id="Benötigte-Software-und-Pakete">
29 <title>Benötigte Software und Pakete</title>
31 <sect2 id="Betriebssystem">
32 <title>Betriebssystem</title>
34 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
35 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
36 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
37 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
38 ohne große Probleme auf den derzeit aktuellen verbreiteten
39 Distributionen läuft.</para>
41 <para>Mitte 2012 sind das folgende Systeme, von denen bekannt ist,
42 dass kivitendo auf ihnen läuft:</para>
46 <para>Ubuntu 10.04 LTS Lucid Lynx bis 12.04 Precise Pangolin</para>
50 <para>Debian 5.0 Lenny und 6.0 Squeeze</para>
54 <para>openSUSE 11.2 und 11.3</para>
58 <para>SuSE Linux Enterprice Server 11</para>
62 <para>Fedora 13 bis 16</para>
67 <sect2 id="Pakete" xreflabel="Pakete">
70 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
71 Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2)
74 <para>Zusätzlich benötigt kivitendo die folgenden Perl-Pakete, die
75 nicht Bestandteil einer Standard-Perl-Installation sind:</para>
83 <para>Archive::Zip</para>
87 <para>Config::Std</para>
103 <para>Email::Address</para>
111 <para>List::MoreUtils</para>
115 <para>Params::Validate</para>
119 <para>PDF::API2</para>
123 <para>Rose::Object</para>
127 <para>Rose::DB</para>
131 <para>Rose::DB::Object</para>
135 <para>Template</para>
139 <para>Text::CSV_XS</para>
143 <para>Text::Iconv</para>
151 <para>XML::Writer</para>
159 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
160 hinzugekommen, <literal>URI</literal> und
161 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
164 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
165 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
166 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
167 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
169 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
170 hinzugekommen.</para>
172 <para><literal>Email::Address</literal> und
173 <literal>List::MoreUtils</literal> sind schon länger feste
174 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
175 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
176 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
177 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
180 <para>Die zu installierenden Pakete können in den verschiedenen
181 Distributionen unterschiedlich heißen.</para>
183 <para>Für Debian oder Ubuntu benötigen Sie diese Pakete:</para>
185 <programlisting>apt-get install apache2 postgresql libparent-perl libarchive-zip-perl \
186 libdatetime-perl libdbi-perl libdbd-pg-perl libpg-perl \
187 libemail-address-perl liblist-moreutils-perl libpdf-api2-perl \
188 librose-object-perl librose-db-perl librose-db-object-perl \
189 libtemplate-perl libtext-csv-xs-perl libtext-iconv-perl liburi-perl \
190 libxml-writer-perl libyaml-perl libconfig-std-perl \
191 libparams-validate-perl libjson-perl libclass-accessor-perl</programlisting>
193 <para>Für Fedora Core benötigen Sie diese Pakete:</para>
195 <programlisting>yum install httpd postgresql-server perl-parent perl-DateTime \
196 perl-DBI perl-DBD-Pg perl-Email-Address perl-List-MoreUtils \
197 perl-PDF-API2 perl-Rose-Object perl-Rose-DB perl-Rose-DB-Object \
198 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
199 perl-XML-Writer perl-YAML</programlisting>
201 <para>Für OpenSuSE benötigen Sie diese Pakete:</para>
203 <programlisting>zypper install apache2 postgresql-server perl-Archive-Zip \
204 perl-DateTime perl-DBI perl-DBD-Pg perl-MailTools perl-List-MoreUtils \
205 perl-PDF-API2 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
206 perl-URI perl-XML-Writer perl-YAML</programlisting>
208 <para>Bei openSuSE 11 ist <literal>parent</literal> bereits enthalten,
209 und braucht nicht nachinstalliert werden. Die
210 <literal>Rose::*</literal> Pakete sind derzeit nicht für SuSE gepackt,
211 und müssen anderweitig nachinstalliert werden.</para>
213 <para>kivitendo enthält ein Script, mit dem überprüft werden kann, ob
214 alle benötigten Perl-Module installiert sind. Der Aufruf lautet wie
217 <programlisting>./scripts/installation_check.pl</programlisting>
221 <sect1 id="Manuelle-Installation-des-Programmpaketes"
222 xreflabel="Manuelle Installation des Programmpaketes">
223 <title>Manuelle Installation des Programmpaketes</title>
225 <para>Die kivitendo ERP Installationsdatei (kivitendo-erp-2.6.3.tgz) wird
226 im Dokumentenverzeichnis des Webservers (z.B.
227 <filename>/var/www/html/</filename>,
228 <filename>/srv/www/htdocs</filename> oder
229 <filename>/var/www/</filename>) entpackt:</para>
231 <programlisting>cd /var/www
232 tar xvzf kivitendo-erp-2.6.3.tgz</programlisting>
234 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
236 <programlisting>cd kivitendo-erp</programlisting>
238 <para>Alternativ können Sie auch einen Alias in der
239 Webserverkonfiguration benutzen, um auf das tatsächliche
240 Installationsverzeichnis zu verweisen.</para>
242 <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
243 beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
244 Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
245 core <constant>apache</constant> oder bei OpenSuSE <constant>wwwrun</constant>).</para>
247 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
248 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
250 <programlisting>chown -R www-data users spool webdav</programlisting>
252 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
253 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>
255 <programlisting>chown www-data templates users</programlisting>
258 <sect1 id="config.config-file">
259 <title>kivitendo-Konfigurationsdatei</title>
261 <sect2 id="config.config-file.introduction"
262 xreflabel="Einführung in die Konfigurationsdatei">
263 <title>Einführung</title>
265 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei,
266 die benötigt wird: <filename>config/kivitendo.conf</filename> (kurz:
267 "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
268 von kivitendo bzw. der Migration von älteren Versionen angelegt
271 <para>Als Vorlage dient die Datei
272 <filename>config/kivitendo.conf.default</filename> (kurz: "die
273 Default-Datei"):</para>
275 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
277 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
278 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
279 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
280 Abschnitte und Werte enthalten, die von denen der Default-Datei
285 Vor der Umbenennung in kivitendo hieß diese Datei noch <filename>config/lx_office.conf</filename>. Aus Gründen der Kompatibilität
286 wird diese Datei eingelesen, sofern die Datei <filename>config/kivitendo.conf</filename> nicht existiert.
290 <para>Diese Hauptkonfigurationsdatei ist dann eine
291 installationsspezifische Datei, d.h. sie enthält bspw. lokale
292 Passwörter und wird auch nicht im Versionsmanagement (git)
295 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
296 Mandaten, bzw. Datenbanken gleich.</para>
299 <sect2 id="config.config-file.sections-parameters">
300 <title>Abschnitte und Parameter</title>
302 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
303 entsprechend kommentiert sind:</para>
307 <para><literal>authentication</literal></para>
311 <para><literal>authentication/database</literal></para>
315 <para><literal>authentication/ldap</literal></para>
319 <para><literal>system</literal></para>
323 <para><literal>features</literal></para>
327 <para><literal>paths</literal></para>
331 <para><literal>applications</literal></para>
335 <para><literal>environment</literal></para>
339 <para><literal>print_templates</literal></para>
343 <para><literal>task_server</literal></para>
347 <para><literal>periodic_invoices</literal></para>
351 <para><literal>console</literal></para>
355 <para><literal>debug</literal></para>
359 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
360 einzustellen oder zu kontrollieren sind, sind:</para>
362 <programlisting>[authentication]
363 admin_password = geheim
365 [authentication/database]
373 dbcharset = UTF-8</programlisting>
375 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
376 <varname>[periodic_invoices]</varname> den Login eines Benutzers
377 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
378 mit Informationen über die erstellten Rechnungen bekommt.</para>
380 <para>Nutzt man den <link
381 linkend="config.task-server">Taskserver</link> für <link
382 linkend="features.periodic-invoices">wiederkehrende Rechnungen</link>,
383 muss unter <varname>[task_server]</varname> ein Login eines Benutzers
384 angegeben werden, mit dem sich der Taskserver an kivitendo bei der
385 Datenbank anmeldet, die dem Benutzer zugewiesen ist.</para>
387 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
388 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
391 <sect2 id="config.config-file.prior-versions">
392 <title>Versionen vor 2.6.3</title>
394 <para>In älteren kivitendo Versionen gab es im Verzeichnis
395 <filename>config</filename> die Dateien
396 <filename>authentication.pl</filename> und
397 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
398 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
399 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
400 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
402 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
403 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
404 manuell übertragen und die alten Konfigurationsdateien anschließend
405 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
406 entsprechende Fehlermeldung an.</para>
410 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
411 <title>Anpassung der PostgreSQL-Konfiguration</title>
413 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
415 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
416 <title>Zeichensätze/die Verwendung von UTF-8</title>
418 <para>Bei aktuellen Serverinstallationen braucht man hier meist nicht
421 <para>Dieses kann überprüft werden: ist das Encoding der Datenbank
422 “template1” “UTF8”, so braucht man nichts weiteres diesbezueglich
423 unternehmen. Zum Testen:
425 <programlisting>su postgres
427 exit </programlisting>
429 Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
430 UTF-8-Encoding anzulegen und diesen zu verwenden. Unter Debian und
431 Ubuntu kann dies z.B. für PostgreSQL 8.2 mit dem folgenden Befehl
434 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2 clustername</programlisting>
436 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
437 Versionsnummer angepasst werden.</para>
439 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
441 <para>Wurde PostgreSQL nicht mit UTF-8 als Encoding initialisiert und
442 ist ein Neuanlegen eines weiteren Clusters nicht möglich, so kann
443 kivitendo mit ISO-8859-15 als Encoding betrieben werden.</para>
445 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
446 <literal>\l</literal> geprüft werden.</para>
449 <sect2 id="Änderungen-an-Konfigurationsdateien">
450 <title>Änderungen an Konfigurationsdateien</title>
452 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
453 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
454 <filename>/var/lib/pgsql/data/</filename> oder
455 <filename>/etc/postgresql/</filename>, muss sichergestellt werden,
456 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
457 Parameter <varname>listen_address</varname> gesteuert. Laufen
458 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
459 <literal>localhost</literal> verwendet werden. Andernfalls müssen
460 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
461 was mit dem Wert <literal>*</literal> geschieht.</para>
463 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
464 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
465 sein sollte, müssen die Berichtigungen für den Zugriff geändert
466 werden. Hier gibt es mehrere Möglichkeiten. sinnvoll ist es nur die
467 nögiten Verbindungen immer zuzulassen, für eine lokal laufenden
468 Datenbank zum Beispiel:</para>
470 <programlisting>local all kivitendo password
471 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
474 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
475 <title>Erweiterung für servergespeicherte Prozeduren</title>
477 <para>In der Datenbank <literal>template1</literal> muss die
478 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
479 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
480 <programlisting>su - postgres
481 psql template1</programlisting>
483 führen Sie die folgenden Kommandos aus:</para>
485 <programlisting>create language 'plpgsql';
489 <sect2 id="Datenbankbenutzer-anlegen">
490 <title>Datenbankbenutzer anlegen</title>
492 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
493 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
494 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
497 <programlisting>su - postgres
498 createuser -d -P kivitendo
499 exit</programlisting>
501 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
502 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.
503 den hier gewählten Benutzernamen.</para>
507 <sect1 id="Apache-Konfiguration">
508 <title>Webserver-Konfiguration</title>
511 <title>Grundkonfiguration mittels CGI</title>
514 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
515 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
516 <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
519 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
520 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
521 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
522 anderen Datei hinzu, die beim Starten des Webservers eingelesen
525 <programlisting>AddHandler cgi-script .pl
526 Alias /kivitendo-erp/ /var/www/kiviteno-erp/
528 <Directory /var/www/kivitendo-erp>
529 Options ExecCGI Includes FollowSymlinks
532 <Directory /var/www/kivitendo-erp/users>
535 </Directory></programlisting>
537 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
538 das kivitendo-Archiv entpacket haben.</para>
541 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
542 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
545 <para>Auf einigen Webservern werden manchmal die Grafiken und
546 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
547 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
549 <programlisting>EnableSendfile Off</programlisting>
552 <sect2 id="Apache-Konfiguration.FCGI"
553 xreflabel="Konfiguration für FastCGI/FCGI">
554 <title>Konfiguration für FastCGI/FCGI</title>
556 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
557 <title>Was ist FastCGI?</title>
559 <para>Direkt aus <ulink
560 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
563 <para><citation> FastCGI ist ein Standard für die Einbindung
564 externer Software zur Generierung dynamischer Webseiten in einem
565 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
566 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
567 umgehen. </citation></para>
570 <sect3 id="Apache-Konfiguration.FCGI.Warum">
571 <title>Warum FastCGI?</title>
573 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
574 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
575 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
576 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
577 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
578 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
579 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
580 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
581 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
582 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
583 deutlich länger dauert als früher, und dass davon 90% für das Laden
584 der Module verwendet wird.</para>
586 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
587 wird nur die eigentliche Programmlogik ausgeführt.</para>
590 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
591 <title>Getestete Kombinationen aus Webservern und Plugin</title>
593 <para>Folgende Kombinationen sind getestet:</para>
597 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
601 <para>Apache 2.2.11 (Ubuntu) und mod_fastcgi.</para>
605 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
606 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
607 mod_fastcgi nicht mehr explizit eingegangen.</para>
609 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
613 <para>FCGI 0.69 und höher ist extrem strict in der Behandlung von
614 Unicode, und verweigert bestimmte Eingaben von kivitendo. Falls es
615 Probleme mit Umlauten in Ihrere Installation gibt, muss auf die
616 Vorgängerversion FCGI 0.68 ausgewichen werden.</para>
618 <para>Mit CPAN lässt sie sich die Vorgängerversion wie folgt
621 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
625 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
626 <title>Konfiguration des Webservers</title>
628 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
629 laufen zu lassen, empfliehlt es sich die Installation ersteinmal
630 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
631 debuggen die beim ersten aufsetzen auftreten können. Sollte die
632 Installation schon funktionieren, lesen Sie weiter.</para>
634 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
635 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
637 <programlisting>a2enmod fcgid</programlisting>
639 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
640 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
641 und <function>Directory</function>-Direktiven. Dabei wird zwischen
642 dem Installationspfad von kivitendo im Dateisystem
643 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
644 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
645 ("<filename>/url/for/kivitendo-erp</filename>").</para>
647 <para>Folgender Konfigurationsschnipsel funktioniert mit
650 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
651 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
653 <Directory /path/to/kivitendo-erp>
655 Options ExecCGI Includes FollowSymlinks
660 <DirectoryMatch /path/to/kivitendo-erp/users>
663 </DirectoryMatch></programlisting>
665 <para>Seit mod_fcgid-Version 2.6.3 gelten sehr kleine Grenzen für
666 die maximale Größe eines Requests. Diese sollte wie folgt
667 hochgesetzt werden:</para>
669 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
671 <para>Das ganze sollte dann so aussehen:</para>
673 <programlisting>AddHandler fcgid-script .fpl
674 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
675 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
676 FcgidMaxRequestLen 10485760
678 <Directory /path/to/kivitendo-erp>
680 Options ExecCGI Includes FollowSymlinks
685 <DirectoryMatch /path/to/kivitendo-erp/users>
688 </DirectoryMatch></programlisting>
690 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
691 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
692 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
693 gibt es hier kleine Performance-Einbußen.</para>
695 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
696 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
697 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
699 <programlisting># Zugriff über CGI
700 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
702 # Zugriff mit mod_fcgid:
703 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
704 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
706 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
707 die normale Version erreichbar, und unter
708 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
709 FastCGI-Version.</para>
714 <sect1 id="config.task-server">
715 <title>Der Task-Server</title>
717 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
718 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
719 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
720 wird bisher nur für die Erzeugung der wiederkehrenden Rechnungen
721 benutzt, wird aber in Zukunft deutlich mehr Aufgaben übertragen
724 <sect2 id="Konfiguration-des-Task-Servers">
725 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
727 <para>Die Konfiguration erfolgt über den Abschnitt
728 <literal>[task_server]</literal> in der Datei
729 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
730 Optionen sind:</para>
734 <term><varname>login</varname></term>
737 <para>gültiger kivitendo-Benutzername, der benutzt wird, um die
738 zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss
739 in der Administration angelegt werden. Diese Option muss
740 angegeben werden.</para>
745 <term><varname>run_as</varname></term>
748 <para>Wird der Server vom Systembenutzer <literal>root</literal>
749 gestartet, so wechselt er auf den mit <literal>run_as</literal>
750 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
751 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
753 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
754 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
755 unter dem auch der Webserver läuft.</para>
760 <term><varname>debug</varname></term>
763 <para>Schaltet Debug-Informationen an und aus.</para>
769 <sect2 id="Einbinden-in-den-Boot-Prozess">
770 <title>Automatisches Starten des Task-Servers beim Booten</title>
772 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
773 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
774 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
776 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
777 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
778 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
779 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
780 anstelle eines symbolischen Links verwendet werden können.</para>
783 <title>SystemV-basierende Systeme (z.B. Debian, OpenSuSE, Fedora
786 <para>Kopieren Sie die Datei
787 <filename>scripts/boot/system-v/kivitendo-server</filename>
788 nach <filename>/etc/init.d/kivitendo-server</filename>. Passen
789 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
790 <literal>DAEMON=....</literal>). Binden Sie das Script in den
791 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
795 <para>Debian-basierende Systeme:</para>
797 <programlisting>update-rc.d kivitendo-task-server defaults
798 # Nur bei Debian Squeeze und neuer:
799 insserv kivitendo-task-server</programlisting>
803 <para>OpenSuSE und Fedora Core:</para>
805 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
809 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
810 werden: <command>/etc/init.d/kivitendo-task-server
811 start</command></para>
815 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
817 <para>Kopieren Sie die Datei
818 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
819 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
820 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
821 <literal>exec ....</literal>).</para>
823 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
824 werden: <command>service kivitendo-task-server
825 start</command></para>
829 <sect2 id="Prozesskontrolle">
830 <title>Wie der Task-Server gestartet und beendet wird</title>
832 <para>Der Task-Server wird wie folgt kontrolliert:</para>
834 <programlisting>./scripts/task_server.pl Befehl</programlisting>
836 <para><literal>Befehl</literal> ist dabei eine der folgenden
841 <para><literal>start</literal> startet eine neue Instanz des
842 Task-Servers. Die Prozess-ID wird innerhalb des
843 <filename>users</filename>-Verzeichnisses abgelegt.</para>
847 <para><literal>stop</literal> beendet einen laufenden
852 <para><literal>restart</literal> beendet und startet ihn
857 <para><literal>status</literal> berichtet, ob der Task-Server
862 <para>Der Task-Server wechselt beim Starten automatisch in das
863 kivitendo-Installationsverzeichnis.</para>
865 <para>Dieselben Optionen können auch für die SystemV-basierenden
866 Runlevel-Scripte benutzt werden (siehe oben).</para>
868 <sect2 id="Prozesskontrolle2">
869 <title>Task-Server mit mehreren Mandanten</title>
871 <para>Beim Task-Server wird der Login-Name des Benutzers, unter dem der
872 Task-Server laufen soll, in die Konfigurationsdatei geschrieben. Hat
873 man mehrere Mandanten muß man auch mehrere Konfigurationsdateien
876 <para>Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf,
877 wo in der Kategorie [task_server] der gewünschte "login" steht.</para>
879 <para>Der alternative Task-Server wird dann mit folgendem Befehl
882 <programlisting>./scripts/task_server.pl -c config/DATEINAME.conf</programlisting>
886 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
887 <title>Benutzerauthentifizierung und Administratorpasswort</title>
889 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
890 über die Verwaltung von Gruppen und weitere Einstellungen</para>
892 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
893 <title>Grundlagen zur Benutzerauthentifizierung</title>
895 <para>kivitendo verwaltet die Benutzerinformationen in einer
896 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
897 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
898 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
899 können, müssen aber nicht unterschiedlich sein.</para>
901 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
902 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
903 abgelegt werden.</para>
905 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
906 entweder gegen die Authentifizierungsdatenbank oder gegen einen
907 LDAP-Server überprüft werden.</para>
909 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
910 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
911 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
912 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
913 einer Version vor v2.6.0 angelegt werden. Eine
914 Beispielkonfigurationsdatei
915 <filename>config/kivitendo.conf.default</filename> existiert, die als
916 Vorlage benutzt werden kann.</para>
919 <sect2 id="Administratorpasswort">
920 <title>Administratorpasswort</title>
922 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
923 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
924 nur dort und nicht mehr im Administrationsinterface selber geändert
925 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
926 Abschnitt <varname>[authentication]</varname>.</para>
929 <sect2 id="Authentifizierungsdatenbank">
930 <title>Authentifizierungsdatenbank</title>
932 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
933 Parametern in <varname>[authentication/database]</varname>
934 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
938 <term><literal>host</literal></term>
941 <para>Der Rechnername oder die IP-Adresse des
942 Datenbankservers</para>
947 <term><literal>port</literal></term>
950 <para>Die Portnummer des Datenbankservers, meist 5432</para>
955 <term><literal>db</literal></term>
958 <para>Der Name der Authentifizierungsdatenbank</para>
963 <term><literal>user</literal></term>
966 <para>Der Benutzername, mit dem sich kivitendo beim
967 Datenbankserver anmeldet (z.B.
968 "<literal>postgres</literal>")</para>
973 <term><literal>password</literal></term>
976 <para>Das Passwort für den Datenbankbenutzer</para>
981 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
982 automatisch anlegen (mehr dazu siehe unten).</para>
985 <sect2 id="Passwortüberprüfung">
986 <title>Passwortüberprüfung</title>
988 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
989 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
990 Active-Directory-Server. Welche davon benutzt wird, regelt der
991 Parameter <varname>module</varname> im Abschnitt
992 <varname>[authentication]</varname>.</para>
994 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
995 gespeichert werden, so muss der Parameter <varname>module</varname>
996 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
997 der Administrator als auch die Benutzer selber ihre Psaswörter in
998 kivitendo ändern.</para>
1000 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1001 benutzt werden, so muss der Parameter <varname>module</varname> auf
1002 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1003 zusätzliche Informationen über den LDAP-Server im Abschnitt
1004 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1008 <term><literal>host</literal></term>
1011 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1012 Active-Directory-Servers. Diese Angabe ist zwingend
1013 erforderlich.</para>
1018 <term><literal>port</literal></term>
1021 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1026 <term><literal>tls</literal></term>
1029 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1030 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1031 ‘<literal>0</literal>’ belassen</para>
1036 <term><literal>attribute</literal></term>
1039 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1040 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1041 meist ‘<literal>sAMAccountName</literal>’, für andere
1042 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1043 zwingend erforderlich.</para>
1048 <term><literal>base_dn</literal></term>
1051 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1052 Diese Angabe ist zwingend erforderlich.</para>
1057 <term><literal>filter</literal></term>
1060 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1061 <literal><%login%></literal>, so wird dieses durch den vom
1062 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1063 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1064 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1069 <term><literal>bind_dn</literal> und
1070 <literal>bind_password</literal></term>
1073 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1074 durchsucht werden kann (z.B. ist dies bei
1075 Active-Directory-Servern der Fall), so kann diese hier angegeben
1076 werden. Für Active-Directory-Server kann als
1077 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1078 z.B. ‘<literal>cn=Martin
1079 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1080 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1081 also ‘<literal>Martin Mustermann</literal>’.</para>
1087 <sect2 id="Name-des-Session-Cookies">
1088 <title>Name des Session-Cookies</title>
1090 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1091 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1092 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1093 Parameter <varname>cookie_name</varname> im Abschnitt
1094 <varname>[authentication]</varname>gesetzt.</para>
1096 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1097 Server existiert.</para>
1100 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1101 <title>Anlegen der Authentifizierungsdatenbank</title>
1103 <para>Nachdem alle Einstellungen in
1104 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1105 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1106 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1107 der folgenden URL erreichbar sein sollte:</para>
1110 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
1114 <sect1 id="Benutzer--und-Gruppenverwaltung">
1115 <title>Benutzer- und Gruppenverwaltung</title>
1117 <para>Nach der Installation müssen Benutzer, Gruppen und Datenbanken
1118 angelegt werden. Dieses geschieht im Administrationsmenü, das Sie unter
1119 folgender URL finden:</para>
1122 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
1124 <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
1125 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1127 <sect2 id="Zusammenhänge">
1128 <title>Zusammenhänge</title>
1130 <para>kivitendo verwendet eine Datenbank zum Speichern all seiner
1131 Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um
1132 mit kivitendo arbeiten zu können, muss eine Person einen
1133 Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine
1134 Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist
1135 möglich und normal, dass mehreren Benutzern die selbe Datenbank
1136 zugewiesen wird, sodass sie alle mit den selben Daten arbeiten
1139 <para>Die Basisdaten der Benutzer, die in der Administration
1140 eingegeben werden können, werden in einer zweiten Datenbank
1141 gespeichert, der bereits erwähnten Authentifizierungsdatenbank. Diese
1142 ist also den Produktivdaten enthaltenden Datenbanken vorgeschaltet.
1143 Pro kivitendo-Installation gibt es nur eine
1144 Authentifizierungsdatenbank, aber beliebig viele Datenbanken mit
1147 <para>kivitendo kann seinen Benutzern Zugriff auf bestimmte
1148 Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht
1149 gestattet, so werden der entsprechenden Menüpunkte auch nicht
1150 angezeigt. Diese Rechte werden ebenfalls in der
1151 Authentifizierungsdatenbank gespeichert.</para>
1153 <para>Um Rechte verteilen zu können, verwendet kivitendo ein
1154 Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche
1155 erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder
1156 mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen
1157 Funktionen, die mindestens einer Gruppe erlaubt sind, in der der
1158 Benutzer Mitglied ist.</para>
1160 <para>Die allgemeine Reihenfolge, in der Datenbanken, Gruppen und
1161 Benutzer angelegt werden sollten, lautet:</para>
1163 <orderedlist numeration="arabic">
1165 <para>Datenbank anlegen</para>
1169 <para>Gruppen anlegen</para>
1173 <para>Benutzer anlegen</para>
1177 <para>Benutzer den Gruppen zuordnen</para>
1182 <sect2 id="Datenbanken-anlegen">
1183 <title>Datenbanken anlegen</title>
1185 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1186 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1187 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1189 <para>Wenn Sie für die kivitendo-Installation nicht Unicode (UTF-8) sondern den europäischen Schriftsatz ISO-8859-15 benutzen
1190 wollen, so müssen Sie vor dem Anlegen der Datenbank in der Datei <filename>config/kivitendo.conf</filename> die Variable
1191 <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf den Wert ‘<literal>ISO-8859-15</literal>’ setzen.</para>
1193 <para>Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz
1194 verwenden müssen, da diese Einstellungen momentan global in kivitendo
1195 vorgenommen wird und nicht nach Datenbank unterschieden werden kann.
1196 Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz
1197 angelegt worden sein.</para>
1200 <sect2 id="Gruppen-anlegen">
1201 <title>Gruppen anlegen</title>
1203 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1204 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1205 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1206 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1208 <para>Benutzergruppen sind unabhängig von Datenbanken, da sie in der
1209 Authentifizierungsdatenbank gespeichert werden. Sie gelten für alle
1210 Datenbanken, die in dieser Installation verwaltet werden.</para>
1213 <sect2 id="Benutzer-anlegen">
1214 <title>Benutzer anlegen</title>
1216 <para>Beim Anlegen von Benutzern werden für viele Parameter
1217 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1218 deutschen Raumes entsprechen.</para>
1220 <para>Zwingend anzugeben sind der Loginname sowie die komplette
1221 Datenbankkonfiguration. Wenn die Passwortauthentifizierung über die
1222 Datenbank eingestellt ist, so kann hier auch das Benutzerpasswort
1223 gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung
1224 aktiv, so ist das Passwort-Feld deaktiviert.</para>
1226 <para>In der Datenbankkonfiguration müssen die Zugriffsdaten einer der
1227 eben angelegten Datenbanken eingetragen werden.</para>
1230 <sect2 id="Gruppenmitgliedschaften-verwalten">
1231 <title>Gruppenmitgliedschaften verwalten</title>
1233 <para>Nach dem Anlegen von Benutzern und Gruppen müssen Benutzer den
1234 Gruppen zugewiesen werden. Dazu gibt es zwei Möglichkeiten:</para>
1236 <orderedlist numeration="arabic">
1238 <para>In der Gruppenverwaltung wählt man eine Gruppe aus. Im
1239 folgenden Dialog kann man dann einzeln die Benutzer der Gruppe
1244 <para>In der Gruppenverwaltung wählt man das Tool zur Verwaltung
1245 der Gruppenmitgliedschaft. Hier wird eine Matrix angezeigt, die
1246 alle im System angelegten Gruppen und Benutzer enthält. Durch
1247 Setzen der Häkchen wird der Benutzer in der ausgewählten Zeile der
1248 Gruppe in der ausgewählten Spalte hinzugefügt.</para>
1253 <sect2 id="Migration-alter-Installationen">
1254 <title>Migration alter Installationen</title>
1256 <para>Wenn kivitendo 2.6.3 über eine ältere Version installiert wird,
1257 in der die Benutzerdaten noch im Dateisystem im Verzeichnis
1258 <literal>users</literal> verwaltet wurden, so bietet kivitendo die
1259 Möglichkeit, diese Benutzerdaten automatisch in die
1260 Authentifizierungsdatenbank zu übernehmen. Dies geschieht, wenn man
1261 sich nach dem Update der Installation das erste Mal im
1262 Administrationsbereich anmeldet. Findet kivitendo die Datei
1263 <literal>users/members</literal>, so wird der Migrationsprozess
1266 <para>Der Migrationsprozess ist nahezu vollautomatisch. Alle
1267 Benutzerdaten können übernommen werden. Nach den Benutzerdaten bietet
1268 kivitendo noch die Möglichkeit an, dass automatisch eine
1269 Benutzergruppe angelegt wird. Dieser Gruppe wird Zugriff auf alle
1270 Funktionen von kivitendo gewährt. Alle migrierten Benutzern werden
1271 Mitglied in dieser Gruppe. Damit wird das Verhalten von kivitendo bis
1272 Version 2.4.3 inklusive wiederhergestellt, und die Benutzer können
1273 sich sofort wieder anmelden und mit dem System arbeiten.</para>
1277 <sect1 id="Drucken-mit-kivitendo">
1278 <title>Drucken mit kivitendo</title>
1280 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX Vorlagen.
1281 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1282 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1283 Debianoiden Betriebssystemen sind das die Pakete:</para>
1285 <para><literal>texlive-latex-base texlive-latex-extra
1286 texlive-fonts-recommended</literal></para>
1288 <para>Diese hinteren beiden enthalten Bibliotheken und Schriftarten die
1289 von den Standardvorlagen verwendet werden.</para>
1291 <para>TODO: rpm Pakete.</para>
1293 <para>In den allermeisten Installationen sollte drucken jetzt schon
1294 funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
1295 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
1296 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1301 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1302 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1303 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1308 <para>! Package inputenc Error: Unicode char \u8:æ¡
\9c not set up for
1309 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1310 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1311 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1312 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1313 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1317 <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
1318 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1319 Prüfen Sie den Namen in der Konfiguration (Standard:
1320 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1321 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1325 <sect1 id="OpenDocument-Vorlagen">
1326 <title>OpenDocument-Vorlagen</title>
1328 <para>kivitendo unterstützt die Verwendung von Vorlagen im
1329 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1330 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1331 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1332 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1333 <filename>config/kivitendo.conf</filename> die Variable
1334 <literal>opendocument</literal> im Abschnitt
1335 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1336 Dieses ist die Standardeinstellung.</para>
1338 <para>Weiterhin muss in der Datei
1339 <filename>config/kivitendo.conf</filename> die Variable
1340 <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf
1341 die Zeichenkodierung gesetzt werden, die auch bei der Speicherung der
1342 Daten in der Datenbank verwendet wird. Diese ist in den meisten Fällen
1345 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1346 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1347 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1348 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1349 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1350 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1352 <para>Nach der Installation müssen in der Datei
1353 <filename>config/kivitendo.conf</filename> zwei weitere Variablen
1354 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1355 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1356 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1357 enthalten. Beide stehen im Abschnitt
1358 <literal>applications</literal>.</para>
1360 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
1361 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1362 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1363 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1364 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1365 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1366 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1367 werden muss. Der Nachteil ist, dass diese Methode Python und die
1368 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1371 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1372 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1373 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1374 Dokumentenvorlage enthalten sein und
1375 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1376 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1377 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1378 ebenfalls enthalten sein muss.</para>
1380 <para>Als letztes muss herausgefunden werden, welchen Namen
1381 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1382 gibt. Unter Debian ist dies momentan
1383 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1384 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1385 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1386 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1387 folgender Befehl auszuführen:</para>
1389 <para><literal>mv users/.openoffice.org2
1390 users/.openoffice</literal></para>
1392 <para>Dieses Verzeichnis, wie auch das komplette
1393 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1394 sein. Dieses wurde bereits erledigt (siehe <xref
1395 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1396 erneut überprüft werden, wenn die Konvertierung nach PDF
1400 <sect1 id="config.eur">
1401 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1404 <sect2 id="config.eur.introduction"
1405 xreflabel="Einführung in die Konfiguration zur EUR">
1406 <title>Einführung</title>
1408 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
1409 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1410 Konfigurationsdatei <filename>config/lx_office.conf</filename>
1411 befand. Somit galt er für alle Mandanten, die in dieser Installation
1412 benutzt wurden.</para>
1414 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1415 die Mandantendatenbank verschoben und dabei auch gleich in drei
1416 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1417 steuern lässt.</para>
1420 <sect2 id="config.eur.parameters"
1421 xreflabel="Konfigurationsparameter für EUR">
1422 <title>Konfigurationsparameter</title>
1424 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1425 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1429 <term><varname>profit_determination</varname></term>
1432 <para>Dieser Parameter legt die Berechnungsmethode für die
1433 Gewinnermittlung fest. Er enthält entweder
1434 <literal>balance</literal> für
1435 Betriebsvermögensvergleich/Bilanzierung oder
1436 <literal>income</literal> für die
1437 Einnahmen-Überschuss-Rechnung.</para>
1442 <term><varname>accounting_method</varname></term>
1445 <para>Dieser Parameter steuert die Buchungs- und
1446 Berechnungsmethoden für die Versteuerungsart. Er enthält
1447 entweder <literal>accrual</literal> für die Soll-Versteuerung
1448 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1453 <term><varname>inventory_system</varname></term>
1456 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1457 enthält entweder <literal>perpetual</literal> für die
1458 Bestandsmethode oder <literal>periodic</literal> für die
1459 Aufwandsmethode.</para>
1464 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1465 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1466 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1467 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1468 Bestandsmethode.</para>
1470 <para>Die Konfiguration "<varname>eur</varname>" unter
1471 <varname>[system]</varname> in der <link
1472 linkend="config.config-file">Konfigurationsdatei</link>
1473 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
1474 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1477 <sect2 id="config.eur.setting-parameters">
1478 <title>Festlegen der Parameter</title>
1480 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1481 der Admininstration können diese Optionen nun unabhängig voneinander
1482 eingestellt werden.</para>
1484 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1485 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1488 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1489 Standardkonten unter dem neuen Punkt "Einstellungen" angezeigt
1490 (read-only). Eine spätere Änderung ist für einen bestehenden Mandanten
1491 nicht mehr möglich. Dies war auch vorher nicht möglich, bzw.
1492 vorhandene Daten wurden so belassen und haben damit die Ergebnisse
1496 <sect2 id="config.eur.inventory-system-perpetual">
1497 <title>Bemerkungen zu Bestandsmethode</title>
1499 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1500 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
1501 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1502 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1503 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1504 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1505 Einkaufsrechnungen berechnet wird.</para>
1507 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1508 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1509 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1513 <sect2 id="config.eur.knonw-issues">
1514 <title>Bekannte Probleme</title>
1516 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1517 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1518 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1519 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1520 die Konfigurationsvariable
1521 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1524 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1525 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1529 <sect1 id="config.skr04-update-3804">
1530 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1532 <sect2 id="config.skr04-update-3804.introduction">
1533 <title>Einführung</title>
1535 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1536 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1537 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1538 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1539 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1540 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1541 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1542 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1543 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1544 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1545 Screenshots dargestellt.</para>
1547 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1548 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1549 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1550 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1553 <sect2 id="config.skr04-update-3804.create-chart">
1554 <title>Konto 3804 manuell anlegen</title>
1556 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
1557 anzulegen und zu konfigurieren. Zuerst wird in
1558 <guimenu>System</guimenu> ->
1559 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
1560 erfassen</guimenuitem> das Konto angelegt.</para>
1563 <screeninfo>Konto 3804 erfassen</screeninfo>
1567 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
1573 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
1574 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
1575 wie im folgenden Screenshot angezeigt anpassen.
1579 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
1583 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
1589 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
1590 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
1594 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
1598 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
1604 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
1605 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
1606 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
1607 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
1611 <screeninfo>Konto 4315 anpassen</screeninfo>
1615 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
1621 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
1622 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
1626 <screeninfo>Steuerliste vergleichen</screeninfo>
1630 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
1637 <sect1 id="kivitendo-ERP-verwenden">
1638 <title>kivitendo ERP verwenden</title>
1640 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
1641 folgender URL erreichbar:</para>
1644 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
1646 <para>Die Administrationsseite erreichen Sie unter:</para>
1649 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
1653 <chapter id="features" xreflabel="Features und Funktionen">
1654 <title>Features und Funktionen</title>
1656 <sect1 id="features.periodic-invoices"
1657 xreflabel="Wiedekehrende Rechnungen">
1658 <title>Wiederkehrende Rechnungen</title>
1660 <sect2 id="features.periodic-invoices.introduction"
1661 xreflabel="Einführung in wiederkehrende Rechnungen">
1662 <title>Einführung</title>
1664 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
1665 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
1666 Die konfigurierten Aufträge werden später automatisch in Rechnungen
1667 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
1668 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
1669 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
1670 wiederzufinden sind.</para>
1673 <sect2 id="features.periodic-invoices.configuration"
1674 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
1675 <title>Konfiguration</title>
1677 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
1678 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
1679 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
1680 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
1681 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
1684 <para>Folgende Parameter kann man konfigurieren:</para>
1691 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
1692 erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
1693 neuen Monats).</para>
1695 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
1696 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
1697 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
1698 nächsten Periodenwechsel für alle Perioden, seit der letzten
1699 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
1700 verhindern, muss man vorher das Startdatum neu setzen.</para>
1702 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
1703 erstellt. Man kann sich diese Aufträge aber gesondert in den
1704 Berichten anzeigen lassen.</para>
1709 <term>Periodizität</term>
1712 <para>Ob monatlich, quartalsweise oder jährlich auf neue
1713 Rechnungen überprüft werden soll. Für jede Periode seit dem
1714 Startdatum wird überprüft, ob für die Periode (beginnend immer
1715 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
1716 wurde. Unter Umständen können bei einem Startdatum in der
1717 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
1722 <term>Buchen auf</term>
1725 <para>Das Forderungskonto, in der Regel "Forderungen aus
1726 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
1727 Buchungsgruppen der betreffenden Waren.</para>
1732 <term>Startdatum</term>
1735 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
1741 <term>Enddatum</term>
1744 <para>ab wann keine Rechnungen mehr erstellt werden
1750 <term>Automatische Verlängerung um x Monate</term>
1753 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
1754 eingetragenen Enddatums weiterhin erstellt werden, so kann man
1755 hier die Anzahl der Monate eingeben, um die das Enddatum
1756 automatisch nach hinten geschoben wird.</para>
1761 <term>Drucken</term>
1764 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
1765 Rechnungen auch gleich ausdrucken lassen.</para>
1770 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
1771 Informationen zu den erstellten Rechnungen verschickt werden.
1772 Konfiguriert wird dies in der <link
1773 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
1774 <filename>config/kivitendo.conf</filename> im Abschnitt
1775 <varname>[periodic_invoices]</varname>.</para>
1778 <sect2 id="features.periodic-invoices.reports">
1779 <title>Auflisten</title>
1781 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
1782 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
1783 Rechnungen inaktiv", mit denen man sich einen Überglick über die
1784 wiederkehrenden Rechnungen verschaffen kann.</para>
1787 <sect2 id="features.periodic-invoices.task-server">
1788 <title>Erzeugung der eigentlichen Rechnungen</title>
1790 <para>Die zeitliche und periodische Überprüfung, ob eine
1791 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
1792 durch den <link linkend="config.task-server">Taskserver</link>, einen
1793 externen Dienst, der automatisch beim Start des Servers gestartet
1794 werden sollte.</para>
1797 <sect2 id="features.periodic-invoices.create-for-current-month">
1798 <title>Erste Rechnung für aktuellen Monat erstellen</title>
1800 <para>Will man im laufenden Monat eine monatlich wiederkehrende
1801 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
1802 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
1803 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
1804 generiert hat. Alternativ setzt man das Startdatum auf den
1805 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
1806 manuell über den Workflow.</para>
1810 <sect1 id="dokumentenvorlagen-und-variablen">
1811 <title>Dokumentenvorlagen und verfügbare Variablen</title>
1813 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
1814 <title>Einführung</title>
1816 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
1817 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
1818 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
1819 <function><%variablenname%></function> verwendet wird. Für
1820 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
1822 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
1824 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
1825 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
1826 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
1827 alle Vorlagenarten.</para>
1829 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
1830 verfügbar als hier aufgelistet werden. Die meisten davon können
1831 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
1832 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
1833 diese wie folgt erhalten werden:</para>
1837 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
1838 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
1842 <para>In <filename>Form.pm</filename> die Funktion
1843 <function>parse_template</function> suchen und hier die Zeile
1844 <command>print(STDERR Dumper($self));</command> einfügen.</para>
1848 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
1849 ein PDF für eine Rechnung erzeugen.</para>
1853 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
1854 der Variablen <varname>$self</varname> in der Form <varname>'key'
1855 => 'value',</varname>. Alle <varname>key</varname>s sind
1861 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
1862 <title>Variablen ausgeben</title>
1864 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
1865 Tags geschrieben werden, also z.B.
1866 <varname><%variablenname%></varname>.</para>
1868 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
1869 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
1870 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
1871 werden die folgenden Flags unterstützt:</para>
1875 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
1876 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
1877 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
1878 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
1882 <para><option>NOESCAPE</option> unterdrückt das Escapen von
1883 Sonderzeichen für die Vorlagensprache. Wenn also in einer
1884 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
1885 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
1886 ist dieses Flag sinnvoll.</para>
1890 <para>Beispiel:</para>
1892 <programlisting><%quototal NOFORMAT%></programlisting>
1895 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
1896 <title>Verwendung in Druckbefehlen</title>
1898 <para>In der Admininstration können Drucker definiert werden. Auch im
1899 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
1900 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
1901 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
1902 <function>`...`</function> nicht zu unerwünschtem Verhalten
1905 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
1906 für das die Telefonnummer eines Ansprechpartners als Teil der
1907 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
1908 z.B. wie folgt aussehen:</para>
1910 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
1913 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
1914 xreflabel="Anfang und Ende der Tags verändern">
1915 <title>Anfang und Ende der Tags verändern</title>
1917 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
1918 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
1919 Prozentzeichen und dem Größerzeichen endet, beispielsweise
1920 <function><%customer%></function>. Da diese Form aber z.B. in
1921 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
1922 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
1923 Stil umgestellt werden.</para>
1925 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
1926 Format gültigen Kommentarzeichen anfangen, dann
1927 <function>config:</function> enthalten, die entsprechende Option
1928 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
1929 enden. Beispiel für LaTeX:</para>
1931 <programlisting>% config: tag-style=($ $)</programlisting>
1933 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
1934 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
1935 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
1937 <programlisting><!-- config: tag-style=($ $) --></programlisting>
1940 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
1941 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
1943 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
1944 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
1945 "<filename>.ext</filename>" geeignet zu ersetzen:
1946 "<filename>.tex</filename>" für LaTeX-Vorlagen und
1947 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
1951 <term><filename>bin_list.ext</filename></term>
1954 <para>Lagerliste</para>
1959 <term><filename>check.ext</filename></term>
1967 <term><filename>invoice.ext</filename></term>
1970 <para>Rechnung</para>
1975 <term><filename>packing_list.ext</filename></term>
1978 <para>Packliste</para>
1983 <term><filename>pick_list.ext</filename></term>
1986 <para>Sammelliste</para>
1991 <term><filename>purchase_delivery_order.ext</filename></term>
1994 <para>Lieferschein (Einkauf)</para>
1999 <term><filename>purcharse_order.ext</filename></term>
2002 <para>Bestellung an Lieferanten</para>
2007 <term><filename>request_quotation.ext</filename></term>
2010 <para>Anfrage an Lieferanten</para>
2015 <term><filename>sales_delivery_order.ext</filename></term>
2018 <para>Lieferschein (Verkauf)</para>
2023 <term><filename>sales_order.ext</filename></term>
2026 <para>Bestellung</para>
2031 <term><filename>sales_quotation.ext</filename></term>
2034 <para>Angebot an Kunden</para>
2039 <term><filename>zahlungserinnerung.ext</filename></term>
2042 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2047 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2050 <para>Rechnung über Mahngebühren (Dateiname im Programm
2051 konfigurierbar)</para>
2057 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2058 <title>Sprache, Drucker und E-Mail</title>
2060 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2061 eingearbeitet. So wird aus der Vorlage
2062 <filename>sales_order.ext</filename> bei Sprache
2063 <function>de</function> und Druckerkürzel <function>lpr2</function>
2064 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2065 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2066 bekommen dann noch das Kürzel <filename>_email</filename>, der
2067 vollständige Vorlagenname wäre dann
2068 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2069 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2070 werden. Diese wird verwendet, wenn keine der anderen Varianten
2071 gefunden wird.</para>
2073 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2074 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2075 verschickt wird, ist:</para>
2079 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2083 <para><filename>sales_order_de_lpr2.tex</filename></para>
2087 <para><filename>sales_order.tex</filename></para>
2091 <para><filename>default.tex</filename></para>
2095 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2096 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2098 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2101 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2102 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2105 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2106 xreflabel="Metainformationen zur angeforderten Vorlage">
2107 <title>Metainformationen zur angeforderten Vorlage</title>
2109 <para>Diese Variablen liefern Informationen darüber welche Variante
2110 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2111 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2112 Formulare einbinden möchten.</para>
2116 <term><varname>template_meta.formname</varname></term>
2119 <para>Basisname der Vorlage. Identisch mit der <link
2120 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2121 zu den Dateinamen</link> ohne die Erweiterung. Ein
2122 Verkaufsauftrag enthält hier
2123 <constant>sales_order</constant>.</para>
2128 <term><varname>template_meta.language.description</varname></term>
2131 <para>Beschreibung der verwendeten Sprache</para>
2136 <term><varname>template_meta.language.template_code</varname></term>
2139 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2140 Kürzel das im Dateinamen verwendetet wird.</para>
2145 <term><varname>template_meta.language.output_numberformat</varname></term>
2148 <para>Zahlenformat der verwendeten Sprache in der Form
2149 "<constant>1.000,00</constant>". Experimentell! Nur
2150 interessant für Vorlagen die mit unformatierten Werten
2156 <term><varname>template_meta.language.output_dateformat</varname></term>
2159 <para>Datumsformat der verwendeten Sprache in der Form
2160 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2161 interessant für Vorlagen die mit unformatierten Werten
2167 <term><varname>template_meta.format</varname></term>
2170 <para>Das angeforderte Format. Kann im Moment die Werte
2171 <constant>pdf</constant>, <constant>postscript</constant>,
2172 <constant>html</constant>, <constant>opendocument</constant>,
2173 <constant>opendocument_pdf</constant> und
2174 <constant>excel</constant> enthalten.</para>
2179 <term><varname>template_meta.extension</varname></term>
2182 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2183 <constant>format</constant> entschieden.</para>
2188 <term><varname>template_meta.media</varname></term>
2191 <para>Ausgabemedium. Kann zur Zeit die Werte
2192 <constant>screen</constant> für Bildschirm,
2193 <constant>email</constant> für E-Mmail (triggert das
2194 <constant>_email</constant> Kürzel im Dateinamen),
2195 <constant>printer</constant> für Drucker, und
2196 <constant>queue</constant> für Warteschlange enthalten.</para>
2201 <term><varname>template_meta.printer.description</varname></term>
2204 <para>Beschreibung des ausgewählten Druckers</para>
2209 <term><varname>template_meta.printer.template_code</varname></term>
2212 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2213 dem Kürzel das im Dateinamen verwendetet wird.</para>
2218 <term><varname>template_meta.tmpfile</varname></term>
2221 <para>Datei-Prefix für temporäre Dateien.</para>
2227 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2228 <title>Stammdaten von Kunden und Lieferanten</title>
2232 <term><varname>account_number</varname></term>
2235 <para>Kontonummer</para>
2240 <term><varname>bank</varname></term>
2243 <para>Name der Bank</para>
2248 <term><varname>bank_code</varname></term>
2251 <para>Bankleitzahl</para>
2256 <term><varname>bic</varname></term>
2259 <para>Bank-Identifikations-Code (Bank Identifier Code,
2265 <term><varname>business</varname></term>
2268 <para>Kunden-/Lieferantentyp</para>
2273 <term><varname>city</varname></term>
2281 <term><varname>contact</varname></term>
2284 <para>Kontakt</para>
2289 <term><varname>country</varname></term>
2297 <term><varname>cp_email</varname></term>
2300 <para>Email des Ansprechpartners</para>
2305 <term><varname>cp_givenname</varname></term>
2308 <para>Vorname des Ansprechpartners</para>
2313 <term><varname>cp_greeting</varname></term>
2316 <para>Anrede des Ansprechpartners</para>
2321 <term><varname>cp_name</varname></term>
2324 <para>Name des Ansprechpartners</para>
2329 <term><varname>cp_phone1</varname></term>
2332 <para>Telefonnummer 1 des Ansprechpartners</para>
2337 <term><varname>cp_phone2</varname></term>
2340 <para>Telefonnummer 2 des Ansprechpartners</para>
2345 <term><varname>cp_title</varname></term>
2348 <para>Titel des Ansprechpartners</para>
2353 <term><varname>creditlimit</varname></term>
2356 <para>Kreditlimit</para>
2361 <term><varname>customeremail</varname></term>
2364 <para>Email des Kunden; nur für Kunden</para>
2369 <term><varname>customerfax</varname></term>
2372 <para>Faxnummer des Kunden; nur für Kunden</para>
2377 <term><varname>customernotes</varname></term>
2380 <para>Bemerkungen beim Kunden; nur für Kunden</para>
2385 <term><varname>customernumber</varname></term>
2388 <para>Kundennummer; nur für Kunden</para>
2393 <term><varname>customerphone</varname></term>
2396 <para>Telefonnummer des Kunden; nur für Kunden</para>
2401 <term><varname>discount</varname></term>
2409 <term><varname>email</varname></term>
2412 <para>Emailadresse</para>
2417 <term><varname>fax</varname></term>
2420 <para>Faxnummer</para>
2425 <term><varname>homepage</varname></term>
2428 <para>Homepage</para>
2433 <term><varname>iban</varname></term>
2436 <para>Internationale Kontonummer (International Bank Account
2437 Number, IBAN)</para>
2442 <term><varname>language</varname></term>
2445 <para>Sprache</para>
2450 <term><varname>name</varname></term>
2453 <para>Firmenname</para>
2458 <term><varname>payment_description</varname></term>
2461 <para>Name der Zahlart</para>
2466 <term><varname>payment_terms</varname></term>
2469 <para>Zahlungskonditionen</para>
2474 <term><varname>phone</varname></term>
2477 <para>Telefonnummer</para>
2482 <term><varname>shiptocity</varname></term>
2485 <para>Stadt (Lieferadresse) <link
2486 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2491 <term><varname>shiptocontact</varname></term>
2494 <para>Kontakt (Lieferadresse) <link
2495 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2500 <term><varname>shiptocountry</varname></term>
2503 <para>Land (Lieferadresse) <link
2504 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2509 <term><varname>shiptodepartment1</varname></term>
2512 <para>Abteilung 1 (Lieferadresse) <link
2513 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2518 <term><varname>shiptodepartment2</varname></term>
2521 <para>Abteilung 2 (Lieferadresse) <link
2522 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2527 <term><varname>shiptoemail</varname></term>
2530 <para>Email (Lieferadresse) <link
2531 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2536 <term><varname>shiptofax</varname></term>
2539 <para>Fax (Lieferadresse) <link
2540 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2545 <term><varname>shiptoname</varname></term>
2548 <para>Firmenname (Lieferadresse) <link
2549 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2554 <term><varname>shiptophone</varname></term>
2557 <para>Telefonnummer (Lieferadresse) <link
2558 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2563 <term><varname>shiptostreet</varname></term>
2566 <para>Straße und Hausnummer (Lieferadresse) <link
2567 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2572 <term><varname>shiptozipcode</varname></term>
2575 <para>Postleitzahl (Lieferadresse) <link
2576 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2581 <term><varname>street</varname></term>
2584 <para>Straße und Hausnummer</para>
2589 <term><varname>taxnumber</varname></term>
2592 <para>Steuernummer</para>
2597 <term><varname>ustid</varname></term>
2600 <para>Umsatzsteuer-Identifikationsnummer</para>
2605 <term><varname>vendoremail</varname></term>
2608 <para>Email des Lieferanten; nur für Lieferanten</para>
2613 <term><varname>vendorfax</varname></term>
2616 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
2621 <term><varname>vendornotes</varname></term>
2624 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
2629 <term><varname>vendornumber</varname></term>
2632 <para>Lieferantennummer; nur für Lieferanten</para>
2637 <term><varname>vendorphone</varname></term>
2640 <para>Telefonnummer des Lieferanten; nur für
2646 <term><varname>zipcode</varname></term>
2649 <para>Postleitzahl</para>
2654 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
2655 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
2656 Stammdaten nicht eingetragen, so haben die Variablen
2657 <varname>shipto*</varname> den gleichen Wert wie die die
2658 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
2659 einige <varname>shipto*</varname>-Variablen so nicht in den
2660 Stammdaten wiederfinden sondern schlicht Kopien der
2661 Lieferdatenvariablen sind (z.B.
2662 <varname>shiptocontact</varname>).</para>
2666 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
2667 <title>Informationen über den Bearbeiter</title>
2671 <term><varname>employee_address</varname></term>
2674 <para>Adressfeld</para>
2679 <term><varname>employee_businessnumber</varname></term>
2682 <para>Firmennummer</para>
2687 <term><varname>employee_company</varname></term>
2690 <para>Firmenname</para>
2695 <term><varname>employee_co_ustid</varname></term>
2698 <para>Usatzsteuer-Identifikationsnummer</para>
2703 <term><varname>employee_duns</varname></term>
2706 <para>DUNS-Nummer</para>
2711 <term><varname>employee_email</varname></term>
2719 <term><varname>employee_fax</varname></term>
2727 <term><varname>employee_name</varname></term>
2730 <para>voller Name</para>
2735 <term><varname>employee_signature</varname></term>
2738 <para>Signatur</para>
2743 <term><varname>employee_taxnumber</varname></term>
2746 <para>Steuernummer</para>
2751 <term><varname>employee_tel</varname></term>
2754 <para>Telefonnummer</para>
2760 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
2761 <title>Informationen über den Bearbeiter</title>
2765 <term><varname>salesman_address</varname></term>
2768 <para>Adressfeld</para>
2773 <term><varname>salesman_businessnumber</varname></term>
2776 <para>Firmennummer</para>
2781 <term><varname>salesman_company</varname></term>
2784 <para>Firmenname</para>
2789 <term><varname>salesman_co_ustid</varname></term>
2792 <para>Usatzsteuer-Identifikationsnummer</para>
2797 <term><varname>salesman_duns</varname></term>
2800 <para>DUNS-Nummer</para>
2805 <term><varname>salesman_email</varname></term>
2813 <term><varname>salesman_fax</varname></term>
2821 <term><varname>salesman_name</varname></term>
2824 <para>voller Name</para>
2829 <term><varname>salesman_signature</varname></term>
2832 <para>Signatur</para>
2837 <term><varname>salesman_taxnumber</varname></term>
2840 <para>Steuernummer</para>
2845 <term><varname>salesman_tel</varname></term>
2848 <para>Telefonnummer</para>
2854 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
2855 <title>Variablen für die einzelnen Steuern</title>
2859 <term><varname>tax</varname></term>
2867 <term><varname>taxbase</varname></term>
2870 <para>zu versteuernder Betrag</para>
2875 <term><varname>taxdescription</varname></term>
2878 <para>Name der Steuer</para>
2883 <term><varname>taxrate</varname></term>
2886 <para>Steuersatz</para>
2893 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
2894 <title>Variablen in Rechnungen</title>
2896 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
2897 <title>Allgemeine Variablen</title>
2901 <term><varname>creditremaining</varname></term>
2904 <para>Verbleibender Kredit</para>
2909 <term><varname>currency</varname></term>
2912 <para>Währung</para>
2917 <term><varname>cusordnumber</varname></term>
2920 <para>Bestellnummer beim Kunden</para>
2925 <term><varname>deliverydate</varname></term>
2928 <para>Lieferdatum</para>
2933 <term><varname>duedate</varname></term>
2936 <para>Fälligkeitsdatum</para>
2941 <term><varname>globalprojectnumber</varname></term>
2944 <para>Projektnummer des ganzen Beleges</para>
2949 <term><varname>globalprojectdescription</varname></term>
2952 <para>Projekbeschreibung des ganzen Beleges</para>
2957 <term><varname>intnotes</varname></term>
2960 <para>Interne Bemerkungen</para>
2965 <term><varname>invdate</varname></term>
2968 <para>Rechnungsdatum</para>
2973 <term><varname>invnumber</varname></term>
2976 <para>Rechnungsnummer</para>
2981 <term><varname>invtotal</varname></term>
2984 <para>gesamter Rechnungsbetrag</para>
2989 <term><varname>notes</varname></term>
2992 <para>Bemerkungen der Rechnung</para>
2997 <term><varname>orddate</varname></term>
3000 <para>Auftragsdatum</para>
3005 <term><varname>ordnumber</varname></term>
3008 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3009 erstellt wurde</para>
3014 <term><varname>payment_description</varname></term>
3017 <para>Name der Zahlart</para>
3022 <term><varname>payment_terms</varname></term>
3025 <para>Zahlungskonditionen</para>
3030 <term><varname>quodate</varname></term>
3033 <para>Angebotsdatum</para>
3038 <term><varname>quonumber</varname></term>
3041 <para>Angebotsnummer</para>
3046 <term><varname>shippingpoint</varname></term>
3049 <para>Versandort</para>
3054 <term><varname>shipvia</varname></term>
3057 <para>Transportmittel</para>
3062 <term><varname>subtotal</varname></term>
3065 <para>Zwischensumme aller Posten ohne Steuern</para>
3070 <term><varname>total</varname></term>
3073 <para>Restsumme der Rechnung (Summe abzüglich bereits
3074 bezahlter Posten)</para>
3079 <term><varname>transaction_description</varname></term>
3082 <para>Vorgangsbezeichnung</para>
3087 <term><varname>transdate</varname></term>
3090 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3091 erstellt wurde</para>
3097 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3098 <title>Variablen für jeden Posten auf der Rechnung</title>
3102 <term><varname>bin</varname></term>
3105 <para>Stellage</para>
3110 <term><varname>description</varname></term>
3113 <para>Artikelbeschreibung</para>
3118 <term><varname>discount</varname></term>
3121 <para>Rabatt als Betrag</para>
3126 <term><varname>discount_sub</varname></term>
3129 <para>Zwischensumme mit Rabatt</para>
3134 <term><varname>drawing</varname></term>
3137 <para>Zeichnung</para>
3142 <term><varname>ean</varname></term>
3145 <para>EAN-Code</para>
3150 <term><varname>image</varname></term>
3158 <term><varname>linetotal</varname></term>
3161 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3166 <term><varname>longdescription</varname></term>
3169 <para>Langtext</para>
3174 <term><varname>microfiche</varname></term>
3177 <para>Mikrofilm</para>
3182 <term><varname>netprice</varname></term>
3185 <para>Nettopreis</para>
3190 <term><varname>nodiscount_linetotal</varname></term>
3193 <para>Zeilensumme ohne Rabatt</para>
3198 <term><varname>nodiscount_sub</varname></term>
3201 <para>Zwischensumme ohne Rabatt</para>
3206 <term><varname>number</varname></term>
3209 <para>Artikelnummer</para>
3214 <term><varname>ordnumber_oe</varname></term>
3217 <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
3218 aus einem Sammelauftrag erstellt wurde</para>
3223 <term><varname>p_discount</varname></term>
3226 <para>Rabatt in Prozent</para>
3231 <term><varname>partnotes</varname></term>
3234 <para>Die beim Artikel gespeicherten Bemerkungen</para>
3239 <term><varname>partsgroup</varname></term>
3242 <para>Warengruppe</para>
3247 <term><varname>price_factor</varname></term>
3250 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
3256 <term><varname>price_factor_name</varname></term>
3259 <para>Der Name des Preisfaktors, sofern einer eingestellt
3265 <term><varname>projectnumber</varname></term>
3268 <para>Projektnummer</para>
3273 <term><varname>projectdescription</varname></term>
3276 <para>Projektbeschreibung</para>
3281 <term><varname>qty</varname></term>
3289 <term><varname>reqdate</varname></term>
3292 <para>Lieferdatum</para>
3297 <term><varname>runningnumber</varname></term>
3300 <para>Position auf der Rechnung (1, 2, 3...)</para>
3305 <term><varname>sellprice</varname></term>
3308 <para>Verkaufspreis</para>
3313 <term><varname>serialnumber</varname></term>
3316 <para>Seriennummer</para>
3321 <term><varname>tax_rate</varname></term>
3324 <para>Steuersatz</para>
3329 <term><varname>transdate_oe</varname></term>
3332 <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
3333 aus einem Sammelauftrag erstellt wurde</para>
3338 <term><varname>unit</varname></term>
3341 <para>Einheit</para>
3346 <term><varname>weight</varname></term>
3349 <para>Gewicht</para>
3354 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
3355 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
3356 einer <function>foreach</function>-Schleife ausgegeben werden, da
3357 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
3358 können. Die Variablen dafür lauten:</para>
3362 <term><varname>make</varname></term>
3365 <para>Lieferant</para>
3370 <term><varname>model</varname></term>
3373 <para>Lieferantenartikelnummer</para>
3379 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
3380 <title>Variablen für die einzelnen Zahlungseingänge</title>
3384 <term><varname>payment</varname></term>
3392 <term><varname>paymentaccount</varname></term>
3400 <term><varname>paymentdate</varname></term>
3408 <term><varname>paymentmemo</varname></term>
3416 <term><varname>paymentsource</varname></term>
3425 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
3426 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
3428 <para>Die vom Benutzer definierten Variablen für Kunden und
3429 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
3430 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
3431 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
3432 Variablennamen zusammen.</para>
3434 <para>Beispiel: Der Benutzer hat eine Variable namens
3435 <varname>number_of_employees</varname> definiert, die die Anzahl der
3436 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
3437 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
3442 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
3443 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
3445 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
3446 <title>Namen der Vorlagen</title>
3448 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
3449 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
3450 Erstellung einer Rechnung über die Mahngebühren und Zinsen
3451 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
3452 Vorlagenname für diese Mahnstufe mit dem Zusatz
3453 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
3454 für die ausgewählte Sprache und den ausgewählten Drucker
3458 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
3459 <title>Allgemeine Variablen in Mahnungen</title>
3461 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3462 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3463 Kunden stehen als Variablen <varname>name</varname>,
3464 <varname>street</varname>, <varname>zipcode</varname>,
3465 <varname>city</varname>, <varname>country</varname>,
3466 <varname>department_1</varname>, <varname>department_2</varname>,
3467 und <varname>email</varname> zur Verfügung.</para>
3469 <para>Weitere Variablen beinhalten:</para>
3473 <term><varname>dunning_date</varname></term>
3476 <para>Datum der Mahnung</para>
3481 <term><varname>dunning_duedate</varname></term>
3484 <para>Fälligkeitsdatum für diese Mahhnung</para>
3489 <term><varname>dunning_id</varname></term>
3492 <para>Mahnungsnummer</para>
3497 <term><varname>fee</varname></term>
3500 <para>Kummulative Mahngebühren</para>
3505 <term><varname>interest_rate</varname></term>
3508 <para>Zinssatz per anno in Prozent</para>
3513 <term><varname>total_amount</varname></term>
3516 <para>Gesamter noch zu zahlender Betrag als
3517 <function>fee</function> + <function>total_interest</function>
3518 + <function>total_open_amount</function></para>
3523 <term><varname>total_interest</varname></term>
3526 <para>Zinsen per anno über alle Rechnungen</para>
3531 <term><varname>total_open_amount</varname></term>
3534 <para>Summe über alle offene Beträge der Rechnungen</para>
3540 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
3541 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
3545 <term><varname>dn_amount</varname></term>
3548 <para>Rechnungssumme (brutto)</para>
3553 <term><varname>dn_duedate</varname></term>
3556 <para>Originales Fälligkeitsdatum der Rechnung</para>
3561 <term><varname>dn_dunning_date</varname></term>
3564 <para>Datum der Mahnung</para>
3569 <term><varname>dn_dunning_duedate</varname></term>
3572 <para>Fälligkeitsdatum der Mahnung</para>
3577 <term><varname>dn_fee</varname></term>
3580 <para>Kummulative Mahngebühr</para>
3585 <term><varname>dn_interest</varname></term>
3588 <para>Zinsen per anno für diese Rechnung</para>
3593 <term><varname>dn_invnumber</varname></term>
3596 <para>Rechnungsnummer</para>
3601 <term><varname>dn_linetotal</varname></term>
3604 <para>Noch zu zahlender Betrag (ergibt sich aus
3605 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
3606 + <varname>dn_interest</varname>)</para>
3611 <term><varname>dn_netamount</varname></term>
3614 <para>Rechnungssumme (netto)</para>
3619 <term><varname>dn_open_amount</varname></term>
3622 <para>Offener Rechnungsbetrag</para>
3627 <term><varname>dn_ordnumber</varname></term>
3630 <para>Bestellnummer</para>
3635 <term><varname>dn_transdate</varname></term>
3638 <para>Rechnungsdatum</para>
3643 <term><varname>dn_curr</varname></term>
3646 <para>Währung, in der die Rechnung erstellt wurde. (Die
3647 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
3653 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
3654 <title>Variablen in automatisch erzeugten Rechnungen über
3655 Mahngebühren</title>
3657 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3658 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3659 Kunden stehen als Variablen <varname>name</varname>,
3660 <varname>street</varname>, <varname>zipcode</varname>,
3661 <varname>city</varname>, <varname>country</varname>,
3662 <varname>department_1</varname>, <varname>department_2</varname>,
3663 und <varname>email</varname> zur Verfügung.</para>
3665 <para>Weitere Variablen beinhalten:</para>
3669 <term><varname>duedate</varname></term>
3672 <para>Fälligkeitsdatum der Rechnung</para>
3677 <term><varname>dunning_id</varname></term>
3680 <para>Mahnungsnummer</para>
3685 <term><varname>fee</varname></term>
3688 <para>Mahngebühren</para>
3693 <term><varname>interest</varname></term>
3701 <term><varname>invamount</varname></term>
3704 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
3705 <varname>interest</varname>)</para>
3710 <term><varname>invdate</varname></term>
3713 <para>Rechnungsdatum</para>
3718 <term><varname>invnumber</varname></term>
3721 <para>Rechnungsnummer</para>
3728 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
3729 <title>Variablen in anderen Vorlagen</title>
3732 <title>Einführung</title>
3734 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
3735 Rechnung. Allerdings heißen die Variablen, die mit
3736 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
3737 fangen sie mit <varname>quo</varname> für "quotation" an:
3738 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
3739 wiederum fangen sie mit <varname>ord</varname> für "order" an:
3740 <varname>ordnumber</varname> für Bestellnummer etc.</para>
3742 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
3743 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
3744 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
3745 Vorlage keine Bedeutung haben oder noch nicht belegt sein
3748 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
3749 in Rechnungen aufgeführt.</para>
3752 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
3753 <title>Angebote und Preisanfragen</title>
3757 <term><varname>quonumber</varname></term>
3760 <para>Angebots- bzw. Anfragenummer</para>
3765 <term><varname>reqdate</varname></term>
3768 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
3769 Preisanfragen)</para>
3774 <term><varname>transdate</varname></term>
3777 <para>Angebots- bzw. Anfragedatum</para>
3783 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
3784 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
3788 <term><varname>ordnumber</varname></term>
3791 <para>Auftragsnummer</para>
3796 <term><varname>reqdate</varname></term>
3799 <para>Lieferdatum</para>
3804 <term><varname>transdate</varname></term>
3807 <para>Auftragsdatum</para>
3813 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
3814 <title>Lieferscheine (Verkauf und Einkauf)</title>
3818 <term><varname>cusordnumber</varname></term>
3821 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
3822 des Lieferanten (im Einkauf)</para>
3827 <term><varname>donumber</varname></term>
3830 <para>Lieferscheinnummer</para>
3835 <term><varname>transdate</varname></term>
3838 <para>Lieferscheindatum</para>
3843 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
3844 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
3845 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
3846 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
3847 <function>foreach</function>-Schleife ausgegeben werden. Diese
3848 Variablen sind:</para>
3852 <term><varname>si_bin</varname></term>
3855 <para>Lagerplatz</para>
3860 <term><varname>si_chargenumber</varname></term>
3863 <para>Chargennummer</para>
3868 <term><varname>si_bestbefore</varname></term>
3871 <para>Mindesthaltbarkeit</para>
3876 <term><varname>si_number</varname></term>
3879 <para>Artikelnummer</para>
3884 <term><varname>si_qty</varname></term>
3887 <para>Anzahl bzw. Menge</para>
3892 <term><varname>si_runningnumber</varname></term>
3895 <para>Positionsnummer (1, 2, 3 etc)</para>
3900 <term><varname>si_unit</varname></term>
3903 <para>Einheit</para>
3908 <term><varname>si_warehouse</varname></term>
3917 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
3918 <title>Variablen für Sammelrechnung</title>
3922 <term><varname>c0total</varname></term>
3925 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
3931 <term><varname>c30total</varname></term>
3934 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
3935 und < 60 Tage</para>
3940 <term><varname>c60total</varname></term>
3943 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
3944 und < 90 Tage</para>
3949 <term><varname>c90total</varname></term>
3952 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
3958 <term><varname>total</varname></term>
3961 <para>Gesamtbetrag aller Rechnungen</para>
3966 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
3970 <term><varname>invnumber</varname></term>
3973 <para>Rechnungsnummer</para>
3978 <term><varname>invdate</varname></term>
3981 <para>Rechnungsdatum</para>
3986 <term><varname>duedate</varname></term>
3989 <para>Fälligkeitsdatum</para>
3994 <term><varname>amount</varname></term>
3997 <para>Summe der Rechnung</para>
4002 <term><varname>open</varname></term>
4005 <para>Noch offener Betrag der Rechnung</para>
4010 <term><varname>c0</varname></term>
4013 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4019 <term><varname>c30</varname></term>
4022 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4028 <term><varname>c60</varname></term>
4031 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4037 <term><varname>c90</varname></term>
4040 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4048 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4049 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4051 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4052 <title>Einfürhung</title>
4054 <para>Der Parser kennt neben den Variablen einige weitere
4055 Konstrukte, die gesondert behandelt werden. Diese sind wie
4056 Variablennamen in spezieller Weise markiert:
4057 <command><%anweisung%> ... <%end%></command></para>
4059 <para>Anmerkung zum <command><%end%></command>: Der besseren
4060 Verständlichkeit halber kann man nach dem <command>end</command>
4061 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4062 Anweisung (z.B. <command>if</command> oder
4063 <command>foreach</command>) damit abgeschlossen wird.</para>
4065 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4066 <command><%if type == "sales_quotation"%></command>, so könnte
4067 er mit <command><%end%></command> genauso abgeschlossen werden
4068 wie mit <command><%end if%></command> oder auch
4069 <command><%end type == "sales_quotation"%></command>.</para>
4072 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4073 <title>Der if-Block</title>
4075 <programlisting><%if variablenname%>
4077 <%end%></programlisting>
4079 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4080 und dem "end" werden nur ausgegeben, wenn die Variable
4081 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4083 <para>Die Bedingung kann auch negiert werden, indem das Wort
4084 <function>not</function> nach dem <filename>if</filename> verwendet
4085 wird. Beispiel:</para>
4087 <programlisting><%if not cp_greeting%>
4089 <%end%></programlisting>
4091 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4092 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4093 einer Variablen mit einer festen Zeichenkette oder einer anderen
4094 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4095 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4096 die rechte Seite des Vergleichsoperators in Anführungszeichen
4097 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4098 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4101 <programlisting><%if var1 == "Wert"%></programlisting>
4103 <para>Testet die Variable <varname>var1</varname> auf
4104 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4105 Mittels <function>!=</function> anstelle von <function>==</function>
4106 würde auf Ungleichheit getestet.</para>
4108 <programlisting><%if var1 == var2%></programlisting>
4110 <para>Testet die Variable <varname>var1</varname> auf
4111 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4112 <function>!=</function> anstelle von <function>==</function> würde
4113 auf Ungleichheit getestet.</para>
4115 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4116 auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
4117 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4118 dieselbe Syntax wie oben nur mit <function>=~</function> und
4119 <function>!~</function> als Vergleichsoperatoren.</para>
4121 <para>Beispiel für einen Test, ob die Variable
4122 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4123 <constant>schwierig</constant> enthält:</para>
4125 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4128 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4129 <title>Der foreach-Block</title>
4131 <programlisting><%foreach variablenname%>
4133 <%end%></programlisting>
4135 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4136 wie das Perl-Array der Variablen <varname>variablenname</varname>
4137 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4138 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4139 benutzt. In jedem Durchlauf werden die <link
4140 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4141 Variablen</link> jeweils auf den Wert für die aktuelle Position
4144 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
4146 <programlisting><%foreach number%>
4147 Position: <%runningnumber%>
4148 Anzahl: <%qty%>
4149 Artikelnummer: <%number%>
4150 Beschreibung: <%description%>
4152 <%end%></programlisting>
4154 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
4155 <function><%foreach%></function>-Block innerhalb einer
4156 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
4157 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
4158 Inhalt zwischen <function><%foreach%></function> und
4159 <function><%end%></function> wiederholt, nicht aber die
4160 komplette Zeile, in der er steht.</para>
4164 <sect2 id="dokumentenvorlagen-und-variablen.markup">
4165 <title>Markup-Code zur Textformatierung innerhalb von
4168 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
4169 anders formatiert haben möchte, so ist dies begrenzt möglich.
4170 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
4171 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
4172 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
4173 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
4174 (HTML oder PDF über LaTeX) umgesetzt.</para>
4176 <para>Die unterstützen Formatierungen sind:</para>
4180 <term><b>Text</b></term>
4183 <para>Text wird in Fettdruck gesetzt.</para>
4188 <term><i>Text</i></term>
4191 <para>Text wird kursiv gesetzt.</para>
4196 <term><u>Text</u></term>
4199 <para>Text wird unterstrichen.</para>
4204 <term><s>Text</s></term>
4207 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
4208 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
4213 <term><bullet></term>
4216 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
4222 <para>Der Befehl <command><bullet></command> funktioniert
4223 momentan auch nur in Latex-Vorlagen.</para>
4227 <sect1 id="excel-templates">
4228 <title>Excel-Vorlagen</title>
4230 <sect2 id="excel-templates.summary">
4231 <title>Zusammenfassung</title>
4233 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
4234 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
4238 <sect2 id="excel-templates.usage">
4239 <title>Bedienung</title>
4241 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
4242 werden. Die Konfigurationsoption heißt <varname>excel_templates =
4243 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
4245 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
4246 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
4247 werden. In den normalen Verkaufsmasken taucht nun
4248 <constant>Excel</constant> als auswählbares Format auf und kann von da
4249 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
4251 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
4252 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
4253 <filename>sales_quotation.xls</filename> gespeichert.</para>
4256 <sect2 id="excel-templates.syntax">
4257 <title>Variablensyntax</title>
4259 <para>Einfache Syntax:
4260 <command><<varname>></command></para>
4262 <para>Dabei sind <constant><<</constant> und
4263 <constant>>></constant> die Delimiter. Da Excel auf festen
4264 Breiten besteht, kann der Tag künstlich verlängert werden, indem
4265 weitere <constant><</constant> oder <constant>></constant>
4266 eingefügt werden. Der Tag muss nicht symmetrisch sein.
4269 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4271 <para>Um die Limitierung der festen Breite zu reduzieren, können
4272 weitere Variablen in einem Block interpoliert werden. Whitespace wird
4273 dazwishen dann erhalten. Beispiel:</para>
4275 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4277 <para>Die Variablen werden interpoliert, und linksbündig mit
4278 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
4279 lang, werden überzählige Zeichen abgeschnitten.</para>
4281 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
4282 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
4284 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4286 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
4287 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
4291 <sect2 id="excel-templates.limitations">
4292 <title>Einschränkungen</title>
4294 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
4295 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
4296 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
4297 Text zu ersetzen.</para>
4299 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
4300 <command><%if%></command> und
4301 <command><%foreach%></command> nicht vorhanden. Der Delimiter
4302 <constant><% %></constant> kommt in den Headerinformationen
4303 evtl. vor. Deshalb wurde auf den sichereren Delimiter
4304 <constant><<</constant> und <constant>>></constant>
4311 <title>Entwicklerdokumentation</title>
4313 <sect1 id="devel.globals" xreflabel="Globale Variablen">
4314 <title>Globale Variablen</title>
4317 <title>Wie sehen globale Variablen in Perl aus?</title>
4319 <para>Globale Variablen liegen in einem speziellen namespace namens
4320 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
4321 globs global und die meisten speziellen Variablen sind...
4324 <para>Daraus ergeben sich folgende Formen:</para>
4328 <term><literal>$main::form</literal></term>
4331 <para>expliziter Namespace "main"</para>
4336 <term><literal>$::form</literal></term>
4339 <para>impliziter Namespace "main"</para>
4344 <term><literal>open FILE, "file.txt"</literal></term>
4347 <para><varname>FILE</varname> ist global</para>
4352 <term><literal>$_</literal></term>
4355 <para>speziell</para>
4360 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
4361 Schlüsselwort wie "<function>global</function>", mit dem man
4362 importieren kann. <function>my</function>, <function>our</function>
4363 und <function>local</function> machen was anderes.</para>
4367 <term><literal>my $form</literal></term>
4370 <para>lexikalische Variable, gültig bis zum Ende des
4376 <term><literal>our $form</literal></term>
4379 <para><varname>$form</varname> referenziert ab hier
4380 <varname>$PACKAGE::form</varname>.</para>
4385 <term><literal>local $form</literal></term>
4388 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
4389 des scopes zurückgesetzt</para>
4396 <title>Warum sind globale Variablen ein Problem?</title>
4398 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
4400 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
4401 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
4402 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
4403 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
4404 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
4405 Datenbankverbindungen, weil die sehr lange zum Initialisieren
4408 <para>Das zweite Problem ist <function>strict</function>. Unter
4409 <function>strict</function> werden alle Variablen die nicht explizit
4410 mit <function>Package</function>, <function>my</function> oder
4411 <function>our</function> angegeben werden als Tippfehler angemarkert,
4412 dies hat, seit der Einführung, u.a. schon so manche langwierige
4413 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
4414 angegeben werden, werden die nicht geprüft, und somit kann sich
4415 schnell ein Tippfehler einschleichen.</para>
4419 <title>Kanonische globale Variablen</title>
4421 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
4422 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
4423 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
4424 umhergereicht werden.</para>
4426 <para>Diese Variablen sind im Moment die folgenden neun:</para>
4430 <para><varname>$::form</varname></para>
4434 <para><varname>%::myconfig</varname></para>
4438 <para><varname>$::locale</varname></para>
4442 <para><varname>$::lxdebug</varname></para>
4446 <para><varname>$::auth</varname></para>
4450 <para><varname>$::lx_office_conf</varname></para>
4454 <para><varname>$::instance_conf</varname></para>
4458 <para><varname>$::dispatcher</varname></para>
4462 <para><varname>$::request</varname></para>
4466 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
4467 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
4468 Eigenschaften (Konventionen):</para>
4471 <title>$::form</title>
4475 <para>Ist ein Objekt der Klasse
4476 "<classname>Form</classname>"</para>
4480 <para>Wird nach jedem Request gelöscht</para>
4484 <para>Muss auch in Tests und Konsolenscripts vorhanden
4489 <para>Enthält am Anfang eines Requests die Requestparameter vom
4494 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
4495 cachen, das wird aber momentan absichtlich zerstört</para>
4499 <para><varname>$::form</varname> wurde unter <productname>SQL
4500 Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
4501 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
4502 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
4503 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
4504 <function>IS->retrieve_customer()</function> in Sicherheit
4507 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
4508 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
4509 3552, Stand version 2.7beta), um dies hinterher wieder auf den
4510 richtigen Wert zu setzen:</para>
4512 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
4513 $::myconfig{numberformat} = $numberformat;
4514 # (...) div Berechnungen
4515 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
4517 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
4518 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
4519 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
4520 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
4521 Es geht ziemlich sicher etwas kaputt.</para>
4523 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
4524 in den <productname>Template::Toolkit</productname> Templates
4525 außerhalb der Controller: der Ausdruck <function>[% var
4526 %]</function> greift auf <varname>$::form->{var}</varname> zu.
4527 Unter Controllern ist der Standard Scope anders, da lautet der
4528 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
4529 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
4530 <function><%var%></function> zeigt auf
4531 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
4532 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
4535 <programlisting>[%- IF business %]
4536 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
4537 [%- END %]</programlisting>
4539 <para>Entweder wird hier dann $::form->{business} ausgewertet
4540 oder aber der Funktion
4541 <function>$form->parse_html_template</function> wird explizit
4542 noch ein zusätzlicher Hash übergeben, der dann auch in den
4543 (Web-)Templates zu Verfügung steht, bspw. so:</para>
4545 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
4547 <para>Innerhalb von Schleifen wird
4548 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
4549 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
4550 welches über alle Positionen eines Lieferscheins in Schleife
4553 <programlisting>for $i (1 .. $form->{rowcount}) {
4555 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
4556 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
4557 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
4563 <title>%::myconfig</title>
4567 <para>Das einzige Hash unter den globalen Variablen</para>
4571 <para>Wird spätestens benötigt wenn auf die Datenbank
4572 zugegriffen wird</para>
4576 <para>Wird bei jedem Request neu erstellt.</para>
4580 <para>Enthält die Userdaten des aktuellen Logins</para>
4584 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
4585 extern serialisiert werden, weil da auch der Datenbankzugriff
4586 für diesen user drinsteht.</para>
4590 <para>Enthält unter anderem Listenbegrenzung vclimit,
4591 Datumsformat dateformat und Nummernformat numberformat</para>
4595 <para>Enthält Datenbankzugriffinformationen</para>
4599 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
4600 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
4601 aktuellen Users entscheiden müssen, befragen
4602 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
4603 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
4604 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
4605 Informationen über den Benutzer die über die
4606 Administrator-Schnittstelle (admin.pl) eingegeben wurden.</para>
4610 <title>$::locale</title>
4614 <para>Objekt der Klasse "Locale"</para>
4618 <para>Wird pro Request erstellt</para>
4622 <para>Muss auch für Tests und Scripte immer verfügbar
4627 <para>Cached intern über Requestgrenzen hinweg benutzte
4632 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
4633 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
4637 <title>$::lxdebug</title>
4641 <para>Objekt der Klasse "LXDebug"</para>
4645 <para>Wird global gecached</para>
4649 <para>Muss immer verfügbar sein, in nahezu allen
4654 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
4655 bereit, wie "<function>enter_sub</function>" und
4656 "<function>leave_sub</function>", mit denen in den alten Modulen ein
4657 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
4658 der man die Wallclockzeit seit Requeststart loggen kann, sowie
4659 "<function>message</function>" und "<function>dump</function>" mit
4660 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
4663 <para>Beispielsweise so:</para>
4665 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
4666 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
4670 <title>$::auth</title>
4674 <para>Objekt der Klasse "SL::Auth"</para>
4678 <para>Wird global gecached</para>
4682 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
4686 <para>Wird nach jedem Request resettet.</para>
4690 <para><varname>$::auth</varname> stellt Funktionen bereit um die
4691 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
4692 vom aktuellen User abhängen wird das Objekt aus
4693 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
4694 Request kurz resettet.</para>
4698 <title>$::lx_office_conf</title>
4702 <para>Objekt der Klasse
4703 "<classname>SL::LxOfficeConf</classname>"</para>
4707 <para>Global gecached</para>
4711 <para>Repräsentation der
4712 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
4716 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
4717 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
4718 das Programm die Konfiguration ändern kann oder sollte.</para>
4720 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
4721 Debug- und Trace-Log-Datei wie folgt konfiguriert und
4724 <programlisting>[debug]
4725 file = /tmp/kivitendo-debug.log</programlisting>
4727 <para>ist der Key <varname>file</varname> im Programm als
4728 <varname>$::lx_office_conf->{debug}{file}</varname>
4732 <para>Zugriff auf die Konfiguration erfolgt im Moment über
4733 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
4738 <title>$::instance_conf</title>
4742 <para>Objekt der Klasse
4743 "<classname>SL::InstanceConfiguration</classname>"</para>
4747 <para>wird pro Request neu erstellt</para>
4751 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
4752 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
4753 ist hier eine Mandantendatenbank. Beispielsweise überprüft
4754 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
4755 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
4759 <title>$::dispatcher</title>
4763 <para>Objekt der Klasse
4764 "<varname>SL::Dispatcher</varname>"</para>
4768 <para>wird pro Serverprozess erstellt.</para>
4772 <para>enthält Informationen über die technische Verbindung zum
4777 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
4778 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
4779 Objekt untergebracht.</para>
4783 <title>$::request</title>
4787 <para>Hashref (evtl später Objekt)</para>
4791 <para>Wird pro Request neu initialisiert.</para>
4795 <para>Keine Unterstruktur garantiert.</para>
4799 <para><varname>$::request</varname> ist ein generischer Platz um
4800 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
4801 at a distance benutzt werden, sondern um lokales memoizing zu
4802 ermöglichen, das garantiert am Ende des Requests zerstört
4805 <para>Vieles von dem, was im moment in <varname>$::form</varname>
4806 liegt, sollte eigentlich hier liegen. Die groben
4807 Differentialkriterien sind:</para>
4811 <para>Kommt es vom User, und soll unverändert wieder an den
4812 User? Dann <varname>$::form</varname>, steht da eh schon</para>
4816 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
4817 Requests gebraucht werden? Dann
4818 <varname>$::request</varname></para>
4822 <para>Muss ich von anderen Teilen des Programms lesend drauf
4823 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
4824 Wrappermethode</para>
4831 <title>Ehemalige globale Variablen</title>
4833 <para>Die folgenden Variablen waren einmal im Programm, und wurden
4837 <title>$::cgi</title>
4841 <para>war nötig, weil cookie Methoden nicht als
4842 Klassenfunktionen funktionieren</para>
4846 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
4847 Klassennamespace gehalten wird und über Requestgrenzen
4852 <para>liegt jetzt unter
4853 <varname>$::request->{cgi}</varname></para>
4859 <title>$::all_units</title>
4863 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
4864 ein paar hundert mal pro Request eine Liste der Einheiten
4865 brauchen, und de als Parameter durch einen Riesenstack von
4866 Funktionen geschleift werden müssten.</para>
4870 <para>Liegt jetzt unter
4871 <varname>$::request->{cache}{all_units}</varname></para>
4876 <function>AM->retrieve_all_units()</function> gesetzt oder
4883 <title>%::called_subs</title>
4887 <para>wurde benutzt um callsub deep recursions
4892 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
4893 möglichen Rekursioenen darstellt, und da nie welche
4898 <para>komplette recursion protection wurde entfernt.</para>
4905 <sect1 id="devel.fcgi">
4906 <title>Entwicklung unter FastCGI</title>
4908 <sect2 id="devel.fcgi.general">
4909 <title>Allgemeines</title>
4911 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
4912 werden, muss der Webserver neu gestartet werden.</para>
4914 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
4915 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
4916 müssen folgende Aspekte beachtet werden.</para>
4919 <sect2 id="devel.fcgi.exiting">
4920 <title>Programmende und Ausnahmen</title>
4922 <para>Betrifft die Funktionen <function>warn</function>,
4923 <function>die</function>, <function>exit</function>,
4924 <function>carp</function> und <function>confess</function>.</para>
4926 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
4927 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
4928 am Laufen zu halten. Man kann mit <function>die</function>,
4929 <function>confess</function> oder <function>carp</function> Fehler
4930 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
4931 eigene <function>$::form-</function>error()> tut im Prinzip das
4932 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
4933 <function>exit</function> hingegen werden nicht abgefangen.
4934 <function>warn</function> wird direkt nach STDERR, also in Server Log
4935 eine Nachricht schreiben (sofern in der Konfiguration nicht die
4936 Warnungen in das kivitendo Log umgeleitet wurden), und
4937 <function>exit</function> wird die Ausführung beenden.</para>
4939 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
4940 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
4941 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
4942 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
4945 <sect2 id="devel.fcgi.globals">
4946 <title>Globale Variablen</title>
4948 <para>Um zu vermeiden, dass Informationen von einem Request in einen
4949 anderen gelangen, müssen alle globalen Variablen vor einem Request
4950 sauber initialisiert werden. Das ist besonders wichtig im
4951 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
4952 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
4955 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
4956 abgetrennten Block, der alle kanonischen globalen Variablen listet und
4957 erklärt. Bitte keine anderen einführen ohne das sauber zu
4958 dokumentieren.</para>
4960 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
4961 man sicher geht, dass man die richtige erwischt.</para>
4964 <sect2 id="devel.fcgi.performance">
4965 <title>Performance und Statistiken</title>
4967 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
4968 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
4969 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
4970 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
4971 sind es je nach Menge der definierten Variablen 1-2s. Ab der
4972 Moose/Rose::DB Version sind es 5-6s.</para>
4974 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
4975 den kritischen Pfaden, unter 0,15 sonst.</para>
4978 <sect2 id="devel.fcgi.known-issues">
4979 <title>Bekannte Probleme</title>
4981 <sect3 id="devel.fcgi.known-issues.encoding">
4982 <title>Encoding Awareness</title>
4984 <para>UTF-8 kodierte Installationen sind sehr anfällig gegen
4985 fehlerhfate Encodings unter FCGI. latin9 Installationen behandeln
4986 falsch kodierte Zeichen eher unwissend, und geben sie einfach
4987 weiter. UTF-8 verweigert bei fehlerhaften Programmpfaden kurzerhand
4988 das Ausliefern. Es wird noch daran gearbeitet, alle Fehler da zu
4994 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
4995 <title>SQL-Upgradedateien</title>
4997 <sect2 id="db-upgrade-files.introduction"
4998 xreflabel="Einführung in die Datenbank-Upgradedateien">
4999 <title>Einführung</title>
5001 <para>Der alte Mechanismus für SQL-Upgradescripte, der auf einer
5002 Versionsnummer beruht und dann in sql/Pg-upgrade nach einem Script für
5003 diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele
5004 Entwicklung im stable- und unstable-Baum betrifft.</para>
5006 <para>Dieser Mechanismus wurde für kivitendo 2.4.1 deutlich erweitert.
5007 Es werden weiterhin alle Scripte aus sql/Pg-upgrade ausgeführt.
5008 Zusätzlich gibt es aber ein zweites Verzeichnis, sql/Pg-upgrade2. In
5009 diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren,
5010 die neben den eigentlich auszuführenden SQL- oder Perl-Befehlen einige
5011 Kontrollinformationen enthält.</para>
5013 <para>Neu sind die Kontrollinformationen, die Abhängigkeiten und
5014 Prioritäten definieren können werden, sodass Datenbankscripte zwar in
5015 einer sicheren Reihenfolge ausgeführt werden (z.B. darf ein "ALTER
5016 TABLE" erst ausgeführt werden, wenn die Tabelle mit "CREATE TABLE"
5017 angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man
5018 keine Versionsnummern mehr braucht.</para>
5020 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
5021 sql/Pg-upgrade2 bereits durchgeführt wurde und führt diese nicht
5022 erneut aus. Dazu dient die Tabelle "schema_info", die bei der
5023 Anmeldung automatisch angelegt wird.</para>
5026 <sect2 id="db-upgrade-files.format"
5027 xreflabel="Format der Upgradedateien">
5028 <title>Format der Kontrollinformationen</title>
5030 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5031 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5032 hat dabei das folgende Format:</para>
5034 <para>Für SQL-Upgradedateien:</para>
5036 <programlisting>-- @key: value</programlisting>
5038 <para>Für Perl-Upgradedateien:</para>
5040 <programlisting># @key: value</programlisting>
5042 <para>Leerzeichen vor "<varname>value</varname>" werden
5045 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5049 <term><varname>tag</varname></term>
5052 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5053 Dieser "tag" kann von anderen Kontrolldateien in ihren
5054 Abhängigkeiten verwendet werden (Schlüsselwort
5055 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5056 in der Datenbank eingetragen wird.</para>
5058 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5059 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5061 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5062 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5063 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5069 <term><varname>charset</varname></term>
5072 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
5073 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5074 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
5075 Abwesenheit des Tags der Zeichensatz
5076 "<literal>ISO-8859-15</literal>" angenommen.</para>
5081 <term><varname>description</varname></term>
5084 <para>Benötigt. Eine Beschreibung, was in diesem Update
5085 passiert. Diese wird dem Benutzer beim eigentlichen
5086 Datenbankupdate angezeigt. Während der Tag in englisch gehalten
5087 sein sollte, sollte die Beschreibung auf Deutsch
5093 <term><varname>depends</varname></term>
5096 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5097 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
5098 dass die in dieser Liste aufgeführten Scripte bereits
5099 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5101 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5102 Script "b" existiert, das von Änderungen in "a" abhängt, und
5103 eine neue Kontrolldatei für "c" erstellt wird, die von
5104 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5105 Tag "b" als Abhängigkeit zu definieren.</para>
5107 <para>Es ist nicht erlaubt, sich selbst referenzierende
5108 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5109 und "c" -> "a").</para>
5114 <term><varname>priority</varname></term>
5117 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5118 der Scripte ausgeführt werden, die die gleichen
5119 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5120 der Wert 1000 benutzt.</para>
5122 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5123 "depends" benutzt werden. kivitendo sortiert die auszuführenden
5124 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5125 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5126 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5127 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5128 Priorität alphabetisch nach dem "tag".</para>
5133 <term><varname>ignore</varname></term>
5136 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
5137 Skript bei der Anmeldung ignoriert und entsprechend nicht
5144 <sect2 id="db-upgrade-files.dbupgrade-tool"
5145 xreflabel="Hilfsscript dbupgrade2_tool.pl">
5146 <title>Hilfsscript dbupgrade2_tool.pl</title>
5148 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
5149 existiert ein Hilfsscript namens
5150 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
5151 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
5152 liest alle Datenbankupgradescripte aus dem Verzeichnis
5153 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
5154 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
5155 von der Kommandozeile überprüft werden können.</para>
5157 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
5158 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
5159 sich aber auch Informationen auf verschiedene Art ausgeben
5164 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
5165 --list</command>"</para>
5167 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
5168 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
5169 würde. Es werden neben der Listenposition der Tag, die
5170 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
5174 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
5175 --tree</command>"</para>
5177 <para>Listet alle Tags in Baumform basierend auf den
5178 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
5179 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
5180 beim übergeordneten Script als Abhängigkeit eingetragen
5184 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
5185 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
5186 --rtree</command>"</para>
5188 <para>Listet alle Tags in Baumform basierend auf den
5189 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
5190 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
5191 die das übergeordnete Script als Abhängigkeit eingetragen
5196 <para>Baumform mit Postscriptausgabe:
5197 "<command>./scripts/dbupgrade2_tool.pl
5198 --graphviz</command>"</para>
5200 <para>Benötigt das Tool "<command>graphviz</command>", um mit
5201 seiner Hilfe die <link
5202 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
5203 Baumform</link> in eine Postscriptdatei namens
5204 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
5205 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
5206 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
5207 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
5212 <para>Scripte, von denen kein anderes Script abhängt:
5213 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
5215 <para>Listet die Tags aller Scripte auf, von denen keine anderen
5216 Scripte abhängen.</para>
5222 <sect1 id="translations-languages" xreflabel="Translations and languages">
5223 <title>Translations and languages</title>
5225 <sect2 id="translations-languages.introduction"
5226 xreflabel="Introduction to translations and languages">
5227 <title>Introduction</title>
5230 <para>Dieser Abschnitt ist in Englisch geschrieben, um
5231 internationalen Übersetzern die Arbeit zu erleichtern.</para>
5234 <para>This section describes how localization packages in kivitendo
5235 are built. Currently the only language fully supported is German, and
5236 since most of the internal messages are held in English the English
5237 version is usable too.</para>
5239 <para>A stub version of French is included but not functunal at this
5243 <sect2 id="translations-languages.file-structure"
5244 xreflabel="File structure">
5245 <title>File structure</title>
5247 <para>The structure of locales in kivitendo is:</para>
5249 <programlisting>kivitendo/locale/<langcode>/</programlisting>
5251 <para>where <langcode> stands for an abbreviation of the
5252 language package. The builtin packages use two letter <ulink
5253 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
5254 but the actual name is not relevant for the program and can easily be
5256 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
5257 tags</ulink> (i.e. "en_GB"). In fact the original language packages
5258 from SQL Ledger are named in this way.</para>
5260 <para>In such a language directory the following files are
5265 <term>LANGUAGE</term>
5268 <para>This file is mandatory.</para>
5270 <para>The <filename>LANGUAGE</filename> file contains the self
5271 descripted name of the language. It should contain a native
5272 representation first, and in parenthesis an english translation
5273 after that. Example:</para>
5275 <programlisting>Deutsch (German)</programlisting>
5280 <term>charset</term>
5283 <para>This file should be present.</para>
5285 <para>The <filename>charset</filename> file describes which
5286 charset a language package is written in and applies to all
5287 other language files in the package. It is possible to write
5288 some language packages without an explicit charset, but it is
5289 still strongly recommended. You'll never know in what
5290 environment your language package will be used, and neither
5291 UTF-8 nor Latin1 are guaranteed.</para>
5293 <para>The whole content of this file is a string that can be
5294 recognized as a valid charset encoding. Example:</para>
5296 <programlisting>UTF-8</programlisting>
5304 <para>This file is mandatory.</para>
5306 <para>The central translation file. It is essentially an inline
5307 Perl script autogenerated by <command>locales.pl</command>. To
5308 generate it, generate the directory and the two files mentioned
5309 above, and execute the following command:</para>
5311 <programlisting>scripts/locales.pl <langcode></programlisting>
5313 <para>Otherwise you can simply copy one of the other languages.
5314 You will be told how many are missing like this:</para>
5316 <programlisting>$ scripts/locales.pl en
5317 English - 0.6% - 2015/2028 missing</programlisting>
5319 <para>A file named "<filename>missing</filename>" will be
5320 generated and can be edited. You can also edit the
5321 "<filename>all</filename>" file directly. Edit everything you
5322 like to fit the target language and execute
5323 <command>locales.pl</command> again. See how the missing words
5329 <term>Num2text</term>
5332 <para>Legacy code from SQL Ledger. It provides a means for
5333 numbers to be converted into natural language, like
5334 <literal>1523 => one thousand five hundred twenty
5335 three</literal>. If you want to provide it, it must be inlinable
5336 Perl code which provides a <function>num2text</function> sub. If
5337 an <function>init</function> sub exists it will be executed
5340 <para>Only used in the check and receipt printing module.</para>
5345 <term>special_chars</term>
5348 <para>kivitendo comes with a lot of interfaces to different
5349 formats, some of which are rather picky with their accepted
5350 charset. The <filename>special_chars</filename> file contains a
5351 listing of chars not suited for different file format and
5352 provides substitutions. It is written in "Simple Ini" style,
5353 containing a block for every file format.</para>
5355 <para>First entry should be the order of substitution for
5356 entries as a whitespace separated list. All entries are
5357 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
5358 and <literal>\\</literal> all work.</para>
5360 <para>After that every entry is a special char that should be
5361 translated when writing text into such a file.</para>
5363 <para>Example:</para>
5365 <programlisting>[Template/XML]
5366 order=& < > \n
5370 \n=<br></programlisting>
5372 <para>Note the importance of the order in this example.
5373 Substituting < and > befor & would lead to $gt; become
5376 <para>For a list of valid formats, see the German
5377 <filename>special_chars</filename> entry. As of this writing the
5378 following are recognized:</para>
5380 <programlisting>HTML
5385 Template/OpenDocument
5386 filenames</programlisting>
5388 <para>The last of which is very machine dependant. Remember that
5389 a lot of characters are forbidden by some filesystems, for
5390 exmaple MS Windows doesn't like ':' in its files where Linux
5391 doesn't mind that. If you want the files created with your
5392 language pack to be portable, find all chars that could cause
5398 <term>missing</term>
5401 <para>This file is not a part of the language package
5404 <para>This is a file generated by
5405 <command>scripts/locales.pl</command> while processing your
5406 locales. It's only to have the missing entries singled out and
5407 does not belong to a language package.</para>
5415 <para>This file is not a part of the language package
5418 <para>Another file generated by
5419 <command>scripts/locales.pl</command>. If for any reason a
5420 translation does not appear anymore and can be deleted, it gets
5421 moved here. The last 50 or so entries deleted are saved here in
5422 case you made a typo, so that you don't have to translate
5423 everything again. If a tranlsation is missing, the lost file is
5424 checked first. If you maintain a language package, you might
5425 want to keep this safe somewhere.</para>
5432 <sect1 id="devel.style-guide">
5433 <title>Stil-Richtlinien</title>
5435 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
5436 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
5437 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
5438 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
5440 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
5443 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
5444 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
5449 <para>Es werden keine echten Tabs sondern Leerzeichen
5454 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
5456 <programlisting>foreach my $row (@data) {
5458 # do something with $row
5462 $row->{modules} = MODULE->retrieve(
5463 id => $row->{id},
5464 date => $use_now ? localtime() : $row->{time},
5468 $report->add($row);
5473 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
5474 Zeile wie der letzte Befehl. Beispiele:</para>
5476 <programlisting>sub debug {
5482 <programlisting>if ($form->{item_rows} > 0) {
5488 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
5489 der Befehl / die öffnende schließende Klammer, die den Block
5490 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
5491 Beispiele wie bei 3. gelten.</para>
5495 <para>Die Wörter "<function>else</function>",
5496 "<function>elsif</function>", "<function>while</function>" befinden
5497 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
5500 <programlisting>if ($form->{sum} > 1000) {
5502 } elsif ($form->{sum} > 0) {
5510 } until ($a > 0);</programlisting>
5514 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
5515 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
5516 und grep-ähnliche Operatoren. Beispiel:</para>
5518 <programlisting>$main::lxdebug->message("Could not find file.");
5519 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
5523 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
5525 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
5526 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
5527 Blöcke schon. Beispiel:</para>
5529 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
5534 $form->{sum} += $form->{"row_$i"};
5535 $form->{ $form->{index} } += 1;
5537 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
5541 <para>Mehrzeilige Befehle</para>
5545 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
5546 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
5547 werden, in der die ersten Funktionsparameter in der ersten Zeile
5548 stehen. Beispiel:</para>
5550 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
5551 $form->{some_col_value});</programlisting>
5555 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
5556 besten in einer übersichtlichen Tabellenstruktur organisiert
5557 wird. Beispiel:</para>
5559 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
5560 : $form->{oldcount} ? $form->{oldcount} + 1
5561 : $form->{rowcount} - $form->{rowbase};</programlisting>
5567 <para>Kommentare</para>
5571 <para>Kommentare, die alleine in einer Zeile stehen, sollten
5572 soweit wie der Code eingerückt sein.</para>
5576 <para>Seitliche hängende Kommentare sollten einheitlich
5577 formatiert werden.</para>
5581 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
5582 auf Englisch zu verfassen. So wie ich keine Lust habe,
5583 französischen Quelltext zu lesen, sollte auch der kivitendo
5584 Quelltext für nicht-Deutschsprachige lesbar sein.
5587 <programlisting>my $found = 0;
5595 $i = 0 # initialize $i
5597 $i *= $const; # do something crazy
5598 $i = $n; # recover $i</programlisting>
5604 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
5605 Interpolation gewünscht ist. Beispiel:</para>
5607 <programlisting>$form->{sum} = 0;
5608 $form->{"row_$i"} = $form->{"row_$i"} - 5;
5609 $some_hash{42} = 54;</programlisting>
5613 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
5614 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
5615 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
5616 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
5618 <para>Als Beispiel sei die Funktion
5619 <function>print_options</function> aus
5620 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
5624 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
5625 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
5628 <para>Emacs und vim haben beide recht einfache Methoden zur
5629 Entfernung von trailing whitespace. Emacs kennt das Kommande
5630 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
5631 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
5632 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
5637 <para>Es wird kein <command>perltidy</command> verwendet.</para>
5639 <para>In der Vergangenheit wurde versucht,
5640 <command>perltidy</command> zu verwenden, um einen einheitlichen
5641 Stil zu erlangen. Es hat sich aber gezeigt, dass
5642 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
5643 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
5644 den Interessierten sind hier die
5645 <command>perltidy</command>-Optionen, die grob den beschriebenen
5646 Richtlinien entsprechen:</para>
5648 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
5649 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
5650 -lp -vt=1 -vtc=1</programlisting>
5654 <para><varname>STDERR</varname> ist tabu. Unkonditionale
5655 Debugmeldungen auch.</para>
5657 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
5658 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
5659 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
5661 <para>Die <classname>LXDebug</classname>-Methode
5662 "<function>message</function>" nimmt als ersten Paramter außerdem
5663 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
5664 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
5665 und werden in den meisten Fällen auch vom Repository
5666 zurückgewiesen.</para>
5670 <para>Alle neuen Module müssen use strict verwenden.</para>
5672 <para><varname>$form</varname>, <varname>$auth</varname>,
5673 <varname>$locale</varname>, <varname>$lxdebug</varname> und
5674 <varname>%myconfig</varname> werden derzeit aus dem main package
5675 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
5676 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
5681 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
5682 <title>Dokumentation erstellen</title>
5684 <sect2 id="devel.build-doc.introduction">
5685 <title>Einführung</title>
5687 <para>Diese Dokumentation ist in <productname>DocBook</productname>
5688 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
5689 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
5690 Editor nutzt, der spezielle Unterstützung für
5691 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
5692 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
5693 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
5697 <sect2 id="devel.build-doc.required-software">
5698 <title>Benötigte Software</title>
5700 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
5701 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
5702 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
5703 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
5704 <command>scripts/build_doc.sh</command>.</para>
5706 <para>Das Script benötigt zur Konvertierung verschiedene
5707 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
5713 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
5714 in einer halbwegs aktuellen Version</para>
5718 <para>Das Java-Build-System <ulink
5719 url="http://ant.apache.org/">Apache Ant</ulink></para>
5723 <para>Das Dokumentations-System Dobudish für
5724 <productname>DocBook</productname> 4.5, eine Zusammenstellung
5725 diverser Stylesheets und Grafiken zur Konvertierung von
5726 <productname>DocBook</productname> XML in andere Formate. Das
5727 Paket, das benötigt wird, ist zum Zeitpunkt der
5728 Dokumentationserstellung
5729 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
5730 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
5735 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
5736 sind auf allen gängigen Plattformen verfügbar. Beispiel für
5737 Debian/Ubuntu:</para>
5739 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
5741 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
5742 <filename>doc/build</filename> entpackt werden. Beispiel unter der
5743 Annahme, das <productname>Dobudish</productname> in
5744 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
5746 <programlisting>cd doc/build
5747 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
5750 <sect2 id="devel.build-doc.build">
5751 <title>PDFs und HTML-Seiten erstellen</title>
5753 <para>Die eigentliche Konvertierung erfolgt nach Installation der
5754 benötigten Software mit einem einfachen Aufruf direkt aus dem
5755 kivitendo-Installationsverzeichnis heraus:</para>
5757 <programlisting>./scripts/build_doc.sh</programlisting>
5760 <sect2 id="devel.build-doc.repository">
5761 <title>Einchecken in das Git-Repository</title>
5763 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
5764 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
5765 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
5766 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
5768 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
5769 symbolischen Links gehören hingegen nicht in das Repository.</para>