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>
21 <title>Installation und Grundkonfiguration</title>
23 <sect1 id="Benötigte-Software-und-Pakete">
24 <title>Benötigte Software und Pakete</title>
26 <sect2 id="Betriebssystem">
27 <title>Betriebssystem</title>
29 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
30 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
31 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
32 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
33 ohne große Probleme auf den derzeit aktuellen verbreiteten
34 Distributionen läuft.</para>
36 <para>Mitte 2012 sind das folgende Systeme, von denen bekannt ist,
37 dass kivitendo auf ihnen läuft:</para>
45 <para>6.0 Squeeze (hier muss allerdings das Modul FCGI in der Version >= 0.72 compiled werden)</para>
48 <para>7.0 Wheezy</para>
54 <para>Ubuntu 10.04 LTS Lucid Lynx bis 12.10 Oneiric Ocelot</para>
58 <para>openSUSE 11.2 und 11.3</para>
62 <para>SuSE Linux Enterprice Server 11</para>
66 <para>Fedora 13 bis 16</para>
71 <sect2 id="Pakete" xreflabel="Pakete">
74 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
75 Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2)
78 <para>Zusätzlich benötigt kivitendo die folgenden Perl-Pakete, die
79 nicht Bestandteil einer Standard-Perl-Installation sind:</para>
82 <listitem><para><literal>parent</literal></para></listitem>
84 <listitem><para><literal>Archive::Zip</literal></para></listitem>
86 <listitem><para><literal>Config::Std</literal></para></listitem>
88 <listitem><para><literal>DateTime</literal></para></listitem>
90 <listitem><para><literal>DBI</literal></para></listitem>
92 <listitem><para><literal>DBD::Pg</literal></para></listitem>
94 <listitem><para><literal>Email::Address</literal></para></listitem>
96 <listitem><para><literal>Email::MIME</literal></para></listitem>
98 <listitem><para><literal>JSON</literal></para></listitem>
100 <listitem><para><literal>List::MoreUtils</literal></para></listitem>
102 <listitem><para><literal>Net::SMTP::SSL</literal> (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "<xref
103 linkend="config.sending-email.smtp"/>")</para></listitem>
105 <listitem><para><literal>Net::SSLGlue</literal> (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "<xref
106 linkend="config.sending-email.smtp"/>")</para></listitem>
108 <listitem><para><literal>Params::Validate</literal></para></listitem>
110 <listitem><para><literal>PDF::API2</literal></para></listitem>
112 <listitem><para><literal>Rose::Object</literal></para></listitem>
114 <listitem><para><literal>Rose::DB</literal></para></listitem>
116 <listitem><para><literal>Rose::DB::Object</literal></para></listitem>
118 <listitem><para><literal>Template</literal></para></listitem>
120 <listitem><para><literal>Text::CSV_XS</literal></para></listitem>
122 <listitem><para><literal>Text::Iconv</literal></para></listitem>
124 <listitem><para><literal>URI</literal></para></listitem>
126 <listitem><para><literal>XML::Writer</literal></para></listitem>
128 <listitem><para><literal>YAML</literal></para></listitem>
131 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen: <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
132 <literal>Net::SSLGlue</literal>.</para>
134 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
135 hinzugekommen, <literal>URI</literal> und
136 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
139 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
140 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
141 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
142 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
144 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
145 hinzugekommen.</para>
147 <para><literal>Email::Address</literal> und
148 <literal>List::MoreUtils</literal> sind schon länger feste
149 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
150 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
151 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
152 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
155 <para>Die zu installierenden Pakete können in den verschiedenen
156 Distributionen unterschiedlich heißen.</para>
158 <para>Für Debian oder Ubuntu benötigen Sie diese Pakete:</para>
160 <programlisting>apt-get install apache2 postgresql libparent-perl libarchive-zip-perl \
161 libdatetime-perl libdbi-perl libdbd-pg-perl libpg-perl \
162 libemail-address-perl libemail-mime-perl liblist-moreutils-perl libpdf-api2-perl \
163 librose-object-perl librose-db-perl librose-db-object-perl \
164 libtemplate-perl libtext-csv-xs-perl libtext-iconv-perl liburi-perl \
165 libxml-writer-perl libyaml-perl libconfig-std-perl \
166 libparams-validate-perl libjson-perl libclass-accessor-perl \
167 libnet-sslglue-perl libnet-smtp-ssl-perl</programlisting>
169 <para>Für Fedora Core benötigen Sie diese Pakete:</para>
171 <programlisting>yum install httpd postgresql-server perl-parent perl-DateTime \
172 perl-DBI perl-DBD-Pg perl-Email-Address perl-Email-MIME perl-List-MoreUtils \
173 perl-PDF-API2 perl-Rose-Object perl-Rose-DB perl-Rose-DB-Object \
174 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
175 perl-XML-Writer perl-YAML perl-Net-SSLGlue perl-Net-SMTP-SSL</programlisting>
177 <para>Für OpenSuSE benötigen Sie diese Pakete:</para>
179 <programlisting>zypper install apache2 postgresql-server perl-Archive-Zip \
180 perl-DateTime perl-DBI perl-DBD-Pg perl-Email-MIME perl-MailTools perl-List-MoreUtils \
181 perl-PDF-API2 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
182 perl-URI perl-XML-Writer perl-YAML perl-Net-SSLGlue perl-Net-SMTP-SSL</programlisting>
184 <para>kivitendo enthält ein Script, mit dem überprüft werden kann, ob
185 alle benötigten Perl-Module installiert sind. Der Aufruf lautet wie
188 <programlisting>./scripts/installation_check.pl</programlisting>
192 <sect1 id="Manuelle-Installation-des-Programmpaketes"
193 xreflabel="Manuelle Installation des Programmpaketes">
194 <title>Manuelle Installation des Programmpaketes</title>
196 <para>Die kivitendo ERP Installationsdatei (kivitendo-erp-2.6.3.tgz) wird
197 im Dokumentenverzeichnis des Webservers (z.B.
198 <filename>/var/www/html/</filename>,
199 <filename>/srv/www/htdocs</filename> oder
200 <filename>/var/www/</filename>) entpackt:</para>
202 <programlisting>cd /var/www
203 tar xvzf kivitendo-erp-2.6.3.tgz</programlisting>
205 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
207 <programlisting>cd kivitendo-erp</programlisting>
209 <para>Alternativ können Sie auch einen Alias in der
210 Webserverkonfiguration benutzen, um auf das tatsächliche
211 Installationsverzeichnis zu verweisen.</para>
213 <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
214 beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
215 Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
216 core <constant>apache</constant> oder bei OpenSuSE <constant>wwwrun</constant>).</para>
218 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
219 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
221 <programlisting>chown -R www-data users spool webdav</programlisting>
223 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
224 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>
226 <programlisting>chown www-data templates users</programlisting>
229 <sect1 id="config.config-file">
230 <title>kivitendo-Konfigurationsdatei</title>
232 <sect2 id="config.config-file.introduction"
233 xreflabel="Einführung in die Konfigurationsdatei">
234 <title>Einführung</title>
236 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei,
237 die benötigt wird: <filename>config/kivitendo.conf</filename> (kurz:
238 "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
239 von kivitendo bzw. der Migration von älteren Versionen angelegt
242 <para>Als Vorlage dient die Datei
243 <filename>config/kivitendo.conf.default</filename> (kurz: "die
244 Default-Datei"):</para>
246 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
248 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
249 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
250 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
251 Abschnitte und Werte enthalten, die von denen der Default-Datei
256 Vor der Umbenennung in kivitendo hieß diese Datei noch <filename>config/lx_office.conf</filename>. Aus Gründen der Kompatibilität
257 wird diese Datei eingelesen, sofern die Datei <filename>config/kivitendo.conf</filename> nicht existiert.
261 <para>Diese Hauptkonfigurationsdatei ist dann eine
262 installationsspezifische Datei, d.h. sie enthält bspw. lokale
263 Passwörter und wird auch nicht im Versionsmanagement (git)
266 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
267 Mandaten, bzw. Datenbanken gleich.</para>
270 <sect2 id="config.config-file.sections-parameters">
271 <title>Abschnitte und Parameter</title>
273 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
274 entsprechend kommentiert sind:</para>
277 <listitem><para><literal>authentication</literal> (siehe Abschnitt "<xref
278 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>" in diesem Kapitel)</para></listitem>
280 <listitem><para><literal>authentication/database</literal></para></listitem>
282 <listitem><para><literal>authentication/ldap</literal></para></listitem>
284 <listitem><para><literal>system</literal></para></listitem>
286 <listitem><para><literal>features</literal> (siehe Kapitel "<xref linkend="features"/>")</para></listitem>
288 <listitem><para><literal>paths</literal></para></listitem>
290 <listitem><para><literal>applications</literal></para></listitem>
292 <listitem><para><literal>environment</literal></para></listitem>
294 <listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>
296 <listitem><para><literal>print_templates</literal></para></listitem>
298 <listitem><para><literal>task_server</literal></para></listitem>
300 <listitem><para><literal>periodic_invoices</literal></para></listitem>
302 <listitem><para><literal>console</literal></para></listitem>
304 <listitem><para><literal>debug</literal></para></listitem>
307 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
308 einzustellen oder zu kontrollieren sind, sind:</para>
310 <programlisting>[authentication]
311 admin_password = geheim
313 [authentication/database]
321 dbcharset = UTF-8</programlisting>
323 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
324 <varname>[periodic_invoices]</varname> den Login eines Benutzers
325 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
326 mit Informationen über die erstellten Rechnungen bekommt.</para>
328 <para>Nutzt man den <link
329 linkend="config.task-server">Taskserver</link> für <link
330 linkend="features.periodic-invoices">wiederkehrende Rechnungen</link>,
331 muss unter <varname>[task_server]</varname> ein Login eines Benutzers
332 angegeben werden, mit dem sich der Taskserver an kivitendo bei der
333 Datenbank anmeldet, die dem Benutzer zugewiesen ist.</para>
335 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
336 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
339 <sect2 id="config.config-file.prior-versions">
340 <title>Versionen vor 2.6.3</title>
342 <para>In älteren kivitendo Versionen gab es im Verzeichnis
343 <filename>config</filename> die Dateien
344 <filename>authentication.pl</filename> und
345 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
346 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
347 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
348 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
350 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
351 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
352 manuell übertragen und die alten Konfigurationsdateien anschließend
353 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
354 entsprechende Fehlermeldung an.</para>
358 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
359 <title>Anpassung der PostgreSQL-Konfiguration</title>
361 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
363 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
364 <title>Zeichensätze/die Verwendung von UTF-8</title>
366 <para>Bei aktuellen Serverinstallationen braucht man hier meist nicht
369 <para>Dieses kann überprüft werden: ist das Encoding der Datenbank
370 “template1” “UTF8”, so braucht man nichts weiteres diesbezüglich
371 unternehmen. Zum Testen:
373 <programlisting>su postgres
375 exit </programlisting>
377 Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
378 UTF-8-Encoding anzulegen und diesen zu verwenden. Unter Debian und
379 Ubuntu kann dies z.B. für PostgreSQL 8.2 mit dem folgenden Befehl
382 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2 clustername</programlisting>
384 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
385 Versionsnummer angepasst werden.</para>
387 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
389 <para>Wurde PostgreSQL nicht mit UTF-8 als Encoding initialisiert und
390 ist ein Neuanlegen eines weiteren Clusters nicht möglich, so kann
391 kivitendo mit ISO-8859-15 als Encoding betrieben werden.</para>
393 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
394 <literal>\l</literal> geprüft werden.</para>
397 <sect2 id="Änderungen-an-Konfigurationsdateien">
398 <title>Änderungen an Konfigurationsdateien</title>
400 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
401 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
402 <filename>/var/lib/pgsql/data/</filename> oder
403 <filename>/etc/postgresql/</filename>, muss sichergestellt werden,
404 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
405 Parameter <varname>listen_address</varname> gesteuert. Laufen
406 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
407 <literal>localhost</literal> verwendet werden. Andernfalls müssen
408 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
409 was mit dem Wert <literal>*</literal> geschieht.</para>
411 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
412 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
413 sein sollte, müssen die Berichtigungen für den Zugriff geändert
414 werden. Hier gibt es mehrere Möglichkeiten. sinnvoll ist es nur die
415 nögiten Verbindungen immer zuzulassen, für eine lokal laufenden
416 Datenbank zum Beispiel:</para>
418 <programlisting>local all kivitendo password
419 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
422 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
423 <title>Erweiterung für servergespeicherte Prozeduren</title>
425 <para>In der Datenbank <literal>template1</literal> muss die
426 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
427 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
428 <programlisting>su - postgres
429 psql template1</programlisting>
431 führen Sie die folgenden Kommandos aus:</para>
433 <programlisting>create language 'plpgsql';
437 <sect2 id="Datenbankbenutzer-anlegen">
438 <title>Datenbankbenutzer anlegen</title>
440 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
441 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
442 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
445 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit nein
446 beantworten, genauso ist die Berechtigung neue User (Roles) zu
447 generieren nicht nötig.</para>
448 <programlisting>su - postgres
449 createuser -d -P kivitendo
450 exit</programlisting>
452 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
453 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.
454 den hier gewählten Benutzernamen.</para>
458 <sect1 id="Apache-Konfiguration">
459 <title>Webserver-Konfiguration</title>
462 <title>Grundkonfiguration mittels CGI</title>
465 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
466 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
467 <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
470 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
471 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
472 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
473 anderen Datei hinzu, die beim Starten des Webservers eingelesen
476 <programlisting>AddHandler cgi-script .pl
477 Alias /kivitendo-erp/ /var/www/kiviteno-erp/
479 <Directory /var/www/kivitendo-erp>
480 Options ExecCGI Includes FollowSymlinks
483 <Directory /var/www/kivitendo-erp/users>
486 </Directory></programlisting>
488 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
489 das kivitendo-Archiv entpacket haben.</para>
492 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
493 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
496 <para>Auf einigen Webservern werden manchmal die Grafiken und
497 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
498 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
500 <programlisting>EnableSendfile Off</programlisting>
503 <sect2 id="Apache-Konfiguration.FCGI"
504 xreflabel="Konfiguration für FastCGI/FCGI">
505 <title>Konfiguration für FastCGI/FCGI</title>
507 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
508 <title>Was ist FastCGI?</title>
510 <para>Direkt aus <ulink
511 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
514 <para><citation> FastCGI ist ein Standard für die Einbindung
515 externer Software zur Generierung dynamischer Webseiten in einem
516 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
517 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
518 umgehen. </citation></para>
521 <sect3 id="Apache-Konfiguration.FCGI.Warum">
522 <title>Warum FastCGI?</title>
524 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
525 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
526 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
527 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
528 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
529 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
530 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
531 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
532 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
533 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
534 deutlich länger dauert als früher, und dass davon 90% für das Laden
535 der Module verwendet wird.</para>
537 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
538 wird nur die eigentliche Programmlogik ausgeführt.</para>
541 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
542 <title>Getestete Kombinationen aus Webservern und Plugin</title>
544 <para>Folgende Kombinationen sind getestet:</para>
548 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
552 <para>Apache 2.2.11 (Ubuntu) und mod_fastcgi.</para>
556 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
557 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
558 mod_fastcgi nicht mehr explizit eingegangen.</para>
560 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
564 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern
565 bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrere Installation gibt, muss zwingend Version 0.68 oder
566 aber Version 0.72 und neuer eingesetzt werden.</para>
568 <para>Mit CPAN lässt sie sich die Vorgängerversion wie folgt
571 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
575 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
576 <title>Konfiguration des Webservers</title>
578 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
579 laufen zu lassen, empfliehlt es sich die Installation ersteinmal
580 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
581 debuggen die beim ersten aufsetzen auftreten können. Sollte die
582 Installation schon funktionieren, lesen Sie weiter.</para>
584 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
585 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
587 <programlisting>a2enmod fcgid</programlisting>
589 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
590 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
591 und <function>Directory</function>-Direktiven. Dabei wird zwischen
592 dem Installationspfad von kivitendo im Dateisystem
593 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
594 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
595 ("<filename>/url/for/kivitendo-erp</filename>").</para>
597 <para>Folgender Konfigurationsschnipsel funktioniert mit
600 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
601 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
603 <Directory /path/to/kivitendo-erp>
605 Options ExecCGI Includes FollowSymlinks
610 <DirectoryMatch /path/to/kivitendo-erp/users>
613 </DirectoryMatch></programlisting>
615 <para>Seit mod_fcgid-Version 2.6.3 gelten sehr kleine Grenzen für
616 die maximale Größe eines Requests. Diese sollte wie folgt
617 hochgesetzt werden:</para>
619 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
621 <para>Das ganze sollte dann so aussehen:</para>
623 <programlisting>AddHandler fcgid-script .fpl
624 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
625 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
626 FcgidMaxRequestLen 10485760
628 <Directory /path/to/kivitendo-erp>
630 Options ExecCGI Includes FollowSymlinks
635 <DirectoryMatch /path/to/kivitendo-erp/users>
638 </DirectoryMatch></programlisting>
640 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
641 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
642 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
643 gibt es hier kleine Performance-Einbußen.</para>
645 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
646 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
647 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
649 <programlisting># Zugriff über CGI
650 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
652 # Zugriff mit mod_fcgid:
653 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
654 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
656 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
657 die normale Version erreichbar, und unter
658 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
659 FastCGI-Version.</para>
664 <sect1 id="config.task-server">
665 <title>Der Task-Server</title>
667 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
668 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
669 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
670 wird bisher nur für die Erzeugung der wiederkehrenden Rechnungen
671 benutzt, wird aber in Zukunft deutlich mehr Aufgaben übertragen
674 <sect2 id="Konfiguration-des-Task-Servers">
675 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
677 <para>Die Konfiguration erfolgt über den Abschnitt
678 <literal>[task_server]</literal> in der Datei
679 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
680 Optionen sind:</para>
684 <term><varname>login</varname></term>
687 <para>gültiger kivitendo-Benutzername, der benutzt wird, um die
688 zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss
689 in der Administration angelegt werden. Diese Option muss
690 angegeben werden.</para>
695 <term><varname>run_as</varname></term>
698 <para>Wird der Server vom Systembenutzer <literal>root</literal>
699 gestartet, so wechselt er auf den mit <literal>run_as</literal>
700 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
701 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
703 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
704 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
705 unter dem auch der Webserver läuft.</para>
710 <term><varname>debug</varname></term>
713 <para>Schaltet Debug-Informationen an und aus.</para>
719 <sect2 id="Einbinden-in-den-Boot-Prozess">
720 <title>Automatisches Starten des Task-Servers beim Booten</title>
722 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
723 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
724 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
726 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
727 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
728 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
729 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
730 anstelle eines symbolischen Links verwendet werden können.</para>
733 <title>SystemV-basierende Systeme (z.B. Debian, OpenSuSE, Fedora
736 <para>Kopieren Sie die Datei
737 <filename>scripts/boot/system-v/kivitendo-server</filename>
738 nach <filename>/etc/init.d/kivitendo-server</filename>. Passen
739 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
740 <literal>DAEMON=....</literal>). Binden Sie das Script in den
741 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
745 <para>Debian-basierende Systeme:</para>
747 <programlisting>update-rc.d kivitendo-task-server defaults
748 # Nur bei Debian Squeeze und neuer:
749 insserv kivitendo-task-server</programlisting>
753 <para>OpenSuSE und Fedora Core:</para>
755 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
759 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
760 werden: <command>/etc/init.d/kivitendo-task-server
761 start</command></para>
765 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
767 <para>Kopieren Sie die Datei
768 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
769 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
770 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
771 <literal>exec ....</literal>).</para>
773 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
774 werden: <command>service kivitendo-task-server
775 start</command></para>
779 <sect2 id="Prozesskontrolle">
780 <title>Wie der Task-Server gestartet und beendet wird</title>
782 <para>Der Task-Server wird wie folgt kontrolliert:</para>
784 <programlisting>./scripts/task_server.pl Befehl</programlisting>
786 <para><literal>Befehl</literal> ist dabei eine der folgenden
791 <para><literal>start</literal> startet eine neue Instanz des
792 Task-Servers. Die Prozess-ID wird innerhalb des
793 <filename>users</filename>-Verzeichnisses abgelegt.</para>
797 <para><literal>stop</literal> beendet einen laufenden
802 <para><literal>restart</literal> beendet und startet ihn
807 <para><literal>status</literal> berichtet, ob der Task-Server
812 <para>Der Task-Server wechselt beim Starten automatisch in das
813 kivitendo-Installationsverzeichnis.</para>
815 <para>Dieselben Optionen können auch für die SystemV-basierenden
816 Runlevel-Scripte benutzt werden (siehe oben).</para>
818 <sect2 id="Prozesskontrolle2">
819 <title>Task-Server mit mehreren Mandanten</title>
821 <para>Beim Task-Server wird der Login-Name des Benutzers, unter dem der
822 Task-Server laufen soll, in die Konfigurationsdatei geschrieben. Hat
823 man mehrere Mandanten muß man auch mehrere Konfigurationsdateien
826 <para>Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf,
827 wo in der Kategorie [task_server] der gewünschte "login" steht.</para>
829 <para>Der alternative Task-Server wird dann mit folgendem Befehl
832 <programlisting>./scripts/task_server.pl -c config/DATEINAME.conf</programlisting>
836 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
837 <title>Benutzerauthentifizierung und Administratorpasswort</title>
839 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
840 über die Verwaltung von Gruppen und weitere Einstellungen</para>
842 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
843 <title>Grundlagen zur Benutzerauthentifizierung</title>
845 <para>kivitendo verwaltet die Benutzerinformationen in einer
846 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
847 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
848 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
849 können, müssen aber nicht unterschiedlich sein.</para>
851 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
852 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
853 abgelegt werden.</para>
855 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
856 entweder gegen die Authentifizierungsdatenbank oder gegen einen
857 LDAP-Server überprüft werden.</para>
859 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
860 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
861 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
862 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
863 einer Version vor v2.6.0 angelegt werden. Eine
864 Beispielkonfigurationsdatei
865 <filename>config/kivitendo.conf.default</filename> existiert, die als
866 Vorlage benutzt werden kann.</para>
869 <sect2 id="Administratorpasswort">
870 <title>Administratorpasswort</title>
872 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
873 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
874 nur dort und nicht mehr im Administrationsinterface selber geändert
875 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
876 Abschnitt <varname>[authentication]</varname>.</para>
879 <sect2 id="Authentifizierungsdatenbank">
880 <title>Authentifizierungsdatenbank</title>
882 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
883 Parametern in <varname>[authentication/database]</varname>
884 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
888 <term><literal>host</literal></term>
891 <para>Der Rechnername oder die IP-Adresse des
892 Datenbankservers</para>
897 <term><literal>port</literal></term>
900 <para>Die Portnummer des Datenbankservers, meist 5432</para>
905 <term><literal>db</literal></term>
908 <para>Der Name der Authentifizierungsdatenbank</para>
913 <term><literal>user</literal></term>
916 <para>Der Benutzername, mit dem sich kivitendo beim
917 Datenbankserver anmeldet (z.B.
918 "<literal>postgres</literal>")</para>
923 <term><literal>password</literal></term>
926 <para>Das Passwort für den Datenbankbenutzer</para>
931 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
932 automatisch anlegen (mehr dazu siehe unten).</para>
935 <sect2 id="Passwortüberprüfung">
936 <title>Passwortüberprüfung</title>
938 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
939 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
940 Active-Directory-Server. Welche davon benutzt wird, regelt der
941 Parameter <varname>module</varname> im Abschnitt
942 <varname>[authentication]</varname>.</para>
944 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
945 gespeichert werden, so muss der Parameter <varname>module</varname>
946 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
947 der Administrator als auch die Benutzer selber ihre Psaswörter in
948 kivitendo ändern.</para>
950 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
951 benutzt werden, so muss der Parameter <varname>module</varname> auf
952 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
953 zusätzliche Informationen über den LDAP-Server im Abschnitt
954 <literal>[authentication/ldap]</literal> angegeben werden:</para>
958 <term><literal>host</literal></term>
961 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
962 Active-Directory-Servers. Diese Angabe ist zwingend
968 <term><literal>port</literal></term>
971 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
976 <term><literal>tls</literal></term>
979 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
980 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
981 ‘<literal>0</literal>’ belassen</para>
986 <term><literal>attribute</literal></term>
989 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
990 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
991 meist ‘<literal>sAMAccountName</literal>’, für andere
992 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
993 zwingend erforderlich.</para>
998 <term><literal>base_dn</literal></term>
1001 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1002 Diese Angabe ist zwingend erforderlich.</para>
1007 <term><literal>filter</literal></term>
1010 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1011 <literal><%login%></literal>, so wird dieses durch den vom
1012 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1013 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1014 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1019 <term><literal>bind_dn</literal> und
1020 <literal>bind_password</literal></term>
1023 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1024 durchsucht werden kann (z.B. ist dies bei
1025 Active-Directory-Servern der Fall), so kann diese hier angegeben
1026 werden. Für Active-Directory-Server kann als
1027 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1028 z.B. ‘<literal>cn=Martin
1029 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1030 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1031 also ‘<literal>Martin Mustermann</literal>’.</para>
1037 <sect2 id="Name-des-Session-Cookies">
1038 <title>Name des Session-Cookies</title>
1040 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1041 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1042 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1043 Parameter <varname>cookie_name</varname> im Abschnitt
1044 <varname>[authentication]</varname>gesetzt.</para>
1046 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1047 Server existiert.</para>
1050 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1051 <title>Anlegen der Authentifizierungsdatenbank</title>
1053 <para>Nachdem alle Einstellungen in
1054 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1055 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1056 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1057 der folgenden URL erreichbar sein sollte:</para>
1060 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
1064 <sect1 id="Benutzer--und-Gruppenverwaltung">
1065 <title>Benutzer- und Gruppenverwaltung</title>
1067 <para>Nach der Installation müssen Benutzer, Gruppen und Datenbanken
1068 angelegt werden. Dieses geschieht im Administrationsmenü, das Sie unter
1069 folgender URL finden:</para>
1072 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
1074 <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
1075 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1077 <sect2 id="Zusammenhänge">
1078 <title>Zusammenhänge</title>
1080 <para>kivitendo verwendet eine Datenbank zum Speichern all seiner
1081 Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um
1082 mit kivitendo arbeiten zu können, muss eine Person einen
1083 Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine
1084 Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist
1085 möglich und normal, dass mehreren Benutzern die selbe Datenbank
1086 zugewiesen wird, sodass sie alle mit den selben Daten arbeiten
1089 <para>Die Basisdaten der Benutzer, die in der Administration
1090 eingegeben werden können, werden in einer zweiten Datenbank
1091 gespeichert, der bereits erwähnten Authentifizierungsdatenbank. Diese
1092 ist also den Produktivdaten enthaltenden Datenbanken vorgeschaltet.
1093 Pro kivitendo-Installation gibt es nur eine
1094 Authentifizierungsdatenbank, aber beliebig viele Datenbanken mit
1097 <para>kivitendo kann seinen Benutzern Zugriff auf bestimmte
1098 Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht
1099 gestattet, so werden der entsprechenden Menüpunkte auch nicht
1100 angezeigt. Diese Rechte werden ebenfalls in der
1101 Authentifizierungsdatenbank gespeichert.</para>
1103 <para>Um Rechte verteilen zu können, verwendet kivitendo ein
1104 Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche
1105 erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder
1106 mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen
1107 Funktionen, die mindestens einer Gruppe erlaubt sind, in der der
1108 Benutzer Mitglied ist.</para>
1110 <para>Die allgemeine Reihenfolge, in der Datenbanken, Gruppen und
1111 Benutzer angelegt werden sollten, lautet:</para>
1113 <orderedlist numeration="arabic">
1115 <para>Datenbank anlegen</para>
1119 <para>Gruppen anlegen</para>
1123 <para>Benutzer anlegen</para>
1127 <para>Benutzer den Gruppen zuordnen</para>
1132 <sect2 id="Datenbanken-anlegen">
1133 <title>Datenbanken anlegen</title>
1135 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1136 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1137 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1139 <para>Wenn Sie für die kivitendo-Installation nicht Unicode (UTF-8) sondern den europäischen Schriftsatz ISO-8859-15 benutzen
1140 wollen, so müssen Sie vor dem Anlegen der Datenbank in der Datei <filename>config/kivitendo.conf</filename> die Variable
1141 <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf den Wert ‘<literal>ISO-8859-15</literal>’ setzen.</para>
1143 <para>Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz
1144 verwenden müssen, da diese Einstellungen momentan global in kivitendo
1145 vorgenommen wird und nicht nach Datenbank unterschieden werden kann.
1146 Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz
1147 angelegt worden sein.</para>
1150 <sect2 id="Gruppen-anlegen">
1151 <title>Gruppen anlegen</title>
1153 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1154 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1155 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1156 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1158 <para>Benutzergruppen sind unabhängig von Datenbanken, da sie in der
1159 Authentifizierungsdatenbank gespeichert werden. Sie gelten für alle
1160 Datenbanken, die in dieser Installation verwaltet werden.</para>
1163 <sect2 id="Benutzer-anlegen">
1164 <title>Benutzer anlegen</title>
1166 <para>Beim Anlegen von Benutzern werden für viele Parameter
1167 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1168 deutschen Raumes entsprechen.</para>
1170 <para>Zwingend anzugeben sind der Loginname sowie die komplette
1171 Datenbankkonfiguration. Wenn die Passwortauthentifizierung über die
1172 Datenbank eingestellt ist, so kann hier auch das Benutzerpasswort
1173 gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung
1174 aktiv, so ist das Passwort-Feld deaktiviert.</para>
1176 <para>In der Datenbankkonfiguration müssen die Zugriffsdaten einer der
1177 eben angelegten Datenbanken eingetragen werden.</para>
1180 <sect2 id="Gruppenmitgliedschaften-verwalten">
1181 <title>Gruppenmitgliedschaften verwalten</title>
1183 <para>Nach dem Anlegen von Benutzern und Gruppen müssen Benutzer den
1184 Gruppen zugewiesen werden. Dazu gibt es zwei Möglichkeiten:</para>
1186 <orderedlist numeration="arabic">
1188 <para>In der Gruppenverwaltung wählt man eine Gruppe aus. Im
1189 folgenden Dialog kann man dann einzeln die Benutzer der Gruppe
1194 <para>In der Gruppenverwaltung wählt man das Tool zur Verwaltung
1195 der Gruppenmitgliedschaft. Hier wird eine Matrix angezeigt, die
1196 alle im System angelegten Gruppen und Benutzer enthält. Durch
1197 Setzen der Häkchen wird der Benutzer in der ausgewählten Zeile der
1198 Gruppe in der ausgewählten Spalte hinzugefügt.</para>
1203 <sect2 id="Migration-alter-Installationen">
1204 <title>Migration alter Installationen</title>
1206 <para>Wenn kivitendo 2.6.3 über eine ältere Version installiert wird,
1207 in der die Benutzerdaten noch im Dateisystem im Verzeichnis
1208 <literal>users</literal> verwaltet wurden, so bietet kivitendo die
1209 Möglichkeit, diese Benutzerdaten automatisch in die
1210 Authentifizierungsdatenbank zu übernehmen. Dies geschieht, wenn man
1211 sich nach dem Update der Installation das erste Mal im
1212 Administrationsbereich anmeldet. Findet kivitendo die Datei
1213 <literal>users/members</literal>, so wird der Migrationsprozess
1216 <para>Der Migrationsprozess ist nahezu vollautomatisch. Alle
1217 Benutzerdaten können übernommen werden. Nach den Benutzerdaten bietet
1218 kivitendo noch die Möglichkeit an, dass automatisch eine
1219 Benutzergruppe angelegt wird. Dieser Gruppe wird Zugriff auf alle
1220 Funktionen von kivitendo gewährt. Alle migrierten Benutzern werden
1221 Mitglied in dieser Gruppe. Damit wird das Verhalten von kivitendo bis
1222 Version 2.4.3 inklusive wiederhergestellt, und die Benutzer können
1223 sich sofort wieder anmelden und mit dem System arbeiten.</para>
1227 <sect1 id="config.sending-email" xreflabel="E-Mail-Versand aus kivitendo heraus">
1228 <title>E-Mail-Versand aus kivitendo heraus</title>
1230 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden, z.B. um ein Angebot direkt an einen Kunden zu
1231 verschicken. Damit dies funktioniert, muss eingestellt werden, über welchen Server die E-Mails verschickt werden sollen. kivitendo
1232 unterstützt dabei zwei Mechanismen: Versand über einen lokalen E-Mail-Server (z.B. mit <productname>Postfix</productname> oder
1233 <productname>Exim</productname>, was auch die standardmäßig aktive Methode ist) sowie Versand über einen SMTP-Server (z.B. der des
1234 eigenen Internet-Providers).</para>
1236 <para>Welche Methode und welcher Server verwendet werden, wird über die Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1237 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1239 <sect2 id="config.sending-email.sendmail" xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1240 <title>Versand über lokalen E-Mail-Server</title>
1242 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie
1243 z.B. <productname>Postfix</productname>, <productname>Exim</productname> oder <productname>Sendmail</productname> läuft.</para>
1245 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1246 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1248 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet wird, dient der Parameter '<literal>sendmail =
1249 ...</literal>'. Der Standardwert verweist auf das Programm <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1250 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1252 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen dieses sprengen. Hierfür sei auf die Dokumentation des
1253 E-Mail-Servers verwiesen.</para>
1256 <sect2 id="config.sending-email.smtp" xreflabel="E-Mail-Versand über einen SMTP-Server">
1257 <title>Versand über einen SMTP-Server</title>
1259 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server vorhanden oder zwar einer vorhanden, dieser aber nicht
1260 konfiguriert ist.</para>
1262 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1263 Parameter dienen dabei der weiteren Konfiguration:</para>
1267 <term><varname>hostname</varname></term>
1269 <listitem><para>Name oder IP-Adresse des SMTP-Servers. Standardwert: '<literal>localhost</literal>'</para></listitem>
1273 <term><varname>port</varname></term>
1275 <listitem><para>Portnummer. Der Standardwert hängt von der verwendeten Verschlüsselungsmethode ab. Gilt '<literal>security =
1276 none</literal>' oder '<literal>security = tls</literal>', so ist 25 die Standardportnummer. Für '<literal>security =
1277 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht geändert werden.</para></listitem>
1281 <term><varname>security</varname></term>
1283 <listitem><para>Wahl der zu verwendenden Verschlüsselung der Verbindung mit dem Server. Standardwert ist
1284 '<literal>none</literal>', wodurch keine Verschlüsselung verwendet wird. Mit '<literal>tls</literal>' wird TLS-Verschlüsselung
1285 eingeschaltet, und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL eingeschaltet. Achtung: Für
1286 '<literal>tls</literal>' und '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt (siehe unten).</para></listitem>
1290 <term><varname>login</varname> und <varname>password</varname></term>
1292 <listitem><para>Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername
1293 und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von
1294 Verschlüsselung aktiviert werden.</para></listitem>
1298 <para>Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind:</para>
1301 <listitem><para>TLS-Verschlüsselung: Modul <literal>Net::SSLGlue</literal> (Debian-Paketname
1302 <literal>libnet-sslglue-perl</literal>, Fedora Core: <literal>perl-Net-SSLGlue</literal>, openSuSE:
1303 <literal>perl-Net-SSLGlue</literal></para></listitem>
1305 <listitem><para>SSL-Verschlüsselung: Modul <literal>Net::SMTP::SSL</literal> (Debian-Paketname
1306 <literal>libnet-smtp-ssl-perl</literal>, Fedora Core: <literal>perl-Net-SMTP-SSL</literal>, openSuSE:
1307 <literal>perl-Net-SMTP-SSL</literal></para></listitem>
1312 <sect1 id="Drucken-mit-kivitendo">
1313 <title>Drucken mit kivitendo</title>
1315 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX Vorlagen.
1316 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1317 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1318 Debianoiden Betriebssystemen installiert man die Pakete mit:</para>
1320 <para><programlisting>aptitude install \
1322 texlive-latex-recommended \
1323 texlive-fonts-recommended \
1324 texlive-latex-extra \
1325 texlive-lang-german \
1326 texlive-generic-extra
1327 </programlisting></para>
1329 <para>TODO: rpm Pakete.</para>
1331 <para>kivitendo bringt 3 alternative Vorlagensätze mit:</para>
1333 <listitem>Standard</listitem>
1334 <listitem>f-tex</listitem>
1335 <listitem>RB</listitem>
1338 <sect2 id="Vorlagenverzeichnis-anlegen" xreflabel="Vorlagenverzeichnis anlegen">
1339 <title>Vorlagenverzeichnis anlegen</title>
1340 <para>Bei einem neuen Benutzer/Mandanten lässt sich einer dieser Vorlagensätze
1341 als Basis für die zu druckenden Dokumente auswählen:</para>
1343 <para><programlisting>unter:
1344 Administration -> Benutzerverwaltung -> [ein Benutzer]
1345 Erzeuge Vorlagen, Name: [Name für das neue Vorlagenverzeichnis]
1346 Vorlagen auswählen: [Default, f-tex oder RB]
1348 </programlisting></para>
1349 <para>der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Benutzern verwendet werden.</para>
1351 <para>Die Abhängigkeiten kann man prüfen mit:</para>
1352 <para><programlisting>/scripts/installation_check.pl -l</programlisting></para>
1355 <sect2 id="Standard">
1356 <title>Default</title>
1358 <para>Der standard Vorlagensatz von Kivitendo. Wie unter
1359 <ulink url="http://demo.kivitendo.org">http://demo.kivitendo.org</ulink> zu sehen.</para>
1364 <title>f-tex</title>
1366 <para>Ein Vorlagensatz, der in Wenigen Minuten alle Dokumente zur stellt.</para>
1368 <sect3 id="f-tex-Feature-Übersicht">
1369 <title>f-tex Feature Übersicht</title>
1371 <listitem>Keine Retundanz. Es wird ein und die selbe Latex-Vorlage für alle
1372 briefartigen Dokumente verwendet. Also Angebot, Rechnung,
1373 Performarechnung, Lieferschein, aber eben nicht für Paketaufkleber
1375 <listitem>Leichte Anpassung an das Firmen Layout durch verwendung eines Hintergrund-PDF
1376 dieses kann leicht mit dem eigenen Lieblingsprogramm erstellt werden
1377 (Openoffice, Inkscape, Gimp, Adobe*)
1379 <listitem>Hintergrundpdf um schaltbar auf "nur erste Seite" (default) oder "alle Seiten"
1380 (option "bgPdfFirstPageOnly" in Datei letter.lco)
1382 <listitem>Hintergrundpdf für Ausdruck auf bereits bedrucktem Briefpapier Abschaltbar,
1383 es wird dann nur bei per email versendeten Dokumenten eingebunden.
1384 (Option "bgPdfEmailOnly" in Datei letter.lco)
1386 <listitem>Nutzung der Layout-Funktionen von Latex für Seitenumbruch,
1387 wiederholung von Kopfzeilen, Zwischensummen etc. (danke an Kai-Martin für
1390 <listitem>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom Land des
1391 eigenen Unternehmens abweicht (also die Rechnung das Land verlässt).
1393 <listitem>Multisprachfähig leicht um weitere Sprachen zu erweitern, alle
1394 Übersetzungen in der Datei translatinos.tex.
1396 <listitem>Auflistung von Bruttopreisen für Endverbraucher.
1401 <sect3 id="f-tex-installation">
1402 <title>f-tex Die Installation</title>
1404 <listitem>Vorlagenverzeichnis mit Option f-tex anlegen, siehe:
1405 <xref linkend="Vorlagenverzeichnis-anlegen"/>
1406 Das Vorlagensystem funktioniert jetzt schon, hat allerdings noch einen
1410 Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
1411 <programlisting>./letter_head.pdf</programlisting>
1414 Editiere den Bereich "settings" in der datei letter.lco
1418 <para>oder etwas Detaillierter:</para>
1421 Es wird eine Datei sample.lco erstellt und diese nach letter.lco verlinkt.
1422 Eigentlich ist dies die Datei die für die Firmenspezifischen Anpassungen
1423 gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist, wird in
1424 dieser Datei auf ein Hintergrundpdf verwiesen. Ich empfehle über dieses pdf
1425 die persönlichen Layoutanpassungen vorzunehmen und sample.lco unverändert zu
1426 lassen. Die die Anpassung über eine *.lco Datei die letztlich auf letter.lco
1427 verlinkt ist ist aber auch möglich.
1430 Es wird eine Datei sample_head.pdf mit ausgeliefert, diese wird nach
1431 letter_head.pdf verlinkt. Damit gibt es schon mal eine Funktionsfähige
1432 Vorlage. Schau Dir nach Abschluss der Installation die Datei sample_haed.pdf
1433 an und erstelle ein entsprechendes pdf passend zum Briefkopf Deiner Firma,
1434 diese dann im Template Verzeichniss ablegen und statt sample_head.pdf nach
1435 letter_head.pdf verlinken.
1438 letzlich muss ./letter_head.pdf auf das passende Hintergrundpdf verweisen,
1439 welches gewünschten Briefkopf enthält. Bei Updates oder nach erneutem
1442 Es wird eine Datei mydata.tex.example ausgeliefert die nach mytdata.tex
1443 verlinkt ist. Bei verwendetem Hintergrundpdf wird nur der Eintrag für das
1444 Land verwendet die Datei muss also nicht angefasst werden. Die Anderen Werte
1445 sind für das Modul lp (Label Print in erp - zur Zeit nicht im
1446 öffentlichen Zweig).
1449 Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
1450 sollten über die Hintergrund pdf datei oder die *.lco Datei erfolgen.
1453 <sect3 id="f-tex-Funktionsübersicht">
1454 <title>f-tex Funktionsübersicht</title>
1456 Das Konzept von kivitendo sieht vor, für jedes Dokument
1457 (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
1458 Latex-Vorlage vorzuhalten, dies ist sehr Wartungsunfreundlich. Auch
1459 das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
1460 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus
1461 dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
1462 Briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
1463 Latexvorlage verwendet, welche über Codeweichen die Besonderheiten
1464 der jeweiligen Dokumente Berücksichtigt
1467 <listitem>Tabellen mit oder ohne Preis
1469 <listitem>Sprache der Tabellenüberschriften etc.
1471 <listitem>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
1474 <listitem>Darstellung von Brutto oder Netto-Preisen in der Auflistung
1475 (Endverbraucher versus Gewerblicher Kunde)
1479 <para>Nachteil:</para>
1481 Latex hat ohnehin eine sehr steile Lehrnkurve. Die Datei letter.tex
1482 ist sehr komplex und verstärkt damit diesen Effekt noch einmal erheblich.
1483 Wer Latex-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann
1484 natürlich auch innerhalb der Tabellendarstellung gut persönliche Anpassungen
1485 vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell häftig in
1488 <para>Wer nicht so tief in die Materie einsteigen will oder leicht zu
1489 frustrieren ist, sollte sein Hintergrund PDF auf Basis der mitglieferten
1490 Datei sample_head.pdf erstellen, und sich an der Form der dargestellten Tabellen
1491 wie sie ausgeliefert werden, erfreuen.
1494 Nicht zu viel auf einmal wollen, lieber kleine kontinuierliche
1499 <para>Bruttopreise für Endvorbraucher</para>
1500 <para>Der auszuweisende Bruttopreis wird innerhalb der LaTeX
1501 Umgebung berechnet. es gibt zwar ein Feld um bei Aufträgen "alle Preise
1502 Brutto" auszuwählen, aber:</para>
1505 hierfür müssen die Preise auch in Brutto in der Datenbank stehen
1506 (ja - das lässt sich über die Preisgruppen und die Zuordung einer Default-Preisgruppe
1510 man darf beim Anlegen des Vorgangs nicht vergessen Dieses Häkchen zu setzen.
1511 (das ist in der Praxis wenn man sowohl Endverbraucher- wie Gewerbekunden beliefert
1512 der eigentliche Knackpunkt)
1517 Es gibt mit f-tex eine weitere Alternative. Die Information ob Brutto oder
1518 Nettorechnung wird mit den Zahlarten verknüpft. Zahlarten bei denen
1519 Rechnungen, Angebote, etc, in Brutto ausgegeben werden sollen enden mit "_E"
1520 (für Endverbraucher) Falls identische Zahlarten für Gewerbekunden und
1521 Endverbraucher vorhanden sind legt man diese einfach doppelt an (einmal mit
1522 der Namensendung "_E"). Gewinn:</para>
1525 die Entscheidung ob Netopreise ausgewiesen werden ist nicht mehr fix
1526 mit einer Preisliste Verbunden.
1529 die Default-Zahlart kann im Kundendatensatz hinterlegt werden und man
1530 muss nicht mehr daran denken "alle Preise Netto" auszuwählen.
1533 Die Entscheidung ob Netto/Oder Bruttopreise ausgewiesen werden kann direkt
1534 beim Drucken reviediert werden, ohne dass sich der Auftragswert ändert.
1538 <para>Lieferadressen</para>
1541 in Lieferscheinen kommen shipto* -Variablen im Adressfeld zum Einsatz
1544 wenn die shipto*variable leer ist wird die entsprechende
1545 Adressvariable eingesetzt. Wenn Also die Lieferadresse in Strasse,
1546 Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
1547 Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert der
1548 Hauptadresse angezeigt.
1558 <para>Vollständiger Dokumentensatz mit alternativen Design</para>
1562 <sect2 id="Allgemeine Hinweise zu LaTeX">
1563 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
1564 <para>In den allermeisten Installationen sollte drucken jetzt schon
1565 funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
1566 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
1567 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1572 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1573 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1574 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1578 <para>! Package inputenc Error: Unicode char \u8:æ¡
\9c not set up for
1579 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1580 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1581 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1582 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1583 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1587 <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
1588 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1589 Prüfen Sie den Namen in der Konfiguration (Standard:
1590 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1591 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1594 <para>Wenn sich das Problem nicht auf Grund der ausgabe im Webbrowser verifizieren lässt:</para>
1597 <para> editiere [kivitendo-home]/config/kivitendo.conf und ändere "keep_tmp_files" auf 1</para>
1598 <para><programlisting>keep_temp_files = 1;</programlisting></para>
1601 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
1604 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
1607 <para>wechsele in das users Verzeichnis von kivitendo</para>
1608 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
1611 <para>LaTeX Suchpfad anpassen:</para>
1612 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
1615 <para>Finde herraus welche Datei kivitendo beim letzten Durchlauf erstellt hat</para>
1616 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
1617 <para>Es sollte die letzte Datei ganz unten sein</para>
1620 <para>für besseren Hinweis auf Fehler texdatei nochmals übersetzen</para>
1621 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
1622 <para>in der *.tex datei nach dem Fehler suchen.</para>
1628 <sect1 id="OpenDocument-Vorlagen">
1629 <title>OpenDocument-Vorlagen</title>
1631 <para>kivitendo unterstützt die Verwendung von Vorlagen im
1632 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1633 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1634 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1635 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1636 <filename>config/kivitendo.conf</filename> die Variable
1637 <literal>opendocument</literal> im Abschnitt
1638 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1639 Dieses ist die Standardeinstellung.</para>
1641 <para>Weiterhin muss in der Datei
1642 <filename>config/kivitendo.conf</filename> die Variable
1643 <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf
1644 die Zeichenkodierung gesetzt werden, die auch bei der Speicherung der
1645 Daten in der Datenbank verwendet wird. Diese ist in den meisten Fällen
1648 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1649 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1650 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1651 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1652 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1653 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1655 <para>Nach der Installation müssen in der Datei
1656 <filename>config/kivitendo.conf</filename> zwei weitere Variablen
1657 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1658 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1659 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1660 enthalten. Beide stehen im Abschnitt
1661 <literal>applications</literal>.</para>
1663 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
1664 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1665 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1666 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1667 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1668 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1669 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1670 werden muss. Der Nachteil ist, dass diese Methode Python und die
1671 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1674 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1675 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1676 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1677 Dokumentenvorlage enthalten sein und
1678 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1679 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1680 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1681 ebenfalls enthalten sein muss.</para>
1683 <para>Als letztes muss herausgefunden werden, welchen Namen
1684 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1685 gibt. Unter Debian ist dies momentan
1686 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1687 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1688 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1689 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1690 folgender Befehl auszuführen:</para>
1692 <para><literal>mv users/.openoffice.org2
1693 users/.openoffice</literal></para>
1695 <para>Dieses Verzeichnis, wie auch das komplette
1696 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1697 sein. Dieses wurde bereits erledigt (siehe <xref
1698 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1699 erneut überprüft werden, wenn die Konvertierung nach PDF
1703 <sect1 id="config.eur">
1704 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1707 <sect2 id="config.eur.introduction"
1708 xreflabel="Einführung in die Konfiguration zur EUR">
1709 <title>Einführung</title>
1711 <para>kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1712 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals noch <filename>config/lx_office.conf</filename>)
1713 befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden.</para>
1715 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1716 die Mandantendatenbank verschoben und dabei auch gleich in drei
1717 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1718 steuern lässt.</para>
1721 <sect2 id="config.eur.parameters"
1722 xreflabel="Konfigurationsparameter für EUR">
1723 <title>Konfigurationsparameter</title>
1725 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1726 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1730 <term><varname>profit_determination</varname></term>
1733 <para>Dieser Parameter legt die Berechnungsmethode für die
1734 Gewinnermittlung fest. Er enthält entweder
1735 <literal>balance</literal> für
1736 Betriebsvermögensvergleich/Bilanzierung oder
1737 <literal>income</literal> für die
1738 Einnahmen-Überschuss-Rechnung.</para>
1743 <term><varname>accounting_method</varname></term>
1746 <para>Dieser Parameter steuert die Buchungs- und
1747 Berechnungsmethoden für die Versteuerungsart. Er enthält
1748 entweder <literal>accrual</literal> für die Soll-Versteuerung
1749 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1754 <term><varname>inventory_system</varname></term>
1757 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1758 enthält entweder <literal>perpetual</literal> für die
1759 Bestandsmethode oder <literal>periodic</literal> für die
1760 Aufwandsmethode.</para>
1765 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1766 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1767 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1768 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1769 Bestandsmethode.</para>
1771 <para>Die Konfiguration "<varname>eur</varname>" unter
1772 <varname>[system]</varname> in der <link
1773 linkend="config.config-file">Konfigurationsdatei</link>
1774 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
1775 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1778 <sect2 id="config.eur.setting-parameters">
1779 <title>Festlegen der Parameter</title>
1781 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1782 der Admininstration können diese Optionen nun unabhängig voneinander
1783 eingestellt werden.</para>
1785 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1786 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1789 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1790 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
1791 angezeigt. Unter <guimenu>System</guimenu>
1792 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> können
1793 die Einstellungen auch geändert werden. Dabei ist zu beachten,
1794 dass eine Änderung vorhandene Daten so belässt und damit
1795 evtl. die Ergebnisse verfälscht. Dies gilt vor Allem für die
1796 Warenbuchungsmethode (siehe auch
1797 <link linkend="config.eur.inventory-system-perpetual">
1798 Bemerkungen zu Bestandsmethode</link>).</para>
1801 <sect2 id="config.eur.inventory-system-perpetual">
1802 <title>Bemerkungen zu Bestandsmethode</title>
1804 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1805 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
1806 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1807 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1808 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1809 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1810 Einkaufsrechnungen berechnet wird.</para>
1812 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1813 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1814 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1818 <sect2 id="config.eur.knonw-issues">
1819 <title>Bekannte Probleme</title>
1821 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1822 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1823 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1824 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1825 die Konfigurationsvariable
1826 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1829 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1830 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1834 <sect1 id="config.skr04-update-3804">
1835 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1837 <sect2 id="config.skr04-update-3804.introduction">
1838 <title>Einführung</title>
1840 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1841 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1842 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1843 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1844 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1845 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1846 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1847 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1848 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1849 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1850 Screenshots dargestellt.</para>
1852 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1853 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1854 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1855 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1858 <sect2 id="config.skr04-update-3804.create-chart">
1859 <title>Konto 3804 manuell anlegen</title>
1861 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
1862 anzulegen und zu konfigurieren. Zuerst wird in
1863 <guimenu>System</guimenu> ->
1864 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
1865 erfassen</guimenuitem> das Konto angelegt.</para>
1868 <screeninfo>Konto 3804 erfassen</screeninfo>
1872 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
1878 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
1879 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
1880 wie im folgenden Screenshot angezeigt anpassen.
1884 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
1888 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
1894 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
1895 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
1899 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
1903 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
1909 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
1910 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
1911 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
1912 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
1916 <screeninfo>Konto 4315 anpassen</screeninfo>
1920 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
1926 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
1927 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
1931 <screeninfo>Steuerliste vergleichen</screeninfo>
1935 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
1942 <sect1 id="config.client">
1943 <title>Einstellungen pro Mandant</title>
1945 <para>Einige Einstellungen können von einem Benutzer mit dem
1946 <link linkend="Zusammenhänge">Recht</link> "Administration
1947 (Für die Verwaltung der aktuellen Instanz aus einem Userlogin heraus)"
1948 gemacht werden. Diese Einstellungen sind dann für die aktuellen
1949 Mandanten-Datenbank gültig. Die Einstellungen sind
1950 unter <guimenu>System</guimenu>
1951 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
1953 <para>Bitte beachten Sie die Hinweise zu den einzelnen
1954 Einstellungen. Einige Einstellungen sollten nicht ohne Weiteres
1955 im laufenden Betrieb geändert werden (siehe
1956 auch <link linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
1957 Bestandsmethode</link>).</para>
1959 <para>Die Einstellungen <literal>show_bestbefore</literal>
1960 und <literal>payments_changeable</literal> aus dem
1961 Abschnitt <literal>features</literal> und die Einstellungen im
1962 Abschnitt <literal>datev_check</literal> (sofern schon vorhanden)
1963 der <link linkend="config.config-file">kivitendo-Konfigurationsdatei</link>
1964 werden bei einem Datenbankupdate einer älteren Version automatisch
1965 übernommen. Diese Einträge können danach aus der Konfigurationsdatei
1966 entfernt werden.</para>
1969 <sect1 id="kivitendo-ERP-verwenden">
1970 <title>kivitendo ERP verwenden</title>
1972 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
1973 folgender URL erreichbar:</para>
1976 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
1978 <para>Die Administrationsseite erreichen Sie unter:</para>
1981 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
1985 <chapter id="features" xreflabel="Features und Funktionen">
1986 <title>Features und Funktionen</title>
1988 <sect1 id="features.periodic-invoices"
1989 xreflabel="Wiedekehrende Rechnungen">
1990 <title>Wiederkehrende Rechnungen</title>
1992 <sect2 id="features.periodic-invoices.introduction"
1993 xreflabel="Einführung in wiederkehrende Rechnungen">
1994 <title>Einführung</title>
1996 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
1997 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
1998 Die konfigurierten Aufträge werden später automatisch in Rechnungen
1999 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
2000 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
2001 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
2002 wiederzufinden sind.</para>
2005 <sect2 id="features.periodic-invoices.configuration"
2006 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
2007 <title>Konfiguration</title>
2009 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
2010 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
2011 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
2012 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
2013 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
2016 <para>Folgende Parameter kann man konfigurieren:</para>
2023 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
2024 erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
2025 neuen Monats).</para>
2027 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
2028 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
2029 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
2030 nächsten Periodenwechsel für alle Perioden, seit der letzten
2031 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
2032 verhindern, muss man vorher das Startdatum neu setzen.</para>
2034 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
2035 erstellt. Man kann sich diese Aufträge aber gesondert in den
2036 Berichten anzeigen lassen.</para>
2041 <term>Periodizität</term>
2044 <para>Ob monatlich, quartalsweise oder jährlich auf neue
2045 Rechnungen überprüft werden soll. Für jede Periode seit dem
2046 Startdatum wird überprüft, ob für die Periode (beginnend immer
2047 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
2048 wurde. Unter Umständen können bei einem Startdatum in der
2049 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
2054 <term>Buchen auf</term>
2057 <para>Das Forderungskonto, in der Regel "Forderungen aus
2058 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
2059 Buchungsgruppen der betreffenden Waren.</para>
2064 <term>Startdatum</term>
2067 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
2073 <term>Enddatum</term>
2076 <para>ab wann keine Rechnungen mehr erstellt werden
2082 <term>Automatische Verlängerung um x Monate</term>
2085 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
2086 eingetragenen Enddatums weiterhin erstellt werden, so kann man
2087 hier die Anzahl der Monate eingeben, um die das Enddatum
2088 automatisch nach hinten geschoben wird.</para>
2093 <term>Drucken</term>
2096 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
2097 Rechnungen auch gleich ausdrucken lassen.</para>
2102 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
2103 Informationen zu den erstellten Rechnungen verschickt werden.
2104 Konfiguriert wird dies in der <link
2105 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
2106 <filename>config/kivitendo.conf</filename> im Abschnitt
2107 <varname>[periodic_invoices]</varname>.</para>
2110 <sect2 id="features.periodic-invoices.reports">
2111 <title>Auflisten</title>
2113 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
2114 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
2115 Rechnungen inaktiv", mit denen man sich einen Überglick über die
2116 wiederkehrenden Rechnungen verschaffen kann.</para>
2119 <sect2 id="features.periodic-invoices.task-server">
2120 <title>Erzeugung der eigentlichen Rechnungen</title>
2122 <para>Die zeitliche und periodische Überprüfung, ob eine
2123 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
2124 durch den <link linkend="config.task-server">Taskserver</link>, einen
2125 externen Dienst, der automatisch beim Start des Servers gestartet
2126 werden sollte.</para>
2129 <sect2 id="features.periodic-invoices.create-for-current-month">
2130 <title>Erste Rechnung für aktuellen Monat erstellen</title>
2132 <para>Will man im laufenden Monat eine monatlich wiederkehrende
2133 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
2134 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
2135 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
2136 generiert hat. Alternativ setzt man das Startdatum auf den
2137 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
2138 manuell über den Workflow.</para>
2142 <sect1 id="dokumentenvorlagen-und-variablen">
2143 <title>Dokumentenvorlagen und verfügbare Variablen</title>
2145 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
2146 <title>Einführung</title>
2148 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
2149 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
2150 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
2151 <function><%variablenname%></function> verwendet wird. Für
2152 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
2154 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
2156 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
2157 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
2158 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
2159 alle Vorlagenarten.</para>
2161 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
2162 verfügbar als hier aufgelistet werden. Die meisten davon können
2163 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
2164 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
2165 diese wie folgt erhalten werden:</para>
2169 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
2170 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
2174 <para>In <filename>Form.pm</filename> die Funktion
2175 <function>parse_template</function> suchen und hier die Zeile
2176 <command>print(STDERR Dumper($self));</command> einfügen.</para>
2180 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
2181 ein PDF für eine Rechnung erzeugen.</para>
2185 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
2186 der Variablen <varname>$self</varname> in der Form <varname>'key'
2187 => 'value',</varname>. Alle <varname>key</varname>s sind
2193 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
2194 <title>Variablen ausgeben</title>
2196 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
2197 Tags geschrieben werden, also z.B.
2198 <varname><%variablenname%></varname>.</para>
2200 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
2201 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
2202 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
2203 werden die folgenden Flags unterstützt:</para>
2207 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
2208 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
2209 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
2210 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
2214 <para><option>NOESCAPE</option> unterdrückt das Escapen von
2215 Sonderzeichen für die Vorlagensprache. Wenn also in einer
2216 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
2217 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
2218 ist dieses Flag sinnvoll.</para>
2222 <para>Beispiel:</para>
2224 <programlisting><%quototal NOFORMAT%></programlisting>
2227 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
2228 <title>Verwendung in Druckbefehlen</title>
2230 <para>In der Admininstration können Drucker definiert werden. Auch im
2231 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
2232 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
2233 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
2234 <function>`...`</function> nicht zu unerwünschtem Verhalten
2237 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
2238 für das die Telefonnummer eines Ansprechpartners als Teil der
2239 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
2240 z.B. wie folgt aussehen:</para>
2242 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
2245 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
2246 xreflabel="Anfang und Ende der Tags verändern">
2247 <title>Anfang und Ende der Tags verändern</title>
2249 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
2250 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
2251 Prozentzeichen und dem Größerzeichen endet, beispielsweise
2252 <function><%customer%></function>. Da diese Form aber z.B. in
2253 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
2254 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
2255 Stil umgestellt werden.</para>
2257 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
2258 Format gültigen Kommentarzeichen anfangen, dann
2259 <function>config:</function> enthalten, die entsprechende Option
2260 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
2261 enden. Beispiel für LaTeX:</para>
2263 <programlisting>% config: tag-style=($ $)</programlisting>
2265 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
2266 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
2267 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
2269 <programlisting><!-- config: tag-style=($ $) --></programlisting>
2272 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
2273 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
2275 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
2276 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
2277 "<filename>.ext</filename>" geeignet zu ersetzen:
2278 "<filename>.tex</filename>" für LaTeX-Vorlagen und
2279 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
2283 <term><filename>bin_list.ext</filename></term>
2286 <para>Lagerliste</para>
2291 <term><filename>check.ext</filename></term>
2299 <term><filename>invoice.ext</filename></term>
2302 <para>Rechnung</para>
2307 <term><filename>packing_list.ext</filename></term>
2310 <para>Packliste</para>
2315 <term><filename>pick_list.ext</filename></term>
2318 <para>Sammelliste</para>
2323 <term><filename>purchase_delivery_order.ext</filename></term>
2326 <para>Lieferschein (Einkauf)</para>
2331 <term><filename>purcharse_order.ext</filename></term>
2334 <para>Bestellung an Lieferanten</para>
2339 <term><filename>request_quotation.ext</filename></term>
2342 <para>Anfrage an Lieferanten</para>
2347 <term><filename>sales_delivery_order.ext</filename></term>
2350 <para>Lieferschein (Verkauf)</para>
2355 <term><filename>sales_order.ext</filename></term>
2358 <para>Bestellung</para>
2363 <term><filename>sales_quotation.ext</filename></term>
2366 <para>Angebot an Kunden</para>
2371 <term><filename>zahlungserinnerung.ext</filename></term>
2374 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2379 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2382 <para>Rechnung über Mahngebühren (Dateiname im Programm
2383 konfigurierbar)</para>
2389 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2390 <title>Sprache, Drucker und E-Mail</title>
2392 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2393 eingearbeitet. So wird aus der Vorlage
2394 <filename>sales_order.ext</filename> bei Sprache
2395 <function>de</function> und Druckerkürzel <function>lpr2</function>
2396 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2397 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2398 bekommen dann noch das Kürzel <filename>_email</filename>, der
2399 vollständige Vorlagenname wäre dann
2400 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2401 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2402 werden. Diese wird verwendet, wenn keine der anderen Varianten
2403 gefunden wird.</para>
2405 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2406 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2407 verschickt wird, ist:</para>
2411 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2415 <para><filename>sales_order_de_lpr2.tex</filename></para>
2419 <para><filename>sales_order.tex</filename></para>
2423 <para><filename>default.tex</filename></para>
2427 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2428 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2430 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2433 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2434 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2437 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2438 xreflabel="Metainformationen zur angeforderten Vorlage">
2439 <title>Metainformationen zur angeforderten Vorlage</title>
2441 <para>Diese Variablen liefern Informationen darüber welche Variante
2442 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2443 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2444 Formulare einbinden möchten.</para>
2448 <term><varname>template_meta.formname</varname></term>
2451 <para>Basisname der Vorlage. Identisch mit der <link
2452 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2453 zu den Dateinamen</link> ohne die Erweiterung. Ein
2454 Verkaufsauftrag enthält hier
2455 <constant>sales_order</constant>.</para>
2460 <term><varname>template_meta.language.description</varname></term>
2463 <para>Beschreibung der verwendeten Sprache</para>
2468 <term><varname>template_meta.language.template_code</varname></term>
2471 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2472 Kürzel das im Dateinamen verwendetet wird.</para>
2477 <term><varname>template_meta.language.output_numberformat</varname></term>
2480 <para>Zahlenformat der verwendeten Sprache in der Form
2481 "<constant>1.000,00</constant>". Experimentell! Nur
2482 interessant für Vorlagen die mit unformatierten Werten
2488 <term><varname>template_meta.language.output_dateformat</varname></term>
2491 <para>Datumsformat der verwendeten Sprache in der Form
2492 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2493 interessant für Vorlagen die mit unformatierten Werten
2499 <term><varname>template_meta.format</varname></term>
2502 <para>Das angeforderte Format. Kann im Moment die Werte
2503 <constant>pdf</constant>, <constant>postscript</constant>,
2504 <constant>html</constant>, <constant>opendocument</constant>,
2505 <constant>opendocument_pdf</constant> und
2506 <constant>excel</constant> enthalten.</para>
2511 <term><varname>template_meta.extension</varname></term>
2514 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2515 <constant>format</constant> entschieden.</para>
2520 <term><varname>template_meta.media</varname></term>
2523 <para>Ausgabemedium. Kann zur Zeit die Werte
2524 <constant>screen</constant> für Bildschirm,
2525 <constant>email</constant> für E-Mmail (triggert das
2526 <constant>_email</constant> Kürzel im Dateinamen),
2527 <constant>printer</constant> für Drucker, und
2528 <constant>queue</constant> für Warteschlange enthalten.</para>
2533 <term><varname>template_meta.printer.description</varname></term>
2536 <para>Beschreibung des ausgewählten Druckers</para>
2541 <term><varname>template_meta.printer.template_code</varname></term>
2544 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2545 dem Kürzel das im Dateinamen verwendetet wird.</para>
2550 <term><varname>template_meta.tmpfile</varname></term>
2553 <para>Datei-Prefix für temporäre Dateien.</para>
2559 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2560 <title>Stammdaten von Kunden und Lieferanten</title>
2564 <term><varname>account_number</varname></term>
2567 <para>Kontonummer</para>
2572 <term><varname>bank</varname></term>
2575 <para>Name der Bank</para>
2580 <term><varname>bank_code</varname></term>
2583 <para>Bankleitzahl</para>
2588 <term><varname>bic</varname></term>
2591 <para>Bank-Identifikations-Code (Bank Identifier Code,
2597 <term><varname>business</varname></term>
2600 <para>Kunden-/Lieferantentyp</para>
2605 <term><varname>city</varname></term>
2613 <term><varname>contact</varname></term>
2616 <para>Kontakt</para>
2621 <term><varname>country</varname></term>
2629 <term><varname>cp_email</varname></term>
2632 <para>Email des Ansprechpartners</para>
2637 <term><varname>cp_givenname</varname></term>
2640 <para>Vorname des Ansprechpartners</para>
2645 <term><varname>cp_greeting</varname></term>
2648 <para>Anrede des Ansprechpartners</para>
2653 <term><varname>cp_name</varname></term>
2656 <para>Name des Ansprechpartners</para>
2661 <term><varname>cp_phone1</varname></term>
2664 <para>Telefonnummer 1 des Ansprechpartners</para>
2669 <term><varname>cp_phone2</varname></term>
2672 <para>Telefonnummer 2 des Ansprechpartners</para>
2677 <term><varname>cp_title</varname></term>
2680 <para>Titel des Ansprechpartners</para>
2685 <term><varname>creditlimit</varname></term>
2688 <para>Kreditlimit</para>
2693 <term><varname>customeremail</varname></term>
2696 <para>Email des Kunden; nur für Kunden</para>
2701 <term><varname>customerfax</varname></term>
2704 <para>Faxnummer des Kunden; nur für Kunden</para>
2709 <term><varname>customernotes</varname></term>
2712 <para>Bemerkungen beim Kunden; nur für Kunden</para>
2717 <term><varname>customernumber</varname></term>
2720 <para>Kundennummer; nur für Kunden</para>
2725 <term><varname>customerphone</varname></term>
2728 <para>Telefonnummer des Kunden; nur für Kunden</para>
2733 <term><varname>discount</varname></term>
2741 <term><varname>email</varname></term>
2744 <para>Emailadresse</para>
2749 <term><varname>fax</varname></term>
2752 <para>Faxnummer</para>
2757 <term><varname>homepage</varname></term>
2760 <para>Homepage</para>
2765 <term><varname>iban</varname></term>
2768 <para>Internationale Kontonummer (International Bank Account
2769 Number, IBAN)</para>
2774 <term><varname>language</varname></term>
2777 <para>Sprache</para>
2782 <term><varname>name</varname></term>
2785 <para>Firmenname</para>
2790 <term><varname>payment_description</varname></term>
2793 <para>Name der Zahlart</para>
2798 <term><varname>payment_terms</varname></term>
2801 <para>Zahlungskonditionen</para>
2806 <term><varname>phone</varname></term>
2809 <para>Telefonnummer</para>
2814 <term><varname>shiptocity</varname></term>
2817 <para>Stadt (Lieferadresse) <link
2818 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2823 <term><varname>shiptocontact</varname></term>
2826 <para>Kontakt (Lieferadresse) <link
2827 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2832 <term><varname>shiptocountry</varname></term>
2835 <para>Land (Lieferadresse) <link
2836 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2841 <term><varname>shiptodepartment1</varname></term>
2844 <para>Abteilung 1 (Lieferadresse) <link
2845 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2850 <term><varname>shiptodepartment2</varname></term>
2853 <para>Abteilung 2 (Lieferadresse) <link
2854 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2859 <term><varname>shiptoemail</varname></term>
2862 <para>Email (Lieferadresse) <link
2863 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2868 <term><varname>shiptofax</varname></term>
2871 <para>Fax (Lieferadresse) <link
2872 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2877 <term><varname>shiptoname</varname></term>
2880 <para>Firmenname (Lieferadresse) <link
2881 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2886 <term><varname>shiptophone</varname></term>
2889 <para>Telefonnummer (Lieferadresse) <link
2890 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2895 <term><varname>shiptostreet</varname></term>
2898 <para>Straße und Hausnummer (Lieferadresse) <link
2899 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2904 <term><varname>shiptozipcode</varname></term>
2907 <para>Postleitzahl (Lieferadresse) <link
2908 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2913 <term><varname>street</varname></term>
2916 <para>Straße und Hausnummer</para>
2921 <term><varname>taxnumber</varname></term>
2924 <para>Steuernummer</para>
2929 <term><varname>ustid</varname></term>
2932 <para>Umsatzsteuer-Identifikationsnummer</para>
2937 <term><varname>vendoremail</varname></term>
2940 <para>Email des Lieferanten; nur für Lieferanten</para>
2945 <term><varname>vendorfax</varname></term>
2948 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
2953 <term><varname>vendornotes</varname></term>
2956 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
2961 <term><varname>vendornumber</varname></term>
2964 <para>Lieferantennummer; nur für Lieferanten</para>
2969 <term><varname>vendorphone</varname></term>
2972 <para>Telefonnummer des Lieferanten; nur für
2978 <term><varname>zipcode</varname></term>
2981 <para>Postleitzahl</para>
2986 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
2987 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
2988 Stammdaten nicht eingetragen, so haben die Variablen
2989 <varname>shipto*</varname> den gleichen Wert wie die die
2990 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
2991 einige <varname>shipto*</varname>-Variablen so nicht in den
2992 Stammdaten wiederfinden sondern schlicht Kopien der
2993 Lieferdatenvariablen sind (z.B.
2994 <varname>shiptocontact</varname>).</para>
2998 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
2999 <title>Informationen über den Bearbeiter</title>
3003 <term><varname>employee_address</varname></term>
3006 <para>Adressfeld</para>
3011 <term><varname>employee_businessnumber</varname></term>
3014 <para>Firmennummer</para>
3019 <term><varname>employee_company</varname></term>
3022 <para>Firmenname</para>
3027 <term><varname>employee_co_ustid</varname></term>
3030 <para>Usatzsteuer-Identifikationsnummer</para>
3035 <term><varname>employee_duns</varname></term>
3038 <para>DUNS-Nummer</para>
3043 <term><varname>employee_email</varname></term>
3051 <term><varname>employee_fax</varname></term>
3059 <term><varname>employee_name</varname></term>
3062 <para>voller Name</para>
3067 <term><varname>employee_signature</varname></term>
3070 <para>Signatur</para>
3075 <term><varname>employee_taxnumber</varname></term>
3078 <para>Steuernummer</para>
3083 <term><varname>employee_tel</varname></term>
3086 <para>Telefonnummer</para>
3092 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
3093 <title>Informationen über den Bearbeiter</title>
3097 <term><varname>salesman_address</varname></term>
3100 <para>Adressfeld</para>
3105 <term><varname>salesman_businessnumber</varname></term>
3108 <para>Firmennummer</para>
3113 <term><varname>salesman_company</varname></term>
3116 <para>Firmenname</para>
3121 <term><varname>salesman_co_ustid</varname></term>
3124 <para>Usatzsteuer-Identifikationsnummer</para>
3129 <term><varname>salesman_duns</varname></term>
3132 <para>DUNS-Nummer</para>
3137 <term><varname>salesman_email</varname></term>
3145 <term><varname>salesman_fax</varname></term>
3153 <term><varname>salesman_name</varname></term>
3156 <para>voller Name</para>
3161 <term><varname>salesman_signature</varname></term>
3164 <para>Signatur</para>
3169 <term><varname>salesman_taxnumber</varname></term>
3172 <para>Steuernummer</para>
3177 <term><varname>salesman_tel</varname></term>
3180 <para>Telefonnummer</para>
3186 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
3187 <title>Variablen für die einzelnen Steuern</title>
3191 <term><varname>tax</varname></term>
3199 <term><varname>taxbase</varname></term>
3202 <para>zu versteuernder Betrag</para>
3207 <term><varname>taxdescription</varname></term>
3210 <para>Name der Steuer</para>
3215 <term><varname>taxrate</varname></term>
3218 <para>Steuersatz</para>
3225 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
3226 <title>Variablen in Rechnungen</title>
3228 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
3229 <title>Allgemeine Variablen</title>
3233 <term><varname>creditremaining</varname></term>
3236 <para>Verbleibender Kredit</para>
3241 <term><varname>currency</varname></term>
3244 <para>Währung</para>
3249 <term><varname>cusordnumber</varname></term>
3252 <para>Bestellnummer beim Kunden</para>
3257 <term><varname>deliverydate</varname></term>
3260 <para>Lieferdatum</para>
3265 <term><varname>duedate</varname></term>
3268 <para>Fälligkeitsdatum</para>
3273 <term><varname>globalprojectnumber</varname></term>
3276 <para>Projektnummer des ganzen Beleges</para>
3281 <term><varname>globalprojectdescription</varname></term>
3284 <para>Projekbeschreibung des ganzen Beleges</para>
3289 <term><varname>intnotes</varname></term>
3292 <para>Interne Bemerkungen</para>
3297 <term><varname>invdate</varname></term>
3300 <para>Rechnungsdatum</para>
3305 <term><varname>invnumber</varname></term>
3308 <para>Rechnungsnummer</para>
3313 <term><varname>invtotal</varname></term>
3316 <para>gesamter Rechnungsbetrag</para>
3321 <term><varname>notes</varname></term>
3324 <para>Bemerkungen der Rechnung</para>
3329 <term><varname>orddate</varname></term>
3332 <para>Auftragsdatum</para>
3337 <term><varname>ordnumber</varname></term>
3340 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3341 erstellt wurde</para>
3346 <term><varname>payment_description</varname></term>
3349 <para>Name der Zahlart</para>
3354 <term><varname>payment_terms</varname></term>
3357 <para>Zahlungskonditionen</para>
3362 <term><varname>quodate</varname></term>
3365 <para>Angebotsdatum</para>
3370 <term><varname>quonumber</varname></term>
3373 <para>Angebotsnummer</para>
3378 <term><varname>shippingpoint</varname></term>
3381 <para>Versandort</para>
3386 <term><varname>shipvia</varname></term>
3389 <para>Transportmittel</para>
3394 <term><varname>subtotal</varname></term>
3397 <para>Zwischensumme aller Posten ohne Steuern</para>
3402 <term><varname>total</varname></term>
3405 <para>Restsumme der Rechnung (Summe abzüglich bereits
3406 bezahlter Posten)</para>
3411 <term><varname>transaction_description</varname></term>
3414 <para>Vorgangsbezeichnung</para>
3419 <term><varname>transdate</varname></term>
3422 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3423 erstellt wurde</para>
3429 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3430 <title>Variablen für jeden Posten auf der Rechnung</title>
3434 <term><varname>bin</varname></term>
3437 <para>Stellage</para>
3442 <term><varname>description</varname></term>
3445 <para>Artikelbeschreibung</para>
3450 <term><varname>discount</varname></term>
3453 <para>Rabatt als Betrag</para>
3458 <term><varname>discount_sub</varname></term>
3461 <para>Zwischensumme mit Rabatt</para>
3466 <term><varname>drawing</varname></term>
3469 <para>Zeichnung</para>
3474 <term><varname>ean</varname></term>
3477 <para>EAN-Code</para>
3482 <term><varname>image</varname></term>
3490 <term><varname>linetotal</varname></term>
3493 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3498 <term><varname>longdescription</varname></term>
3501 <para>Langtext</para>
3506 <term><varname>microfiche</varname></term>
3509 <para>Mikrofilm</para>
3514 <term><varname>netprice</varname></term>
3517 <para>Nettopreis</para>
3522 <term><varname>nodiscount_linetotal</varname></term>
3525 <para>Zeilensumme ohne Rabatt</para>
3530 <term><varname>nodiscount_sub</varname></term>
3533 <para>Zwischensumme ohne Rabatt</para>
3538 <term><varname>number</varname></term>
3541 <para>Artikelnummer</para>
3546 <term><varname>ordnumber_oe</varname></term>
3549 <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
3550 aus einem Sammelauftrag erstellt wurde</para>
3555 <term><varname>p_discount</varname></term>
3558 <para>Rabatt in Prozent</para>
3563 <term><varname>partnotes</varname></term>
3566 <para>Die beim Artikel gespeicherten Bemerkungen</para>
3571 <term><varname>partsgroup</varname></term>
3574 <para>Warengruppe</para>
3579 <term><varname>price_factor</varname></term>
3582 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
3588 <term><varname>price_factor_name</varname></term>
3591 <para>Der Name des Preisfaktors, sofern einer eingestellt
3597 <term><varname>projectnumber</varname></term>
3600 <para>Projektnummer</para>
3605 <term><varname>projectdescription</varname></term>
3608 <para>Projektbeschreibung</para>
3613 <term><varname>qty</varname></term>
3621 <term><varname>reqdate</varname></term>
3624 <para>Lieferdatum</para>
3629 <term><varname>runningnumber</varname></term>
3632 <para>Position auf der Rechnung (1, 2, 3...)</para>
3637 <term><varname>sellprice</varname></term>
3640 <para>Verkaufspreis</para>
3645 <term><varname>serialnumber</varname></term>
3648 <para>Seriennummer</para>
3653 <term><varname>tax_rate</varname></term>
3656 <para>Steuersatz</para>
3661 <term><varname>transdate_oe</varname></term>
3664 <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
3665 aus einem Sammelauftrag erstellt wurde</para>
3670 <term><varname>unit</varname></term>
3673 <para>Einheit</para>
3678 <term><varname>weight</varname></term>
3681 <para>Gewicht</para>
3686 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
3687 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
3688 einer <function>foreach</function>-Schleife ausgegeben werden, da
3689 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
3690 können. Die Variablen dafür lauten:</para>
3694 <term><varname>make</varname></term>
3697 <para>Lieferant</para>
3702 <term><varname>model</varname></term>
3705 <para>Lieferantenartikelnummer</para>
3711 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
3712 <title>Variablen für die einzelnen Zahlungseingänge</title>
3716 <term><varname>payment</varname></term>
3724 <term><varname>paymentaccount</varname></term>
3732 <term><varname>paymentdate</varname></term>
3740 <term><varname>paymentmemo</varname></term>
3748 <term><varname>paymentsource</varname></term>
3757 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
3758 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
3760 <para>Die vom Benutzer definierten Variablen für Kunden und
3761 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
3762 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
3763 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
3764 Variablennamen zusammen.</para>
3766 <para>Beispiel: Der Benutzer hat eine Variable namens
3767 <varname>number_of_employees</varname> definiert, die die Anzahl der
3768 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
3769 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
3774 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
3775 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
3777 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
3778 <title>Namen der Vorlagen</title>
3780 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
3781 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
3782 Erstellung einer Rechnung über die Mahngebühren und Zinsen
3783 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
3784 Vorlagenname für diese Mahnstufe mit dem Zusatz
3785 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
3786 für die ausgewählte Sprache und den ausgewählten Drucker
3790 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
3791 <title>Allgemeine Variablen in Mahnungen</title>
3793 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3794 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3795 Kunden stehen als Variablen <varname>name</varname>,
3796 <varname>street</varname>, <varname>zipcode</varname>,
3797 <varname>city</varname>, <varname>country</varname>,
3798 <varname>department_1</varname>, <varname>department_2</varname>,
3799 und <varname>email</varname> zur Verfügung.</para>
3801 <para>Weitere Variablen beinhalten:</para>
3805 <term><varname>dunning_date</varname></term>
3808 <para>Datum der Mahnung</para>
3813 <term><varname>dunning_duedate</varname></term>
3816 <para>Fälligkeitsdatum für diese Mahhnung</para>
3821 <term><varname>dunning_id</varname></term>
3824 <para>Mahnungsnummer</para>
3829 <term><varname>fee</varname></term>
3832 <para>Kummulative Mahngebühren</para>
3837 <term><varname>interest_rate</varname></term>
3840 <para>Zinssatz per anno in Prozent</para>
3845 <term><varname>total_amount</varname></term>
3848 <para>Gesamter noch zu zahlender Betrag als
3849 <function>fee</function> + <function>total_interest</function>
3850 + <function>total_open_amount</function></para>
3855 <term><varname>total_interest</varname></term>
3858 <para>Zinsen per anno über alle Rechnungen</para>
3863 <term><varname>total_open_amount</varname></term>
3866 <para>Summe über alle offene Beträge der Rechnungen</para>
3872 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
3873 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
3877 <term><varname>dn_amount</varname></term>
3880 <para>Rechnungssumme (brutto)</para>
3885 <term><varname>dn_duedate</varname></term>
3888 <para>Originales Fälligkeitsdatum der Rechnung</para>
3893 <term><varname>dn_dunning_date</varname></term>
3896 <para>Datum der Mahnung</para>
3901 <term><varname>dn_dunning_duedate</varname></term>
3904 <para>Fälligkeitsdatum der Mahnung</para>
3909 <term><varname>dn_fee</varname></term>
3912 <para>Kummulative Mahngebühr</para>
3917 <term><varname>dn_interest</varname></term>
3920 <para>Zinsen per anno für diese Rechnung</para>
3925 <term><varname>dn_invnumber</varname></term>
3928 <para>Rechnungsnummer</para>
3933 <term><varname>dn_linetotal</varname></term>
3936 <para>Noch zu zahlender Betrag (ergibt sich aus
3937 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
3938 + <varname>dn_interest</varname>)</para>
3943 <term><varname>dn_netamount</varname></term>
3946 <para>Rechnungssumme (netto)</para>
3951 <term><varname>dn_open_amount</varname></term>
3954 <para>Offener Rechnungsbetrag</para>
3959 <term><varname>dn_ordnumber</varname></term>
3962 <para>Bestellnummer</para>
3967 <term><varname>dn_transdate</varname></term>
3970 <para>Rechnungsdatum</para>
3975 <term><varname>dn_curr</varname></term>
3978 <para>Währung, in der die Rechnung erstellt wurde. (Die
3979 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
3985 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
3986 <title>Variablen in automatisch erzeugten Rechnungen über
3987 Mahngebühren</title>
3989 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3990 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3991 Kunden stehen als Variablen <varname>name</varname>,
3992 <varname>street</varname>, <varname>zipcode</varname>,
3993 <varname>city</varname>, <varname>country</varname>,
3994 <varname>department_1</varname>, <varname>department_2</varname>,
3995 und <varname>email</varname> zur Verfügung.</para>
3997 <para>Weitere Variablen beinhalten:</para>
4001 <term><varname>duedate</varname></term>
4004 <para>Fälligkeitsdatum der Rechnung</para>
4009 <term><varname>dunning_id</varname></term>
4012 <para>Mahnungsnummer</para>
4017 <term><varname>fee</varname></term>
4020 <para>Mahngebühren</para>
4025 <term><varname>interest</varname></term>
4033 <term><varname>invamount</varname></term>
4036 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
4037 <varname>interest</varname>)</para>
4042 <term><varname>invdate</varname></term>
4045 <para>Rechnungsdatum</para>
4050 <term><varname>invnumber</varname></term>
4053 <para>Rechnungsnummer</para>
4060 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
4061 <title>Variablen in anderen Vorlagen</title>
4064 <title>Einführung</title>
4066 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
4067 Rechnung. Allerdings heißen die Variablen, die mit
4068 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
4069 fangen sie mit <varname>quo</varname> für "quotation" an:
4070 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
4071 wiederum fangen sie mit <varname>ord</varname> für "order" an:
4072 <varname>ordnumber</varname> für Bestellnummer etc.</para>
4074 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
4075 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
4076 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
4077 Vorlage keine Bedeutung haben oder noch nicht belegt sein
4080 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
4081 in Rechnungen aufgeführt.</para>
4084 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
4085 <title>Angebote und Preisanfragen</title>
4089 <term><varname>quonumber</varname></term>
4092 <para>Angebots- bzw. Anfragenummer</para>
4097 <term><varname>reqdate</varname></term>
4100 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
4101 Preisanfragen)</para>
4106 <term><varname>transdate</varname></term>
4109 <para>Angebots- bzw. Anfragedatum</para>
4115 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
4116 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
4120 <term><varname>ordnumber</varname></term>
4123 <para>Auftragsnummer</para>
4128 <term><varname>reqdate</varname></term>
4131 <para>Lieferdatum</para>
4136 <term><varname>transdate</varname></term>
4139 <para>Auftragsdatum</para>
4145 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
4146 <title>Lieferscheine (Verkauf und Einkauf)</title>
4150 <term><varname>cusordnumber</varname></term>
4153 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
4154 des Lieferanten (im Einkauf)</para>
4159 <term><varname>donumber</varname></term>
4162 <para>Lieferscheinnummer</para>
4167 <term><varname>transdate</varname></term>
4170 <para>Lieferscheindatum</para>
4175 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
4176 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
4177 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
4178 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
4179 <function>foreach</function>-Schleife ausgegeben werden. Diese
4180 Variablen sind:</para>
4184 <term><varname>si_bin</varname></term>
4187 <para>Lagerplatz</para>
4192 <term><varname>si_chargenumber</varname></term>
4195 <para>Chargennummer</para>
4200 <term><varname>si_bestbefore</varname></term>
4203 <para>Mindesthaltbarkeit</para>
4208 <term><varname>si_number</varname></term>
4211 <para>Artikelnummer</para>
4216 <term><varname>si_qty</varname></term>
4219 <para>Anzahl bzw. Menge</para>
4224 <term><varname>si_runningnumber</varname></term>
4227 <para>Positionsnummer (1, 2, 3 etc)</para>
4232 <term><varname>si_unit</varname></term>
4235 <para>Einheit</para>
4240 <term><varname>si_warehouse</varname></term>
4249 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
4250 <title>Variablen für Sammelrechnung</title>
4254 <term><varname>c0total</varname></term>
4257 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
4263 <term><varname>c30total</varname></term>
4266 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
4267 und < 60 Tage</para>
4272 <term><varname>c60total</varname></term>
4275 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
4276 und < 90 Tage</para>
4281 <term><varname>c90total</varname></term>
4284 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
4290 <term><varname>total</varname></term>
4293 <para>Gesamtbetrag aller Rechnungen</para>
4298 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
4302 <term><varname>invnumber</varname></term>
4305 <para>Rechnungsnummer</para>
4310 <term><varname>invdate</varname></term>
4313 <para>Rechnungsdatum</para>
4318 <term><varname>duedate</varname></term>
4321 <para>Fälligkeitsdatum</para>
4326 <term><varname>amount</varname></term>
4329 <para>Summe der Rechnung</para>
4334 <term><varname>open</varname></term>
4337 <para>Noch offener Betrag der Rechnung</para>
4342 <term><varname>c0</varname></term>
4345 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4351 <term><varname>c30</varname></term>
4354 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4360 <term><varname>c60</varname></term>
4363 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4369 <term><varname>c90</varname></term>
4372 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4380 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4381 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4383 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4384 <title>Einfürhung</title>
4386 <para>Der Parser kennt neben den Variablen einige weitere
4387 Konstrukte, die gesondert behandelt werden. Diese sind wie
4388 Variablennamen in spezieller Weise markiert:
4389 <command><%anweisung%> ... <%end%></command></para>
4391 <para>Anmerkung zum <command><%end%></command>: Der besseren
4392 Verständlichkeit halber kann man nach dem <command>end</command>
4393 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4394 Anweisung (z.B. <command>if</command> oder
4395 <command>foreach</command>) damit abgeschlossen wird.</para>
4397 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4398 <command><%if type == "sales_quotation"%></command>, so könnte
4399 er mit <command><%end%></command> genauso abgeschlossen werden
4400 wie mit <command><%end if%></command> oder auch
4401 <command><%end type == "sales_quotation"%></command>.</para>
4404 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4405 <title>Der if-Block</title>
4407 <programlisting><%if variablenname%>
4409 <%end%></programlisting>
4411 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4412 und dem "end" werden nur ausgegeben, wenn die Variable
4413 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4415 <para>Die Bedingung kann auch negiert werden, indem das Wort
4416 <function>not</function> nach dem <filename>if</filename> verwendet
4417 wird. Beispiel:</para>
4419 <programlisting><%if not cp_greeting%>
4421 <%end%></programlisting>
4423 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4424 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4425 einer Variablen mit einer festen Zeichenkette oder einer anderen
4426 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4427 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4428 die rechte Seite des Vergleichsoperators in Anführungszeichen
4429 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4430 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4433 <programlisting><%if var1 == "Wert"%></programlisting>
4435 <para>Testet die Variable <varname>var1</varname> auf
4436 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4437 Mittels <function>!=</function> anstelle von <function>==</function>
4438 würde auf Ungleichheit getestet.</para>
4440 <programlisting><%if var1 == var2%></programlisting>
4442 <para>Testet die Variable <varname>var1</varname> auf
4443 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4444 <function>!=</function> anstelle von <function>==</function> würde
4445 auf Ungleichheit getestet.</para>
4447 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4448 auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
4449 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4450 dieselbe Syntax wie oben nur mit <function>=~</function> und
4451 <function>!~</function> als Vergleichsoperatoren.</para>
4453 <para>Beispiel für einen Test, ob die Variable
4454 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4455 <constant>schwierig</constant> enthält:</para>
4457 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4460 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4461 <title>Der foreach-Block</title>
4463 <programlisting><%foreach variablenname%>
4465 <%end%></programlisting>
4467 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4468 wie das Perl-Array der Variablen <varname>variablenname</varname>
4469 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4470 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4471 benutzt. In jedem Durchlauf werden die <link
4472 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4473 Variablen</link> jeweils auf den Wert für die aktuelle Position
4476 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
4478 <programlisting><%foreach number%>
4479 Position: <%runningnumber%>
4480 Anzahl: <%qty%>
4481 Artikelnummer: <%number%>
4482 Beschreibung: <%description%>
4484 <%end%></programlisting>
4486 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
4487 <function><%foreach%></function>-Block innerhalb einer
4488 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
4489 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
4490 Inhalt zwischen <function><%foreach%></function> und
4491 <function><%end%></function> wiederholt, nicht aber die
4492 komplette Zeile, in der er steht.</para>
4496 <sect2 id="dokumentenvorlagen-und-variablen.markup">
4497 <title>Markup-Code zur Textformatierung innerhalb von
4500 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
4501 anders formatiert haben möchte, so ist dies begrenzt möglich.
4502 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
4503 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
4504 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
4505 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
4506 (HTML oder PDF über LaTeX) umgesetzt.</para>
4508 <para>Die unterstützen Formatierungen sind:</para>
4512 <term><b>Text</b></term>
4515 <para>Text wird in Fettdruck gesetzt.</para>
4520 <term><i>Text</i></term>
4523 <para>Text wird kursiv gesetzt.</para>
4528 <term><u>Text</u></term>
4531 <para>Text wird unterstrichen.</para>
4536 <term><s>Text</s></term>
4539 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
4540 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
4545 <term><bullet></term>
4548 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
4554 <para>Der Befehl <command><bullet></command> funktioniert
4555 momentan auch nur in Latex-Vorlagen.</para>
4559 <sect1 id="excel-templates">
4560 <title>Excel-Vorlagen</title>
4562 <sect2 id="excel-templates.summary">
4563 <title>Zusammenfassung</title>
4565 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
4566 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
4570 <sect2 id="excel-templates.usage">
4571 <title>Bedienung</title>
4573 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
4574 werden. Die Konfigurationsoption heißt <varname>excel_templates =
4575 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
4577 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
4578 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
4579 werden. In den normalen Verkaufsmasken taucht nun
4580 <constant>Excel</constant> als auswählbares Format auf und kann von da
4581 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
4583 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
4584 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
4585 <filename>sales_quotation.xls</filename> gespeichert.</para>
4588 <sect2 id="excel-templates.syntax">
4589 <title>Variablensyntax</title>
4591 <para>Einfache Syntax:
4592 <command><<varname>></command></para>
4594 <para>Dabei sind <constant><<</constant> und
4595 <constant>>></constant> die Delimiter. Da Excel auf festen
4596 Breiten besteht, kann der Tag künstlich verlängert werden, indem
4597 weitere <constant><</constant> oder <constant>></constant>
4598 eingefügt werden. Der Tag muss nicht symmetrisch sein.
4601 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4603 <para>Um die Limitierung der festen Breite zu reduzieren, können
4604 weitere Variablen in einem Block interpoliert werden. Whitespace wird
4605 dazwishen dann erhalten. Beispiel:</para>
4607 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4609 <para>Die Variablen werden interpoliert, und linksbündig mit
4610 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
4611 lang, werden überzählige Zeichen abgeschnitten.</para>
4613 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
4614 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
4616 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4618 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
4619 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
4623 <sect2 id="excel-templates.limitations">
4624 <title>Einschränkungen</title>
4626 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
4627 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
4628 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
4629 Text zu ersetzen.</para>
4631 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
4632 <command><%if%></command> und
4633 <command><%foreach%></command> nicht vorhanden. Der Delimiter
4634 <constant><% %></constant> kommt in den Headerinformationen
4635 evtl. vor. Deshalb wurde auf den sichereren Delimiter
4636 <constant><<</constant> und <constant>>></constant>
4643 <title>Entwicklerdokumentation</title>
4645 <sect1 id="devel.globals" xreflabel="Globale Variablen">
4646 <title>Globale Variablen</title>
4649 <title>Wie sehen globale Variablen in Perl aus?</title>
4651 <para>Globale Variablen liegen in einem speziellen namespace namens
4652 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
4653 globs global und die meisten speziellen Variablen sind...
4656 <para>Daraus ergeben sich folgende Formen:</para>
4660 <term><literal>$main::form</literal></term>
4663 <para>expliziter Namespace "main"</para>
4668 <term><literal>$::form</literal></term>
4671 <para>impliziter Namespace "main"</para>
4676 <term><literal>open FILE, "file.txt"</literal></term>
4679 <para><varname>FILE</varname> ist global</para>
4684 <term><literal>$_</literal></term>
4687 <para>speziell</para>
4692 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
4693 Schlüsselwort wie "<function>global</function>", mit dem man
4694 importieren kann. <function>my</function>, <function>our</function>
4695 und <function>local</function> machen was anderes.</para>
4699 <term><literal>my $form</literal></term>
4702 <para>lexikalische Variable, gültig bis zum Ende des
4708 <term><literal>our $form</literal></term>
4711 <para><varname>$form</varname> referenziert ab hier
4712 <varname>$PACKAGE::form</varname>.</para>
4717 <term><literal>local $form</literal></term>
4720 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
4721 des scopes zurückgesetzt</para>
4728 <title>Warum sind globale Variablen ein Problem?</title>
4730 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
4732 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
4733 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
4734 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
4735 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
4736 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
4737 Datenbankverbindungen, weil die sehr lange zum Initialisieren
4740 <para>Das zweite Problem ist <function>strict</function>. Unter
4741 <function>strict</function> werden alle Variablen die nicht explizit
4742 mit <function>Package</function>, <function>my</function> oder
4743 <function>our</function> angegeben werden als Tippfehler angemarkert,
4744 dies hat, seit der Einführung, u.a. schon so manche langwierige
4745 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
4746 angegeben werden, werden die nicht geprüft, und somit kann sich
4747 schnell ein Tippfehler einschleichen.</para>
4751 <title>Kanonische globale Variablen</title>
4753 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
4754 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
4755 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
4756 umhergereicht werden.</para>
4758 <para>Diese Variablen sind im Moment die folgenden neun:</para>
4762 <para><varname>$::form</varname></para>
4766 <para><varname>%::myconfig</varname></para>
4770 <para><varname>$::locale</varname></para>
4774 <para><varname>$::lxdebug</varname></para>
4778 <para><varname>$::auth</varname></para>
4782 <para><varname>$::lx_office_conf</varname></para>
4786 <para><varname>$::instance_conf</varname></para>
4790 <para><varname>$::dispatcher</varname></para>
4794 <para><varname>$::request</varname></para>
4798 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
4799 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
4800 Eigenschaften (Konventionen):</para>
4803 <title>$::form</title>
4807 <para>Ist ein Objekt der Klasse
4808 "<classname>Form</classname>"</para>
4812 <para>Wird nach jedem Request gelöscht</para>
4816 <para>Muss auch in Tests und Konsolenscripts vorhanden
4821 <para>Enthält am Anfang eines Requests die Requestparameter vom
4826 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
4827 cachen, das wird aber momentan absichtlich zerstört</para>
4831 <para><varname>$::form</varname> wurde unter <productname>SQL
4832 Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
4833 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
4834 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
4835 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
4836 <function>IS->retrieve_customer()</function> in Sicherheit
4839 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
4840 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
4841 3552, Stand version 2.7beta), um dies hinterher wieder auf den
4842 richtigen Wert zu setzen:</para>
4844 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
4845 $::myconfig{numberformat} = $numberformat;
4846 # (...) div Berechnungen
4847 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
4849 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
4850 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
4851 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
4852 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
4853 Es geht ziemlich sicher etwas kaputt.</para>
4855 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
4856 in den <productname>Template::Toolkit</productname> Templates
4857 außerhalb der Controller: der Ausdruck <function>[% var
4858 %]</function> greift auf <varname>$::form->{var}</varname> zu.
4859 Unter Controllern ist der Standard Scope anders, da lautet der
4860 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
4861 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
4862 <function><%var%></function> zeigt auf
4863 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
4864 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
4867 <programlisting>[%- IF business %]
4868 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
4869 [%- END %]</programlisting>
4871 <para>Entweder wird hier dann $::form->{business} ausgewertet
4872 oder aber der Funktion
4873 <function>$form->parse_html_template</function> wird explizit
4874 noch ein zusätzlicher Hash übergeben, der dann auch in den
4875 (Web-)Templates zu Verfügung steht, bspw. so:</para>
4877 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
4879 <para>Innerhalb von Schleifen wird
4880 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
4881 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
4882 welches über alle Positionen eines Lieferscheins in Schleife
4885 <programlisting>for $i (1 .. $form->{rowcount}) {
4887 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
4888 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
4889 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
4895 <title>%::myconfig</title>
4899 <para>Das einzige Hash unter den globalen Variablen</para>
4903 <para>Wird spätestens benötigt wenn auf die Datenbank
4904 zugegriffen wird</para>
4908 <para>Wird bei jedem Request neu erstellt.</para>
4912 <para>Enthält die Userdaten des aktuellen Logins</para>
4916 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
4917 extern serialisiert werden, weil da auch der Datenbankzugriff
4918 für diesen user drinsteht.</para>
4922 <para>Enthält unter anderem Listenbegrenzung vclimit,
4923 Datumsformat dateformat und Nummernformat numberformat</para>
4927 <para>Enthält Datenbankzugriffinformationen</para>
4931 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
4932 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
4933 aktuellen Users entscheiden müssen, befragen
4934 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
4935 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
4936 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
4937 Informationen über den Benutzer die über die
4938 Administrator-Schnittstelle (admin.pl) eingegeben wurden.</para>
4942 <title>$::locale</title>
4946 <para>Objekt der Klasse "Locale"</para>
4950 <para>Wird pro Request erstellt</para>
4954 <para>Muss auch für Tests und Scripte immer verfügbar
4959 <para>Cached intern über Requestgrenzen hinweg benutzte
4964 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
4965 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
4969 <title>$::lxdebug</title>
4973 <para>Objekt der Klasse "LXDebug"</para>
4977 <para>Wird global gecached</para>
4981 <para>Muss immer verfügbar sein, in nahezu allen
4986 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
4987 bereit, wie "<function>enter_sub</function>" und
4988 "<function>leave_sub</function>", mit denen in den alten Modulen ein
4989 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
4990 der man die Wallclockzeit seit Requeststart loggen kann, sowie
4991 "<function>message</function>" und "<function>dump</function>" mit
4992 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
4995 <para>Beispielsweise so:</para>
4997 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
4998 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
5002 <title>$::auth</title>
5006 <para>Objekt der Klasse "SL::Auth"</para>
5010 <para>Wird global gecached</para>
5014 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
5018 <para>Wird nach jedem Request resettet.</para>
5022 <para><varname>$::auth</varname> stellt Funktionen bereit um die
5023 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
5024 vom aktuellen User abhängen wird das Objekt aus
5025 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
5026 Request kurz resettet.</para>
5030 <title>$::lx_office_conf</title>
5034 <para>Objekt der Klasse
5035 "<classname>SL::LxOfficeConf</classname>"</para>
5039 <para>Global gecached</para>
5043 <para>Repräsentation der
5044 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
5048 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
5049 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
5050 das Programm die Konfiguration ändern kann oder sollte.</para>
5052 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
5053 Debug- und Trace-Log-Datei wie folgt konfiguriert und
5056 <programlisting>[debug]
5057 file = /tmp/kivitendo-debug.log</programlisting>
5059 <para>ist der Key <varname>file</varname> im Programm als
5060 <varname>$::lx_office_conf->{debug}{file}</varname>
5064 <para>Zugriff auf die Konfiguration erfolgt im Moment über
5065 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
5070 <title>$::instance_conf</title>
5074 <para>Objekt der Klasse
5075 "<classname>SL::InstanceConfiguration</classname>"</para>
5079 <para>wird pro Request neu erstellt</para>
5083 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
5084 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
5085 ist hier eine Mandantendatenbank. Beispielsweise überprüft
5086 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
5087 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
5091 <title>$::dispatcher</title>
5095 <para>Objekt der Klasse
5096 "<varname>SL::Dispatcher</varname>"</para>
5100 <para>wird pro Serverprozess erstellt.</para>
5104 <para>enthält Informationen über die technische Verbindung zum
5109 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
5110 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
5111 Objekt untergebracht.</para>
5115 <title>$::request</title>
5119 <para>Hashref (evtl später Objekt)</para>
5123 <para>Wird pro Request neu initialisiert.</para>
5127 <para>Keine Unterstruktur garantiert.</para>
5131 <para><varname>$::request</varname> ist ein generischer Platz um
5132 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
5133 at a distance benutzt werden, sondern um lokales memoizing zu
5134 ermöglichen, das garantiert am Ende des Requests zerstört
5137 <para>Vieles von dem, was im moment in <varname>$::form</varname>
5138 liegt, sollte eigentlich hier liegen. Die groben
5139 Differentialkriterien sind:</para>
5143 <para>Kommt es vom User, und soll unverändert wieder an den
5144 User? Dann <varname>$::form</varname>, steht da eh schon</para>
5148 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
5149 Requests gebraucht werden? Dann
5150 <varname>$::request</varname></para>
5154 <para>Muss ich von anderen Teilen des Programms lesend drauf
5155 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
5156 Wrappermethode</para>
5163 <title>Ehemalige globale Variablen</title>
5165 <para>Die folgenden Variablen waren einmal im Programm, und wurden
5169 <title>$::cgi</title>
5173 <para>war nötig, weil cookie Methoden nicht als
5174 Klassenfunktionen funktionieren</para>
5178 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
5179 Klassennamespace gehalten wird und über Requestgrenzen
5184 <para>liegt jetzt unter
5185 <varname>$::request->{cgi}</varname></para>
5191 <title>$::all_units</title>
5195 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
5196 ein paar hundert mal pro Request eine Liste der Einheiten
5197 brauchen, und de als Parameter durch einen Riesenstack von
5198 Funktionen geschleift werden müssten.</para>
5202 <para>Liegt jetzt unter
5203 <varname>$::request->{cache}{all_units}</varname></para>
5208 <function>AM->retrieve_all_units()</function> gesetzt oder
5215 <title>%::called_subs</title>
5219 <para>wurde benutzt um callsub deep recursions
5224 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
5225 möglichen Rekursioenen darstellt, und da nie welche
5230 <para>komplette recursion protection wurde entfernt.</para>
5237 <sect1 id="devel.fcgi">
5238 <title>Entwicklung unter FastCGI</title>
5240 <sect2 id="devel.fcgi.general">
5241 <title>Allgemeines</title>
5243 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
5244 werden, muss der Webserver neu gestartet werden.</para>
5246 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
5247 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
5248 müssen folgende Aspekte beachtet werden.</para>
5251 <sect2 id="devel.fcgi.exiting">
5252 <title>Programmende und Ausnahmen</title>
5254 <para>Betrifft die Funktionen <function>warn</function>,
5255 <function>die</function>, <function>exit</function>,
5256 <function>carp</function> und <function>confess</function>.</para>
5258 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
5259 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
5260 am Laufen zu halten. Man kann mit <function>die</function>,
5261 <function>confess</function> oder <function>carp</function> Fehler
5262 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
5263 eigene <function>$::form-</function>error()> tut im Prinzip das
5264 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
5265 <function>exit</function> hingegen werden nicht abgefangen.
5266 <function>warn</function> wird direkt nach STDERR, also in Server Log
5267 eine Nachricht schreiben (sofern in der Konfiguration nicht die
5268 Warnungen in das kivitendo Log umgeleitet wurden), und
5269 <function>exit</function> wird die Ausführung beenden.</para>
5271 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
5272 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
5273 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
5274 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
5277 <sect2 id="devel.fcgi.globals">
5278 <title>Globale Variablen</title>
5280 <para>Um zu vermeiden, dass Informationen von einem Request in einen
5281 anderen gelangen, müssen alle globalen Variablen vor einem Request
5282 sauber initialisiert werden. Das ist besonders wichtig im
5283 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
5284 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
5287 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
5288 abgetrennten Block, der alle kanonischen globalen Variablen listet und
5289 erklärt. Bitte keine anderen einführen ohne das sauber zu
5290 dokumentieren.</para>
5292 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
5293 man sicher geht, dass man die richtige erwischt.</para>
5296 <sect2 id="devel.fcgi.performance">
5297 <title>Performance und Statistiken</title>
5299 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
5300 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
5301 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
5302 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
5303 sind es je nach Menge der definierten Variablen 1-2s. Ab der
5304 Moose/Rose::DB Version sind es 5-6s.</para>
5306 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
5307 den kritischen Pfaden, unter 0,15 sonst.</para>
5310 <sect2 id="devel.fcgi.known-issues">
5311 <title>Bekannte Probleme</title>
5313 <sect3 id="devel.fcgi.known-issues.encoding">
5314 <title>Encoding Awareness</title>
5316 <para>UTF-8 kodierte Installationen sind sehr anfällig gegen
5317 fehlerhfate Encodings unter FCGI. latin9 Installationen behandeln
5318 falsch kodierte Zeichen eher unwissend, und geben sie einfach
5319 weiter. UTF-8 verweigert bei fehlerhaften Programmpfaden kurzerhand
5320 das Ausliefern. Es wird noch daran gearbeitet, alle Fehler da zu
5326 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
5327 <title>SQL-Upgradedateien</title>
5329 <sect2 id="db-upgrade-files.introduction"
5330 xreflabel="Einführung in die Datenbank-Upgradedateien">
5331 <title>Einführung</title>
5333 <para>Der alte Mechanismus für SQL-Upgradescripte, der auf einer
5334 Versionsnummer beruht und dann in sql/Pg-upgrade nach einem Script für
5335 diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele
5336 Entwicklung im stable- und unstable-Baum betrifft.</para>
5338 <para>Dieser Mechanismus wurde für kivitendo 2.4.1 deutlich erweitert.
5339 Es werden weiterhin alle Scripte aus sql/Pg-upgrade ausgeführt.
5340 Zusätzlich gibt es aber ein zweites Verzeichnis, sql/Pg-upgrade2. In
5341 diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren,
5342 die neben den eigentlich auszuführenden SQL- oder Perl-Befehlen einige
5343 Kontrollinformationen enthält.</para>
5345 <para>Neu sind die Kontrollinformationen, die Abhängigkeiten und
5346 Prioritäten definieren können werden, sodass Datenbankscripte zwar in
5347 einer sicheren Reihenfolge ausgeführt werden (z.B. darf ein "ALTER
5348 TABLE" erst ausgeführt werden, wenn die Tabelle mit "CREATE TABLE"
5349 angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man
5350 keine Versionsnummern mehr braucht.</para>
5352 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
5353 sql/Pg-upgrade2 bereits durchgeführt wurde und führt diese nicht
5354 erneut aus. Dazu dient die Tabelle "schema_info", die bei der
5355 Anmeldung automatisch angelegt wird.</para>
5358 <sect2 id="db-upgrade-files.format"
5359 xreflabel="Format der Upgradedateien">
5360 <title>Format der Kontrollinformationen</title>
5362 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5363 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5364 hat dabei das folgende Format:</para>
5366 <para>Für SQL-Upgradedateien:</para>
5368 <programlisting>-- @key: value</programlisting>
5370 <para>Für Perl-Upgradedateien:</para>
5372 <programlisting># @key: value</programlisting>
5374 <para>Leerzeichen vor "<varname>value</varname>" werden
5377 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5381 <term><varname>tag</varname></term>
5384 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5385 Dieser "tag" kann von anderen Kontrolldateien in ihren
5386 Abhängigkeiten verwendet werden (Schlüsselwort
5387 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5388 in der Datenbank eingetragen wird.</para>
5390 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5391 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5393 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5394 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5395 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5401 <term><varname>charset</varname></term>
5404 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
5405 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5406 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
5407 Abwesenheit des Tags der Zeichensatz
5408 "<literal>ISO-8859-15</literal>" angenommen.</para>
5413 <term><varname>description</varname></term>
5416 <para>Benötigt. Eine Beschreibung, was in diesem Update
5417 passiert. Diese wird dem Benutzer beim eigentlichen
5418 Datenbankupdate angezeigt. Während der Tag in englisch gehalten
5419 sein sollte, sollte die Beschreibung auf Deutsch
5425 <term><varname>depends</varname></term>
5428 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5429 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
5430 dass die in dieser Liste aufgeführten Scripte bereits
5431 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5433 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5434 Script "b" existiert, das von Änderungen in "a" abhängt, und
5435 eine neue Kontrolldatei für "c" erstellt wird, die von
5436 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5437 Tag "b" als Abhängigkeit zu definieren.</para>
5439 <para>Es ist nicht erlaubt, sich selbst referenzierende
5440 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5441 und "c" -> "a").</para>
5446 <term><varname>priority</varname></term>
5449 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5450 der Scripte ausgeführt werden, die die gleichen
5451 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5452 der Wert 1000 benutzt.</para>
5454 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5455 "depends" benutzt werden. kivitendo sortiert die auszuführenden
5456 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5457 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5458 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5459 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5460 Priorität alphabetisch nach dem "tag".</para>
5465 <term><varname>ignore</varname></term>
5468 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
5469 Skript bei der Anmeldung ignoriert und entsprechend nicht
5476 <sect2 id="db-upgrade-files.dbupgrade-tool"
5477 xreflabel="Hilfsscript dbupgrade2_tool.pl">
5478 <title>Hilfsscript dbupgrade2_tool.pl</title>
5480 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
5481 existiert ein Hilfsscript namens
5482 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
5483 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
5484 liest alle Datenbankupgradescripte aus dem Verzeichnis
5485 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
5486 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
5487 von der Kommandozeile überprüft werden können.</para>
5489 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
5490 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
5491 sich aber auch Informationen auf verschiedene Art ausgeben
5496 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
5497 --list</command>"</para>
5499 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
5500 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
5501 würde. Es werden neben der Listenposition der Tag, die
5502 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
5506 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
5507 --tree</command>"</para>
5509 <para>Listet alle Tags in Baumform basierend auf den
5510 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
5511 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
5512 beim übergeordneten Script als Abhängigkeit eingetragen
5516 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
5517 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
5518 --rtree</command>"</para>
5520 <para>Listet alle Tags in Baumform basierend auf den
5521 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
5522 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
5523 die das übergeordnete Script als Abhängigkeit eingetragen
5528 <para>Baumform mit Postscriptausgabe:
5529 "<command>./scripts/dbupgrade2_tool.pl
5530 --graphviz</command>"</para>
5532 <para>Benötigt das Tool "<command>graphviz</command>", um mit
5533 seiner Hilfe die <link
5534 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
5535 Baumform</link> in eine Postscriptdatei namens
5536 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
5537 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
5538 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
5539 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
5544 <para>Scripte, von denen kein anderes Script abhängt:
5545 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
5547 <para>Listet die Tags aller Scripte auf, von denen keine anderen
5548 Scripte abhängen.</para>
5554 <sect1 id="translations-languages" xreflabel="Translations and languages">
5555 <title>Translations and languages</title>
5557 <sect2 id="translations-languages.introduction"
5558 xreflabel="Introduction to translations and languages">
5559 <title>Introduction</title>
5562 <para>Dieser Abschnitt ist in Englisch geschrieben, um
5563 internationalen Übersetzern die Arbeit zu erleichtern.</para>
5566 <para>This section describes how localization packages in kivitendo
5567 are built. Currently the only language fully supported is German, and
5568 since most of the internal messages are held in English the English
5569 version is usable too.</para>
5571 <para>A stub version of French is included but not functunal at this
5575 <sect2 id="translations-languages.file-structure"
5576 xreflabel="File structure">
5577 <title>File structure</title>
5579 <para>The structure of locales in kivitendo is:</para>
5581 <programlisting>kivitendo/locale/<langcode>/</programlisting>
5583 <para>where <langcode> stands for an abbreviation of the
5584 language package. The builtin packages use two letter <ulink
5585 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
5586 but the actual name is not relevant for the program and can easily be
5588 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
5589 tags</ulink> (i.e. "en_GB"). In fact the original language packages
5590 from SQL Ledger are named in this way.</para>
5592 <para>In such a language directory the following files are
5597 <term>LANGUAGE</term>
5600 <para>This file is mandatory.</para>
5602 <para>The <filename>LANGUAGE</filename> file contains the self
5603 descripted name of the language. It should contain a native
5604 representation first, and in parenthesis an english translation
5605 after that. Example:</para>
5607 <programlisting>Deutsch (German)</programlisting>
5612 <term>charset</term>
5615 <para>This file should be present.</para>
5617 <para>The <filename>charset</filename> file describes which
5618 charset a language package is written in and applies to all
5619 other language files in the package. It is possible to write
5620 some language packages without an explicit charset, but it is
5621 still strongly recommended. You'll never know in what
5622 environment your language package will be used, and neither
5623 UTF-8 nor Latin1 are guaranteed.</para>
5625 <para>The whole content of this file is a string that can be
5626 recognized as a valid charset encoding. Example:</para>
5628 <programlisting>UTF-8</programlisting>
5636 <para>This file is mandatory.</para>
5638 <para>The central translation file. It is essentially an inline
5639 Perl script autogenerated by <command>locales.pl</command>. To
5640 generate it, generate the directory and the two files mentioned
5641 above, and execute the following command:</para>
5643 <programlisting>scripts/locales.pl <langcode></programlisting>
5645 <para>Otherwise you can simply copy one of the other languages.
5646 You will be told how many are missing like this:</para>
5648 <programlisting>$ scripts/locales.pl en
5649 English - 0.6% - 2015/2028 missing</programlisting>
5651 <para>A file named "<filename>missing</filename>" will be
5652 generated and can be edited. You can also edit the
5653 "<filename>all</filename>" file directly. Edit everything you
5654 like to fit the target language and execute
5655 <command>locales.pl</command> again. See how the missing words
5661 <term>Num2text</term>
5664 <para>Legacy code from SQL Ledger. It provides a means for
5665 numbers to be converted into natural language, like
5666 <literal>1523 => one thousand five hundred twenty
5667 three</literal>. If you want to provide it, it must be inlinable
5668 Perl code which provides a <function>num2text</function> sub. If
5669 an <function>init</function> sub exists it will be executed
5672 <para>Only used in the check and receipt printing module.</para>
5677 <term>special_chars</term>
5680 <para>kivitendo comes with a lot of interfaces to different
5681 formats, some of which are rather picky with their accepted
5682 charset. The <filename>special_chars</filename> file contains a
5683 listing of chars not suited for different file format and
5684 provides substitutions. It is written in "Simple Ini" style,
5685 containing a block for every file format.</para>
5687 <para>First entry should be the order of substitution for
5688 entries as a whitespace separated list. All entries are
5689 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
5690 and <literal>\\</literal> all work.</para>
5692 <para>After that every entry is a special char that should be
5693 translated when writing text into such a file.</para>
5695 <para>Example:</para>
5697 <programlisting>[Template/XML]
5698 order=& < > \n
5702 \n=<br></programlisting>
5704 <para>Note the importance of the order in this example.
5705 Substituting < and > befor & would lead to $gt; become
5708 <para>For a list of valid formats, see the German
5709 <filename>special_chars</filename> entry. As of this writing the
5710 following are recognized:</para>
5712 <programlisting>HTML
5717 Template/OpenDocument
5718 filenames</programlisting>
5720 <para>The last of which is very machine dependant. Remember that
5721 a lot of characters are forbidden by some filesystems, for
5722 exmaple MS Windows doesn't like ':' in its files where Linux
5723 doesn't mind that. If you want the files created with your
5724 language pack to be portable, find all chars that could cause
5730 <term>missing</term>
5733 <para>This file is not a part of the language package
5736 <para>This is a file generated by
5737 <command>scripts/locales.pl</command> while processing your
5738 locales. It's only to have the missing entries singled out and
5739 does not belong to a language package.</para>
5747 <para>This file is not a part of the language package
5750 <para>Another file generated by
5751 <command>scripts/locales.pl</command>. If for any reason a
5752 translation does not appear anymore and can be deleted, it gets
5753 moved here. The last 50 or so entries deleted are saved here in
5754 case you made a typo, so that you don't have to translate
5755 everything again. If a tranlsation is missing, the lost file is
5756 checked first. If you maintain a language package, you might
5757 want to keep this safe somewhere.</para>
5764 <sect1 id="devel.testsuite">
5765 <title>Die kivitendo-Test-Suite</title>
5767 <sect2 id="devel.testsuite.intro">
5768 <title>Einführung</title>
5770 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul <literal>Test::More</literal>.</para>
5772 <para>Die grundlegenden Fakten sind:</para>
5775 <listitem><para>Alle Tests liegen im Unterverzeichnis <filename>t/</filename>.</para></listitem>
5777 <listitem><para>Ein Script (bzw. ein Test) in <filename>f/</filename> enthält einen oder mehrere Testfälle.</para></listitem>
5779 <listitem><para>Alle Dateinamen von Tests enden auf <literal>.t</literal>. Es sind selbstständig ausführbare Perl-Scripte.</para></listitem>
5781 <listitem><para>Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in <filename>f/</filename>, deren
5782 Dateiname auf <literal>.t</literal> endet.</para></listitem>
5786 <sect2 id="devel.testsuite.prerequisites">
5787 <title>Voraussetzungen</title>
5789 <para>Für die Ausführung werden neben den für kivitendo eh schon benötigten Module noch weitere Perl-Module benötigt. Diese sind:</para>
5792 <listitem><para><literal>Test::Deep</literal> (Debian-Paketname: <literal>libtest-deep-perl</literal>; Fedora Core:
5793 <literal>perl-Test-Deep</literal>; openSuSE: <literal>perl-Test-Deep</literal>)</para></listitem>
5797 <sect2 id="devel.testsuite.execution">
5799 Existierende Tests ausführen
5802 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder, man lässt alle Tests auf einmal ausführen, oder man führt
5803 gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript <filename>t/test.sh</filename>.</para>
5805 <para>Will man die komplette Test-Suite ausführen, so muss man einfach nur <filename>t/test.sh</filename> ohne weitere Parameter aus
5806 dem kivitendo-Basisverzeichnis heraus ausführen.</para>
5808 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an <filename>t/test.sh</filename>. Beispielsweise:</para>
5810 <programlisting>t/test.sh t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
5814 <sect2 id="devel.testsuite.meaning_of_scripts">
5816 Bedeutung der verschiedenen Test-Scripte
5819 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch
5820 während der Entwicklung nützliche Tests sind:</para>
5823 <listitem><para><filename>t/001compile.t</filename> -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab</para></listitem>
5824 <listitem><para><filename>t/002goodperl.t</filename> -- überprüft alle Perl-Dateien auf Anwesenheit von '<literal>use strict</literal>'-Anweisungen</para></listitem>
5825 <listitem><para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von <function>system()</function> und <function>exec()</function> auf Gültigkeit</para></listitem>
5826 <listitem><para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien Tab-Zeichen enthalten</para></listitem>
5827 <listitem><para><filename>t/006spelling.t</filename> -- sucht nach häufigen Rechtschreibfehlern</para></listitem>
5828 <listitem><para><filename>t/011pod.t</filename> -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit</para></listitem>
5831 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module.</para>
5834 <sect2 id="devel.testsuite.create_new">
5836 Neue Test-Scripte erstellen
5839 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende
5840 Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden.</para>
5842 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
5844 Ideen für neue Test-Scripte, die keine konkreten Funktionen testen
5847 <para> Ideen, die abgesehen von Funktions noch nicht umgesetzt wurden:</para>
5850 <listitem><para>Überprüfung auf fehlende symbolische Links</para></listitem>
5851 <listitem><para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten)</para></listitem>
5852 <listitem><para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para></listitem>
5853 <listitem><para>Überprüfung auf Leerzeichen am Ende von Zeilen</para></listitem>
5854 <listitem><para>Test, ob alle zu übersetzenden Strings in <filename>locale/de/all</filename> vorhanden sind</para></listitem>
5855 <listitem><para>Test, ob alle Webseiten-Templates in <filename>templates/webpages</filename> mit vom Perl-Modul <literal>Template</literal> compiliert werden können</para></listitem>
5859 <sect3 id="devel.testsuite.directory_and_test_names">
5861 Konvention für Verzeichnis- und Dateinamen
5864 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten und ihnen soweit es geht folgen:</para>
5867 <listitem><para>Die Dateiendung muss <filename>.t</filename> lauten.</para></listitem>
5869 <listitem><para>Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise
5870 <filename>bad_function_params.t</filename>).</para></listitem>
5872 <listitem><para>Unterverzeichnisse sollten grob nach dem Themenbereich benannt sind, mit dem sich die Scripte darin befassen
5873 (beispielsweise <filename>background_jobs</filename> für Tests rund um Hintergrund-Jobs).</para></listitem>
5875 <listitem><para>Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist
5876 (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben.</para></listitem>
5880 <sect3 id="devel.testsuite.minimal_example">
5882 Minimales Skelett für eigene Scripte
5885 <para>Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden:</para>
5887 <programlisting>use Test::More tests => 0;
5891 use Support::TestSetup;
5893 Support::TestSetup::login();</programlisting>
5895 <para>Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie
5896 <varname>$::auth</varname>, <varname>$::form</varname> oder <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
5897 <filename>config/kivitendo.conf</filename> im Abschnitt <literal>testing.login</literal> ein gültiger Login-Name eingetragen
5898 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
5900 <para>Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile <code>Support::TestSetup::login();</code>
5901 weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.</para>
5906 <sect1 id="devel.style-guide">
5907 <title>Stil-Richtlinien</title>
5909 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
5910 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
5911 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
5912 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
5914 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
5917 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
5918 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
5923 <para>Es werden keine echten Tabs sondern Leerzeichen
5928 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
5930 <programlisting>foreach my $row (@data) {
5932 # do something with $row
5936 $row->{modules} = MODULE->retrieve(
5937 id => $row->{id},
5938 date => $use_now ? localtime() : $row->{time},
5942 $report->add($row);
5947 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
5948 Zeile wie der letzte Befehl. Beispiele:</para>
5950 <programlisting>sub debug {
5956 <programlisting>if ($form->{item_rows} > 0) {
5962 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
5963 der Befehl / die öffnende schließende Klammer, die den Block
5964 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
5965 Beispiele wie bei 3. gelten.</para>
5969 <para>Die Wörter "<function>else</function>",
5970 "<function>elsif</function>", "<function>while</function>" befinden
5971 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
5974 <programlisting>if ($form->{sum} > 1000) {
5976 } elsif ($form->{sum} > 0) {
5984 } until ($a > 0);</programlisting>
5988 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
5989 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
5990 und grep-ähnliche Operatoren. Beispiel:</para>
5992 <programlisting>$main::lxdebug->message("Could not find file.");
5993 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
5997 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
5999 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
6000 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
6001 Blöcke schon. Beispiel:</para>
6003 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
6008 $form->{sum} += $form->{"row_$i"};
6009 $form->{ $form->{index} } += 1;
6011 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
6015 <para>Mehrzeilige Befehle</para>
6019 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
6020 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
6021 werden, in der die ersten Funktionsparameter in der ersten Zeile
6022 stehen. Beispiel:</para>
6024 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
6025 $form->{some_col_value});</programlisting>
6029 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
6030 besten in einer übersichtlichen Tabellenstruktur organisiert
6031 wird. Beispiel:</para>
6033 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
6034 : $form->{oldcount} ? $form->{oldcount} + 1
6035 : $form->{rowcount} - $form->{rowbase};</programlisting>
6041 <para>Kommentare</para>
6045 <para>Kommentare, die alleine in einer Zeile stehen, sollten
6046 soweit wie der Code eingerückt sein.</para>
6050 <para>Seitliche hängende Kommentare sollten einheitlich
6051 formatiert werden.</para>
6055 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
6056 auf Englisch zu verfassen. So wie ich keine Lust habe,
6057 französischen Quelltext zu lesen, sollte auch der kivitendo
6058 Quelltext für nicht-Deutschsprachige lesbar sein.
6061 <programlisting>my $found = 0;
6069 $i = 0 # initialize $i
6071 $i *= $const; # do something crazy
6072 $i = $n; # recover $i</programlisting>
6078 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
6079 Interpolation gewünscht ist. Beispiel:</para>
6081 <programlisting>$form->{sum} = 0;
6082 $form->{"row_$i"} = $form->{"row_$i"} - 5;
6083 $some_hash{42} = 54;</programlisting>
6087 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
6088 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
6089 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
6090 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
6092 <para>Als Beispiel sei die Funktion
6093 <function>print_options</function> aus
6094 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
6098 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
6099 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
6102 <para>Emacs und vim haben beide recht einfache Methoden zur
6103 Entfernung von trailing whitespace. Emacs kennt das Kommande
6104 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
6105 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
6106 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
6111 <para>Es wird kein <command>perltidy</command> verwendet.</para>
6113 <para>In der Vergangenheit wurde versucht,
6114 <command>perltidy</command> zu verwenden, um einen einheitlichen
6115 Stil zu erlangen. Es hat sich aber gezeigt, dass
6116 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
6117 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
6118 den Interessierten sind hier die
6119 <command>perltidy</command>-Optionen, die grob den beschriebenen
6120 Richtlinien entsprechen:</para>
6122 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
6123 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
6124 -lp -vt=1 -vtc=1</programlisting>
6128 <para><varname>STDERR</varname> ist tabu. Unkonditionale
6129 Debugmeldungen auch.</para>
6131 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
6132 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
6133 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
6135 <para>Die <classname>LXDebug</classname>-Methode
6136 "<function>message</function>" nimmt als ersten Paramter außerdem
6137 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
6138 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
6139 und werden in den meisten Fällen auch vom Repository
6140 zurückgewiesen.</para>
6144 <para>Alle neuen Module müssen use strict verwenden.</para>
6146 <para><varname>$form</varname>, <varname>$auth</varname>,
6147 <varname>$locale</varname>, <varname>$lxdebug</varname> und
6148 <varname>%myconfig</varname> werden derzeit aus dem main package
6149 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
6150 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
6155 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
6156 <title>Dokumentation erstellen</title>
6158 <sect2 id="devel.build-doc.introduction">
6159 <title>Einführung</title>
6161 <para>Diese Dokumentation ist in <productname>DocBook</productname>
6162 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
6163 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
6164 Editor nutzt, der spezielle Unterstützung für
6165 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
6166 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
6167 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
6171 <sect2 id="devel.build-doc.required-software">
6172 <title>Benötigte Software</title>
6174 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
6175 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
6176 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
6177 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
6178 <command>scripts/build_doc.sh</command>.</para>
6180 <para>Das Script benötigt zur Konvertierung verschiedene
6181 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
6187 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
6188 in einer halbwegs aktuellen Version</para>
6192 <para>Das Java-Build-System <ulink
6193 url="http://ant.apache.org/">Apache Ant</ulink></para>
6197 <para>Das Dokumentations-System Dobudish für
6198 <productname>DocBook</productname> 4.5, eine Zusammenstellung
6199 diverser Stylesheets und Grafiken zur Konvertierung von
6200 <productname>DocBook</productname> XML in andere Formate. Das
6201 Paket, das benötigt wird, ist zum Zeitpunkt der
6202 Dokumentationserstellung
6203 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
6204 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
6209 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
6210 sind auf allen gängigen Plattformen verfügbar. Beispiel für
6211 Debian/Ubuntu:</para>
6213 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
6215 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
6216 <filename>doc/build</filename> entpackt werden. Beispiel unter der
6217 Annahme, das <productname>Dobudish</productname> in
6218 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
6220 <programlisting>cd doc/build
6221 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
6224 <sect2 id="devel.build-doc.build">
6225 <title>PDFs und HTML-Seiten erstellen</title>
6227 <para>Die eigentliche Konvertierung erfolgt nach Installation der
6228 benötigten Software mit einem einfachen Aufruf direkt aus dem
6229 kivitendo-Installationsverzeichnis heraus:</para>
6231 <programlisting>./scripts/build_doc.sh</programlisting>
6234 <sect2 id="devel.build-doc.repository">
6235 <title>Einchecken in das Git-Repository</title>
6237 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
6238 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
6239 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
6240 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
6242 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
6243 symbolischen Links gehören hingegen nicht in das Repository.</para>