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>kivitendo kann komplett mit UTF-8 als Zeichensatz verwendet
419 werden. Dabei gibt es zwei Punkte zu beachten: PostgreSQL muss in
420 Version 8.2 oder neuer benutzt werden, und der
421 PostgreSQL-Datenbankcluster muss ebenfalls mit UTF-8 als Locale
422 angelegt worden sein.</para>
424 <para>Dieses ist kann überprüft werden: ist das Encoding der Datenbank
425 “template1” “UTF8”, so kann auch kivitendo mit UTF-8 betrieben werden.
426 Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
427 UTF-8-Encoding anzulegen und diesen zu verwenden. Unter Debian und
428 Ubuntu kann dies z.B. für PostgreSQL 8.2 mit dem folgenden Befehl
431 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2 clustername</programlisting>
433 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
434 Versionsnummer angepasst werden.</para>
436 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
438 <para>Wurde PostgreSQL nicht mit UTF-8 als Encoding initialisiert und
439 ist ein Neuanlegen eines weiteren Clusters nicht möglich, so kann
440 kivitendo mit ISO-8859-15 als Encoding betrieben werden.</para>
442 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
443 <literal>\l</literal> geprüft werden.</para>
446 <sect2 id="Änderungen-an-Konfigurationsdateien">
447 <title>Änderungen an Konfigurationsdateien</title>
449 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
450 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
451 <filename>/var/lib/pgsql/data/</filename> oder
452 <filename>/etc/postgresql/</filename>, muss sichergestellt werden,
453 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
454 Parameter <varname>listen_address</varname> gesteuert. Laufen
455 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
456 <literal>localhost</literal> verwendet werden. Andernfalls müssen
457 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
458 was mit dem Wert <literal>*</literal> geschieht.</para>
460 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
461 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
462 sein sollte, müssen die Berichtigungen für den Zugriff geändert
463 werden. Hier gibt es mehrere Möglichkeiten. Eine besteht darin, lokale
464 Verbindungen immer zuzulassen:</para>
466 <programlisting>local all all trust
467 host all all 127.0.0.1 255.0.0.0 trust</programlisting>
469 <para>Besser ist es, für eine bestimmte Datenbank Zugriff nur per
470 Passwort zuzulassen. Beispielsweise:</para>
472 <programlisting>local all kivitendo password
473 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
476 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
477 <title>Erweiterung für servergespeicherte Prozeduren</title>
479 <para>In der Datenbank <literal>template1</literal> muss die
480 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
481 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an, und
482 führen Sie die folgenden Kommandos aus:</para>
484 <programlisting>create language 'plpgsql';</programlisting>
487 <sect2 id="Datenbankbenutzer-anlegen">
488 <title>Datenbankbenutzer anlegen</title>
490 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
491 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
492 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
495 <programlisting>su - postgres createuser -d -P kivitendo</programlisting>
497 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
498 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.
499 den hier gewählten Benutzernamen.</para>
503 <sect1 id="Apache-Konfiguration">
504 <title>Webserver-Konfiguration</title>
507 <title>Grundkonfiguration mittels CGI</title>
510 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
511 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
512 <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
515 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
516 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
517 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
518 anderen Datei hinzu, die beim Starten des Webservers eingelesen
521 <programlisting>AddHandler cgi-script .pl
522 Alias /kivitendo-erp/ /var/www/kiviteno-erp/
524 <Directory /var/www/kivitendo-erp>
525 Options ExecCGI Includes FollowSymlinks
528 <Directory /var/www/kivitendo-erp/users>
531 </Directory></programlisting>
533 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
534 das kivitendo-Archiv entpacket haben.</para>
537 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
538 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
541 <para>Auf einigen Webservern werden manchmal die Grafiken und
542 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
543 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
545 <programlisting>EnableSendfile Off</programlisting>
548 <sect2 id="Apache-Konfiguration.FCGI"
549 xreflabel="Konfiguration für FastCGI/FCGI">
550 <title>Konfiguration für FastCGI/FCGI</title>
552 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
553 <title>Was ist FastCGI?</title>
555 <para>Direkt aus <ulink
556 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
559 <para><citation> FastCGI ist ein Standard für die Einbindung
560 externer Software zur Generierung dynamischer Webseiten in einem
561 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
562 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
563 umgehen. </citation></para>
566 <sect3 id="Apache-Konfiguration.FCGI.Warum">
567 <title>Warum FastCGI?</title>
569 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
570 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
571 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
572 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
573 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
574 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
575 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
576 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
577 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
578 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
579 deutlich länger dauert als früher, und dass davon 90% für das Laden
580 der Module verwendet wird.</para>
582 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
583 wird nur die eigentliche Programmlogik ausgeführt.</para>
586 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
587 <title>Getestete Kombinationen aus Webservern und Plugin</title>
589 <para>Folgende Kombinationen sind getestet:</para>
593 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
597 <para>Apache 2.2.11 (Ubuntu) und mod_fastcgi.</para>
601 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
602 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
603 mod_fastcgi nicht mehr explizit eingegangen.</para>
605 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
609 <para>FCGI 0.69 und höher ist extrem strict in der Behandlung von
610 Unicode, und verweigert bestimmte Eingaben von kivitendo. Falls es
611 Probleme mit Umlauten in Ihrere Installation gibt, muss auf die
612 Vorgängerversion FCGI 0.68 ausgewichen werden.</para>
614 <para>Mit CPAN lässt sie sich die Vorgängerversion wie folgt
617 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
621 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
622 <title>Konfiguration des Webservers</title>
624 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
625 laufen zu lassen, empfliehlt es sich die Installation ersteinmal
626 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
627 debuggen die beim ersten aufsetzen auftreten können. Sollte die
628 Installation schon funktionieren, lesen Sie weiter.</para>
630 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
631 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
633 <programlisting>a2enmod fcgid</programlisting>
635 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
636 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
637 und <function>Directory</function>-Direktiven. Dabei wird zwischen
638 dem Installationspfad von kivitendo im Dateisystem
639 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
640 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
641 ("<filename>/url/for/kivitendo-erp</filename>").</para>
643 <para>Folgender Konfigurationsschnipsel funktioniert mit
646 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
647 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
649 <Directory /path/to/kivitendo-erp>
651 Options ExecCGI Includes FollowSymlinks
656 <DirectoryMatch /path/to/kivitendo-erp/users>
659 </DirectoryMatch></programlisting>
661 <para>Seit mod_fcgid-Version 2.6.3 gelten sehr kleine Grenzen für
662 die maximale Größe eines Requests. Diese sollte wie folgt
663 hochgesetzt werden:</para>
665 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
667 <para>Das ganze sollte dann so aussehen:</para>
669 <programlisting>AddHandler fcgid-script .fpl
670 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
671 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
672 FcgidMaxRequestLen 10485760
674 <Directory /path/to/kivitendo-erp>
676 Options ExecCGI Includes FollowSymlinks
681 <DirectoryMatch /path/to/kivitendo-erp/users>
684 </DirectoryMatch></programlisting>
686 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
687 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
688 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
689 gibt es hier kleine Performance-Einbußen.</para>
691 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
692 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
693 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
695 <programlisting># Zugriff über CGI
696 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
698 # Zugriff mit mod_fcgid:
699 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
700 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
702 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
703 die normale Version erreichbar, und unter
704 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
705 FastCGI-Version.</para>
710 <sect1 id="config.task-server">
711 <title>Der Task-Server</title>
713 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
714 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
715 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
716 wird bisher nur für die Erzeugung der wiederkehrenden Rechnungen
717 benutzt, wird aber in Zukunft deutlich mehr Aufgaben übertragen
720 <sect2 id="Konfiguration-des-Task-Servers">
721 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
723 <para>Die Konfiguration erfolgt über den Abschnitt
724 <literal>[task_server]</literal> in der Datei
725 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
726 Optionen sind:</para>
730 <term><varname>login</varname></term>
733 <para>gültiger kivitendo-Benutzername, der benutzt wird, um die
734 zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss
735 in der Administration angelegt werden. Diese Option muss
736 angegeben werden.</para>
741 <term><varname>run_as</varname></term>
744 <para>Wird der Server vom Systembenutzer <literal>root</literal>
745 gestartet, so wechselt er auf den mit <literal>run_as</literal>
746 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
747 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
749 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
750 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
751 unter dem auch der Webserver läuft.</para>
756 <term><varname>debug</varname></term>
759 <para>Schaltet Debug-Informationen an und aus.</para>
765 <sect2 id="Einbinden-in-den-Boot-Prozess">
766 <title>Automatisches Starten des Task-Servers beim Booten</title>
768 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
769 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
770 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
772 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
773 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
774 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
775 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
776 anstelle eines symbolischen Links verwendet werden können.</para>
779 <title>SystemV-basierende Systeme (z.B. Debian, OpenSuSE, Fedora
782 <para>Kopieren Sie die Datei
783 <filename>scripts/boot/system-v/kivitendo-server</filename>
784 nach <filename>/etc/init.d/kivitendo-server</filename>. Passen
785 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
786 <literal>DAEMON=....</literal>). Binden Sie das Script in den
787 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
791 <para>Debian-basierende Systeme:</para>
793 <programlisting>update-rc.d kivitendo-task-server defaults
794 # Nur bei Debian Squeeze und neuer:
795 insserv kivitendo-task-server</programlisting>
799 <para>OpenSuSE und Fedora Core:</para>
801 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
805 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
806 werden: <command>/etc/init.d/kivitendo-task-server
807 start</command></para>
811 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
813 <para>Kopieren Sie die Datei
814 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
815 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
816 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
817 <literal>exec ....</literal>).</para>
819 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
820 werden: <command>service kivitendo-task-server
821 start</command></para>
825 <sect2 id="Prozesskontrolle">
826 <title>Wie der Task-Server gestartet und beendet wird</title>
828 <para>Der Task-Server wird wie folgt kontrolliert:</para>
830 <programlisting>./scripts/task_server.pl Befehl</programlisting>
832 <para><literal>Befehl</literal> ist dabei eine der folgenden
837 <para><literal>start</literal> startet eine neue Instanz des
838 Task-Servers. Die Prozess-ID wird innerhalb des
839 <filename>users</filename>-Verzeichnisses abgelegt.</para>
843 <para><literal>stop</literal> beendet einen laufenden
848 <para><literal>restart</literal> beendet und startet ihn
853 <para><literal>status</literal> berichtet, ob der Task-Server
858 <para>Der Task-Server wechselt beim Starten automatisch in das
859 kivitendo-Installationsverzeichnis.</para>
861 <para>Dieselben Optionen können auch für die SystemV-basierenden
862 Runlevel-Scripte benutzt werden (siehe oben).</para>
866 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
867 <title>Benutzerauthentifizierung und Administratorpasswort</title>
869 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
870 über die Verwaltung von Gruppen und weitere Einstellungen</para>
872 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
873 <title>Grundlagen zur Benutzerauthentifizierung</title>
875 <para>kivitendo verwaltet die Benutzerinformationen in einer
876 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
877 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
878 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
879 können, müssen aber nicht unterschiedlich sein.</para>
881 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
882 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
883 abgelegt werden.</para>
885 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
886 entweder gegen die Authentifizierungsdatenbank oder gegen einen
887 LDAP-Server überprüft werden.</para>
889 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
890 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
891 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
892 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
893 einer Version vor v2.6.0 angelegt werden. Eine
894 Beispielkonfigurationsdatei
895 <filename>config/kivitendo.conf.default</filename> existiert, die als
896 Vorlage benutzt werden kann.</para>
899 <sect2 id="Administratorpasswort">
900 <title>Administratorpasswort</title>
902 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
903 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
904 nur dort und nicht mehr im Administrationsinterface selber geändert
905 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
906 Abschnitt <varname>[authentication]</varname>.</para>
909 <sect2 id="Authentifizierungsdatenbank">
910 <title>Authentifizierungsdatenbank</title>
912 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
913 Parametern in <varname>[authentication/database]</varname>
914 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
918 <term><literal>host</literal></term>
921 <para>Der Rechnername oder die IP-Adresse des
922 Datenbankservers</para>
927 <term><literal>port</literal></term>
930 <para>Die Portnummer des Datenbankservers, meist 5432</para>
935 <term><literal>db</literal></term>
938 <para>Der Name der Authentifizierungsdatenbank</para>
943 <term><literal>user</literal></term>
946 <para>Der Benutzername, mit dem sich kivitendo beim
947 Datenbankserver anmeldet (z.B.
948 "<literal>postgres</literal>")</para>
953 <term><literal>password</literal></term>
956 <para>Das Passwort für den Datenbankbenutzer</para>
961 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
962 automatisch anlegen (mehr dazu siehe unten).</para>
965 <sect2 id="Passwortüberprüfung">
966 <title>Passwortüberprüfung</title>
968 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
969 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
970 Active-Directory-Server. Welche davon benutzt wird, regelt der
971 Parameter <varname>module</varname> im Abschnitt
972 <varname>[authentication]</varname>.</para>
974 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
975 gespeichert werden, so muss der Parameter <varname>module</varname>
976 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
977 der Administrator als auch die Benutzer selber ihre Psaswörter in
978 kivitendo ändern.</para>
980 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
981 benutzt werden, so muss der Parameter <varname>module</varname> auf
982 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
983 zusätzliche Informationen über den LDAP-Server im Abschnitt
984 <literal>[authentication/ldap]</literal> angegeben werden:</para>
988 <term><literal>host</literal></term>
991 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
992 Active-Directory-Servers. Diese Angabe ist zwingend
998 <term><literal>port</literal></term>
1001 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1006 <term><literal>tls</literal></term>
1009 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1010 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1011 ‘<literal>0</literal>’ belassen</para>
1016 <term><literal>attribute</literal></term>
1019 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1020 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1021 meist ‘<literal>sAMAccountName</literal>’, für andere
1022 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1023 zwingend erforderlich.</para>
1028 <term><literal>base_dn</literal></term>
1031 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1032 Diese Angabe ist zwingend erforderlich.</para>
1037 <term><literal>filter</literal></term>
1040 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1041 <literal><%login%></literal>, so wird dieses durch den vom
1042 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1043 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1044 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1049 <term><literal>bind_dn</literal> und
1050 <literal>bind_password</literal></term>
1053 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1054 durchsucht werden kann (z.B. ist dies bei
1055 Active-Directory-Servern der Fall), so kann diese hier angegeben
1056 werden. Für Active-Directory-Server kann als
1057 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1058 z.B. ‘<literal>cn=Martin
1059 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1060 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1061 also ‘<literal>Martin Mustermann</literal>’.</para>
1067 <sect2 id="Name-des-Session-Cookies">
1068 <title>Name des Session-Cookies</title>
1070 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1071 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1072 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1073 Parameter <varname>cookie_name</varname> im Abschnitt
1074 <varname>[authentication]</varname>gesetzt.</para>
1076 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1077 Server existiert.</para>
1080 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1081 <title>Anlegen der Authentifizierungsdatenbank</title>
1083 <para>Nachdem alle Einstellungen in
1084 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1085 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1086 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1087 der folgenden URL erreichbar sein sollte:</para>
1090 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
1094 <sect1 id="Benutzer--und-Gruppenverwaltung">
1095 <title>Benutzer- und Gruppenverwaltung</title>
1097 <para>Nach der Installation müssen Benutzer, Gruppen und Datenbanken
1098 angelegt werden. Dieses geschieht im Administrationsmenü, das Sie unter
1099 folgender URL finden:</para>
1102 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
1104 <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
1105 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1107 <sect2 id="Zusammenhänge">
1108 <title>Zusammenhänge</title>
1110 <para>kivitendo verwendet eine Datenbank zum Speichern all seiner
1111 Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um
1112 mit kivitendo arbeiten zu können, muss eine Person einen
1113 Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine
1114 Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist
1115 möglich und normal, dass mehreren Benutzern die selbe Datenbank
1116 zugewiesen wird, sodass sie alle mit den selben Daten arbeiten
1119 <para>Die Basisdaten der Benutzer, die in der Administration
1120 eingegeben werden können, werden in einer zweiten Datenbank
1121 gespeichert, der bereits erwähnten Authentifizierungsdatenbank. Diese
1122 ist also den Produktivdaten enthaltenden Datenbanken vorgeschaltet.
1123 Pro kivitendo-Installation gibt es nur eine
1124 Authentifizierungsdatenbank, aber beliebig viele Datenbanken mit
1127 <para>kivitendo kann seinen Benutzern Zugriff auf bestimmte
1128 Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht
1129 gestattet, so werden der entsprechenden Menüpunkte auch nicht
1130 angezeigt. Diese Rechte werden ebenfalls in der
1131 Authentifizierungsdatenbank gespeichert.</para>
1133 <para>Um Rechte verteilen zu können, verwendet kivitendo ein
1134 Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche
1135 erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder
1136 mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen
1137 Funktionen, die mindestens einer Gruppe erlaubt sind, in der der
1138 Benutzer Mitglied ist.</para>
1140 <para>Die allgemeine Reihenfolge, in der Datenbanken, Gruppen und
1141 Benutzer angelegt werden sollten, lautet:</para>
1143 <orderedlist numeration="arabic">
1145 <para>Datenbank anlegen</para>
1149 <para>Gruppen anlegen</para>
1153 <para>Benutzer anlegen</para>
1157 <para>Benutzer den Gruppen zuordnen</para>
1162 <sect2 id="Datenbanken-anlegen">
1163 <title>Datenbanken anlegen</title>
1165 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1166 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1167 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1169 <para>Wenn Sie für die kivitendo-Installation nicht Unicode (UTF-8) sondern den europäischen Schriftsatz ISO-8859-15 benutzen
1170 wollen, so müssen Sie vor dem Anlegen der Datenbank in der Datei <filename>config/kivitendo.conf</filename> die Variable
1171 <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf den Wert ‘<literal>ISO-8859-15</literal>’ setzen.</para>
1173 <para>Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz
1174 verwenden müssen, da diese Einstellungen momentan global in kivitendo
1175 vorgenommen wird und nicht nach Datenbank unterschieden werden kann.
1176 Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz
1177 angelegt worden sein.</para>
1180 <sect2 id="Gruppen-anlegen">
1181 <title>Gruppen anlegen</title>
1183 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1184 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1185 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1186 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1188 <para>Benutzergruppen sind unabhängig von Datenbanken, da sie in der
1189 Authentifizierungsdatenbank gespeichert werden. Sie gelten für alle
1190 Datenbanken, die in dieser Installation verwaltet werden.</para>
1193 <sect2 id="Benutzer-anlegen">
1194 <title>Benutzer anlegen</title>
1196 <para>Beim Anlegen von Benutzern werden für viele Parameter
1197 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1198 deutschen Raumes entsprechen.</para>
1200 <para>Zwingend anzugeben sind der Loginname sowie die komplette
1201 Datenbankkonfiguration. Wenn die Passwortauthentifizierung über die
1202 Datenbank eingestellt ist, so kann hier auch das Benutzerpasswort
1203 gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung
1204 aktiv, so ist das Passwort-Feld deaktiviert.</para>
1206 <para>In der Datenbankkonfiguration müssen die Zugriffsdaten einer der
1207 eben angelegten Datenbanken eingetragen werden.</para>
1210 <sect2 id="Gruppenmitgliedschaften-verwalten">
1211 <title>Gruppenmitgliedschaften verwalten</title>
1213 <para>Nach dem Anlegen von Benutzern und Gruppen müssen Benutzer den
1214 Gruppen zugewiesen werden. Dazu gibt es zwei Möglichkeiten:</para>
1216 <orderedlist numeration="arabic">
1218 <para>In der Gruppenverwaltung wählt man eine Gruppe aus. Im
1219 folgenden Dialog kann man dann einzeln die Benutzer der Gruppe
1224 <para>In der Gruppenverwaltung wählt man das Tool zur Verwaltung
1225 der Gruppenmitgliedschaft. Hier wird eine Matrix angezeigt, die
1226 alle im System angelegten Gruppen und Benutzer enthält. Durch
1227 Setzen der Häkchen wird der Benutzer in der ausgewählten Zeile der
1228 Gruppe in der ausgewählten Spalte hinzugefügt.</para>
1233 <sect2 id="Migration-alter-Installationen">
1234 <title>Migration alter Installationen</title>
1236 <para>Wenn kivitendo 2.6.3 über eine ältere Version installiert wird,
1237 in der die Benutzerdaten noch im Dateisystem im Verzeichnis
1238 <literal>users</literal> verwaltet wurden, so bietet kivitendo die
1239 Möglichkeit, diese Benutzerdaten automatisch in die
1240 Authentifizierungsdatenbank zu übernehmen. Dies geschieht, wenn man
1241 sich nach dem Update der Installation das erste Mal im
1242 Administrationsbereich anmeldet. Findet kivitendo die Datei
1243 <literal>users/members</literal>, so wird der Migrationsprozess
1246 <para>Der Migrationsprozess ist nahezu vollautomatisch. Alle
1247 Benutzerdaten können übernommen werden. Nach den Benutzerdaten bietet
1248 kivitendo noch die Möglichkeit an, dass automatisch eine
1249 Benutzergruppe angelegt wird. Dieser Gruppe wird Zugriff auf alle
1250 Funktionen von kivitendo gewährt. Alle migrierten Benutzern werden
1251 Mitglied in dieser Gruppe. Damit wird das Verhalten von kivitendo bis
1252 Version 2.4.3 inklusive wiederhergestellt, und die Benutzer können
1253 sich sofort wieder anmelden und mit dem System arbeiten.</para>
1257 <sect1 id="Drucken-mit-kivitendo">
1258 <title>Drucken mit kivitendo</title>
1260 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX Vorlagen.
1261 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1262 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1263 Debianoiden Betriebssystemen sind das die Pakete:</para>
1265 <para><literal>texlive-latex-base texlive-latex-extra
1266 texlive-fonts-recommended</literal></para>
1268 <para>Diese hinteren beiden enthalten Bibliotheken und Schriftarten die
1269 von den Standardvorlagen verwendet werden.</para>
1271 <para>TODO: rpm Pakete.</para>
1273 <para>In den allermeisten Installationen sollte drucken jetzt schon
1274 funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
1275 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
1276 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1281 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1282 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1283 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1288 <para>! Package inputenc Error: Unicode char \u8:æ¡
\9c not set up for
1289 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1290 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1291 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1292 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1293 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1297 <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
1298 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1299 Prüfen Sie den Namen in der Konfiguration (Standard:
1300 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1301 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1305 <sect1 id="OpenDocument-Vorlagen">
1306 <title>OpenDocument-Vorlagen</title>
1308 <para>kivitendo unterstützt die Verwendung von Vorlagen im
1309 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1310 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1311 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1312 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1313 <filename>config/kivitendo.conf</filename> die Variable
1314 <literal>opendocument</literal> im Abschnitt
1315 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1316 Dieses ist die Standardeinstellung.</para>
1318 <para>Weiterhin muss in der Datei
1319 <filename>config/kivitendo.conf</filename> die Variable
1320 <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf
1321 die Zeichenkodierung gesetzt werden, die auch bei der Speicherung der
1322 Daten in der Datenbank verwendet wird. Diese ist in den meisten Fällen
1325 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1326 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1327 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1328 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1329 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1330 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1332 <para>Nach der Installation müssen in der Datei
1333 <filename>config/kivitendo.conf</filename> zwei weitere Variablen
1334 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1335 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1336 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1337 enthalten. Beide stehen im Abschnitt
1338 <literal>applications</literal>.</para>
1340 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
1341 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1342 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1343 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1344 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1345 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1346 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1347 werden muss. Der Nachteil ist, dass diese Methode Python und die
1348 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1351 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1352 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1353 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1354 Dokumentenvorlage enthalten sein und
1355 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1356 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1357 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1358 ebenfalls enthalten sein muss.</para>
1360 <para>Als letztes muss herausgefunden werden, welchen Namen
1361 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1362 gibt. Unter Debian ist dies momentan
1363 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1364 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1365 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1366 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1367 folgender Befehl auszuführen:</para>
1369 <para><literal>mv users/.openoffice.org2
1370 users/.openoffice</literal></para>
1372 <para>Dieses Verzeichnis, wie auch das komplette
1373 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1374 sein. Dieses wurde bereits erledigt (siehe <xref
1375 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1376 erneut überprüft werden, wenn die Konvertierung nach PDF
1380 <sect1 id="config.eur">
1381 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1384 <sect2 id="config.eur.introduction"
1385 xreflabel="Einführung in die Konfiguration zur EUR">
1386 <title>Einführung</title>
1388 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
1389 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1390 Konfigurationsdatei <filename>config/lx_office.conf</filename>
1391 befand. Somit galt er für alle Mandanten, die in dieser Installation
1392 benutzt wurden.</para>
1394 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1395 die Mandantendatenbank verschoben und dabei auch gleich in drei
1396 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1397 steuern lässt.</para>
1400 <sect2 id="config.eur.parameters"
1401 xreflabel="Konfigurationsparameter für EUR">
1402 <title>Konfigurationsparameter</title>
1404 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1405 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1409 <term><varname>profit_determination</varname></term>
1412 <para>Dieser Parameter legt die Berechnungsmethode für die
1413 Gewinnermittlung fest. Er enthält entweder
1414 <literal>balance</literal> für
1415 Betriebsvermögensvergleich/Bilanzierung oder
1416 <literal>income</literal> für die
1417 Einnahmen-Überschuss-Rechnung.</para>
1422 <term><varname>accounting_method</varname></term>
1425 <para>Dieser Parameter steuert die Buchungs- und
1426 Berechnungsmethoden für die Versteuerungsart. Er enthält
1427 entweder <literal>accrual</literal> für die Soll-Versteuerung
1428 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1433 <term><varname>inventory_system</varname></term>
1436 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1437 enthält entweder <literal>perpetual</literal> für die
1438 Bestandsmethode oder <literal>periodic</literal> für die
1439 Aufwandsmethode.</para>
1444 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1445 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1446 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1447 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1448 Bestandsmethode.</para>
1450 <para>Die Konfiguration "<varname>eur</varname>" unter
1451 <varname>[system]</varname> in der <link
1452 linkend="config.config-file">Konfigurationsdatei</link>
1453 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
1454 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1457 <sect2 id="config.eur.setting-parameters">
1458 <title>Festlegen der Parameter</title>
1460 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1461 der Admininstration können diese Optionen nun unabhängig voneinander
1462 eingestellt werden.</para>
1464 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1465 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1468 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1469 Standardkonten unter dem neuen Punkt "Einstellungen" angezeigt
1470 (read-only). Eine spätere Änderung ist für einen bestehenden Mandanten
1471 nicht mehr möglich. Dies war auch vorher nicht möglich, bzw.
1472 vorhandene Daten wurden so belassen und haben damit die Ergebnisse
1476 <sect2 id="config.eur.inventory-system-perpetual">
1477 <title>Bemerkungen zu Bestandsmethode</title>
1479 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1480 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
1481 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1482 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1483 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1484 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1485 Einkaufsrechnungen berechnet wird.</para>
1487 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1488 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1489 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1493 <sect2 id="config.eur.knonw-issues">
1494 <title>Bekannte Probleme</title>
1496 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1497 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1498 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1499 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1500 die Konfigurationsvariable
1501 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1504 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1505 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1509 <sect1 id="config.skr04-update-3804">
1510 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1512 <sect2 id="config.skr04-update-3804.introduction">
1513 <title>Einführung</title>
1515 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1516 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1517 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1518 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1519 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1520 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1521 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1522 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1523 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1524 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1525 Screenshots dargestellt.</para>
1527 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1528 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1529 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1530 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1533 <sect2 id="config.skr04-update-3804.create-chart">
1534 <title>Konto 3804 manuell anlegen</title>
1536 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
1537 anzulegen und zu konfigurieren. Zuerst wird in
1538 <guimenu>System</guimenu> ->
1539 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
1540 erfassen</guimenuitem> das Konto angelegt.</para>
1543 <screeninfo>Konto 3804 erfassen</screeninfo>
1547 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
1553 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
1554 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
1555 wie im folgenden Screenshot angezeigt anpassen.
1559 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
1563 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
1569 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
1570 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
1574 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
1578 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
1584 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
1585 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
1586 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
1587 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
1591 <screeninfo>Konto 4315 anpassen</screeninfo>
1595 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
1601 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
1602 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
1606 <screeninfo>Steuerliste vergleichen</screeninfo>
1610 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
1617 <sect1 id="kivitendo-ERP-verwenden">
1618 <title>kivitendo ERP verwenden</title>
1620 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
1621 folgender URL erreichbar:</para>
1624 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
1626 <para>Die Administrationsseite erreichen Sie unter:</para>
1629 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
1633 <chapter id="features" xreflabel="Features und Funktionen">
1634 <title>Features und Funktionen</title>
1636 <sect1 id="features.periodic-invoices"
1637 xreflabel="Wiedekehrende Rechnungen">
1638 <title>Wiederkehrende Rechnungen</title>
1640 <sect2 id="features.periodic-invoices.introduction"
1641 xreflabel="Einführung in wiederkehrende Rechnungen">
1642 <title>Einführung</title>
1644 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
1645 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
1646 Die konfigurierten Aufträge werden später automatisch in Rechnungen
1647 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
1648 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
1649 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
1650 wiederzufinden sind.</para>
1653 <sect2 id="features.periodic-invoices.configuration"
1654 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
1655 <title>Konfiguration</title>
1657 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
1658 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
1659 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
1660 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
1661 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
1664 <para>Folgende Parameter kann man konfigurieren:</para>
1671 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
1672 erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
1673 neuen Monats).</para>
1675 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
1676 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
1677 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
1678 nächsten Periodenwechsel für alle Perioden, seit der letzten
1679 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
1680 verhindern, muss man vorher das Startdatum neu setzen.</para>
1682 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
1683 erstellt. Man kann sich diese Aufträge aber gesondert in den
1684 Berichten anzeigen lassen.</para>
1689 <term>Periodizität</term>
1692 <para>Ob monatlich, quartalsweise oder jährlich auf neue
1693 Rechnungen überprüft werden soll. Für jede Periode seit dem
1694 Startdatum wird überprüft, ob für die Periode (beginnend immer
1695 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
1696 wurde. Unter Umständen können bei einem Startdatum in der
1697 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
1702 <term>Buchen auf</term>
1705 <para>Das Forderungskonto, in der Regel "Forderungen aus
1706 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
1707 Buchungsgruppen der betreffenden Waren.</para>
1712 <term>Startdatum</term>
1715 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
1721 <term>Enddatum</term>
1724 <para>ab wann keine Rechnungen mehr erstellt werden
1730 <term>Automatische Verlängerung um x Monate</term>
1733 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
1734 eingetragenen Enddatums weiterhin erstellt werden, so kann man
1735 hier die Anzahl der Monate eingeben, um die das Enddatum
1736 automatisch nach hinten geschoben wird.</para>
1741 <term>Drucken</term>
1744 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
1745 Rechnungen auch gleich ausdrucken lassen.</para>
1750 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
1751 Informationen zu den erstellten Rechnungen verschickt werden.
1752 Konfiguriert wird dies in der <link
1753 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
1754 <filename>config/kivitendo.conf</filename> im Abschnitt
1755 <varname>[periodic_invoices]</varname>.</para>
1758 <sect2 id="features.periodic-invoices.reports">
1759 <title>Auflisten</title>
1761 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
1762 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
1763 Rechnungen inaktiv", mit denen man sich einen Überglick über die
1764 wiederkehrenden Rechnungen verschaffen kann.</para>
1767 <sect2 id="features.periodic-invoices.task-server">
1768 <title>Erzeugung der eigentlichen Rechnungen</title>
1770 <para>Die zeitliche und periodische Überprüfung, ob eine
1771 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
1772 durch den <link linkend="config.task-server">Taskserver</link>, einen
1773 externen Dienst, der automatisch beim Start des Servers gestartet
1774 werden sollte.</para>
1777 <sect2 id="features.periodic-invoices.create-for-current-month">
1778 <title>Erste Rechnung für aktuellen Monat erstellen</title>
1780 <para>Will man im laufenden Monat eine monatlich wiederkehrende
1781 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
1782 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
1783 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
1784 generiert hat. Alternativ setzt man das Startdatum auf den
1785 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
1786 manuell über den Workflow.</para>
1790 <sect1 id="dokumentenvorlagen-und-variablen">
1791 <title>Dokumentenvorlagen und verfügbare Variablen</title>
1793 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
1794 <title>Einführung</title>
1796 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
1797 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
1798 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
1799 <function><%variablenname%></function> verwendet wird. Für
1800 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
1802 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
1804 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
1805 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
1806 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
1807 alle Vorlagenarten.</para>
1809 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
1810 verfügbar als hier aufgelistet werden. Die meisten davon können
1811 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
1812 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
1813 diese wie folgt erhalten werden:</para>
1817 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
1818 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
1822 <para>In <filename>Form.pm</filename> die Funktion
1823 <function>parse_template</function> suchen und hier die Zeile
1824 <command>print(STDERR Dumper($self));</command> einfügen.</para>
1828 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
1829 ein PDF für eine Rechnung erzeugen.</para>
1833 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
1834 der Variablen <varname>$self</varname> in der Form <varname>'key'
1835 => 'value',</varname>. Alle <varname>key</varname>s sind
1841 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
1842 <title>Variablen ausgeben</title>
1844 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
1845 Tags geschrieben werden, also z.B.
1846 <varname><%variablenname%></varname>.</para>
1848 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
1849 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
1850 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
1851 werden die folgenden Flags unterstützt:</para>
1855 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
1856 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
1857 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
1858 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
1862 <para><option>NOESCAPE</option> unterdrückt das Escapen von
1863 Sonderzeichen für die Vorlagensprache. Wenn also in einer
1864 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
1865 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
1866 ist dieses Flag sinnvoll.</para>
1870 <para>Beispiel:</para>
1872 <programlisting><%quototal NOFORMAT%></programlisting>
1875 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
1876 <title>Verwendung in Druckbefehlen</title>
1878 <para>In der Admininstration können Drucker definiert werden. Auch im
1879 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
1880 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
1881 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
1882 <function>`...`</function> nicht zu unerwünschtem Verhalten
1885 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
1886 für das die Telefonnummer eines Ansprechpartners als Teil der
1887 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
1888 z.B. wie folgt aussehen:</para>
1890 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
1893 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
1894 xreflabel="Anfang und Ende der Tags verändern">
1895 <title>Anfang und Ende der Tags verändern</title>
1897 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
1898 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
1899 Prozentzeichen und dem Größerzeichen endet, beispielsweise
1900 <function><%customer%></function>. Da diese Form aber z.B. in
1901 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
1902 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
1903 Stil umgestellt werden.</para>
1905 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
1906 Format gültigen Kommentarzeichen anfangen, dann
1907 <function>config:</function> enthalten, die entsprechende Option
1908 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
1909 enden. Beispiel für LaTeX:</para>
1911 <programlisting>% config: tag-style=($ $)</programlisting>
1913 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
1914 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
1915 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
1917 <programlisting><!-- config: tag-style=($ $) --></programlisting>
1920 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
1921 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
1923 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
1924 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
1925 "<filename>.ext</filename>" geeignet zu ersetzen:
1926 "<filename>.tex</filename>" für LaTeX-Vorlagen und
1927 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
1931 <term><filename>bin_list.ext</filename></term>
1934 <para>Lagerliste</para>
1939 <term><filename>check.ext</filename></term>
1947 <term><filename>invoice.ext</filename></term>
1950 <para>Rechnung</para>
1955 <term><filename>packing_list.ext</filename></term>
1958 <para>Packliste</para>
1963 <term><filename>pick_list.ext</filename></term>
1966 <para>Sammelliste</para>
1971 <term><filename>purchase_delivery_order.ext</filename></term>
1974 <para>Lieferschein (Einkauf)</para>
1979 <term><filename>purcharse_order.ext</filename></term>
1982 <para>Bestellung an Lieferanten</para>
1987 <term><filename>request_quotation.ext</filename></term>
1990 <para>Anfrage an Lieferanten</para>
1995 <term><filename>sales_delivery_order.ext</filename></term>
1998 <para>Lieferschein (Verkauf)</para>
2003 <term><filename>sales_order.ext</filename></term>
2006 <para>Bestellung</para>
2011 <term><filename>sales_quotation.ext</filename></term>
2014 <para>Angebot an Kunden</para>
2019 <term><filename>zahlungserinnerung.ext</filename></term>
2022 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2027 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2030 <para>Rechnung über Mahngebühren (Dateiname im Programm
2031 konfigurierbar)</para>
2037 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2038 <title>Sprache, Drucker und E-Mail</title>
2040 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2041 eingearbeitet. So wird aus der Vorlage
2042 <filename>sales_order.ext</filename> bei Sprache
2043 <function>de</function> und Druckerkürzel <function>lpr2</function>
2044 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2045 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2046 bekommen dann noch das Kürzel <filename>_email</filename>, der
2047 vollständige Vorlagenname wäre dann
2048 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2049 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2050 werden. Diese wird verwendet, wenn keine der anderen Varianten
2051 gefunden wird.</para>
2053 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2054 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2055 verschickt wird, ist:</para>
2059 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2063 <para><filename>sales_order_de_lpr2.tex</filename></para>
2067 <para><filename>sales_order.tex</filename></para>
2071 <para><filename>default.tex</filename></para>
2075 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2076 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2078 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2081 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2082 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2085 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2086 xreflabel="Metainformationen zur angeforderten Vorlage">
2087 <title>Metainformationen zur angeforderten Vorlage</title>
2089 <para>Diese Variablen liefern Informationen darüber welche Variante
2090 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2091 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2092 Formulare einbinden möchten.</para>
2096 <term><varname>template_meta.formname</varname></term>
2099 <para>Basisname der Vorlage. Identisch mit der <link
2100 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2101 zu den Dateinamen</link> ohne die Erweiterung. Ein
2102 Verkaufsauftrag enthält hier
2103 <constant>sales_order</constant>.</para>
2108 <term><varname>template_meta.language.description</varname></term>
2111 <para>Beschreibung der verwendeten Sprache</para>
2116 <term><varname>template_meta.language.template_code</varname></term>
2119 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2120 Kürzel das im Dateinamen verwendetet wird.</para>
2125 <term><varname>template_meta.language.output_numberformat</varname></term>
2128 <para>Zahlenformat der verwendeten Sprache in der Form
2129 "<constant>1.000,00</constant>". Experimentell! Nur
2130 interessant für Vorlagen die mit unformatierten Werten
2136 <term><varname>template_meta.language.output_dateformat</varname></term>
2139 <para>Datumsformat der verwendeten Sprache in der Form
2140 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2141 interessant für Vorlagen die mit unformatierten Werten
2147 <term><varname>template_meta.format</varname></term>
2150 <para>Das angeforderte Format. Kann im Moment die Werte
2151 <constant>pdf</constant>, <constant>postscript</constant>,
2152 <constant>html</constant>, <constant>opendocument</constant>,
2153 <constant>opendocument_pdf</constant> und
2154 <constant>excel</constant> enthalten.</para>
2159 <term><varname>template_meta.extension</varname></term>
2162 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2163 <constant>format</constant> entschieden.</para>
2168 <term><varname>template_meta.media</varname></term>
2171 <para>Ausgabemedium. Kann zur Zeit die Werte
2172 <constant>screen</constant> für Bildschirm,
2173 <constant>email</constant> für E-Mmail (triggert das
2174 <constant>_email</constant> Kürzel im Dateinamen),
2175 <constant>printer</constant> für Drucker, und
2176 <constant>queue</constant> für Warteschlange enthalten.</para>
2181 <term><varname>template_meta.printer.description</varname></term>
2184 <para>Beschreibung des ausgewählten Druckers</para>
2189 <term><varname>template_meta.printer.template_code</varname></term>
2192 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2193 dem Kürzel das im Dateinamen verwendetet wird.</para>
2199 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2200 <title>Stammdaten von Kunden und Lieferanten</title>
2204 <term><varname>account_number</varname></term>
2207 <para>Kontonummer</para>
2212 <term><varname>bank</varname></term>
2215 <para>Name der Bank</para>
2220 <term><varname>bank_code</varname></term>
2223 <para>Bankleitzahl</para>
2228 <term><varname>bic</varname></term>
2231 <para>Bank-Identifikations-Code (Bank Identifier Code,
2237 <term><varname>business</varname></term>
2240 <para>Kunden-/Lieferantentyp</para>
2245 <term><varname>city</varname></term>
2253 <term><varname>contact</varname></term>
2256 <para>Kontakt</para>
2261 <term><varname>country</varname></term>
2269 <term><varname>cp_email</varname></term>
2272 <para>Email des Ansprechpartners</para>
2277 <term><varname>cp_givenname</varname></term>
2280 <para>Vorname des Ansprechpartners</para>
2285 <term><varname>cp_greeting</varname></term>
2288 <para>Anrede des Ansprechpartners</para>
2293 <term><varname>cp_name</varname></term>
2296 <para>Name des Ansprechpartners</para>
2301 <term><varname>cp_phone1</varname></term>
2304 <para>Telefonnummer 1 des Ansprechpartners</para>
2309 <term><varname>cp_phone2</varname></term>
2312 <para>Telefonnummer 2 des Ansprechpartners</para>
2317 <term><varname>cp_title</varname></term>
2320 <para>Titel des Ansprechpartners</para>
2325 <term><varname>creditlimit</varname></term>
2328 <para>Kreditlimit</para>
2333 <term><varname>customeremail</varname></term>
2336 <para>Email des Kunden; nur für Kunden</para>
2341 <term><varname>customerfax</varname></term>
2344 <para>Faxnummer des Kunden; nur für Kunden</para>
2349 <term><varname>customernotes</varname></term>
2352 <para>Bemerkungen beim Kunden; nur für Kunden</para>
2357 <term><varname>customernumber</varname></term>
2360 <para>Kundennummer; nur für Kunden</para>
2365 <term><varname>customerphone</varname></term>
2368 <para>Telefonnummer des Kunden; nur für Kunden</para>
2373 <term><varname>discount</varname></term>
2381 <term><varname>email</varname></term>
2384 <para>Emailadresse</para>
2389 <term><varname>fax</varname></term>
2392 <para>Faxnummer</para>
2397 <term><varname>homepage</varname></term>
2400 <para>Homepage</para>
2405 <term><varname>iban</varname></term>
2408 <para>Internationale Kontonummer (International Bank Account
2409 Number, IBAN)</para>
2414 <term><varname>language</varname></term>
2417 <para>Sprache</para>
2422 <term><varname>name</varname></term>
2425 <para>Firmenname</para>
2430 <term><varname>payment_description</varname></term>
2433 <para>Name der Zahlart</para>
2438 <term><varname>payment_terms</varname></term>
2441 <para>Zahlungskonditionen</para>
2446 <term><varname>phone</varname></term>
2449 <para>Telefonnummer</para>
2454 <term><varname>shiptocity</varname></term>
2457 <para>Stadt (Lieferadresse) <link
2458 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2463 <term><varname>shiptocontact</varname></term>
2466 <para>Kontakt (Lieferadresse) <link
2467 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2472 <term><varname>shiptocountry</varname></term>
2475 <para>Land (Lieferadresse) <link
2476 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2481 <term><varname>shiptodepartment1</varname></term>
2484 <para>Abteilung 1 (Lieferadresse) <link
2485 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2490 <term><varname>shiptodepartment2</varname></term>
2493 <para>Abteilung 2 (Lieferadresse) <link
2494 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2499 <term><varname>shiptoemail</varname></term>
2502 <para>Email (Lieferadresse) <link
2503 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2508 <term><varname>shiptofax</varname></term>
2511 <para>Fax (Lieferadresse) <link
2512 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2517 <term><varname>shiptoname</varname></term>
2520 <para>Firmenname (Lieferadresse) <link
2521 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2526 <term><varname>shiptophone</varname></term>
2529 <para>Telefonnummer (Lieferadresse) <link
2530 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2535 <term><varname>shiptostreet</varname></term>
2538 <para>Straße und Hausnummer (Lieferadresse) <link
2539 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2544 <term><varname>shiptozipcode</varname></term>
2547 <para>Postleitzahl (Lieferadresse) <link
2548 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2553 <term><varname>street</varname></term>
2556 <para>Straße und Hausnummer</para>
2561 <term><varname>taxnumber</varname></term>
2564 <para>Steuernummer</para>
2569 <term><varname>ustid</varname></term>
2572 <para>Umsatzsteuer-Identifikationsnummer</para>
2577 <term><varname>vendoremail</varname></term>
2580 <para>Email des Lieferanten; nur für Lieferanten</para>
2585 <term><varname>vendorfax</varname></term>
2588 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
2593 <term><varname>vendornotes</varname></term>
2596 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
2601 <term><varname>vendornumber</varname></term>
2604 <para>Lieferantennummer; nur für Lieferanten</para>
2609 <term><varname>vendorphone</varname></term>
2612 <para>Telefonnummer des Lieferanten; nur für
2618 <term><varname>zipcode</varname></term>
2621 <para>Postleitzahl</para>
2626 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
2627 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
2628 Stammdaten nicht eingetragen, so haben die Variablen
2629 <varname>shipto*</varname> den gleichen Wert wie die die
2630 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
2631 einige <varname>shipto*</varname>-Variablen so nicht in den
2632 Stammdaten wiederfinden sondern schlicht Kopien der
2633 Lieferdatenvariablen sind (z.B.
2634 <varname>shiptocontact</varname>).</para>
2638 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
2639 <title>Informationen über den Bearbeiter</title>
2643 <term><varname>employee_address</varname></term>
2646 <para>Adressfeld</para>
2651 <term><varname>employee_businessnumber</varname></term>
2654 <para>Firmennummer</para>
2659 <term><varname>employee_company</varname></term>
2662 <para>Firmenname</para>
2667 <term><varname>employee_co_ustid</varname></term>
2670 <para>Usatzsteuer-Identifikationsnummer</para>
2675 <term><varname>employee_duns</varname></term>
2678 <para>DUNS-Nummer</para>
2683 <term><varname>employee_email</varname></term>
2691 <term><varname>employee_fax</varname></term>
2699 <term><varname>employee_name</varname></term>
2702 <para>voller Name</para>
2707 <term><varname>employee_signature</varname></term>
2710 <para>Signatur</para>
2715 <term><varname>employee_taxnumber</varname></term>
2718 <para>Steuernummer</para>
2723 <term><varname>employee_tel</varname></term>
2726 <para>Telefonnummer</para>
2732 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
2733 <title>Informationen über den Bearbeiter</title>
2737 <term><varname>salesman_address</varname></term>
2740 <para>Adressfeld</para>
2745 <term><varname>salesman_businessnumber</varname></term>
2748 <para>Firmennummer</para>
2753 <term><varname>salesman_company</varname></term>
2756 <para>Firmenname</para>
2761 <term><varname>salesman_co_ustid</varname></term>
2764 <para>Usatzsteuer-Identifikationsnummer</para>
2769 <term><varname>salesman_duns</varname></term>
2772 <para>DUNS-Nummer</para>
2777 <term><varname>salesman_email</varname></term>
2785 <term><varname>salesman_fax</varname></term>
2793 <term><varname>salesman_name</varname></term>
2796 <para>voller Name</para>
2801 <term><varname>salesman_signature</varname></term>
2804 <para>Signatur</para>
2809 <term><varname>salesman_taxnumber</varname></term>
2812 <para>Steuernummer</para>
2817 <term><varname>salesman_tel</varname></term>
2820 <para>Telefonnummer</para>
2826 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
2827 <title>Variablen für die einzelnen Steuern</title>
2831 <term><varname>tax</varname></term>
2839 <term><varname>taxbase</varname></term>
2842 <para>zu versteuernder Betrag</para>
2847 <term><varname>taxdescription</varname></term>
2850 <para>Name der Steuer</para>
2855 <term><varname>taxrate</varname></term>
2858 <para>Steuersatz</para>
2865 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
2866 <title>Variablen in Rechnungen</title>
2868 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
2869 <title>Allgemeine Variablen</title>
2873 <term><varname>creditremaining</varname></term>
2876 <para>Verbleibender Kredit</para>
2881 <term><varname>currency</varname></term>
2884 <para>Währung</para>
2889 <term><varname>cusordnumber</varname></term>
2892 <para>Bestellnummer beim Kunden</para>
2897 <term><varname>deliverydate</varname></term>
2900 <para>Lieferdatum</para>
2905 <term><varname>duedate</varname></term>
2908 <para>Fälligkeitsdatum</para>
2913 <term><varname>globalprojectnumber</varname></term>
2916 <para>Projektnummer des ganzen Beleges</para>
2921 <term><varname>globalprojectdescription</varname></term>
2924 <para>Projekbeschreibung des ganzen Beleges</para>
2929 <term><varname>intnotes</varname></term>
2932 <para>Interne Bemerkungen</para>
2937 <term><varname>invdate</varname></term>
2940 <para>Rechnungsdatum</para>
2945 <term><varname>invnumber</varname></term>
2948 <para>Rechnungsnummer</para>
2953 <term><varname>invtotal</varname></term>
2956 <para>gesamter Rechnungsbetrag</para>
2961 <term><varname>notes</varname></term>
2964 <para>Bemerkungen der Rechnung</para>
2969 <term><varname>orddate</varname></term>
2972 <para>Auftragsdatum</para>
2977 <term><varname>ordnumber</varname></term>
2980 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
2981 erstellt wurde</para>
2986 <term><varname>payment_description</varname></term>
2989 <para>Name der Zahlart</para>
2994 <term><varname>payment_terms</varname></term>
2997 <para>Zahlungskonditionen</para>
3002 <term><varname>quodate</varname></term>
3005 <para>Angebotsdatum</para>
3010 <term><varname>quonumber</varname></term>
3013 <para>Angebotsnummer</para>
3018 <term><varname>shippingpoint</varname></term>
3021 <para>Versandort</para>
3026 <term><varname>shipvia</varname></term>
3029 <para>Transportmittel</para>
3034 <term><varname>subtotal</varname></term>
3037 <para>Zwischensumme aller Posten ohne Steuern</para>
3042 <term><varname>total</varname></term>
3045 <para>Restsumme der Rechnung (Summe abzüglich bereits
3046 bezahlter Posten)</para>
3051 <term><varname>transaction_description</varname></term>
3054 <para>Vorgangsbezeichnung</para>
3059 <term><varname>transdate</varname></term>
3062 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3063 erstellt wurde</para>
3069 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3070 <title>Variablen für jeden Posten auf der Rechnung</title>
3074 <term><varname>bin</varname></term>
3077 <para>Stellage</para>
3082 <term><varname>description</varname></term>
3085 <para>Artikelbeschreibung</para>
3090 <term><varname>discount</varname></term>
3093 <para>Rabatt als Betrag</para>
3098 <term><varname>discount_sub</varname></term>
3101 <para>Zwischensumme mit Rabatt</para>
3106 <term><varname>drawing</varname></term>
3109 <para>Zeichnung</para>
3114 <term><varname>ean</varname></term>
3117 <para>EAN-Code</para>
3122 <term><varname>image</varname></term>
3130 <term><varname>linetotal</varname></term>
3133 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3138 <term><varname>longdescription</varname></term>
3141 <para>Langtext</para>
3146 <term><varname>microfiche</varname></term>
3149 <para>Mikrofilm</para>
3154 <term><varname>netprice</varname></term>
3157 <para>Nettopreis</para>
3162 <term><varname>nodiscount_linetotal</varname></term>
3165 <para>Zeilensumme ohne Rabatt</para>
3170 <term><varname>nodiscount_sub</varname></term>
3173 <para>Zwischensumme ohne Rabatt</para>
3178 <term><varname>number</varname></term>
3181 <para>Artikelnummer</para>
3186 <term><varname>ordnumber_oe</varname></term>
3189 <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
3190 aus einem Sammelauftrag erstellt wurde</para>
3195 <term><varname>p_discount</varname></term>
3198 <para>Rabatt in Prozent</para>
3203 <term><varname>partnotes</varname></term>
3206 <para>Die beim Artikel gespeicherten Bemerkungen</para>
3211 <term><varname>partsgroup</varname></term>
3214 <para>Warengruppe</para>
3219 <term><varname>price_factor</varname></term>
3222 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
3228 <term><varname>price_factor_name</varname></term>
3231 <para>Der Name des Preisfaktors, sofern einer eingestellt
3237 <term><varname>projectnumber</varname></term>
3240 <para>Projektnummer</para>
3245 <term><varname>projectdescription</varname></term>
3248 <para>Projektbeschreibung</para>
3253 <term><varname>qty</varname></term>
3261 <term><varname>reqdate</varname></term>
3264 <para>Lieferdatum</para>
3269 <term><varname>runningnumber</varname></term>
3272 <para>Position auf der Rechnung (1, 2, 3...)</para>
3277 <term><varname>sellprice</varname></term>
3280 <para>Verkaufspreis</para>
3285 <term><varname>serialnumber</varname></term>
3288 <para>Seriennummer</para>
3293 <term><varname>tax_rate</varname></term>
3296 <para>Steuersatz</para>
3301 <term><varname>transdate_oe</varname></term>
3304 <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
3305 aus einem Sammelauftrag erstellt wurde</para>
3310 <term><varname>unit</varname></term>
3313 <para>Einheit</para>
3318 <term><varname>weight</varname></term>
3321 <para>Gewicht</para>
3326 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
3327 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
3328 einer <function>foreach</function>-Schleife ausgegeben werden, da
3329 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
3330 können. Die Variablen dafür lauten:</para>
3334 <term><varname>make</varname></term>
3337 <para>Lieferant</para>
3342 <term><varname>model</varname></term>
3345 <para>Lieferantenartikelnummer</para>
3351 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
3352 <title>Variablen für die einzelnen Zahlungseingänge</title>
3356 <term><varname>payment</varname></term>
3364 <term><varname>paymentaccount</varname></term>
3372 <term><varname>paymentdate</varname></term>
3380 <term><varname>paymentmemo</varname></term>
3388 <term><varname>paymentsource</varname></term>
3397 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
3398 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
3400 <para>Die vom Benutzer definierten Variablen für Kunden und
3401 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
3402 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
3403 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
3404 Variablennamen zusammen.</para>
3406 <para>Beispiel: Der Benutzer hat eine Variable namens
3407 <varname>number_of_employees</varname> definiert, die die Anzahl der
3408 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
3409 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
3414 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
3415 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
3417 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
3418 <title>Namen der Vorlagen</title>
3420 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
3421 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
3422 Erstellung einer Rechnung über die Mahngebühren und Zinsen
3423 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
3424 Vorlagenname für diese Mahnstufe mit dem Zusatz
3425 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
3426 für die ausgewählte Sprache und den ausgewählten Drucker
3430 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
3431 <title>Allgemeine Variablen in Mahnungen</title>
3433 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3434 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3435 Kunden stehen als Variablen <varname>name</varname>,
3436 <varname>street</varname>, <varname>zipcode</varname>,
3437 <varname>city</varname>, <varname>country</varname>,
3438 <varname>department_1</varname>, <varname>department_2</varname>,
3439 und <varname>email</varname> zur Verfügung.</para>
3441 <para>Weitere Variablen beinhalten:</para>
3445 <term><varname>dunning_date</varname></term>
3448 <para>Datum der Mahnung</para>
3453 <term><varname>dunning_duedate</varname></term>
3456 <para>Fälligkeitsdatum für diese Mahhnung</para>
3461 <term><varname>dunning_id</varname></term>
3464 <para>Mahnungsnummer</para>
3469 <term><varname>fee</varname></term>
3472 <para>Kummulative Mahngebühren</para>
3477 <term><varname>interest_rate</varname></term>
3480 <para>Zinssatz per anno in Prozent</para>
3485 <term><varname>total_amount</varname></term>
3488 <para>Gesamter noch zu zahlender Betrag als
3489 <function>fee</function> + <function>total_interest</function>
3490 + <function>total_open_amount</function></para>
3495 <term><varname>total_interest</varname></term>
3498 <para>Zinsen per anno über alle Rechnungen</para>
3503 <term><varname>total_open_amount</varname></term>
3506 <para>Summe über alle offene Beträge der Rechnungen</para>
3512 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
3513 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
3517 <term><varname>dn_amount</varname></term>
3520 <para>Rechnungssumme (brutto)</para>
3525 <term><varname>dn_duedate</varname></term>
3528 <para>Originales Fälligkeitsdatum der Rechnung</para>
3533 <term><varname>dn_dunning_date</varname></term>
3536 <para>Datum der Mahnung</para>
3541 <term><varname>dn_dunning_duedate</varname></term>
3544 <para>Fälligkeitsdatum der Mahnung</para>
3549 <term><varname>dn_fee</varname></term>
3552 <para>Kummulative Mahngebühr</para>
3557 <term><varname>dn_interest</varname></term>
3560 <para>Zinsen per anno für diese Rechnung</para>
3565 <term><varname>dn_invnumber</varname></term>
3568 <para>Rechnungsnummer</para>
3573 <term><varname>dn_linetotal</varname></term>
3576 <para>Noch zu zahlender Betrag (ergibt sich aus
3577 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
3578 + <varname>dn_interest</varname>)</para>
3583 <term><varname>dn_netamount</varname></term>
3586 <para>Rechnungssumme (netto)</para>
3591 <term><varname>dn_open_amount</varname></term>
3594 <para>Offener Rechnungsbetrag</para>
3599 <term><varname>dn_ordnumber</varname></term>
3602 <para>Bestellnummer</para>
3607 <term><varname>dn_transdate</varname></term>
3610 <para>Rechnungsdatum</para>
3615 <term><varname>dn_curr</varname></term>
3618 <para>Währung, in der die Rechnung erstellt wurde. (Die
3619 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
3625 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
3626 <title>Variablen in automatisch erzeugten Rechnungen über
3627 Mahngebühren</title>
3629 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3630 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3631 Kunden stehen als Variablen <varname>name</varname>,
3632 <varname>street</varname>, <varname>zipcode</varname>,
3633 <varname>city</varname>, <varname>country</varname>,
3634 <varname>department_1</varname>, <varname>department_2</varname>,
3635 und <varname>email</varname> zur Verfügung.</para>
3637 <para>Weitere Variablen beinhalten:</para>
3641 <term><varname>duedate</varname></term>
3644 <para>Fälligkeitsdatum der Rechnung</para>
3649 <term><varname>dunning_id</varname></term>
3652 <para>Mahnungsnummer</para>
3657 <term><varname>fee</varname></term>
3660 <para>Mahngebühren</para>
3665 <term><varname>interest</varname></term>
3673 <term><varname>invamount</varname></term>
3676 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
3677 <varname>interest</varname>)</para>
3682 <term><varname>invdate</varname></term>
3685 <para>Rechnungsdatum</para>
3690 <term><varname>invnumber</varname></term>
3693 <para>Rechnungsnummer</para>
3700 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
3701 <title>Variablen in anderen Vorlagen</title>
3704 <title>Einführung</title>
3706 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
3707 Rechnung. Allerdings heißen die Variablen, die mit
3708 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
3709 fangen sie mit <varname>quo</varname> für "quotation" an:
3710 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
3711 wiederum fangen sie mit <varname>ord</varname> für "order" an:
3712 <varname>ordnumber</varname> für Bestellnummer etc.</para>
3714 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
3715 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
3716 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
3717 Vorlage keine Bedeutung haben oder noch nicht belegt sein
3720 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
3721 in Rechnungen aufgeführt.</para>
3724 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
3725 <title>Angebote und Preisanfragen</title>
3729 <term><varname>quonumber</varname></term>
3732 <para>Angebots- bzw. Anfragenummer</para>
3737 <term><varname>reqdate</varname></term>
3740 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
3741 Preisanfragen)</para>
3746 <term><varname>transdate</varname></term>
3749 <para>Angebots- bzw. Anfragedatum</para>
3755 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
3756 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
3760 <term><varname>ordnumber</varname></term>
3763 <para>Auftragsnummer</para>
3768 <term><varname>reqdate</varname></term>
3771 <para>Lieferdatum</para>
3776 <term><varname>transdate</varname></term>
3779 <para>Auftragsdatum</para>
3785 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
3786 <title>Lieferscheine (Verkauf und Einkauf)</title>
3790 <term><varname>cusordnumber</varname></term>
3793 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
3794 des Lieferanten (im Einkauf)</para>
3799 <term><varname>donumber</varname></term>
3802 <para>Lieferscheinnummer</para>
3807 <term><varname>transdate</varname></term>
3810 <para>Lieferscheindatum</para>
3815 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
3816 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
3817 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
3818 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
3819 <function>foreach</function>-Schleife ausgegeben werden. Diese
3820 Variablen sind:</para>
3824 <term><varname>si_bin</varname></term>
3827 <para>Lagerplatz</para>
3832 <term><varname>si_chargenumber</varname></term>
3835 <para>Chargennummer</para>
3840 <term><varname>si_bestbefore</varname></term>
3843 <para>Mindesthaltbarkeit</para>
3848 <term><varname>si_number</varname></term>
3851 <para>Artikelnummer</para>
3856 <term><varname>si_qty</varname></term>
3859 <para>Anzahl bzw. Menge</para>
3864 <term><varname>si_runningnumber</varname></term>
3867 <para>Positionsnummer (1, 2, 3 etc)</para>
3872 <term><varname>si_unit</varname></term>
3875 <para>Einheit</para>
3880 <term><varname>si_warehouse</varname></term>
3889 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
3890 <title>Variablen für Sammelrechnung</title>
3894 <term><varname>c0total</varname></term>
3897 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
3903 <term><varname>c30total</varname></term>
3906 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
3907 und < 60 Tage</para>
3912 <term><varname>c60total</varname></term>
3915 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
3916 und < 90 Tage</para>
3921 <term><varname>c90total</varname></term>
3924 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
3930 <term><varname>total</varname></term>
3933 <para>Gesamtbetrag aller Rechnungen</para>
3938 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
3942 <term><varname>invnumber</varname></term>
3945 <para>Rechnungsnummer</para>
3950 <term><varname>invdate</varname></term>
3953 <para>Rechnungsdatum</para>
3958 <term><varname>duedate</varname></term>
3961 <para>Fälligkeitsdatum</para>
3966 <term><varname>amount</varname></term>
3969 <para>Summe der Rechnung</para>
3974 <term><varname>open</varname></term>
3977 <para>Noch offener Betrag der Rechnung</para>
3982 <term><varname>c0</varname></term>
3985 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
3991 <term><varname>c30</varname></term>
3994 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4000 <term><varname>c60</varname></term>
4003 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4009 <term><varname>c90</varname></term>
4012 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4020 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4021 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4023 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4024 <title>Einfürhung</title>
4026 <para>Der Parser kennt neben den Variablen einige weitere
4027 Konstrukte, die gesondert behandelt werden. Diese sind wie
4028 Variablennamen in spezieller Weise markiert:
4029 <command><%anweisung%> ... <%end%></command></para>
4031 <para>Anmerkung zum <command><%end%></command>: Der besseren
4032 Verständlichkeit halber kann man nach dem <command>end</command>
4033 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4034 Anweisung (z.B. <command>if</command> oder
4035 <command>foreach</command>) damit abgeschlossen wird.</para>
4037 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4038 <command><%if type == "sales_quotation"%></command>, so könnte
4039 er mit <command><%end%></command> genauso abgeschlossen werden
4040 wie mit <command><%end if%></command> oder auch
4041 <command><%end type == "sales_quotation"%></command>.</para>
4044 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4045 <title>Der if-Block</title>
4047 <programlisting><%if variablenname%>
4049 <%end%></programlisting>
4051 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4052 und dem "end" werden nur ausgegeben, wenn die Variable
4053 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4055 <para>Die Bedingung kann auch negiert werden, indem das Wort
4056 <function>not</function> nach dem <filename>if</filename> verwendet
4057 wird. Beispiel:</para>
4059 <programlisting><%if not cp_greeting%>
4061 <%end%></programlisting>
4063 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4064 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4065 einer Variablen mit einer festen Zeichenkette oder einer anderen
4066 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4067 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4068 die rechte Seite des Vergleichsoperators in Anführungszeichen
4069 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4070 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4073 <programlisting><%if var1 == "Wert"%></programlisting>
4075 <para>Testet die Variable <varname>var1</varname> auf
4076 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4077 Mittels <function>!=</function> anstelle von <function>==</function>
4078 würde auf Ungleichheit getestet.</para>
4080 <programlisting>%if var1 == var2%></programlisting>
4082 <para>Testet die Variable <varname>var1</varname> auf
4083 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4084 <function>!=</function> anstelle von <function>==</function> würde
4085 auf Ungleichheit getestet.</para>
4087 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4088 auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
4089 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4090 dieselbe Syntax wie oben nur mit <function>=~</function> und
4091 <function>!~</function> als Vergleichsoperatoren.</para>
4093 <para>Beispiel für einen Test, ob die Variable
4094 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4095 <constant>schwierig</constant> enthält:</para>
4097 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4100 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4101 <title>Der foreach-Block</title>
4103 <programlisting><%foreach variablenname%>
4105 <%end%></programlisting>
4107 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4108 wie das Perl-Array der Variablen <varname>variablenname</varname>
4109 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4110 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4111 benutzt. In jedem Durchlauf werden die <link
4112 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4113 Variablen</link> jeweils auf den Wert für die aktuelle Position
4116 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
4118 <programlisting><%foreach number%>
4119 Position: <%runningnumber%>
4120 Anzahl: <%qty%>
4121 Artikelnummer: <%number%>
4122 Beschreibung: <%description%>
4124 <%end%></programlisting>
4126 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
4127 <function><%foreach%></function>-Block innerhalb einer
4128 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
4129 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
4130 Inhalt zwischen <function><%foreach%></function> und
4131 <function><%end%></function> wiederholt, nicht aber die
4132 komplette Zeile, in der er steht.</para>
4136 <sect2 id="dokumentenvorlagen-und-variablen.markup">
4137 <title>Markup-Code zur Textformatierung innerhalb von
4140 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
4141 anders formatiert haben möchte, so ist dies begrenzt möglich.
4142 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
4143 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
4144 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
4145 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
4146 (HTML oder PDF über LaTeX) umgesetzt.</para>
4148 <para>Die unterstützen Formatierungen sind:</para>
4152 <term><b>Text</b></term>
4155 <para>Text wird in Fettdruck gesetzt.</para>
4160 <term><i>Text</i></term>
4163 <para>Text wird kursiv gesetzt.</para>
4168 <term><u>Text</u></term>
4171 <para>Text wird unterstrichen.</para>
4176 <term><s>Text</s></term>
4179 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
4180 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
4185 <term><bullet></term>
4188 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
4194 <para>Der Befehl <command><bullet></command> funktioniert
4195 momentan auch nur in Latex-Vorlagen.</para>
4199 <sect1 id="excel-templates">
4200 <title>Excel-Vorlagen</title>
4202 <sect2 id="excel-templates.summary">
4203 <title>Zusammenfassung</title>
4205 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
4206 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
4210 <sect2 id="excel-templates.usage">
4211 <title>Bedienung</title>
4213 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
4214 werden. Die Konfigurationsoption heißt <varname>excel_templates =
4215 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
4217 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
4218 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
4219 werden. In den normalen Verkaufsmasken taucht nun
4220 <constant>Excel</constant> als auswählbares Format auf und kann von da
4221 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
4223 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
4224 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
4225 <filename>sales_quotation.xls</filename> gespeichert.</para>
4228 <sect2 id="excel-templates.syntax">
4229 <title>Variablensyntax</title>
4231 <para>Einfache Syntax:
4232 <command><<varname>></command></para>
4234 <para>Dabei sind <constant><<</constant> und
4235 <constant>>></constant> die Delimiter. Da Excel auf festen
4236 Breiten besteht, kann der Tag künstlich verlängert werden, indem
4237 weitere <constant><</constant> oder <constant>></constant>
4238 eingefügt werden. Der Tag muss nicht symmetrisch sein.
4241 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4243 <para>Um die Limitierung der festen Breite zu reduzieren, können
4244 weitere Variablen in einem Block interpoliert werden. Whitespace wird
4245 dazwishen dann erhalten. Beispiel:</para>
4247 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4249 <para>Die Variablen werden interpoliert, und linksbündig mit
4250 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
4251 lang, werden überzählige Zeichen abgeschnitten.</para>
4253 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
4254 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
4256 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4258 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
4259 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
4263 <sect2 id="excel-templates.limitations">
4264 <title>Einschränkungen</title>
4266 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
4267 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
4268 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
4269 Text zu ersetzen.</para>
4271 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
4272 <command><%if%></command> und
4273 <command><%foreach%></command> nicht vorhanden. Der Delimiter
4274 <constant><% %></constant> kommt in den Headerinformationen
4275 evtl. vor. Deshalb wurde auf den sichereren Delimiter
4276 <constant><<</constant> und <constant>>></constant>
4283 <title>Entwicklerdokumentation</title>
4285 <sect1 id="devel.globals" xreflabel="Globale Variablen">
4286 <title>Globale Variablen</title>
4289 <title>Wie sehen globale Variablen in Perl aus?</title>
4291 <para>Globale Variablen liegen in einem speziellen namespace namens
4292 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
4293 globs global und die meisten speziellen Variablen sind...
4296 <para>Daraus ergeben sich folgende Formen:</para>
4300 <term><literal>$main::form</literal></term>
4303 <para>expliziter Namespace "main"</para>
4308 <term><literal>$::form</literal></term>
4311 <para>impliziter Namespace "main"</para>
4316 <term><literal>open FILE, "file.txt"</literal></term>
4319 <para><varname>FILE</varname> ist global</para>
4324 <term><literal>$_</literal></term>
4327 <para>speziell</para>
4332 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
4333 Schlüsselwort wie "<function>global</function>", mit dem man
4334 importieren kann. <function>my</function>, <function>our</function>
4335 und <function>local</function> machen was anderes.</para>
4339 <term><literal>my $form</literal></term>
4342 <para>lexikalische Variable, gültig bis zum Ende des
4348 <term><literal>our $form</literal></term>
4351 <para><varname>$form</varname> referenziert ab hier
4352 <varname>$PACKAGE::form</varname>.</para>
4357 <term><literal>local $form</literal></term>
4360 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
4361 des scopes zurückgesetzt</para>
4368 <title>Warum sind globale Variablen ein Problem?</title>
4370 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
4372 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
4373 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
4374 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
4375 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
4376 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
4377 Datenbankverbindungen, weil die sehr lange zum Initialisieren
4380 <para>Das zweite Problem ist <function>strict</function>. Unter
4381 <function>strict</function> werden alle Variablen die nicht explizit
4382 mit <function>Package</function>, <function>my</function> oder
4383 <function>our</function> angegeben werden als Tippfehler angemarkert,
4384 dies hat, seit der Einführung, u.a. schon so manche langwierige
4385 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
4386 angegeben werden, werden die nicht geprüft, und somit kann sich
4387 schnell ein Tippfehler einschleichen.</para>
4391 <title>Kanonische globale Variablen</title>
4393 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
4394 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
4395 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
4396 umhergereicht werden.</para>
4398 <para>Diese Variablen sind im Moment die folgenden neun:</para>
4402 <para><varname>$::form</varname></para>
4406 <para><varname>%::myconfig</varname></para>
4410 <para><varname>$::locale</varname></para>
4414 <para><varname>$::lxdebug</varname></para>
4418 <para><varname>$::auth</varname></para>
4422 <para><varname>$::lx_office_conf</varname></para>
4426 <para><varname>$::instance_conf</varname></para>
4430 <para><varname>$::dispatcher</varname></para>
4434 <para><varname>$::request</varname></para>
4438 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
4439 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
4440 Eigenschaften (Konventionen):</para>
4443 <title>$::form</title>
4447 <para>Ist ein Objekt der Klasse
4448 "<classname>Form</classname>"</para>
4452 <para>Wird nach jedem Request gelöscht</para>
4456 <para>Muss auch in Tests und Konsolenscripts vorhanden
4461 <para>Enthält am Anfang eines Requests die Requestparameter vom
4466 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
4467 cachen, das wird aber momentan absichtlich zerstört</para>
4471 <para><varname>$::form</varname> wurde unter <productname>SQL
4472 Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
4473 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
4474 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
4475 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
4476 <function>IS->retrieve_customer()</function> in Sicherheit
4479 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
4480 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
4481 3552, Stand version 2.7beta), um dies hinterher wieder auf den
4482 richtigen Wert zu setzen:</para>
4484 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
4485 $::myconfig{numberformat} = $numberformat;
4486 # (...) div Berechnungen
4487 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
4489 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
4490 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
4491 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
4492 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
4493 Es geht ziemlich sicher etwas kaputt.</para>
4495 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
4496 in den <productname>Template::Toolkit</productname> Templates
4497 außerhalb der Controller: der Ausdruck <function>[% var
4498 %]</function> greift auf <varname>$::form->{var}</varname> zu.
4499 Unter Controllern ist der Standard Scope anders, da lautet der
4500 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
4501 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
4502 <function><%var%></function> zeigt auf
4503 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
4504 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
4507 <programlisting>[%- IF business %]
4508 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
4509 [%- END %]</programlisting>
4511 <para>Entweder wird hier dann $::form->{business} ausgewertet
4512 oder aber der Funktion
4513 <function>$form->parse_html_template</function> wird explizit
4514 noch ein zusätzlicher Hash übergeben, der dann auch in den
4515 (Web-)Templates zu Verfügung steht, bspw. so:</para>
4517 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
4519 <para>Innerhalb von Schleifen wird
4520 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
4521 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
4522 welches über alle Positionen eines Lieferscheins in Schleife
4525 <programlisting>for $i (1 .. $form->{rowcount}) {
4527 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
4528 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
4529 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
4535 <title>%::myconfig</title>
4539 <para>Das einzige Hash unter den globalen Variablen</para>
4543 <para>Wird spätestens benötigt wenn auf die Datenbank
4544 zugegriffen wird</para>
4548 <para>Wird bei jedem Request neu erstellt.</para>
4552 <para>Enthält die Userdaten des aktuellen Logins</para>
4556 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
4557 extern serialisiert werden, weil da auch der Datenbankzugriff
4558 für diesen user drinsteht.</para>
4562 <para>Enthält unter anderem Listenbegrenzung vclimit,
4563 Datumsformat dateformat und Nummernformat numberformat</para>
4567 <para>Enthält Datenbankzugriffinformationen</para>
4571 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
4572 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
4573 aktuellen Users entscheiden müssen, befragen
4574 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
4575 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
4576 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
4577 Informationen über den Benutzer die über die
4578 Administrator-Schnittstelle (admin.pl) eingegeben wurden.</para>
4582 <title>$::locale</title>
4586 <para>Objekt der Klasse "Locale"</para>
4590 <para>Wird pro Request erstellt</para>
4594 <para>Muss auch für Tests und Scripte immer verfügbar
4599 <para>Cached intern über Requestgrenzen hinweg benutzte
4604 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
4605 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
4609 <title>$::lxdebug</title>
4613 <para>Objekt der Klasse "LXDebug"</para>
4617 <para>Wird global gecached</para>
4621 <para>Muss immer verfügbar sein, in nahezu allen
4626 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
4627 bereit, wie "<function>enter_sub</function>" und
4628 "<function>leave_sub</function>", mit denen in den alten Modulen ein
4629 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
4630 der man die Wallclockzeit seit Requeststart loggen kann, sowie
4631 "<function>message</function>" und "<function>dump</function>" mit
4632 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
4635 <para>Beispielsweise so:</para>
4637 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
4638 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
4642 <title>$::auth</title>
4646 <para>Objekt der Klasse "SL::Auth"</para>
4650 <para>Wird global gecached</para>
4654 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
4658 <para>Wird nach jedem Request resettet.</para>
4662 <para><varname>$::auth</varname> stellt Funktionen bereit um die
4663 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
4664 vom aktuellen User abhängen wird das Objekt aus
4665 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
4666 Request kurz resettet.</para>
4670 <title>$::lx_office_conf</title>
4674 <para>Objekt der Klasse
4675 "<classname>SL::LxOfficeConf</classname>"</para>
4679 <para>Global gecached</para>
4683 <para>Repräsentation der
4684 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
4688 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
4689 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
4690 das Programm die Konfiguration ändern kann oder sollte.</para>
4692 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
4693 Debug- und Trace-Log-Datei wie folgt konfiguriert und
4696 <programlisting>[debug]
4697 file = /tmp/kivitendo-debug.log</programlisting>
4699 <para>ist der Key <varname>file</varname> im Programm als
4700 <varname>$::lx_office_conf->{debug}{file}</varname>
4704 <para>Zugriff auf die Konfiguration erfolgt im Moment über
4705 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
4710 <title>$::instance_conf</title>
4714 <para>Objekt der Klasse
4715 "<classname>SL::InstanceConfiguration</classname>"</para>
4719 <para>wird pro Request neu erstellt</para>
4723 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
4724 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
4725 ist hier eine Mandantendatenbank. Beispielsweise überprüft
4726 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
4727 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
4731 <title>$::dispatcher</title>
4735 <para>Objekt der Klasse
4736 "<varname>SL::Dispatcher</varname>"</para>
4740 <para>wird pro Serverprozess erstellt.</para>
4744 <para>enthält Informationen über die technische Verbindung zum
4749 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
4750 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
4751 Objekt untergebracht.</para>
4755 <title>$::request</title>
4759 <para>Hashref (evtl später Objekt)</para>
4763 <para>Wird pro Request neu initialisiert.</para>
4767 <para>Keine Unterstruktur garantiert.</para>
4771 <para><varname>$::request</varname> ist ein generischer Platz um
4772 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
4773 at a distance benutzt werden, sondern um lokales memoizing zu
4774 ermöglichen, das garantiert am Ende des Requests zerstört
4777 <para>Vieles von dem, was im moment in <varname>$::form</varname>
4778 liegt, sollte eigentlich hier liegen. Die groben
4779 Differentialkriterien sind:</para>
4783 <para>Kommt es vom User, und soll unverändert wieder an den
4784 User? Dann <varname>$::form</varname>, steht da eh schon</para>
4788 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
4789 Requests gebraucht werden? Dann
4790 <varname>$::request</varname></para>
4794 <para>Muss ich von anderen Teilen des Programms lesend drauf
4795 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
4796 Wrappermethode</para>
4803 <title>Ehemalige globale Variablen</title>
4805 <para>Die folgenden Variablen waren einmal im Programm, und wurden
4809 <title>$::cgi</title>
4813 <para>war nötig, weil cookie Methoden nicht als
4814 Klassenfunktionen funktionieren</para>
4818 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
4819 Klassennamespace gehalten wird und über Requestgrenzen
4824 <para>liegt jetzt unter
4825 <varname>$::request->{cgi}</varname></para>
4831 <title>$::all_units</title>
4835 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
4836 ein paar hundert mal pro Request eine Liste der Einheiten
4837 brauchen, und de als Parameter durch einen Riesenstack von
4838 Funktionen geschleift werden müssten.</para>
4842 <para>Liegt jetzt unter
4843 <varname>$::request->{cache}{all_units}</varname></para>
4848 <function>AM->retrieve_all_units()</function> gesetzt oder
4855 <title>%::called_subs</title>
4859 <para>wurde benutzt um callsub deep recursions
4864 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
4865 möglichen Rekursioenen darstellt, und da nie welche
4870 <para>komplette recursion protection wurde entfernt.</para>
4877 <sect1 id="devel.fcgi">
4878 <title>Entwicklung unter FastCGI</title>
4880 <sect2 id="devel.fcgi.general">
4881 <title>Allgemeines</title>
4883 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
4884 werden, muss der Webserver neu gestartet werden.</para>
4886 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
4887 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
4888 müssen folgende Aspekte beachtet werden.</para>
4891 <sect2 id="devel.fcgi.exiting">
4892 <title>Programmende und Ausnahmen</title>
4894 <para>Betrifft die Funktionen <function>warn</function>,
4895 <function>die</function>, <function>exit</function>,
4896 <function>carp</function> und <function>confess</function>.</para>
4898 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
4899 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
4900 am Laufen zu halten. Man kann mit <function>die</function>,
4901 <function>confess</function> oder <function>carp</function> Fehler
4902 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
4903 eigene <function>$::form-</function>error()> tut im Prinzip das
4904 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
4905 <function>exit</function> hingegen werden nicht abgefangen.
4906 <function>warn</function> wird direkt nach STDERR, also in Server Log
4907 eine Nachricht schreiben (sofern in der Konfiguration nicht die
4908 Warnungen in das kivitendo Log umgeleitet wurden), und
4909 <function>exit</function> wird die Ausführung beenden.</para>
4911 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
4912 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
4913 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
4914 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
4917 <sect2 id="devel.fcgi.globals">
4918 <title>Globale Variablen</title>
4920 <para>Um zu vermeiden, dass Informationen von einem Request in einen
4921 anderen gelangen, müssen alle globalen Variablen vor einem Request
4922 sauber initialisiert werden. Das ist besonders wichtig im
4923 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
4924 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
4927 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
4928 abgetrennten Block, der alle kanonischen globalen Variablen listet und
4929 erklärt. Bitte keine anderen einführen ohne das sauber zu
4930 dokumentieren.</para>
4932 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
4933 man sicher geht, dass man die richtige erwischt.</para>
4936 <sect2 id="devel.fcgi.performance">
4937 <title>Performance und Statistiken</title>
4939 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
4940 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
4941 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
4942 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
4943 sind es je nach Menge der definierten Variablen 1-2s. Ab der
4944 Moose/Rose::DB Version sind es 5-6s.</para>
4946 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
4947 den kritischen Pfaden, unter 0,15 sonst.</para>
4950 <sect2 id="devel.fcgi.known-issues">
4951 <title>Bekannte Probleme</title>
4953 <sect3 id="devel.fcgi.known-issues.encoding">
4954 <title>Encoding Awareness</title>
4956 <para>UTF-8 kodierte Installationen sind sehr anfällig gegen
4957 fehlerhfate Encodings unter FCGI. latin9 Installationen behandeln
4958 falsch kodierte Zeichen eher unwissend, und geben sie einfach
4959 weiter. UTF-8 verweigert bei fehlerhaften Programmpfaden kurzerhand
4960 das Ausliefern. Es wird noch daran gearbeitet, alle Fehler da zu
4966 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
4967 <title>SQL-Upgradedateien</title>
4969 <sect2 id="db-upgrade-files.introduction"
4970 xreflabel="Einführung in die Datenbank-Upgradedateien">
4971 <title>Einführung</title>
4973 <para>Der alte Mechanismus für SQL-Upgradescripte, der auf einer
4974 Versionsnummer beruht und dann in sql/Pg-upgrade nach einem Script für
4975 diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele
4976 Entwicklung im stable- und unstable-Baum betrifft.</para>
4978 <para>Dieser Mechanismus wurde für kivitendo 2.4.1 deutlich erweitert.
4979 Es werden weiterhin alle Scripte aus sql/Pg-upgrade ausgeführt.
4980 Zusätzlich gibt es aber ein zweites Verzeichnis, sql/Pg-upgrade2. In
4981 diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren,
4982 die neben den eigentlich auszuführenden SQL- oder Perl-Befehlen einige
4983 Kontrollinformationen enthält.</para>
4985 <para>Neu sind die Kontrollinformationen, die Abhängigkeiten und
4986 Prioritäten definieren können werden, sodass Datenbankscripte zwar in
4987 einer sicheren Reihenfolge ausgeführt werden (z.B. darf ein "ALTER
4988 TABLE" erst ausgeführt werden, wenn die Tabelle mit "CREATE TABLE"
4989 angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man
4990 keine Versionsnummern mehr braucht.</para>
4992 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
4993 sql/Pg-upgrade2 bereits durchgeführt wurde und führt diese nicht
4994 erneut aus. Dazu dient die Tabelle "schema_info", die bei der
4995 Anmeldung automatisch angelegt wird.</para>
4998 <sect2 id="db-upgrade-files.format"
4999 xreflabel="Format der Upgradedateien">
5000 <title>Format der Kontrollinformationen</title>
5002 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5003 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5004 hat dabei das folgende Format:</para>
5006 <para>Für SQL-Upgradedateien:</para>
5008 <programlisting>-- @key: value</programlisting>
5010 <para>Für Perl-Upgradedateien:</para>
5012 <programlisting># @key: value</programlisting>
5014 <para>Leerzeichen vor "<varname>value</varname>" werden
5017 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5021 <term><varname>tag</varname></term>
5024 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5025 Dieser "tag" kann von anderen Kontrolldateien in ihren
5026 Abhängigkeiten verwendet werden (Schlüsselwort
5027 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5028 in der Datenbank eingetragen wird.</para>
5030 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5031 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5033 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5034 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5035 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5041 <term><varname>charset</varname></term>
5044 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
5045 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5046 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
5047 Abwesenheit des Tags der Zeichensatz
5048 "<literal>ISO-8859-15</literal>" angenommen.</para>
5053 <term><varname>description</varname></term>
5056 <para>Benötigt. Eine Beschreibung, was in diesem Update
5057 passiert. Diese wird dem Benutzer beim eigentlichen
5058 Datenbankupdate angezeigt. Während der Tag in englisch gehalten
5059 sein sollte, sollte die Beschreibung auf Deutsch
5065 <term><varname>depends</varname></term>
5068 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5069 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
5070 dass die in dieser Liste aufgeführten Scripte bereits
5071 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5073 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5074 Script "b" existiert, das von Änderungen in "a" abhängt, und
5075 eine neue Kontrolldatei für "c" erstellt wird, die von
5076 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5077 Tag "b" als Abhängigkeit zu definieren.</para>
5079 <para>Es ist nicht erlaubt, sich selbst referenzierende
5080 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5081 und "c" -> "a").</para>
5086 <term><varname>priority</varname></term>
5089 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5090 der Scripte ausgeführt werden, die die gleichen
5091 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5092 der Wert 1000 benutzt.</para>
5094 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5095 "depends" benutzt werden. kivitendo sortiert die auszuführenden
5096 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5097 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5098 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5099 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5100 Priorität alphabetisch nach dem "tag".</para>
5105 <term><varname>ignore</varname></term>
5108 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
5109 Skript bei der Anmeldung ignoriert und entsprechend nicht
5116 <sect2 id="db-upgrade-files.dbupgrade-tool"
5117 xreflabel="Hilfsscript dbupgrade2_tool.pl">
5118 <title>Hilfsscript dbupgrade2_tool.pl</title>
5120 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
5121 existiert ein Hilfsscript namens
5122 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
5123 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
5124 liest alle Datenbankupgradescripte aus dem Verzeichnis
5125 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
5126 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
5127 von der Kommandozeile überprüft werden können.</para>
5129 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
5130 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
5131 sich aber auch Informationen auf verschiedene Art ausgeben
5136 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
5137 --list</command>"</para>
5139 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
5140 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
5141 würde. Es werden neben der Listenposition der Tag, die
5142 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
5146 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
5147 --tree</command>"</para>
5149 <para>Listet alle Tags in Baumform basierend auf den
5150 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
5151 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
5152 beim übergeordneten Script als Abhängigkeit eingetragen
5156 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
5157 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
5158 --rtree</command>"</para>
5160 <para>Listet alle Tags in Baumform basierend auf den
5161 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
5162 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
5163 die das übergeordnete Script als Abhängigkeit eingetragen
5168 <para>Baumform mit Postscriptausgabe:
5169 "<command>./scripts/dbupgrade2_tool.pl
5170 --graphviz</command>"</para>
5172 <para>Benötigt das Tool "<command>graphviz</command>", um mit
5173 seiner Hilfe die <link
5174 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
5175 Baumform</link> in eine Postscriptdatei namens
5176 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
5177 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
5178 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
5179 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
5184 <para>Scripte, von denen kein anderes Script abhängt:
5185 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
5187 <para>Listet die Tags aller Scripte auf, von denen keine anderen
5188 Scripte abhängen.</para>
5194 <sect1 id="translations-languages" xreflabel="Translations and languages">
5195 <title>Translations and languages</title>
5197 <sect2 id="translations-languages.introduction"
5198 xreflabel="Introduction to translations and languages">
5199 <title>Introduction</title>
5202 <para>Dieser Abschnitt ist in Englisch geschrieben, um
5203 internationalen Übersetzern die Arbeit zu erleichtern.</para>
5206 <para>This section describes how localization packages in kivitendo
5207 are built. Currently the only language fully supported is German, and
5208 since most of the internal messages are held in English the English
5209 version is usable too.</para>
5211 <para>A stub version of French is included but not functunal at this
5215 <sect2 id="translations-languages.file-structure"
5216 xreflabel="File structure">
5217 <title>File structure</title>
5219 <para>The structure of locales in kivitendo is:</para>
5221 <programlisting>kivitendo/locale/<langcode>/</programlisting>
5223 <para>where <langcode> stands for an abbreviation of the
5224 language package. The builtin packages use two letter <ulink
5225 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
5226 but the actual name is not relevant for the program and can easily be
5228 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
5229 tags</ulink> (i.e. "en_GB"). In fact the original language packages
5230 from SQL Ledger are named in this way.</para>
5232 <para>In such a language directory the following files are
5237 <term>LANGUAGE</term>
5240 <para>This file is mandatory.</para>
5242 <para>The <filename>LANGUAGE</filename> file contains the self
5243 descripted name of the language. It should contain a native
5244 representation first, and in parenthesis an english translation
5245 after that. Example:</para>
5247 <programlisting>Deutsch (German)</programlisting>
5252 <term>charset</term>
5255 <para>This file should be present.</para>
5257 <para>The <filename>charset</filename> file describes which
5258 charset a language package is written in and applies to all
5259 other language files in the package. It is possible to write
5260 some language packages without an explicit charset, but it is
5261 still strongly recommended. You'll never know in what
5262 environment your language package will be used, and neither
5263 UTF-8 nor Latin1 are guaranteed.</para>
5265 <para>The whole content of this file is a string that can be
5266 recognized as a valid charset encoding. Example:</para>
5268 <programlisting>UTF-8</programlisting>
5276 <para>This file is mandatory.</para>
5278 <para>The central translation file. It is essentially an inline
5279 Perl script autogenerated by <command>locales.pl</command>. To
5280 generate it, generate the directory and the two files mentioned
5281 above, and execute the following command:</para>
5283 <programlisting>scripts/locales.pl <langcode></programlisting>
5285 <para>Otherwise you can simply copy one of the other languages.
5286 You will be told how many are missing like this:</para>
5288 <programlisting>$ scripts/locales.pl en
5289 English - 0.6% - 2015/2028 missing</programlisting>
5291 <para>A file named "<filename>missing</filename>" will be
5292 generated and can be edited. You can also edit the
5293 "<filename>all</filename>" file directly. Edit everything you
5294 like to fit the target language and execute
5295 <command>locales.pl</command> again. See how the missing words
5301 <term>Num2text</term>
5304 <para>Legacy code from SQL Ledger. It provides a means for
5305 numbers to be converted into natural language, like
5306 <literal>1523 => one thousand five hundred twenty
5307 three</literal>. If you want to provide it, it must be inlinable
5308 Perl code which provides a <function>num2text</function> sub. If
5309 an <function>init</function> sub exists it will be executed
5312 <para>Only used in the check and receipt printing module.</para>
5317 <term>special_chars</term>
5320 <para>kivitendo comes with a lot of interfaces to different
5321 formats, some of which are rather picky with their accepted
5322 charset. The <filename>special_chars</filename> file contains a
5323 listing of chars not suited for different file format and
5324 provides substitutions. It is written in "Simple Ini" style,
5325 containing a block for every file format.</para>
5327 <para>First entry should be the order of substitution for
5328 entries as a whitespace separated list. All entries are
5329 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
5330 and <literal>\\</literal> all work.</para>
5332 <para>After that every entry is a special char that should be
5333 translated when writing text into such a file.</para>
5335 <para>Example:</para>
5337 <programlisting>[Template/XML]
5338 order=& < > \n
5342 \n=<br></programlisting>
5344 <para>Note the importance of the order in this example.
5345 Substituting < and > befor & would lead to $gt; become
5348 <para>For a list of valid formats, see the German
5349 <filename>special_chars</filename> entry. As of this writing the
5350 following are recognized:</para>
5352 <programlisting>HTML
5357 Template/OpenDocument
5358 filenames</programlisting>
5360 <para>The last of which is very machine dependant. Remember that
5361 a lot of characters are forbidden by some filesystems, for
5362 exmaple MS Windows doesn't like ':' in its files where Linux
5363 doesn't mind that. If you want the files created with your
5364 language pack to be portable, find all chars that could cause
5370 <term>missing</term>
5373 <para>This file is not a part of the language package
5376 <para>This is a file generated by
5377 <command>scripts/locales.pl</command> while processing your
5378 locales. It's only to have the missing entries singled out and
5379 does not belong to a language package.</para>
5387 <para>This file is not a part of the language package
5390 <para>Another file generated by
5391 <command>scripts/locales.pl</command>. If for any reason a
5392 translation does not appear anymore and can be deleted, it gets
5393 moved here. The last 50 or so entries deleted are saved here in
5394 case you made a typo, so that you don't have to translate
5395 everything again. If a tranlsation is missing, the lost file is
5396 checked first. If you maintain a language package, you might
5397 want to keep this safe somewhere.</para>
5404 <sect1 id="devel.style-guide">
5405 <title>Stil-Richtlinien</title>
5407 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
5408 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
5409 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
5410 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
5412 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
5415 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
5416 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
5421 <para>Es werden keine echten Tabs sondern Leerzeichen
5426 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
5428 <programlisting>foreach my $row (@data) {
5430 # do something with $row
5434 $row->{modules} = MODULE->retrieve(
5435 id => $row->{id},
5436 date => $use_now ? localtime() : $row->{time},
5440 $report->add($row);
5445 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
5446 Zeile wie der letzte Befehl. Beispiele:</para>
5448 <programlisting>sub debug {
5454 <programlisting>if ($form->{item_rows} > 0) {
5460 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
5461 der Befehl / die öffnende schließende Klammer, die den Block
5462 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
5463 Beispiele wie bei 3. gelten.</para>
5467 <para>Die Wörter "<function>else</function>",
5468 "<function>elsif</function>", "<function>while</function>" befinden
5469 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
5472 <programlisting>if ($form->{sum} > 1000) {
5474 } elsif ($form->{sum} > 0) {
5482 } until ($a > 0);</programlisting>
5486 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
5487 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
5488 und grep-ähnliche Operatoren. Beispiel:</para>
5490 <programlisting>$main::lxdebug->message("Could not find file.");
5491 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
5495 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
5497 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
5498 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
5499 Blöcke schon. Beispiel:</para>
5501 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
5506 $form->{sum} += $form->{"row_$i"};
5507 $form->{ $form->{index} } += 1;
5509 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
5513 <para>Mehrzeilige Befehle</para>
5517 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
5518 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
5519 werden, in der die ersten Funktionsparameter in der ersten Zeile
5520 stehen. Beispiel:</para>
5522 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
5523 $form->{some_col_value});</programlisting>
5527 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
5528 besten in einer übersichtlichen Tabellenstruktur organisiert
5529 wird. Beispiel:</para>
5531 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
5532 : $form->{oldcount} ? $form->{oldcount} + 1
5533 : $form->{rowcount} - $form->{rowbase};</programlisting>
5539 <para>Kommentare</para>
5543 <para>Kommentare, die alleine in einer Zeile stehen, sollten
5544 soweit wie der Code eingerückt sein.</para>
5548 <para>Seitliche hängende Kommentare sollten einheitlich
5549 formatiert werden.</para>
5553 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
5554 auf Englisch zu verfassen. So wie ich keine Lust habe,
5555 französischen Quelltext zu lesen, sollte auch der kivitendo
5556 Quelltext für nicht-Deutschsprachige lesbar sein.
5559 <programlisting>my $found = 0;
5567 $i = 0 # initialize $i
5569 $i *= $const; # do something crazy
5570 $i = $n; # recover $i</programlisting>
5576 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
5577 Interpolation gewünscht ist. Beispiel:</para>
5579 <programlisting>$form->{sum} = 0;
5580 $form->{"row_$i"} = $form->{"row_$i"} - 5;
5581 $some_hash{42} = 54;</programlisting>
5585 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
5586 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
5587 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
5588 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
5590 <para>Als Beispiel sei die Funktion
5591 <function>print_options</function> aus
5592 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
5596 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
5597 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
5600 <para>Emacs und vim haben beide recht einfache Methoden zur
5601 Entfernung von trailing whitespace. Emacs kennt das Kommande
5602 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
5603 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
5604 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
5609 <para>Es wird kein <command>perltidy</command> verwendet.</para>
5611 <para>In der Vergangenheit wurde versucht,
5612 <command>perltidy</command> zu verwenden, um einen einheitlichen
5613 Stil zu erlangen. Es hat sich aber gezeigt, dass
5614 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
5615 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
5616 den Interessierten sind hier die
5617 <command>perltidy</command>-Optionen, die grob den beschriebenen
5618 Richtlinien entsprechen:</para>
5620 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
5621 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
5622 -lp -vt=1 -vtc=1</programlisting>
5626 <para><varname>STDERR</varname> ist tabu. Unkonditionale
5627 Debugmeldungen auch.</para>
5629 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
5630 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
5631 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
5633 <para>Die <classname>LXDebug</classname>-Methode
5634 "<function>message</function>" nimmt als ersten Paramter außerdem
5635 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
5636 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
5637 und werden in den meisten Fällen auch vom Repository
5638 zurückgewiesen.</para>
5642 <para>Alle neuen Module müssen use strict verwenden.</para>
5644 <para><varname>$form</varname>, <varname>$auth</varname>,
5645 <varname>$locale</varname>, <varname>$lxdebug</varname> und
5646 <varname>%myconfig</varname> werden derzeit aus dem main package
5647 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
5648 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
5653 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
5654 <title>Dokumentation erstellen</title>
5656 <sect2 id="devel.build-doc.introduction">
5657 <title>Einführung</title>
5659 <para>Diese Dokumentation ist in <productname>DocBook</productname>
5660 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
5661 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
5662 Editor nutzt, der spezielle Unterstützung für
5663 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
5664 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
5665 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
5669 <sect2 id="devel.build-doc.required-software">
5670 <title>Benötigte Software</title>
5672 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
5673 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
5674 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
5675 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
5676 <command>scripts/build_doc.sh</command>.</para>
5678 <para>Das Script benötigt zur Konvertierung verschiedene
5679 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
5685 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
5686 in einer halbwegs aktuellen Version</para>
5690 <para>Das Java-Build-System <ulink
5691 url="http://ant.apache.org/">Apache Ant</ulink></para>
5695 <para>Das Dokumentations-System Dobudish für
5696 <productname>DocBook</productname> 4.5, eine Zusammenstellung
5697 diverser Stylesheets und Grafiken zur Konvertierung von
5698 <productname>DocBook</productname> XML in andere Formate. Das
5699 Paket, das benötigt wird, ist zum Zeitpunkt der
5700 Dokumentationserstellung
5701 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
5702 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
5707 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
5708 sind auf allen gängigen Plattformen verfügbar. Beispiel für
5709 Debian/Ubuntu:</para>
5711 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
5713 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
5714 <filename>doc/build</filename> entpackt werden. Beispiel unter der
5715 Annahme, das <productname>Dobudish</productname> in
5716 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
5718 <programlisting>cd doc/build
5719 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
5722 <sect2 id="devel.build-doc.build">
5723 <title>PDFs und HTML-Seiten erstellen</title>
5725 <para>Die eigentliche Konvertierung erfolgt nach Installation der
5726 benötigten Software mit einem einfachen Aufruf direkt aus dem
5727 kivitendo-Installationsverzeichnis heraus:</para>
5729 <programlisting>./scripts/build_doc.sh</programlisting>
5732 <sect2 id="devel.build-doc.repository">
5733 <title>Einchecken in das Git-Repository</title>
5735 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
5736 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
5737 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
5738 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
5740 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
5741 symbolischen Links gehören hingegen nicht in das Repository.</para>