1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <book id="kivitendo-documentation" lang="de">
5 <title>kivitendo: Installation, Konfiguration, Entwicklung</title>
7 <chapter id="Aktuelle-Hinweise">
8 <title>Aktuelle Hinweise</title>
10 <para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>
14 <para>im kivitendo-Forum: <ulink
15 url="https://forum.kivitendo.org/">https://forum.kivitendo.org/</ulink></para>
19 <para>im alten Lx-Office-Wiki unter Dokumentation (<ulink
20 url="http://wiki.lx-office.org/index.php?title=Installation_Lx-Office_ERP">http://wiki.lx-office.org/index.php?title=Installation_Lx-Office_ERP</ulink>)</para>
26 <title>Installation und Grundkonfiguration</title>
28 <sect1 id="Benötigte-Software-und-Pakete">
29 <title>Benötigte Software und Pakete</title>
31 <sect2 id="Betriebssystem">
32 <title>Betriebssystem</title>
34 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
35 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
36 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
37 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
38 ohne große Probleme auf den derzeit aktuellen verbreiteten
39 Distributionen läuft.</para>
41 <para>Mitte 2012 sind das folgende Systeme, von denen bekannt ist,
42 dass kivitendo auf ihnen läuft:</para>
46 <para>Ubuntu 10.04 LTS Lucid Lynx bis 12.10 Oneiric Ocelot</para>
50 <para>Debian 5.0 Lenny und 6.0 Squeeze</para>
54 <para>openSUSE 11.2 und 11.3</para>
58 <para>SuSE Linux Enterprice Server 11</para>
62 <para>Fedora 13 bis 16</para>
67 <sect2 id="Pakete" xreflabel="Pakete">
70 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
71 Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2)
74 <para>Zusätzlich benötigt kivitendo die folgenden Perl-Pakete, die
75 nicht Bestandteil einer Standard-Perl-Installation sind:</para>
78 <listitem><para><literal>parent</literal></para></listitem>
80 <listitem><para><literal>Archive::Zip</literal></para></listitem>
82 <listitem><para><literal>Config::Std</literal></para></listitem>
84 <listitem><para><literal>DateTime</literal></para></listitem>
86 <listitem><para><literal>DBI</literal></para></listitem>
88 <listitem><para><literal>DBD::Pg</literal></para></listitem>
90 <listitem><para><literal>Email::Address</literal></para></listitem>
92 <listitem><para><literal>Email::MIME</literal></para></listitem>
94 <listitem><para><literal>JSON</literal></para></listitem>
96 <listitem><para><literal>List::MoreUtils</literal></para></listitem>
98 <listitem><para><literal>Net::SMTP::SSL</literal> (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "<xref
99 linkend="config.sending-email.smtp"/>")</para></listitem>
101 <listitem><para><literal>Net::SSLGlue</literal> (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "<xref
102 linkend="config.sending-email.smtp"/>")</para></listitem>
104 <listitem><para><literal>Params::Validate</literal></para></listitem>
106 <listitem><para><literal>PDF::API2</literal></para></listitem>
108 <listitem><para><literal>Rose::Object</literal></para></listitem>
110 <listitem><para><literal>Rose::DB</literal></para></listitem>
112 <listitem><para><literal>Rose::DB::Object</literal></para></listitem>
114 <listitem><para><literal>Template</literal></para></listitem>
116 <listitem><para><literal>Text::CSV_XS</literal></para></listitem>
118 <listitem><para><literal>Text::Iconv</literal></para></listitem>
120 <listitem><para><literal>URI</literal></para></listitem>
122 <listitem><para><literal>XML::Writer</literal></para></listitem>
124 <listitem><para><literal>YAML</literal></para></listitem>
127 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen: <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
128 <literal>Net::SSLGlue</literal>.</para>
130 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
131 hinzugekommen, <literal>URI</literal> und
132 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
135 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
136 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
137 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
138 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
140 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
141 hinzugekommen.</para>
143 <para><literal>Email::Address</literal> und
144 <literal>List::MoreUtils</literal> sind schon länger feste
145 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
146 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
147 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
148 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
151 <para>Die zu installierenden Pakete können in den verschiedenen
152 Distributionen unterschiedlich heißen.</para>
154 <para>Für Debian oder Ubuntu benötigen Sie diese Pakete:</para>
156 <programlisting>apt-get install apache2 postgresql libparent-perl libarchive-zip-perl \
157 libdatetime-perl libdbi-perl libdbd-pg-perl libpg-perl \
158 libemail-address-perl libemail-mime-perl liblist-moreutils-perl libpdf-api2-perl \
159 librose-object-perl librose-db-perl librose-db-object-perl \
160 libtemplate-perl libtext-csv-xs-perl libtext-iconv-perl liburi-perl \
161 libxml-writer-perl libyaml-perl libconfig-std-perl \
162 libparams-validate-perl libjson-perl libclass-accessor-perl \
163 libnet-sslglue-perl libnet-smtp-ssl-perl</programlisting>
165 <para>Für Fedora Core benötigen Sie diese Pakete:</para>
167 <programlisting>yum install httpd postgresql-server perl-parent perl-DateTime \
168 perl-DBI perl-DBD-Pg perl-Email-Address perl-Email-MIME perl-List-MoreUtils \
169 perl-PDF-API2 perl-Rose-Object perl-Rose-DB perl-Rose-DB-Object \
170 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
171 perl-XML-Writer perl-YAML perl-Net-SSLGlue perl-Net-SMTP-SSL</programlisting>
173 <para>Für OpenSuSE benötigen Sie diese Pakete:</para>
175 <programlisting>zypper install apache2 postgresql-server perl-Archive-Zip \
176 perl-DateTime perl-DBI perl-DBD-Pg perl-Email-MIME perl-MailTools perl-List-MoreUtils \
177 perl-PDF-API2 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
178 perl-URI perl-XML-Writer perl-YAML perl-Net-SSLGlue perl-Net-SMTP-SSL</programlisting>
180 <para>kivitendo enthält ein Script, mit dem überprüft werden kann, ob
181 alle benötigten Perl-Module installiert sind. Der Aufruf lautet wie
184 <programlisting>./scripts/installation_check.pl</programlisting>
188 <sect1 id="Manuelle-Installation-des-Programmpaketes"
189 xreflabel="Manuelle Installation des Programmpaketes">
190 <title>Manuelle Installation des Programmpaketes</title>
192 <para>Die kivitendo ERP Installationsdatei (kivitendo-erp-2.6.3.tgz) wird
193 im Dokumentenverzeichnis des Webservers (z.B.
194 <filename>/var/www/html/</filename>,
195 <filename>/srv/www/htdocs</filename> oder
196 <filename>/var/www/</filename>) entpackt:</para>
198 <programlisting>cd /var/www
199 tar xvzf kivitendo-erp-2.6.3.tgz</programlisting>
201 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
203 <programlisting>cd kivitendo-erp</programlisting>
205 <para>Alternativ können Sie auch einen Alias in der
206 Webserverkonfiguration benutzen, um auf das tatsächliche
207 Installationsverzeichnis zu verweisen.</para>
209 <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
210 beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
211 Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
212 core <constant>apache</constant> oder bei OpenSuSE <constant>wwwrun</constant>).</para>
214 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
215 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
217 <programlisting>chown -R www-data users spool webdav</programlisting>
219 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
220 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>
222 <programlisting>chown www-data templates users</programlisting>
225 <sect1 id="config.config-file">
226 <title>kivitendo-Konfigurationsdatei</title>
228 <sect2 id="config.config-file.introduction"
229 xreflabel="Einführung in die Konfigurationsdatei">
230 <title>Einführung</title>
232 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei,
233 die benötigt wird: <filename>config/kivitendo.conf</filename> (kurz:
234 "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
235 von kivitendo bzw. der Migration von älteren Versionen angelegt
238 <para>Als Vorlage dient die Datei
239 <filename>config/kivitendo.conf.default</filename> (kurz: "die
240 Default-Datei"):</para>
242 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
244 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
245 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
246 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
247 Abschnitte und Werte enthalten, die von denen der Default-Datei
252 Vor der Umbenennung in kivitendo hieß diese Datei noch <filename>config/lx_office.conf</filename>. Aus Gründen der Kompatibilität
253 wird diese Datei eingelesen, sofern die Datei <filename>config/kivitendo.conf</filename> nicht existiert.
257 <para>Diese Hauptkonfigurationsdatei ist dann eine
258 installationsspezifische Datei, d.h. sie enthält bspw. lokale
259 Passwörter und wird auch nicht im Versionsmanagement (git)
262 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
263 Mandaten, bzw. Datenbanken gleich.</para>
266 <sect2 id="config.config-file.sections-parameters">
267 <title>Abschnitte und Parameter</title>
269 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
270 entsprechend kommentiert sind:</para>
273 <listitem><para><literal>authentication</literal> (siehe Abschnitt "<xref
274 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>" in diesem Kapitel)</para></listitem>
276 <listitem><para><literal>authentication/database</literal></para></listitem>
278 <listitem><para><literal>authentication/ldap</literal></para></listitem>
280 <listitem><para><literal>system</literal></para></listitem>
282 <listitem><para><literal>features</literal> (siehe Kapitel "<xref linkend="features"/>")</para></listitem>
284 <listitem><para><literal>paths</literal></para></listitem>
286 <listitem><para><literal>applications</literal></para></listitem>
288 <listitem><para><literal>environment</literal></para></listitem>
290 <listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>
292 <listitem><para><literal>print_templates</literal></para></listitem>
294 <listitem><para><literal>task_server</literal></para></listitem>
296 <listitem><para><literal>periodic_invoices</literal></para></listitem>
298 <listitem><para><literal>console</literal></para></listitem>
300 <listitem><para><literal>debug</literal></para></listitem>
303 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
304 einzustellen oder zu kontrollieren sind, sind:</para>
306 <programlisting>[authentication]
307 admin_password = geheim
309 [authentication/database]
317 dbcharset = UTF-8</programlisting>
319 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
320 <varname>[periodic_invoices]</varname> den Login eines Benutzers
321 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
322 mit Informationen über die erstellten Rechnungen bekommt.</para>
324 <para>Nutzt man den <link
325 linkend="config.task-server">Taskserver</link> für <link
326 linkend="features.periodic-invoices">wiederkehrende Rechnungen</link>,
327 muss unter <varname>[task_server]</varname> ein Login eines Benutzers
328 angegeben werden, mit dem sich der Taskserver an kivitendo bei der
329 Datenbank anmeldet, die dem Benutzer zugewiesen ist.</para>
331 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
332 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
335 <sect2 id="config.config-file.prior-versions">
336 <title>Versionen vor 2.6.3</title>
338 <para>In älteren kivitendo Versionen gab es im Verzeichnis
339 <filename>config</filename> die Dateien
340 <filename>authentication.pl</filename> und
341 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
342 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
343 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
344 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
346 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
347 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
348 manuell übertragen und die alten Konfigurationsdateien anschließend
349 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
350 entsprechende Fehlermeldung an.</para>
354 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
355 <title>Anpassung der PostgreSQL-Konfiguration</title>
357 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
359 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
360 <title>Zeichensätze/die Verwendung von UTF-8</title>
362 <para>Bei aktuellen Serverinstallationen braucht man hier meist nicht
365 <para>Dieses kann überprüft werden: ist das Encoding der Datenbank
366 “template1” “UTF8”, so braucht man nichts weiteres diesbezueglich
367 unternehmen. Zum Testen:
369 <programlisting>su postgres
371 exit </programlisting>
373 Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
374 UTF-8-Encoding anzulegen und diesen zu verwenden. Unter Debian und
375 Ubuntu kann dies z.B. für PostgreSQL 8.2 mit dem folgenden Befehl
378 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2 clustername</programlisting>
380 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
381 Versionsnummer angepasst werden.</para>
383 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
385 <para>Wurde PostgreSQL nicht mit UTF-8 als Encoding initialisiert und
386 ist ein Neuanlegen eines weiteren Clusters nicht möglich, so kann
387 kivitendo mit ISO-8859-15 als Encoding betrieben werden.</para>
389 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
390 <literal>\l</literal> geprüft werden.</para>
393 <sect2 id="Änderungen-an-Konfigurationsdateien">
394 <title>Änderungen an Konfigurationsdateien</title>
396 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
397 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
398 <filename>/var/lib/pgsql/data/</filename> oder
399 <filename>/etc/postgresql/</filename>, muss sichergestellt werden,
400 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
401 Parameter <varname>listen_address</varname> gesteuert. Laufen
402 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
403 <literal>localhost</literal> verwendet werden. Andernfalls müssen
404 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
405 was mit dem Wert <literal>*</literal> geschieht.</para>
407 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
408 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
409 sein sollte, müssen die Berichtigungen für den Zugriff geändert
410 werden. Hier gibt es mehrere Möglichkeiten. sinnvoll ist es nur die
411 nögiten Verbindungen immer zuzulassen, für eine lokal laufenden
412 Datenbank zum Beispiel:</para>
414 <programlisting>local all kivitendo password
415 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
418 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
419 <title>Erweiterung für servergespeicherte Prozeduren</title>
421 <para>In der Datenbank <literal>template1</literal> muss die
422 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
423 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
424 <programlisting>su - postgres
425 psql template1</programlisting>
427 führen Sie die folgenden Kommandos aus:</para>
429 <programlisting>create language 'plpgsql';
433 <sect2 id="Datenbankbenutzer-anlegen">
434 <title>Datenbankbenutzer anlegen</title>
436 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
437 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
438 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
441 <programlisting>su - postgres
442 createuser -d -P kivitendo
443 exit</programlisting>
445 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
446 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.
447 den hier gewählten Benutzernamen.</para>
451 <sect1 id="Apache-Konfiguration">
452 <title>Webserver-Konfiguration</title>
455 <title>Grundkonfiguration mittels CGI</title>
458 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
459 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
460 <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
463 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
464 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
465 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
466 anderen Datei hinzu, die beim Starten des Webservers eingelesen
469 <programlisting>AddHandler cgi-script .pl
470 Alias /kivitendo-erp/ /var/www/kiviteno-erp/
472 <Directory /var/www/kivitendo-erp>
473 Options ExecCGI Includes FollowSymlinks
476 <Directory /var/www/kivitendo-erp/users>
479 </Directory></programlisting>
481 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
482 das kivitendo-Archiv entpacket haben.</para>
485 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
486 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
489 <para>Auf einigen Webservern werden manchmal die Grafiken und
490 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
491 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
493 <programlisting>EnableSendfile Off</programlisting>
496 <sect2 id="Apache-Konfiguration.FCGI"
497 xreflabel="Konfiguration für FastCGI/FCGI">
498 <title>Konfiguration für FastCGI/FCGI</title>
500 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
501 <title>Was ist FastCGI?</title>
503 <para>Direkt aus <ulink
504 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
507 <para><citation> FastCGI ist ein Standard für die Einbindung
508 externer Software zur Generierung dynamischer Webseiten in einem
509 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
510 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
511 umgehen. </citation></para>
514 <sect3 id="Apache-Konfiguration.FCGI.Warum">
515 <title>Warum FastCGI?</title>
517 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
518 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
519 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
520 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
521 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
522 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
523 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
524 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
525 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
526 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
527 deutlich länger dauert als früher, und dass davon 90% für das Laden
528 der Module verwendet wird.</para>
530 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
531 wird nur die eigentliche Programmlogik ausgeführt.</para>
534 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
535 <title>Getestete Kombinationen aus Webservern und Plugin</title>
537 <para>Folgende Kombinationen sind getestet:</para>
541 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
545 <para>Apache 2.2.11 (Ubuntu) und mod_fastcgi.</para>
549 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
550 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
551 mod_fastcgi nicht mehr explizit eingegangen.</para>
553 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
557 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern
558 bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrere Installation gibt, muss zwingend Version 0.68 oder
559 aber Version 0.72 und neuer eingesetzt werden.</para>
561 <para>Mit CPAN lässt sie sich die Vorgängerversion wie folgt
564 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
568 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
569 <title>Konfiguration des Webservers</title>
571 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
572 laufen zu lassen, empfliehlt es sich die Installation ersteinmal
573 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
574 debuggen die beim ersten aufsetzen auftreten können. Sollte die
575 Installation schon funktionieren, lesen Sie weiter.</para>
577 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
578 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
580 <programlisting>a2enmod fcgid</programlisting>
582 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
583 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
584 und <function>Directory</function>-Direktiven. Dabei wird zwischen
585 dem Installationspfad von kivitendo im Dateisystem
586 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
587 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
588 ("<filename>/url/for/kivitendo-erp</filename>").</para>
590 <para>Folgender Konfigurationsschnipsel funktioniert mit
593 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
594 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
596 <Directory /path/to/kivitendo-erp>
598 Options ExecCGI Includes FollowSymlinks
603 <DirectoryMatch /path/to/kivitendo-erp/users>
606 </DirectoryMatch></programlisting>
608 <para>Seit mod_fcgid-Version 2.6.3 gelten sehr kleine Grenzen für
609 die maximale Größe eines Requests. Diese sollte wie folgt
610 hochgesetzt werden:</para>
612 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
614 <para>Das ganze sollte dann so aussehen:</para>
616 <programlisting>AddHandler fcgid-script .fpl
617 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
618 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
619 FcgidMaxRequestLen 10485760
621 <Directory /path/to/kivitendo-erp>
623 Options ExecCGI Includes FollowSymlinks
628 <DirectoryMatch /path/to/kivitendo-erp/users>
631 </DirectoryMatch></programlisting>
633 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
634 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
635 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
636 gibt es hier kleine Performance-Einbußen.</para>
638 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
639 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
640 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
642 <programlisting># Zugriff über CGI
643 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
645 # Zugriff mit mod_fcgid:
646 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
647 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
649 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
650 die normale Version erreichbar, und unter
651 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
652 FastCGI-Version.</para>
657 <sect1 id="config.task-server">
658 <title>Der Task-Server</title>
660 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
661 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
662 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
663 wird bisher nur für die Erzeugung der wiederkehrenden Rechnungen
664 benutzt, wird aber in Zukunft deutlich mehr Aufgaben übertragen
667 <sect2 id="Konfiguration-des-Task-Servers">
668 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
670 <para>Die Konfiguration erfolgt über den Abschnitt
671 <literal>[task_server]</literal> in der Datei
672 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
673 Optionen sind:</para>
677 <term><varname>login</varname></term>
680 <para>gültiger kivitendo-Benutzername, der benutzt wird, um die
681 zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss
682 in der Administration angelegt werden. Diese Option muss
683 angegeben werden.</para>
688 <term><varname>run_as</varname></term>
691 <para>Wird der Server vom Systembenutzer <literal>root</literal>
692 gestartet, so wechselt er auf den mit <literal>run_as</literal>
693 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
694 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
696 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
697 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
698 unter dem auch der Webserver läuft.</para>
703 <term><varname>debug</varname></term>
706 <para>Schaltet Debug-Informationen an und aus.</para>
712 <sect2 id="Einbinden-in-den-Boot-Prozess">
713 <title>Automatisches Starten des Task-Servers beim Booten</title>
715 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
716 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
717 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
719 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
720 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
721 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
722 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
723 anstelle eines symbolischen Links verwendet werden können.</para>
726 <title>SystemV-basierende Systeme (z.B. Debian, OpenSuSE, Fedora
729 <para>Kopieren Sie die Datei
730 <filename>scripts/boot/system-v/kivitendo-server</filename>
731 nach <filename>/etc/init.d/kivitendo-server</filename>. Passen
732 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
733 <literal>DAEMON=....</literal>). Binden Sie das Script in den
734 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
738 <para>Debian-basierende Systeme:</para>
740 <programlisting>update-rc.d kivitendo-task-server defaults
741 # Nur bei Debian Squeeze und neuer:
742 insserv kivitendo-task-server</programlisting>
746 <para>OpenSuSE und Fedora Core:</para>
748 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
752 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
753 werden: <command>/etc/init.d/kivitendo-task-server
754 start</command></para>
758 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
760 <para>Kopieren Sie die Datei
761 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
762 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
763 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
764 <literal>exec ....</literal>).</para>
766 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
767 werden: <command>service kivitendo-task-server
768 start</command></para>
772 <sect2 id="Prozesskontrolle">
773 <title>Wie der Task-Server gestartet und beendet wird</title>
775 <para>Der Task-Server wird wie folgt kontrolliert:</para>
777 <programlisting>./scripts/task_server.pl Befehl</programlisting>
779 <para><literal>Befehl</literal> ist dabei eine der folgenden
784 <para><literal>start</literal> startet eine neue Instanz des
785 Task-Servers. Die Prozess-ID wird innerhalb des
786 <filename>users</filename>-Verzeichnisses abgelegt.</para>
790 <para><literal>stop</literal> beendet einen laufenden
795 <para><literal>restart</literal> beendet und startet ihn
800 <para><literal>status</literal> berichtet, ob der Task-Server
805 <para>Der Task-Server wechselt beim Starten automatisch in das
806 kivitendo-Installationsverzeichnis.</para>
808 <para>Dieselben Optionen können auch für die SystemV-basierenden
809 Runlevel-Scripte benutzt werden (siehe oben).</para>
811 <sect2 id="Prozesskontrolle2">
812 <title>Task-Server mit mehreren Mandanten</title>
814 <para>Beim Task-Server wird der Login-Name des Benutzers, unter dem der
815 Task-Server laufen soll, in die Konfigurationsdatei geschrieben. Hat
816 man mehrere Mandanten muß man auch mehrere Konfigurationsdateien
819 <para>Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf,
820 wo in der Kategorie [task_server] der gewünschte "login" steht.</para>
822 <para>Der alternative Task-Server wird dann mit folgendem Befehl
825 <programlisting>./scripts/task_server.pl -c config/DATEINAME.conf</programlisting>
829 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
830 <title>Benutzerauthentifizierung und Administratorpasswort</title>
832 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
833 über die Verwaltung von Gruppen und weitere Einstellungen</para>
835 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
836 <title>Grundlagen zur Benutzerauthentifizierung</title>
838 <para>kivitendo verwaltet die Benutzerinformationen in einer
839 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
840 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
841 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
842 können, müssen aber nicht unterschiedlich sein.</para>
844 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
845 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
846 abgelegt werden.</para>
848 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
849 entweder gegen die Authentifizierungsdatenbank oder gegen einen
850 LDAP-Server überprüft werden.</para>
852 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
853 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
854 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
855 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
856 einer Version vor v2.6.0 angelegt werden. Eine
857 Beispielkonfigurationsdatei
858 <filename>config/kivitendo.conf.default</filename> existiert, die als
859 Vorlage benutzt werden kann.</para>
862 <sect2 id="Administratorpasswort">
863 <title>Administratorpasswort</title>
865 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
866 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
867 nur dort und nicht mehr im Administrationsinterface selber geändert
868 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
869 Abschnitt <varname>[authentication]</varname>.</para>
872 <sect2 id="Authentifizierungsdatenbank">
873 <title>Authentifizierungsdatenbank</title>
875 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
876 Parametern in <varname>[authentication/database]</varname>
877 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
881 <term><literal>host</literal></term>
884 <para>Der Rechnername oder die IP-Adresse des
885 Datenbankservers</para>
890 <term><literal>port</literal></term>
893 <para>Die Portnummer des Datenbankservers, meist 5432</para>
898 <term><literal>db</literal></term>
901 <para>Der Name der Authentifizierungsdatenbank</para>
906 <term><literal>user</literal></term>
909 <para>Der Benutzername, mit dem sich kivitendo beim
910 Datenbankserver anmeldet (z.B.
911 "<literal>postgres</literal>")</para>
916 <term><literal>password</literal></term>
919 <para>Das Passwort für den Datenbankbenutzer</para>
924 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
925 automatisch anlegen (mehr dazu siehe unten).</para>
928 <sect2 id="Passwortüberprüfung">
929 <title>Passwortüberprüfung</title>
931 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
932 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
933 Active-Directory-Server. Welche davon benutzt wird, regelt der
934 Parameter <varname>module</varname> im Abschnitt
935 <varname>[authentication]</varname>.</para>
937 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
938 gespeichert werden, so muss der Parameter <varname>module</varname>
939 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
940 der Administrator als auch die Benutzer selber ihre Psaswörter in
941 kivitendo ändern.</para>
943 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
944 benutzt werden, so muss der Parameter <varname>module</varname> auf
945 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
946 zusätzliche Informationen über den LDAP-Server im Abschnitt
947 <literal>[authentication/ldap]</literal> angegeben werden:</para>
951 <term><literal>host</literal></term>
954 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
955 Active-Directory-Servers. Diese Angabe ist zwingend
961 <term><literal>port</literal></term>
964 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
969 <term><literal>tls</literal></term>
972 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
973 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
974 ‘<literal>0</literal>’ belassen</para>
979 <term><literal>attribute</literal></term>
982 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
983 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
984 meist ‘<literal>sAMAccountName</literal>’, für andere
985 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
986 zwingend erforderlich.</para>
991 <term><literal>base_dn</literal></term>
994 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
995 Diese Angabe ist zwingend erforderlich.</para>
1000 <term><literal>filter</literal></term>
1003 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1004 <literal><%login%></literal>, so wird dieses durch den vom
1005 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1006 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1007 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1012 <term><literal>bind_dn</literal> und
1013 <literal>bind_password</literal></term>
1016 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1017 durchsucht werden kann (z.B. ist dies bei
1018 Active-Directory-Servern der Fall), so kann diese hier angegeben
1019 werden. Für Active-Directory-Server kann als
1020 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1021 z.B. ‘<literal>cn=Martin
1022 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1023 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1024 also ‘<literal>Martin Mustermann</literal>’.</para>
1030 <sect2 id="Name-des-Session-Cookies">
1031 <title>Name des Session-Cookies</title>
1033 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1034 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1035 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1036 Parameter <varname>cookie_name</varname> im Abschnitt
1037 <varname>[authentication]</varname>gesetzt.</para>
1039 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1040 Server existiert.</para>
1043 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1044 <title>Anlegen der Authentifizierungsdatenbank</title>
1046 <para>Nachdem alle Einstellungen in
1047 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1048 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1049 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1050 der folgenden URL erreichbar sein sollte:</para>
1053 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
1057 <sect1 id="Benutzer--und-Gruppenverwaltung">
1058 <title>Benutzer- und Gruppenverwaltung</title>
1060 <para>Nach der Installation müssen Benutzer, Gruppen und Datenbanken
1061 angelegt werden. Dieses geschieht im Administrationsmenü, das Sie unter
1062 folgender URL finden:</para>
1065 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
1067 <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
1068 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1070 <sect2 id="Zusammenhänge">
1071 <title>Zusammenhänge</title>
1073 <para>kivitendo verwendet eine Datenbank zum Speichern all seiner
1074 Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um
1075 mit kivitendo arbeiten zu können, muss eine Person einen
1076 Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine
1077 Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist
1078 möglich und normal, dass mehreren Benutzern die selbe Datenbank
1079 zugewiesen wird, sodass sie alle mit den selben Daten arbeiten
1082 <para>Die Basisdaten der Benutzer, die in der Administration
1083 eingegeben werden können, werden in einer zweiten Datenbank
1084 gespeichert, der bereits erwähnten Authentifizierungsdatenbank. Diese
1085 ist also den Produktivdaten enthaltenden Datenbanken vorgeschaltet.
1086 Pro kivitendo-Installation gibt es nur eine
1087 Authentifizierungsdatenbank, aber beliebig viele Datenbanken mit
1090 <para>kivitendo kann seinen Benutzern Zugriff auf bestimmte
1091 Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht
1092 gestattet, so werden der entsprechenden Menüpunkte auch nicht
1093 angezeigt. Diese Rechte werden ebenfalls in der
1094 Authentifizierungsdatenbank gespeichert.</para>
1096 <para>Um Rechte verteilen zu können, verwendet kivitendo ein
1097 Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche
1098 erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder
1099 mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen
1100 Funktionen, die mindestens einer Gruppe erlaubt sind, in der der
1101 Benutzer Mitglied ist.</para>
1103 <para>Die allgemeine Reihenfolge, in der Datenbanken, Gruppen und
1104 Benutzer angelegt werden sollten, lautet:</para>
1106 <orderedlist numeration="arabic">
1108 <para>Datenbank anlegen</para>
1112 <para>Gruppen anlegen</para>
1116 <para>Benutzer anlegen</para>
1120 <para>Benutzer den Gruppen zuordnen</para>
1125 <sect2 id="Datenbanken-anlegen">
1126 <title>Datenbanken anlegen</title>
1128 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1129 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1130 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1132 <para>Wenn Sie für die kivitendo-Installation nicht Unicode (UTF-8) sondern den europäischen Schriftsatz ISO-8859-15 benutzen
1133 wollen, so müssen Sie vor dem Anlegen der Datenbank in der Datei <filename>config/kivitendo.conf</filename> die Variable
1134 <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf den Wert ‘<literal>ISO-8859-15</literal>’ setzen.</para>
1136 <para>Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz
1137 verwenden müssen, da diese Einstellungen momentan global in kivitendo
1138 vorgenommen wird und nicht nach Datenbank unterschieden werden kann.
1139 Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz
1140 angelegt worden sein.</para>
1143 <sect2 id="Gruppen-anlegen">
1144 <title>Gruppen anlegen</title>
1146 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1147 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1148 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1149 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1151 <para>Benutzergruppen sind unabhängig von Datenbanken, da sie in der
1152 Authentifizierungsdatenbank gespeichert werden. Sie gelten für alle
1153 Datenbanken, die in dieser Installation verwaltet werden.</para>
1156 <sect2 id="Benutzer-anlegen">
1157 <title>Benutzer anlegen</title>
1159 <para>Beim Anlegen von Benutzern werden für viele Parameter
1160 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1161 deutschen Raumes entsprechen.</para>
1163 <para>Zwingend anzugeben sind der Loginname sowie die komplette
1164 Datenbankkonfiguration. Wenn die Passwortauthentifizierung über die
1165 Datenbank eingestellt ist, so kann hier auch das Benutzerpasswort
1166 gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung
1167 aktiv, so ist das Passwort-Feld deaktiviert.</para>
1169 <para>In der Datenbankkonfiguration müssen die Zugriffsdaten einer der
1170 eben angelegten Datenbanken eingetragen werden.</para>
1173 <sect2 id="Gruppenmitgliedschaften-verwalten">
1174 <title>Gruppenmitgliedschaften verwalten</title>
1176 <para>Nach dem Anlegen von Benutzern und Gruppen müssen Benutzer den
1177 Gruppen zugewiesen werden. Dazu gibt es zwei Möglichkeiten:</para>
1179 <orderedlist numeration="arabic">
1181 <para>In der Gruppenverwaltung wählt man eine Gruppe aus. Im
1182 folgenden Dialog kann man dann einzeln die Benutzer der Gruppe
1187 <para>In der Gruppenverwaltung wählt man das Tool zur Verwaltung
1188 der Gruppenmitgliedschaft. Hier wird eine Matrix angezeigt, die
1189 alle im System angelegten Gruppen und Benutzer enthält. Durch
1190 Setzen der Häkchen wird der Benutzer in der ausgewählten Zeile der
1191 Gruppe in der ausgewählten Spalte hinzugefügt.</para>
1196 <sect2 id="Migration-alter-Installationen">
1197 <title>Migration alter Installationen</title>
1199 <para>Wenn kivitendo 2.6.3 über eine ältere Version installiert wird,
1200 in der die Benutzerdaten noch im Dateisystem im Verzeichnis
1201 <literal>users</literal> verwaltet wurden, so bietet kivitendo die
1202 Möglichkeit, diese Benutzerdaten automatisch in die
1203 Authentifizierungsdatenbank zu übernehmen. Dies geschieht, wenn man
1204 sich nach dem Update der Installation das erste Mal im
1205 Administrationsbereich anmeldet. Findet kivitendo die Datei
1206 <literal>users/members</literal>, so wird der Migrationsprozess
1209 <para>Der Migrationsprozess ist nahezu vollautomatisch. Alle
1210 Benutzerdaten können übernommen werden. Nach den Benutzerdaten bietet
1211 kivitendo noch die Möglichkeit an, dass automatisch eine
1212 Benutzergruppe angelegt wird. Dieser Gruppe wird Zugriff auf alle
1213 Funktionen von kivitendo gewährt. Alle migrierten Benutzern werden
1214 Mitglied in dieser Gruppe. Damit wird das Verhalten von kivitendo bis
1215 Version 2.4.3 inklusive wiederhergestellt, und die Benutzer können
1216 sich sofort wieder anmelden und mit dem System arbeiten.</para>
1220 <sect1 id="config.sending-email" xreflabel="E-Mail-Versand aus kivitendo heraus">
1221 <title>E-Mail-Versand aus kivitendo heraus</title>
1223 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden, z.B. um ein Angebot direkt an einen Kunden zu
1224 verschicken. Damit dies funktioniert, muss eingestellt werden, über welchen Server die E-Mails verschickt werden sollen. kivitendo
1225 unterstützt dabei zwei Mechanismen: Versand über einen lokalen E-Mail-Server (z.B. mit <productname>Postfix</productname> oder
1226 <productname>Exim</productname>, was auch die standardmäßig aktive Methode ist) sowie Versand über einen SMTP-Server (z.B. der des
1227 eigenen Internet-Providers).</para>
1229 <para>Welche Methode und welcher Server verwendet werden, wird über die Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1230 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1232 <sect2 id="config.sending-email.sendmail" xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1233 <title>Versand über lokalen E-Mail-Server</title>
1235 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie
1236 z.B. <productname>Postfix</productname>, <productname>Exim</productname> oder <productname>Sendmail</productname> läuft.</para>
1238 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1239 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1241 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet wird, dient der Parameter '<literal>sendmail =
1242 ...</literal>'. Der Standardwert verweist auf das Programm <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1243 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1245 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen dieses sprengen. Hierfür sei auf die Dokumentation des
1246 E-Mail-Servers verwiesen.</para>
1249 <sect2 id="config.sending-email.smtp" xreflabel="E-Mail-Versand über einen SMTP-Server">
1250 <title>Versand über einen SMTP-Server</title>
1252 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server vorhanden oder zwar einer vorhanden, dieser aber nicht
1253 konfiguriert ist.</para>
1255 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1256 Parameter dienen dabei der weiteren Konfiguration:</para>
1260 <term><varname>hostname</varname></term>
1262 <listitem><para>Name oder IP-Adresse des SMTP-Servers. Standardwert: '<literal>localhost</literal>'</para></listitem>
1266 <term><varname>port</varname></term>
1268 <listitem><para>Portnummer. Der Standardwert hängt von der verwendeten Verschlüsselungsmethode ab. Gilt '<literal>security =
1269 none</literal>' oder '<literal>security = tls</literal>', so ist 25 die Standardportnummer. Für '<literal>security =
1270 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht geändert werden.</para></listitem>
1274 <term><varname>security</varname></term>
1276 <listitem><para>Wahl der zu verwendenden Verschlüsselung der Verbindung mit dem Server. Standardwert ist
1277 '<literal>none</literal>', wodurch keine Verschlüsselung verwendet wird. Mit '<literal>tls</literal>' wird TLS-Verschlüsselung
1278 eingeschaltet, und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL eingeschaltet. Achtung: Für
1279 '<literal>tls</literal>' und '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt (siehe unten).</para></listitem>
1283 <term><varname>login</varname> und <varname>password</varname></term>
1285 <listitem><para>Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername
1286 und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von
1287 Verschlüsselung aktiviert werden.</para></listitem>
1291 <para>Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind:</para>
1294 <listitem><para>TLS-Verschlüsselung: Modul <literal>Net::SSLGlue</literal> (Debian-Paketname
1295 <literal>libnet-sslglue-perl</literal>, Fedora Core: <literal>perl-Net-SSLGlue</literal>, openSuSE:
1296 <literal>perl-Net-SSLGlue</literal></para></listitem>
1298 <listitem><para>SSL-Verschlüsselung: Modul <literal>Net::SMTP::SSL</literal> (Debian-Paketname
1299 <literal>libnet-smtp-ssl-perl</literal>, Fedora Core: <literal>perl-Net-SMTP-SSL</literal>, openSuSE:
1300 <literal>perl-Net-SMTP-SSL</literal></para></listitem>
1305 <sect1 id="Drucken-mit-kivitendo">
1306 <title>Drucken mit kivitendo</title>
1308 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX Vorlagen.
1309 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1310 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1311 Debianoiden Betriebssystemen sind das die Pakete:</para>
1313 <para><literal>texlive-latex-base texlive-latex-extra
1314 texlive-fonts-recommended</literal></para>
1316 <para>Diese hinteren beiden enthalten Bibliotheken und Schriftarten die
1317 von den Standardvorlagen verwendet werden.</para>
1319 <para>TODO: rpm Pakete.</para>
1321 <para>In den allermeisten Installationen sollte drucken jetzt schon
1322 funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
1323 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
1324 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1329 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1330 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1331 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1336 <para>! Package inputenc Error: Unicode char \u8:æ¡
\9c not set up for
1337 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1338 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1339 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1340 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1341 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1345 <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
1346 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1347 Prüfen Sie den Namen in der Konfiguration (Standard:
1348 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1349 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1353 <sect1 id="OpenDocument-Vorlagen">
1354 <title>OpenDocument-Vorlagen</title>
1356 <para>kivitendo unterstützt die Verwendung von Vorlagen im
1357 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1358 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1359 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1360 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1361 <filename>config/kivitendo.conf</filename> die Variable
1362 <literal>opendocument</literal> im Abschnitt
1363 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1364 Dieses ist die Standardeinstellung.</para>
1366 <para>Weiterhin muss in der Datei
1367 <filename>config/kivitendo.conf</filename> die Variable
1368 <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf
1369 die Zeichenkodierung gesetzt werden, die auch bei der Speicherung der
1370 Daten in der Datenbank verwendet wird. Diese ist in den meisten Fällen
1373 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1374 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1375 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1376 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1377 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1378 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1380 <para>Nach der Installation müssen in der Datei
1381 <filename>config/kivitendo.conf</filename> zwei weitere Variablen
1382 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1383 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1384 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1385 enthalten. Beide stehen im Abschnitt
1386 <literal>applications</literal>.</para>
1388 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
1389 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1390 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1391 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1392 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1393 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1394 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1395 werden muss. Der Nachteil ist, dass diese Methode Python und die
1396 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1399 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1400 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1401 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1402 Dokumentenvorlage enthalten sein und
1403 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1404 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1405 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1406 ebenfalls enthalten sein muss.</para>
1408 <para>Als letztes muss herausgefunden werden, welchen Namen
1409 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1410 gibt. Unter Debian ist dies momentan
1411 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1412 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1413 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1414 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1415 folgender Befehl auszuführen:</para>
1417 <para><literal>mv users/.openoffice.org2
1418 users/.openoffice</literal></para>
1420 <para>Dieses Verzeichnis, wie auch das komplette
1421 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1422 sein. Dieses wurde bereits erledigt (siehe <xref
1423 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1424 erneut überprüft werden, wenn die Konvertierung nach PDF
1428 <sect1 id="config.eur">
1429 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1432 <sect2 id="config.eur.introduction"
1433 xreflabel="Einführung in die Konfiguration zur EUR">
1434 <title>Einführung</title>
1436 <para>kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1437 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals noch <filename>config/lx_office.conf</filename>)
1438 befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden.</para>
1440 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1441 die Mandantendatenbank verschoben und dabei auch gleich in drei
1442 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1443 steuern lässt.</para>
1446 <sect2 id="config.eur.parameters"
1447 xreflabel="Konfigurationsparameter für EUR">
1448 <title>Konfigurationsparameter</title>
1450 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1451 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1455 <term><varname>profit_determination</varname></term>
1458 <para>Dieser Parameter legt die Berechnungsmethode für die
1459 Gewinnermittlung fest. Er enthält entweder
1460 <literal>balance</literal> für
1461 Betriebsvermögensvergleich/Bilanzierung oder
1462 <literal>income</literal> für die
1463 Einnahmen-Überschuss-Rechnung.</para>
1468 <term><varname>accounting_method</varname></term>
1471 <para>Dieser Parameter steuert die Buchungs- und
1472 Berechnungsmethoden für die Versteuerungsart. Er enthält
1473 entweder <literal>accrual</literal> für die Soll-Versteuerung
1474 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1479 <term><varname>inventory_system</varname></term>
1482 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1483 enthält entweder <literal>perpetual</literal> für die
1484 Bestandsmethode oder <literal>periodic</literal> für die
1485 Aufwandsmethode.</para>
1490 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1491 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1492 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1493 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1494 Bestandsmethode.</para>
1496 <para>Die Konfiguration "<varname>eur</varname>" unter
1497 <varname>[system]</varname> in der <link
1498 linkend="config.config-file">Konfigurationsdatei</link>
1499 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
1500 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1503 <sect2 id="config.eur.setting-parameters">
1504 <title>Festlegen der Parameter</title>
1506 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1507 der Admininstration können diese Optionen nun unabhängig voneinander
1508 eingestellt werden.</para>
1510 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1511 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1514 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1515 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
1516 angezeigt. Unter <guimenu>System</guimenu>
1517 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> können
1518 die Einstellungen auch geändert werden. Dabei ist zu beachten,
1519 dass eine Änderung vorhandene Daten so belässt und damit
1520 evtl. die Ergebnisse verfälscht. Dies gilt vor Allem für die
1521 Warenbuchungsmethode (siehe auch
1522 <link linkend="config.eur.inventory-system-perpetual">
1523 Bemerkungen zu Bestandsmethode</link>).</para>
1526 <sect2 id="config.eur.inventory-system-perpetual">
1527 <title>Bemerkungen zu Bestandsmethode</title>
1529 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1530 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
1531 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1532 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1533 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1534 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1535 Einkaufsrechnungen berechnet wird.</para>
1537 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1538 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1539 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1543 <sect2 id="config.eur.knonw-issues">
1544 <title>Bekannte Probleme</title>
1546 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1547 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1548 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1549 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1550 die Konfigurationsvariable
1551 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1554 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1555 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1559 <sect1 id="config.skr04-update-3804">
1560 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1562 <sect2 id="config.skr04-update-3804.introduction">
1563 <title>Einführung</title>
1565 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1566 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1567 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1568 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1569 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1570 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1571 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1572 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1573 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1574 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1575 Screenshots dargestellt.</para>
1577 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1578 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1579 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1580 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1583 <sect2 id="config.skr04-update-3804.create-chart">
1584 <title>Konto 3804 manuell anlegen</title>
1586 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
1587 anzulegen und zu konfigurieren. Zuerst wird in
1588 <guimenu>System</guimenu> ->
1589 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
1590 erfassen</guimenuitem> das Konto angelegt.</para>
1593 <screeninfo>Konto 3804 erfassen</screeninfo>
1597 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
1603 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
1604 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
1605 wie im folgenden Screenshot angezeigt anpassen.
1609 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
1613 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
1619 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
1620 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
1624 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
1628 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
1634 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
1635 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
1636 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
1637 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
1641 <screeninfo>Konto 4315 anpassen</screeninfo>
1645 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
1651 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
1652 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
1656 <screeninfo>Steuerliste vergleichen</screeninfo>
1660 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
1667 <sect1 id="config.client">
1668 <title>Einstellungen pro Mandant</title>
1670 <para>Einige Einstellungen können von einem Benutzer mit dem
1671 <link linkend="Zusammenhänge">Recht</link> "Administration
1672 (Für die Verwaltung der aktuellen Instanz aus einem Userlogin heraus)"
1673 gemacht werden. Diese Einstellungen sind dann für die aktuellen
1674 Mandanten-Datenbank gültig. Die Einstellungen sind
1675 unter <guimenu>System</guimenu>
1676 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
1678 <para>Bitte beachten Sie die Hinweise zu den einzelnen
1679 Einstellungen. Einige Einstellungen sollten nicht ohne Weiteres
1680 im laufenden Betrieb geändert werden (siehe
1681 auch <link linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
1682 Bestandsmethode</link>).</para>
1684 <para>Die Einstellungen <literal>show_bestbefore</literal>
1685 und <literal>payments_changeable</literal> aus dem
1686 Abschnitt <literal>features</literal> und die Einstellungen im
1687 Abschnitt <literal>datev_check</literal> (sofern schon vorhanden)
1688 der <link linkend="config.config-file">kivitendo-Konfigurationsdatei</link>
1689 werden bei einem Datenbankupdate einer älteren Version automatisch
1690 übernommen. Diese Einträge können danach aus der Konfigurationsdatei
1691 entfernt werden.</para>
1694 <sect1 id="kivitendo-ERP-verwenden">
1695 <title>kivitendo ERP verwenden</title>
1697 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
1698 folgender URL erreichbar:</para>
1701 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
1703 <para>Die Administrationsseite erreichen Sie unter:</para>
1706 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
1710 <chapter id="features" xreflabel="Features und Funktionen">
1711 <title>Features und Funktionen</title>
1713 <sect1 id="features.periodic-invoices"
1714 xreflabel="Wiedekehrende Rechnungen">
1715 <title>Wiederkehrende Rechnungen</title>
1717 <sect2 id="features.periodic-invoices.introduction"
1718 xreflabel="Einführung in wiederkehrende Rechnungen">
1719 <title>Einführung</title>
1721 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
1722 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
1723 Die konfigurierten Aufträge werden später automatisch in Rechnungen
1724 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
1725 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
1726 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
1727 wiederzufinden sind.</para>
1730 <sect2 id="features.periodic-invoices.configuration"
1731 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
1732 <title>Konfiguration</title>
1734 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
1735 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
1736 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
1737 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
1738 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
1741 <para>Folgende Parameter kann man konfigurieren:</para>
1748 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
1749 erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
1750 neuen Monats).</para>
1752 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
1753 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
1754 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
1755 nächsten Periodenwechsel für alle Perioden, seit der letzten
1756 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
1757 verhindern, muss man vorher das Startdatum neu setzen.</para>
1759 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
1760 erstellt. Man kann sich diese Aufträge aber gesondert in den
1761 Berichten anzeigen lassen.</para>
1766 <term>Periodizität</term>
1769 <para>Ob monatlich, quartalsweise oder jährlich auf neue
1770 Rechnungen überprüft werden soll. Für jede Periode seit dem
1771 Startdatum wird überprüft, ob für die Periode (beginnend immer
1772 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
1773 wurde. Unter Umständen können bei einem Startdatum in der
1774 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
1779 <term>Buchen auf</term>
1782 <para>Das Forderungskonto, in der Regel "Forderungen aus
1783 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
1784 Buchungsgruppen der betreffenden Waren.</para>
1789 <term>Startdatum</term>
1792 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
1798 <term>Enddatum</term>
1801 <para>ab wann keine Rechnungen mehr erstellt werden
1807 <term>Automatische Verlängerung um x Monate</term>
1810 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
1811 eingetragenen Enddatums weiterhin erstellt werden, so kann man
1812 hier die Anzahl der Monate eingeben, um die das Enddatum
1813 automatisch nach hinten geschoben wird.</para>
1818 <term>Drucken</term>
1821 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
1822 Rechnungen auch gleich ausdrucken lassen.</para>
1827 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
1828 Informationen zu den erstellten Rechnungen verschickt werden.
1829 Konfiguriert wird dies in der <link
1830 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
1831 <filename>config/kivitendo.conf</filename> im Abschnitt
1832 <varname>[periodic_invoices]</varname>.</para>
1835 <sect2 id="features.periodic-invoices.reports">
1836 <title>Auflisten</title>
1838 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
1839 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
1840 Rechnungen inaktiv", mit denen man sich einen Überglick über die
1841 wiederkehrenden Rechnungen verschaffen kann.</para>
1844 <sect2 id="features.periodic-invoices.task-server">
1845 <title>Erzeugung der eigentlichen Rechnungen</title>
1847 <para>Die zeitliche und periodische Überprüfung, ob eine
1848 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
1849 durch den <link linkend="config.task-server">Taskserver</link>, einen
1850 externen Dienst, der automatisch beim Start des Servers gestartet
1851 werden sollte.</para>
1854 <sect2 id="features.periodic-invoices.create-for-current-month">
1855 <title>Erste Rechnung für aktuellen Monat erstellen</title>
1857 <para>Will man im laufenden Monat eine monatlich wiederkehrende
1858 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
1859 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
1860 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
1861 generiert hat. Alternativ setzt man das Startdatum auf den
1862 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
1863 manuell über den Workflow.</para>
1867 <sect1 id="dokumentenvorlagen-und-variablen">
1868 <title>Dokumentenvorlagen und verfügbare Variablen</title>
1870 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
1871 <title>Einführung</title>
1873 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
1874 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
1875 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
1876 <function><%variablenname%></function> verwendet wird. Für
1877 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
1879 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
1881 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
1882 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
1883 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
1884 alle Vorlagenarten.</para>
1886 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
1887 verfügbar als hier aufgelistet werden. Die meisten davon können
1888 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
1889 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
1890 diese wie folgt erhalten werden:</para>
1894 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
1895 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
1899 <para>In <filename>Form.pm</filename> die Funktion
1900 <function>parse_template</function> suchen und hier die Zeile
1901 <command>print(STDERR Dumper($self));</command> einfügen.</para>
1905 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
1906 ein PDF für eine Rechnung erzeugen.</para>
1910 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
1911 der Variablen <varname>$self</varname> in der Form <varname>'key'
1912 => 'value',</varname>. Alle <varname>key</varname>s sind
1918 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
1919 <title>Variablen ausgeben</title>
1921 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
1922 Tags geschrieben werden, also z.B.
1923 <varname><%variablenname%></varname>.</para>
1925 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
1926 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
1927 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
1928 werden die folgenden Flags unterstützt:</para>
1932 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
1933 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
1934 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
1935 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
1939 <para><option>NOESCAPE</option> unterdrückt das Escapen von
1940 Sonderzeichen für die Vorlagensprache. Wenn also in einer
1941 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
1942 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
1943 ist dieses Flag sinnvoll.</para>
1947 <para>Beispiel:</para>
1949 <programlisting><%quototal NOFORMAT%></programlisting>
1952 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
1953 <title>Verwendung in Druckbefehlen</title>
1955 <para>In der Admininstration können Drucker definiert werden. Auch im
1956 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
1957 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
1958 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
1959 <function>`...`</function> nicht zu unerwünschtem Verhalten
1962 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
1963 für das die Telefonnummer eines Ansprechpartners als Teil der
1964 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
1965 z.B. wie folgt aussehen:</para>
1967 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
1970 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
1971 xreflabel="Anfang und Ende der Tags verändern">
1972 <title>Anfang und Ende der Tags verändern</title>
1974 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
1975 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
1976 Prozentzeichen und dem Größerzeichen endet, beispielsweise
1977 <function><%customer%></function>. Da diese Form aber z.B. in
1978 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
1979 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
1980 Stil umgestellt werden.</para>
1982 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
1983 Format gültigen Kommentarzeichen anfangen, dann
1984 <function>config:</function> enthalten, die entsprechende Option
1985 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
1986 enden. Beispiel für LaTeX:</para>
1988 <programlisting>% config: tag-style=($ $)</programlisting>
1990 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
1991 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
1992 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
1994 <programlisting><!-- config: tag-style=($ $) --></programlisting>
1997 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
1998 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
2000 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
2001 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
2002 "<filename>.ext</filename>" geeignet zu ersetzen:
2003 "<filename>.tex</filename>" für LaTeX-Vorlagen und
2004 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
2008 <term><filename>bin_list.ext</filename></term>
2011 <para>Lagerliste</para>
2016 <term><filename>check.ext</filename></term>
2024 <term><filename>invoice.ext</filename></term>
2027 <para>Rechnung</para>
2032 <term><filename>packing_list.ext</filename></term>
2035 <para>Packliste</para>
2040 <term><filename>pick_list.ext</filename></term>
2043 <para>Sammelliste</para>
2048 <term><filename>purchase_delivery_order.ext</filename></term>
2051 <para>Lieferschein (Einkauf)</para>
2056 <term><filename>purcharse_order.ext</filename></term>
2059 <para>Bestellung an Lieferanten</para>
2064 <term><filename>request_quotation.ext</filename></term>
2067 <para>Anfrage an Lieferanten</para>
2072 <term><filename>sales_delivery_order.ext</filename></term>
2075 <para>Lieferschein (Verkauf)</para>
2080 <term><filename>sales_order.ext</filename></term>
2083 <para>Bestellung</para>
2088 <term><filename>sales_quotation.ext</filename></term>
2091 <para>Angebot an Kunden</para>
2096 <term><filename>zahlungserinnerung.ext</filename></term>
2099 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2104 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2107 <para>Rechnung über Mahngebühren (Dateiname im Programm
2108 konfigurierbar)</para>
2114 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2115 <title>Sprache, Drucker und E-Mail</title>
2117 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2118 eingearbeitet. So wird aus der Vorlage
2119 <filename>sales_order.ext</filename> bei Sprache
2120 <function>de</function> und Druckerkürzel <function>lpr2</function>
2121 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2122 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2123 bekommen dann noch das Kürzel <filename>_email</filename>, der
2124 vollständige Vorlagenname wäre dann
2125 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2126 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2127 werden. Diese wird verwendet, wenn keine der anderen Varianten
2128 gefunden wird.</para>
2130 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2131 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2132 verschickt wird, ist:</para>
2136 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2140 <para><filename>sales_order_de_lpr2.tex</filename></para>
2144 <para><filename>sales_order.tex</filename></para>
2148 <para><filename>default.tex</filename></para>
2152 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2153 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2155 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2158 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2159 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2162 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2163 xreflabel="Metainformationen zur angeforderten Vorlage">
2164 <title>Metainformationen zur angeforderten Vorlage</title>
2166 <para>Diese Variablen liefern Informationen darüber welche Variante
2167 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2168 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2169 Formulare einbinden möchten.</para>
2173 <term><varname>template_meta.formname</varname></term>
2176 <para>Basisname der Vorlage. Identisch mit der <link
2177 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2178 zu den Dateinamen</link> ohne die Erweiterung. Ein
2179 Verkaufsauftrag enthält hier
2180 <constant>sales_order</constant>.</para>
2185 <term><varname>template_meta.language.description</varname></term>
2188 <para>Beschreibung der verwendeten Sprache</para>
2193 <term><varname>template_meta.language.template_code</varname></term>
2196 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2197 Kürzel das im Dateinamen verwendetet wird.</para>
2202 <term><varname>template_meta.language.output_numberformat</varname></term>
2205 <para>Zahlenformat der verwendeten Sprache in der Form
2206 "<constant>1.000,00</constant>". Experimentell! Nur
2207 interessant für Vorlagen die mit unformatierten Werten
2213 <term><varname>template_meta.language.output_dateformat</varname></term>
2216 <para>Datumsformat der verwendeten Sprache in der Form
2217 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2218 interessant für Vorlagen die mit unformatierten Werten
2224 <term><varname>template_meta.format</varname></term>
2227 <para>Das angeforderte Format. Kann im Moment die Werte
2228 <constant>pdf</constant>, <constant>postscript</constant>,
2229 <constant>html</constant>, <constant>opendocument</constant>,
2230 <constant>opendocument_pdf</constant> und
2231 <constant>excel</constant> enthalten.</para>
2236 <term><varname>template_meta.extension</varname></term>
2239 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2240 <constant>format</constant> entschieden.</para>
2245 <term><varname>template_meta.media</varname></term>
2248 <para>Ausgabemedium. Kann zur Zeit die Werte
2249 <constant>screen</constant> für Bildschirm,
2250 <constant>email</constant> für E-Mmail (triggert das
2251 <constant>_email</constant> Kürzel im Dateinamen),
2252 <constant>printer</constant> für Drucker, und
2253 <constant>queue</constant> für Warteschlange enthalten.</para>
2258 <term><varname>template_meta.printer.description</varname></term>
2261 <para>Beschreibung des ausgewählten Druckers</para>
2266 <term><varname>template_meta.printer.template_code</varname></term>
2269 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2270 dem Kürzel das im Dateinamen verwendetet wird.</para>
2275 <term><varname>template_meta.tmpfile</varname></term>
2278 <para>Datei-Prefix für temporäre Dateien.</para>
2284 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2285 <title>Stammdaten von Kunden und Lieferanten</title>
2289 <term><varname>account_number</varname></term>
2292 <para>Kontonummer</para>
2297 <term><varname>bank</varname></term>
2300 <para>Name der Bank</para>
2305 <term><varname>bank_code</varname></term>
2308 <para>Bankleitzahl</para>
2313 <term><varname>bic</varname></term>
2316 <para>Bank-Identifikations-Code (Bank Identifier Code,
2322 <term><varname>business</varname></term>
2325 <para>Kunden-/Lieferantentyp</para>
2330 <term><varname>city</varname></term>
2338 <term><varname>contact</varname></term>
2341 <para>Kontakt</para>
2346 <term><varname>country</varname></term>
2354 <term><varname>cp_email</varname></term>
2357 <para>Email des Ansprechpartners</para>
2362 <term><varname>cp_givenname</varname></term>
2365 <para>Vorname des Ansprechpartners</para>
2370 <term><varname>cp_greeting</varname></term>
2373 <para>Anrede des Ansprechpartners</para>
2378 <term><varname>cp_name</varname></term>
2381 <para>Name des Ansprechpartners</para>
2386 <term><varname>cp_phone1</varname></term>
2389 <para>Telefonnummer 1 des Ansprechpartners</para>
2394 <term><varname>cp_phone2</varname></term>
2397 <para>Telefonnummer 2 des Ansprechpartners</para>
2402 <term><varname>cp_title</varname></term>
2405 <para>Titel des Ansprechpartners</para>
2410 <term><varname>creditlimit</varname></term>
2413 <para>Kreditlimit</para>
2418 <term><varname>customeremail</varname></term>
2421 <para>Email des Kunden; nur für Kunden</para>
2426 <term><varname>customerfax</varname></term>
2429 <para>Faxnummer des Kunden; nur für Kunden</para>
2434 <term><varname>customernotes</varname></term>
2437 <para>Bemerkungen beim Kunden; nur für Kunden</para>
2442 <term><varname>customernumber</varname></term>
2445 <para>Kundennummer; nur für Kunden</para>
2450 <term><varname>customerphone</varname></term>
2453 <para>Telefonnummer des Kunden; nur für Kunden</para>
2458 <term><varname>discount</varname></term>
2466 <term><varname>email</varname></term>
2469 <para>Emailadresse</para>
2474 <term><varname>fax</varname></term>
2477 <para>Faxnummer</para>
2482 <term><varname>homepage</varname></term>
2485 <para>Homepage</para>
2490 <term><varname>iban</varname></term>
2493 <para>Internationale Kontonummer (International Bank Account
2494 Number, IBAN)</para>
2499 <term><varname>language</varname></term>
2502 <para>Sprache</para>
2507 <term><varname>name</varname></term>
2510 <para>Firmenname</para>
2515 <term><varname>payment_description</varname></term>
2518 <para>Name der Zahlart</para>
2523 <term><varname>payment_terms</varname></term>
2526 <para>Zahlungskonditionen</para>
2531 <term><varname>phone</varname></term>
2534 <para>Telefonnummer</para>
2539 <term><varname>shiptocity</varname></term>
2542 <para>Stadt (Lieferadresse) <link
2543 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2548 <term><varname>shiptocontact</varname></term>
2551 <para>Kontakt (Lieferadresse) <link
2552 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2557 <term><varname>shiptocountry</varname></term>
2560 <para>Land (Lieferadresse) <link
2561 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2566 <term><varname>shiptodepartment1</varname></term>
2569 <para>Abteilung 1 (Lieferadresse) <link
2570 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2575 <term><varname>shiptodepartment2</varname></term>
2578 <para>Abteilung 2 (Lieferadresse) <link
2579 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2584 <term><varname>shiptoemail</varname></term>
2587 <para>Email (Lieferadresse) <link
2588 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2593 <term><varname>shiptofax</varname></term>
2596 <para>Fax (Lieferadresse) <link
2597 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2602 <term><varname>shiptoname</varname></term>
2605 <para>Firmenname (Lieferadresse) <link
2606 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2611 <term><varname>shiptophone</varname></term>
2614 <para>Telefonnummer (Lieferadresse) <link
2615 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2620 <term><varname>shiptostreet</varname></term>
2623 <para>Straße und Hausnummer (Lieferadresse) <link
2624 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2629 <term><varname>shiptozipcode</varname></term>
2632 <para>Postleitzahl (Lieferadresse) <link
2633 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2638 <term><varname>street</varname></term>
2641 <para>Straße und Hausnummer</para>
2646 <term><varname>taxnumber</varname></term>
2649 <para>Steuernummer</para>
2654 <term><varname>ustid</varname></term>
2657 <para>Umsatzsteuer-Identifikationsnummer</para>
2662 <term><varname>vendoremail</varname></term>
2665 <para>Email des Lieferanten; nur für Lieferanten</para>
2670 <term><varname>vendorfax</varname></term>
2673 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
2678 <term><varname>vendornotes</varname></term>
2681 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
2686 <term><varname>vendornumber</varname></term>
2689 <para>Lieferantennummer; nur für Lieferanten</para>
2694 <term><varname>vendorphone</varname></term>
2697 <para>Telefonnummer des Lieferanten; nur für
2703 <term><varname>zipcode</varname></term>
2706 <para>Postleitzahl</para>
2711 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
2712 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
2713 Stammdaten nicht eingetragen, so haben die Variablen
2714 <varname>shipto*</varname> den gleichen Wert wie die die
2715 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
2716 einige <varname>shipto*</varname>-Variablen so nicht in den
2717 Stammdaten wiederfinden sondern schlicht Kopien der
2718 Lieferdatenvariablen sind (z.B.
2719 <varname>shiptocontact</varname>).</para>
2723 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
2724 <title>Informationen über den Bearbeiter</title>
2728 <term><varname>employee_address</varname></term>
2731 <para>Adressfeld</para>
2736 <term><varname>employee_businessnumber</varname></term>
2739 <para>Firmennummer</para>
2744 <term><varname>employee_company</varname></term>
2747 <para>Firmenname</para>
2752 <term><varname>employee_co_ustid</varname></term>
2755 <para>Usatzsteuer-Identifikationsnummer</para>
2760 <term><varname>employee_duns</varname></term>
2763 <para>DUNS-Nummer</para>
2768 <term><varname>employee_email</varname></term>
2776 <term><varname>employee_fax</varname></term>
2784 <term><varname>employee_name</varname></term>
2787 <para>voller Name</para>
2792 <term><varname>employee_signature</varname></term>
2795 <para>Signatur</para>
2800 <term><varname>employee_taxnumber</varname></term>
2803 <para>Steuernummer</para>
2808 <term><varname>employee_tel</varname></term>
2811 <para>Telefonnummer</para>
2817 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
2818 <title>Informationen über den Bearbeiter</title>
2822 <term><varname>salesman_address</varname></term>
2825 <para>Adressfeld</para>
2830 <term><varname>salesman_businessnumber</varname></term>
2833 <para>Firmennummer</para>
2838 <term><varname>salesman_company</varname></term>
2841 <para>Firmenname</para>
2846 <term><varname>salesman_co_ustid</varname></term>
2849 <para>Usatzsteuer-Identifikationsnummer</para>
2854 <term><varname>salesman_duns</varname></term>
2857 <para>DUNS-Nummer</para>
2862 <term><varname>salesman_email</varname></term>
2870 <term><varname>salesman_fax</varname></term>
2878 <term><varname>salesman_name</varname></term>
2881 <para>voller Name</para>
2886 <term><varname>salesman_signature</varname></term>
2889 <para>Signatur</para>
2894 <term><varname>salesman_taxnumber</varname></term>
2897 <para>Steuernummer</para>
2902 <term><varname>salesman_tel</varname></term>
2905 <para>Telefonnummer</para>
2911 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
2912 <title>Variablen für die einzelnen Steuern</title>
2916 <term><varname>tax</varname></term>
2924 <term><varname>taxbase</varname></term>
2927 <para>zu versteuernder Betrag</para>
2932 <term><varname>taxdescription</varname></term>
2935 <para>Name der Steuer</para>
2940 <term><varname>taxrate</varname></term>
2943 <para>Steuersatz</para>
2950 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
2951 <title>Variablen in Rechnungen</title>
2953 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
2954 <title>Allgemeine Variablen</title>
2958 <term><varname>creditremaining</varname></term>
2961 <para>Verbleibender Kredit</para>
2966 <term><varname>currency</varname></term>
2969 <para>Währung</para>
2974 <term><varname>cusordnumber</varname></term>
2977 <para>Bestellnummer beim Kunden</para>
2982 <term><varname>deliverydate</varname></term>
2985 <para>Lieferdatum</para>
2990 <term><varname>duedate</varname></term>
2993 <para>Fälligkeitsdatum</para>
2998 <term><varname>globalprojectnumber</varname></term>
3001 <para>Projektnummer des ganzen Beleges</para>
3006 <term><varname>globalprojectdescription</varname></term>
3009 <para>Projekbeschreibung des ganzen Beleges</para>
3014 <term><varname>intnotes</varname></term>
3017 <para>Interne Bemerkungen</para>
3022 <term><varname>invdate</varname></term>
3025 <para>Rechnungsdatum</para>
3030 <term><varname>invnumber</varname></term>
3033 <para>Rechnungsnummer</para>
3038 <term><varname>invtotal</varname></term>
3041 <para>gesamter Rechnungsbetrag</para>
3046 <term><varname>notes</varname></term>
3049 <para>Bemerkungen der Rechnung</para>
3054 <term><varname>orddate</varname></term>
3057 <para>Auftragsdatum</para>
3062 <term><varname>ordnumber</varname></term>
3065 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3066 erstellt wurde</para>
3071 <term><varname>payment_description</varname></term>
3074 <para>Name der Zahlart</para>
3079 <term><varname>payment_terms</varname></term>
3082 <para>Zahlungskonditionen</para>
3087 <term><varname>quodate</varname></term>
3090 <para>Angebotsdatum</para>
3095 <term><varname>quonumber</varname></term>
3098 <para>Angebotsnummer</para>
3103 <term><varname>shippingpoint</varname></term>
3106 <para>Versandort</para>
3111 <term><varname>shipvia</varname></term>
3114 <para>Transportmittel</para>
3119 <term><varname>subtotal</varname></term>
3122 <para>Zwischensumme aller Posten ohne Steuern</para>
3127 <term><varname>total</varname></term>
3130 <para>Restsumme der Rechnung (Summe abzüglich bereits
3131 bezahlter Posten)</para>
3136 <term><varname>transaction_description</varname></term>
3139 <para>Vorgangsbezeichnung</para>
3144 <term><varname>transdate</varname></term>
3147 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3148 erstellt wurde</para>
3154 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3155 <title>Variablen für jeden Posten auf der Rechnung</title>
3159 <term><varname>bin</varname></term>
3162 <para>Stellage</para>
3167 <term><varname>description</varname></term>
3170 <para>Artikelbeschreibung</para>
3175 <term><varname>discount</varname></term>
3178 <para>Rabatt als Betrag</para>
3183 <term><varname>discount_sub</varname></term>
3186 <para>Zwischensumme mit Rabatt</para>
3191 <term><varname>drawing</varname></term>
3194 <para>Zeichnung</para>
3199 <term><varname>ean</varname></term>
3202 <para>EAN-Code</para>
3207 <term><varname>image</varname></term>
3215 <term><varname>linetotal</varname></term>
3218 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3223 <term><varname>longdescription</varname></term>
3226 <para>Langtext</para>
3231 <term><varname>microfiche</varname></term>
3234 <para>Mikrofilm</para>
3239 <term><varname>netprice</varname></term>
3242 <para>Nettopreis</para>
3247 <term><varname>nodiscount_linetotal</varname></term>
3250 <para>Zeilensumme ohne Rabatt</para>
3255 <term><varname>nodiscount_sub</varname></term>
3258 <para>Zwischensumme ohne Rabatt</para>
3263 <term><varname>number</varname></term>
3266 <para>Artikelnummer</para>
3271 <term><varname>ordnumber_oe</varname></term>
3274 <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
3275 aus einem Sammelauftrag erstellt wurde</para>
3280 <term><varname>p_discount</varname></term>
3283 <para>Rabatt in Prozent</para>
3288 <term><varname>partnotes</varname></term>
3291 <para>Die beim Artikel gespeicherten Bemerkungen</para>
3296 <term><varname>partsgroup</varname></term>
3299 <para>Warengruppe</para>
3304 <term><varname>price_factor</varname></term>
3307 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
3313 <term><varname>price_factor_name</varname></term>
3316 <para>Der Name des Preisfaktors, sofern einer eingestellt
3322 <term><varname>projectnumber</varname></term>
3325 <para>Projektnummer</para>
3330 <term><varname>projectdescription</varname></term>
3333 <para>Projektbeschreibung</para>
3338 <term><varname>qty</varname></term>
3346 <term><varname>reqdate</varname></term>
3349 <para>Lieferdatum</para>
3354 <term><varname>runningnumber</varname></term>
3357 <para>Position auf der Rechnung (1, 2, 3...)</para>
3362 <term><varname>sellprice</varname></term>
3365 <para>Verkaufspreis</para>
3370 <term><varname>serialnumber</varname></term>
3373 <para>Seriennummer</para>
3378 <term><varname>tax_rate</varname></term>
3381 <para>Steuersatz</para>
3386 <term><varname>transdate_oe</varname></term>
3389 <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
3390 aus einem Sammelauftrag erstellt wurde</para>
3395 <term><varname>unit</varname></term>
3398 <para>Einheit</para>
3403 <term><varname>weight</varname></term>
3406 <para>Gewicht</para>
3411 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
3412 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
3413 einer <function>foreach</function>-Schleife ausgegeben werden, da
3414 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
3415 können. Die Variablen dafür lauten:</para>
3419 <term><varname>make</varname></term>
3422 <para>Lieferant</para>
3427 <term><varname>model</varname></term>
3430 <para>Lieferantenartikelnummer</para>
3436 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
3437 <title>Variablen für die einzelnen Zahlungseingänge</title>
3441 <term><varname>payment</varname></term>
3449 <term><varname>paymentaccount</varname></term>
3457 <term><varname>paymentdate</varname></term>
3465 <term><varname>paymentmemo</varname></term>
3473 <term><varname>paymentsource</varname></term>
3482 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
3483 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
3485 <para>Die vom Benutzer definierten Variablen für Kunden und
3486 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
3487 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
3488 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
3489 Variablennamen zusammen.</para>
3491 <para>Beispiel: Der Benutzer hat eine Variable namens
3492 <varname>number_of_employees</varname> definiert, die die Anzahl der
3493 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
3494 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
3499 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
3500 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
3502 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
3503 <title>Namen der Vorlagen</title>
3505 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
3506 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
3507 Erstellung einer Rechnung über die Mahngebühren und Zinsen
3508 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
3509 Vorlagenname für diese Mahnstufe mit dem Zusatz
3510 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
3511 für die ausgewählte Sprache und den ausgewählten Drucker
3515 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
3516 <title>Allgemeine Variablen in Mahnungen</title>
3518 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3519 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3520 Kunden stehen als Variablen <varname>name</varname>,
3521 <varname>street</varname>, <varname>zipcode</varname>,
3522 <varname>city</varname>, <varname>country</varname>,
3523 <varname>department_1</varname>, <varname>department_2</varname>,
3524 und <varname>email</varname> zur Verfügung.</para>
3526 <para>Weitere Variablen beinhalten:</para>
3530 <term><varname>dunning_date</varname></term>
3533 <para>Datum der Mahnung</para>
3538 <term><varname>dunning_duedate</varname></term>
3541 <para>Fälligkeitsdatum für diese Mahhnung</para>
3546 <term><varname>dunning_id</varname></term>
3549 <para>Mahnungsnummer</para>
3554 <term><varname>fee</varname></term>
3557 <para>Kummulative Mahngebühren</para>
3562 <term><varname>interest_rate</varname></term>
3565 <para>Zinssatz per anno in Prozent</para>
3570 <term><varname>total_amount</varname></term>
3573 <para>Gesamter noch zu zahlender Betrag als
3574 <function>fee</function> + <function>total_interest</function>
3575 + <function>total_open_amount</function></para>
3580 <term><varname>total_interest</varname></term>
3583 <para>Zinsen per anno über alle Rechnungen</para>
3588 <term><varname>total_open_amount</varname></term>
3591 <para>Summe über alle offene Beträge der Rechnungen</para>
3597 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
3598 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
3602 <term><varname>dn_amount</varname></term>
3605 <para>Rechnungssumme (brutto)</para>
3610 <term><varname>dn_duedate</varname></term>
3613 <para>Originales Fälligkeitsdatum der Rechnung</para>
3618 <term><varname>dn_dunning_date</varname></term>
3621 <para>Datum der Mahnung</para>
3626 <term><varname>dn_dunning_duedate</varname></term>
3629 <para>Fälligkeitsdatum der Mahnung</para>
3634 <term><varname>dn_fee</varname></term>
3637 <para>Kummulative Mahngebühr</para>
3642 <term><varname>dn_interest</varname></term>
3645 <para>Zinsen per anno für diese Rechnung</para>
3650 <term><varname>dn_invnumber</varname></term>
3653 <para>Rechnungsnummer</para>
3658 <term><varname>dn_linetotal</varname></term>
3661 <para>Noch zu zahlender Betrag (ergibt sich aus
3662 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
3663 + <varname>dn_interest</varname>)</para>
3668 <term><varname>dn_netamount</varname></term>
3671 <para>Rechnungssumme (netto)</para>
3676 <term><varname>dn_open_amount</varname></term>
3679 <para>Offener Rechnungsbetrag</para>
3684 <term><varname>dn_ordnumber</varname></term>
3687 <para>Bestellnummer</para>
3692 <term><varname>dn_transdate</varname></term>
3695 <para>Rechnungsdatum</para>
3700 <term><varname>dn_curr</varname></term>
3703 <para>Währung, in der die Rechnung erstellt wurde. (Die
3704 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
3710 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
3711 <title>Variablen in automatisch erzeugten Rechnungen über
3712 Mahngebühren</title>
3714 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3715 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3716 Kunden stehen als Variablen <varname>name</varname>,
3717 <varname>street</varname>, <varname>zipcode</varname>,
3718 <varname>city</varname>, <varname>country</varname>,
3719 <varname>department_1</varname>, <varname>department_2</varname>,
3720 und <varname>email</varname> zur Verfügung.</para>
3722 <para>Weitere Variablen beinhalten:</para>
3726 <term><varname>duedate</varname></term>
3729 <para>Fälligkeitsdatum der Rechnung</para>
3734 <term><varname>dunning_id</varname></term>
3737 <para>Mahnungsnummer</para>
3742 <term><varname>fee</varname></term>
3745 <para>Mahngebühren</para>
3750 <term><varname>interest</varname></term>
3758 <term><varname>invamount</varname></term>
3761 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
3762 <varname>interest</varname>)</para>
3767 <term><varname>invdate</varname></term>
3770 <para>Rechnungsdatum</para>
3775 <term><varname>invnumber</varname></term>
3778 <para>Rechnungsnummer</para>
3785 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
3786 <title>Variablen in anderen Vorlagen</title>
3789 <title>Einführung</title>
3791 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
3792 Rechnung. Allerdings heißen die Variablen, die mit
3793 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
3794 fangen sie mit <varname>quo</varname> für "quotation" an:
3795 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
3796 wiederum fangen sie mit <varname>ord</varname> für "order" an:
3797 <varname>ordnumber</varname> für Bestellnummer etc.</para>
3799 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
3800 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
3801 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
3802 Vorlage keine Bedeutung haben oder noch nicht belegt sein
3805 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
3806 in Rechnungen aufgeführt.</para>
3809 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
3810 <title>Angebote und Preisanfragen</title>
3814 <term><varname>quonumber</varname></term>
3817 <para>Angebots- bzw. Anfragenummer</para>
3822 <term><varname>reqdate</varname></term>
3825 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
3826 Preisanfragen)</para>
3831 <term><varname>transdate</varname></term>
3834 <para>Angebots- bzw. Anfragedatum</para>
3840 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
3841 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
3845 <term><varname>ordnumber</varname></term>
3848 <para>Auftragsnummer</para>
3853 <term><varname>reqdate</varname></term>
3856 <para>Lieferdatum</para>
3861 <term><varname>transdate</varname></term>
3864 <para>Auftragsdatum</para>
3870 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
3871 <title>Lieferscheine (Verkauf und Einkauf)</title>
3875 <term><varname>cusordnumber</varname></term>
3878 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
3879 des Lieferanten (im Einkauf)</para>
3884 <term><varname>donumber</varname></term>
3887 <para>Lieferscheinnummer</para>
3892 <term><varname>transdate</varname></term>
3895 <para>Lieferscheindatum</para>
3900 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
3901 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
3902 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
3903 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
3904 <function>foreach</function>-Schleife ausgegeben werden. Diese
3905 Variablen sind:</para>
3909 <term><varname>si_bin</varname></term>
3912 <para>Lagerplatz</para>
3917 <term><varname>si_chargenumber</varname></term>
3920 <para>Chargennummer</para>
3925 <term><varname>si_bestbefore</varname></term>
3928 <para>Mindesthaltbarkeit</para>
3933 <term><varname>si_number</varname></term>
3936 <para>Artikelnummer</para>
3941 <term><varname>si_qty</varname></term>
3944 <para>Anzahl bzw. Menge</para>
3949 <term><varname>si_runningnumber</varname></term>
3952 <para>Positionsnummer (1, 2, 3 etc)</para>
3957 <term><varname>si_unit</varname></term>
3960 <para>Einheit</para>
3965 <term><varname>si_warehouse</varname></term>
3974 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
3975 <title>Variablen für Sammelrechnung</title>
3979 <term><varname>c0total</varname></term>
3982 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
3988 <term><varname>c30total</varname></term>
3991 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
3992 und < 60 Tage</para>
3997 <term><varname>c60total</varname></term>
4000 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
4001 und < 90 Tage</para>
4006 <term><varname>c90total</varname></term>
4009 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
4015 <term><varname>total</varname></term>
4018 <para>Gesamtbetrag aller Rechnungen</para>
4023 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
4027 <term><varname>invnumber</varname></term>
4030 <para>Rechnungsnummer</para>
4035 <term><varname>invdate</varname></term>
4038 <para>Rechnungsdatum</para>
4043 <term><varname>duedate</varname></term>
4046 <para>Fälligkeitsdatum</para>
4051 <term><varname>amount</varname></term>
4054 <para>Summe der Rechnung</para>
4059 <term><varname>open</varname></term>
4062 <para>Noch offener Betrag der Rechnung</para>
4067 <term><varname>c0</varname></term>
4070 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4076 <term><varname>c30</varname></term>
4079 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4085 <term><varname>c60</varname></term>
4088 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4094 <term><varname>c90</varname></term>
4097 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4105 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4106 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4108 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4109 <title>Einfürhung</title>
4111 <para>Der Parser kennt neben den Variablen einige weitere
4112 Konstrukte, die gesondert behandelt werden. Diese sind wie
4113 Variablennamen in spezieller Weise markiert:
4114 <command><%anweisung%> ... <%end%></command></para>
4116 <para>Anmerkung zum <command><%end%></command>: Der besseren
4117 Verständlichkeit halber kann man nach dem <command>end</command>
4118 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4119 Anweisung (z.B. <command>if</command> oder
4120 <command>foreach</command>) damit abgeschlossen wird.</para>
4122 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4123 <command><%if type == "sales_quotation"%></command>, so könnte
4124 er mit <command><%end%></command> genauso abgeschlossen werden
4125 wie mit <command><%end if%></command> oder auch
4126 <command><%end type == "sales_quotation"%></command>.</para>
4129 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4130 <title>Der if-Block</title>
4132 <programlisting><%if variablenname%>
4134 <%end%></programlisting>
4136 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4137 und dem "end" werden nur ausgegeben, wenn die Variable
4138 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4140 <para>Die Bedingung kann auch negiert werden, indem das Wort
4141 <function>not</function> nach dem <filename>if</filename> verwendet
4142 wird. Beispiel:</para>
4144 <programlisting><%if not cp_greeting%>
4146 <%end%></programlisting>
4148 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4149 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4150 einer Variablen mit einer festen Zeichenkette oder einer anderen
4151 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4152 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4153 die rechte Seite des Vergleichsoperators in Anführungszeichen
4154 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4155 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4158 <programlisting><%if var1 == "Wert"%></programlisting>
4160 <para>Testet die Variable <varname>var1</varname> auf
4161 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4162 Mittels <function>!=</function> anstelle von <function>==</function>
4163 würde auf Ungleichheit getestet.</para>
4165 <programlisting><%if var1 == var2%></programlisting>
4167 <para>Testet die Variable <varname>var1</varname> auf
4168 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4169 <function>!=</function> anstelle von <function>==</function> würde
4170 auf Ungleichheit getestet.</para>
4172 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4173 auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
4174 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4175 dieselbe Syntax wie oben nur mit <function>=~</function> und
4176 <function>!~</function> als Vergleichsoperatoren.</para>
4178 <para>Beispiel für einen Test, ob die Variable
4179 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4180 <constant>schwierig</constant> enthält:</para>
4182 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4185 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4186 <title>Der foreach-Block</title>
4188 <programlisting><%foreach variablenname%>
4190 <%end%></programlisting>
4192 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4193 wie das Perl-Array der Variablen <varname>variablenname</varname>
4194 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4195 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4196 benutzt. In jedem Durchlauf werden die <link
4197 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4198 Variablen</link> jeweils auf den Wert für die aktuelle Position
4201 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
4203 <programlisting><%foreach number%>
4204 Position: <%runningnumber%>
4205 Anzahl: <%qty%>
4206 Artikelnummer: <%number%>
4207 Beschreibung: <%description%>
4209 <%end%></programlisting>
4211 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
4212 <function><%foreach%></function>-Block innerhalb einer
4213 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
4214 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
4215 Inhalt zwischen <function><%foreach%></function> und
4216 <function><%end%></function> wiederholt, nicht aber die
4217 komplette Zeile, in der er steht.</para>
4221 <sect2 id="dokumentenvorlagen-und-variablen.markup">
4222 <title>Markup-Code zur Textformatierung innerhalb von
4225 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
4226 anders formatiert haben möchte, so ist dies begrenzt möglich.
4227 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
4228 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
4229 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
4230 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
4231 (HTML oder PDF über LaTeX) umgesetzt.</para>
4233 <para>Die unterstützen Formatierungen sind:</para>
4237 <term><b>Text</b></term>
4240 <para>Text wird in Fettdruck gesetzt.</para>
4245 <term><i>Text</i></term>
4248 <para>Text wird kursiv gesetzt.</para>
4253 <term><u>Text</u></term>
4256 <para>Text wird unterstrichen.</para>
4261 <term><s>Text</s></term>
4264 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
4265 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
4270 <term><bullet></term>
4273 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
4279 <para>Der Befehl <command><bullet></command> funktioniert
4280 momentan auch nur in Latex-Vorlagen.</para>
4284 <sect1 id="excel-templates">
4285 <title>Excel-Vorlagen</title>
4287 <sect2 id="excel-templates.summary">
4288 <title>Zusammenfassung</title>
4290 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
4291 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
4295 <sect2 id="excel-templates.usage">
4296 <title>Bedienung</title>
4298 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
4299 werden. Die Konfigurationsoption heißt <varname>excel_templates =
4300 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
4302 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
4303 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
4304 werden. In den normalen Verkaufsmasken taucht nun
4305 <constant>Excel</constant> als auswählbares Format auf und kann von da
4306 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
4308 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
4309 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
4310 <filename>sales_quotation.xls</filename> gespeichert.</para>
4313 <sect2 id="excel-templates.syntax">
4314 <title>Variablensyntax</title>
4316 <para>Einfache Syntax:
4317 <command><<varname>></command></para>
4319 <para>Dabei sind <constant><<</constant> und
4320 <constant>>></constant> die Delimiter. Da Excel auf festen
4321 Breiten besteht, kann der Tag künstlich verlängert werden, indem
4322 weitere <constant><</constant> oder <constant>></constant>
4323 eingefügt werden. Der Tag muss nicht symmetrisch sein.
4326 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4328 <para>Um die Limitierung der festen Breite zu reduzieren, können
4329 weitere Variablen in einem Block interpoliert werden. Whitespace wird
4330 dazwishen dann erhalten. Beispiel:</para>
4332 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4334 <para>Die Variablen werden interpoliert, und linksbündig mit
4335 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
4336 lang, werden überzählige Zeichen abgeschnitten.</para>
4338 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
4339 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
4341 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4343 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
4344 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
4348 <sect2 id="excel-templates.limitations">
4349 <title>Einschränkungen</title>
4351 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
4352 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
4353 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
4354 Text zu ersetzen.</para>
4356 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
4357 <command><%if%></command> und
4358 <command><%foreach%></command> nicht vorhanden. Der Delimiter
4359 <constant><% %></constant> kommt in den Headerinformationen
4360 evtl. vor. Deshalb wurde auf den sichereren Delimiter
4361 <constant><<</constant> und <constant>>></constant>
4368 <title>Entwicklerdokumentation</title>
4370 <sect1 id="devel.globals" xreflabel="Globale Variablen">
4371 <title>Globale Variablen</title>
4374 <title>Wie sehen globale Variablen in Perl aus?</title>
4376 <para>Globale Variablen liegen in einem speziellen namespace namens
4377 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
4378 globs global und die meisten speziellen Variablen sind...
4381 <para>Daraus ergeben sich folgende Formen:</para>
4385 <term><literal>$main::form</literal></term>
4388 <para>expliziter Namespace "main"</para>
4393 <term><literal>$::form</literal></term>
4396 <para>impliziter Namespace "main"</para>
4401 <term><literal>open FILE, "file.txt"</literal></term>
4404 <para><varname>FILE</varname> ist global</para>
4409 <term><literal>$_</literal></term>
4412 <para>speziell</para>
4417 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
4418 Schlüsselwort wie "<function>global</function>", mit dem man
4419 importieren kann. <function>my</function>, <function>our</function>
4420 und <function>local</function> machen was anderes.</para>
4424 <term><literal>my $form</literal></term>
4427 <para>lexikalische Variable, gültig bis zum Ende des
4433 <term><literal>our $form</literal></term>
4436 <para><varname>$form</varname> referenziert ab hier
4437 <varname>$PACKAGE::form</varname>.</para>
4442 <term><literal>local $form</literal></term>
4445 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
4446 des scopes zurückgesetzt</para>
4453 <title>Warum sind globale Variablen ein Problem?</title>
4455 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
4457 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
4458 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
4459 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
4460 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
4461 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
4462 Datenbankverbindungen, weil die sehr lange zum Initialisieren
4465 <para>Das zweite Problem ist <function>strict</function>. Unter
4466 <function>strict</function> werden alle Variablen die nicht explizit
4467 mit <function>Package</function>, <function>my</function> oder
4468 <function>our</function> angegeben werden als Tippfehler angemarkert,
4469 dies hat, seit der Einführung, u.a. schon so manche langwierige
4470 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
4471 angegeben werden, werden die nicht geprüft, und somit kann sich
4472 schnell ein Tippfehler einschleichen.</para>
4476 <title>Kanonische globale Variablen</title>
4478 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
4479 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
4480 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
4481 umhergereicht werden.</para>
4483 <para>Diese Variablen sind im Moment die folgenden neun:</para>
4487 <para><varname>$::form</varname></para>
4491 <para><varname>%::myconfig</varname></para>
4495 <para><varname>$::locale</varname></para>
4499 <para><varname>$::lxdebug</varname></para>
4503 <para><varname>$::auth</varname></para>
4507 <para><varname>$::lx_office_conf</varname></para>
4511 <para><varname>$::instance_conf</varname></para>
4515 <para><varname>$::dispatcher</varname></para>
4519 <para><varname>$::request</varname></para>
4523 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
4524 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
4525 Eigenschaften (Konventionen):</para>
4528 <title>$::form</title>
4532 <para>Ist ein Objekt der Klasse
4533 "<classname>Form</classname>"</para>
4537 <para>Wird nach jedem Request gelöscht</para>
4541 <para>Muss auch in Tests und Konsolenscripts vorhanden
4546 <para>Enthält am Anfang eines Requests die Requestparameter vom
4551 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
4552 cachen, das wird aber momentan absichtlich zerstört</para>
4556 <para><varname>$::form</varname> wurde unter <productname>SQL
4557 Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
4558 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
4559 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
4560 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
4561 <function>IS->retrieve_customer()</function> in Sicherheit
4564 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
4565 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
4566 3552, Stand version 2.7beta), um dies hinterher wieder auf den
4567 richtigen Wert zu setzen:</para>
4569 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
4570 $::myconfig{numberformat} = $numberformat;
4571 # (...) div Berechnungen
4572 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
4574 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
4575 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
4576 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
4577 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
4578 Es geht ziemlich sicher etwas kaputt.</para>
4580 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
4581 in den <productname>Template::Toolkit</productname> Templates
4582 außerhalb der Controller: der Ausdruck <function>[% var
4583 %]</function> greift auf <varname>$::form->{var}</varname> zu.
4584 Unter Controllern ist der Standard Scope anders, da lautet der
4585 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
4586 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
4587 <function><%var%></function> zeigt auf
4588 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
4589 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
4592 <programlisting>[%- IF business %]
4593 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
4594 [%- END %]</programlisting>
4596 <para>Entweder wird hier dann $::form->{business} ausgewertet
4597 oder aber der Funktion
4598 <function>$form->parse_html_template</function> wird explizit
4599 noch ein zusätzlicher Hash übergeben, der dann auch in den
4600 (Web-)Templates zu Verfügung steht, bspw. so:</para>
4602 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
4604 <para>Innerhalb von Schleifen wird
4605 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
4606 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
4607 welches über alle Positionen eines Lieferscheins in Schleife
4610 <programlisting>for $i (1 .. $form->{rowcount}) {
4612 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
4613 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
4614 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
4620 <title>%::myconfig</title>
4624 <para>Das einzige Hash unter den globalen Variablen</para>
4628 <para>Wird spätestens benötigt wenn auf die Datenbank
4629 zugegriffen wird</para>
4633 <para>Wird bei jedem Request neu erstellt.</para>
4637 <para>Enthält die Userdaten des aktuellen Logins</para>
4641 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
4642 extern serialisiert werden, weil da auch der Datenbankzugriff
4643 für diesen user drinsteht.</para>
4647 <para>Enthält unter anderem Listenbegrenzung vclimit,
4648 Datumsformat dateformat und Nummernformat numberformat</para>
4652 <para>Enthält Datenbankzugriffinformationen</para>
4656 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
4657 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
4658 aktuellen Users entscheiden müssen, befragen
4659 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
4660 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
4661 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
4662 Informationen über den Benutzer die über die
4663 Administrator-Schnittstelle (admin.pl) eingegeben wurden.</para>
4667 <title>$::locale</title>
4671 <para>Objekt der Klasse "Locale"</para>
4675 <para>Wird pro Request erstellt</para>
4679 <para>Muss auch für Tests und Scripte immer verfügbar
4684 <para>Cached intern über Requestgrenzen hinweg benutzte
4689 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
4690 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
4694 <title>$::lxdebug</title>
4698 <para>Objekt der Klasse "LXDebug"</para>
4702 <para>Wird global gecached</para>
4706 <para>Muss immer verfügbar sein, in nahezu allen
4711 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
4712 bereit, wie "<function>enter_sub</function>" und
4713 "<function>leave_sub</function>", mit denen in den alten Modulen ein
4714 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
4715 der man die Wallclockzeit seit Requeststart loggen kann, sowie
4716 "<function>message</function>" und "<function>dump</function>" mit
4717 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
4720 <para>Beispielsweise so:</para>
4722 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
4723 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
4727 <title>$::auth</title>
4731 <para>Objekt der Klasse "SL::Auth"</para>
4735 <para>Wird global gecached</para>
4739 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
4743 <para>Wird nach jedem Request resettet.</para>
4747 <para><varname>$::auth</varname> stellt Funktionen bereit um die
4748 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
4749 vom aktuellen User abhängen wird das Objekt aus
4750 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
4751 Request kurz resettet.</para>
4755 <title>$::lx_office_conf</title>
4759 <para>Objekt der Klasse
4760 "<classname>SL::LxOfficeConf</classname>"</para>
4764 <para>Global gecached</para>
4768 <para>Repräsentation der
4769 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
4773 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
4774 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
4775 das Programm die Konfiguration ändern kann oder sollte.</para>
4777 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
4778 Debug- und Trace-Log-Datei wie folgt konfiguriert und
4781 <programlisting>[debug]
4782 file = /tmp/kivitendo-debug.log</programlisting>
4784 <para>ist der Key <varname>file</varname> im Programm als
4785 <varname>$::lx_office_conf->{debug}{file}</varname>
4789 <para>Zugriff auf die Konfiguration erfolgt im Moment über
4790 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
4795 <title>$::instance_conf</title>
4799 <para>Objekt der Klasse
4800 "<classname>SL::InstanceConfiguration</classname>"</para>
4804 <para>wird pro Request neu erstellt</para>
4808 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
4809 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
4810 ist hier eine Mandantendatenbank. Beispielsweise überprüft
4811 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
4812 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
4816 <title>$::dispatcher</title>
4820 <para>Objekt der Klasse
4821 "<varname>SL::Dispatcher</varname>"</para>
4825 <para>wird pro Serverprozess erstellt.</para>
4829 <para>enthält Informationen über die technische Verbindung zum
4834 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
4835 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
4836 Objekt untergebracht.</para>
4840 <title>$::request</title>
4844 <para>Hashref (evtl später Objekt)</para>
4848 <para>Wird pro Request neu initialisiert.</para>
4852 <para>Keine Unterstruktur garantiert.</para>
4856 <para><varname>$::request</varname> ist ein generischer Platz um
4857 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
4858 at a distance benutzt werden, sondern um lokales memoizing zu
4859 ermöglichen, das garantiert am Ende des Requests zerstört
4862 <para>Vieles von dem, was im moment in <varname>$::form</varname>
4863 liegt, sollte eigentlich hier liegen. Die groben
4864 Differentialkriterien sind:</para>
4868 <para>Kommt es vom User, und soll unverändert wieder an den
4869 User? Dann <varname>$::form</varname>, steht da eh schon</para>
4873 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
4874 Requests gebraucht werden? Dann
4875 <varname>$::request</varname></para>
4879 <para>Muss ich von anderen Teilen des Programms lesend drauf
4880 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
4881 Wrappermethode</para>
4888 <title>Ehemalige globale Variablen</title>
4890 <para>Die folgenden Variablen waren einmal im Programm, und wurden
4894 <title>$::cgi</title>
4898 <para>war nötig, weil cookie Methoden nicht als
4899 Klassenfunktionen funktionieren</para>
4903 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
4904 Klassennamespace gehalten wird und über Requestgrenzen
4909 <para>liegt jetzt unter
4910 <varname>$::request->{cgi}</varname></para>
4916 <title>$::all_units</title>
4920 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
4921 ein paar hundert mal pro Request eine Liste der Einheiten
4922 brauchen, und de als Parameter durch einen Riesenstack von
4923 Funktionen geschleift werden müssten.</para>
4927 <para>Liegt jetzt unter
4928 <varname>$::request->{cache}{all_units}</varname></para>
4933 <function>AM->retrieve_all_units()</function> gesetzt oder
4940 <title>%::called_subs</title>
4944 <para>wurde benutzt um callsub deep recursions
4949 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
4950 möglichen Rekursioenen darstellt, und da nie welche
4955 <para>komplette recursion protection wurde entfernt.</para>
4962 <sect1 id="devel.fcgi">
4963 <title>Entwicklung unter FastCGI</title>
4965 <sect2 id="devel.fcgi.general">
4966 <title>Allgemeines</title>
4968 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
4969 werden, muss der Webserver neu gestartet werden.</para>
4971 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
4972 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
4973 müssen folgende Aspekte beachtet werden.</para>
4976 <sect2 id="devel.fcgi.exiting">
4977 <title>Programmende und Ausnahmen</title>
4979 <para>Betrifft die Funktionen <function>warn</function>,
4980 <function>die</function>, <function>exit</function>,
4981 <function>carp</function> und <function>confess</function>.</para>
4983 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
4984 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
4985 am Laufen zu halten. Man kann mit <function>die</function>,
4986 <function>confess</function> oder <function>carp</function> Fehler
4987 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
4988 eigene <function>$::form-</function>error()> tut im Prinzip das
4989 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
4990 <function>exit</function> hingegen werden nicht abgefangen.
4991 <function>warn</function> wird direkt nach STDERR, also in Server Log
4992 eine Nachricht schreiben (sofern in der Konfiguration nicht die
4993 Warnungen in das kivitendo Log umgeleitet wurden), und
4994 <function>exit</function> wird die Ausführung beenden.</para>
4996 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
4997 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
4998 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
4999 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
5002 <sect2 id="devel.fcgi.globals">
5003 <title>Globale Variablen</title>
5005 <para>Um zu vermeiden, dass Informationen von einem Request in einen
5006 anderen gelangen, müssen alle globalen Variablen vor einem Request
5007 sauber initialisiert werden. Das ist besonders wichtig im
5008 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
5009 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
5012 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
5013 abgetrennten Block, der alle kanonischen globalen Variablen listet und
5014 erklärt. Bitte keine anderen einführen ohne das sauber zu
5015 dokumentieren.</para>
5017 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
5018 man sicher geht, dass man die richtige erwischt.</para>
5021 <sect2 id="devel.fcgi.performance">
5022 <title>Performance und Statistiken</title>
5024 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
5025 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
5026 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
5027 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
5028 sind es je nach Menge der definierten Variablen 1-2s. Ab der
5029 Moose/Rose::DB Version sind es 5-6s.</para>
5031 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
5032 den kritischen Pfaden, unter 0,15 sonst.</para>
5035 <sect2 id="devel.fcgi.known-issues">
5036 <title>Bekannte Probleme</title>
5038 <sect3 id="devel.fcgi.known-issues.encoding">
5039 <title>Encoding Awareness</title>
5041 <para>UTF-8 kodierte Installationen sind sehr anfällig gegen
5042 fehlerhfate Encodings unter FCGI. latin9 Installationen behandeln
5043 falsch kodierte Zeichen eher unwissend, und geben sie einfach
5044 weiter. UTF-8 verweigert bei fehlerhaften Programmpfaden kurzerhand
5045 das Ausliefern. Es wird noch daran gearbeitet, alle Fehler da zu
5051 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
5052 <title>SQL-Upgradedateien</title>
5054 <sect2 id="db-upgrade-files.introduction"
5055 xreflabel="Einführung in die Datenbank-Upgradedateien">
5056 <title>Einführung</title>
5058 <para>Der alte Mechanismus für SQL-Upgradescripte, der auf einer
5059 Versionsnummer beruht und dann in sql/Pg-upgrade nach einem Script für
5060 diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele
5061 Entwicklung im stable- und unstable-Baum betrifft.</para>
5063 <para>Dieser Mechanismus wurde für kivitendo 2.4.1 deutlich erweitert.
5064 Es werden weiterhin alle Scripte aus sql/Pg-upgrade ausgeführt.
5065 Zusätzlich gibt es aber ein zweites Verzeichnis, sql/Pg-upgrade2. In
5066 diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren,
5067 die neben den eigentlich auszuführenden SQL- oder Perl-Befehlen einige
5068 Kontrollinformationen enthält.</para>
5070 <para>Neu sind die Kontrollinformationen, die Abhängigkeiten und
5071 Prioritäten definieren können werden, sodass Datenbankscripte zwar in
5072 einer sicheren Reihenfolge ausgeführt werden (z.B. darf ein "ALTER
5073 TABLE" erst ausgeführt werden, wenn die Tabelle mit "CREATE TABLE"
5074 angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man
5075 keine Versionsnummern mehr braucht.</para>
5077 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
5078 sql/Pg-upgrade2 bereits durchgeführt wurde und führt diese nicht
5079 erneut aus. Dazu dient die Tabelle "schema_info", die bei der
5080 Anmeldung automatisch angelegt wird.</para>
5083 <sect2 id="db-upgrade-files.format"
5084 xreflabel="Format der Upgradedateien">
5085 <title>Format der Kontrollinformationen</title>
5087 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5088 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5089 hat dabei das folgende Format:</para>
5091 <para>Für SQL-Upgradedateien:</para>
5093 <programlisting>-- @key: value</programlisting>
5095 <para>Für Perl-Upgradedateien:</para>
5097 <programlisting># @key: value</programlisting>
5099 <para>Leerzeichen vor "<varname>value</varname>" werden
5102 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5106 <term><varname>tag</varname></term>
5109 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5110 Dieser "tag" kann von anderen Kontrolldateien in ihren
5111 Abhängigkeiten verwendet werden (Schlüsselwort
5112 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5113 in der Datenbank eingetragen wird.</para>
5115 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5116 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5118 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5119 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5120 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5126 <term><varname>charset</varname></term>
5129 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
5130 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5131 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
5132 Abwesenheit des Tags der Zeichensatz
5133 "<literal>ISO-8859-15</literal>" angenommen.</para>
5138 <term><varname>description</varname></term>
5141 <para>Benötigt. Eine Beschreibung, was in diesem Update
5142 passiert. Diese wird dem Benutzer beim eigentlichen
5143 Datenbankupdate angezeigt. Während der Tag in englisch gehalten
5144 sein sollte, sollte die Beschreibung auf Deutsch
5150 <term><varname>depends</varname></term>
5153 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5154 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
5155 dass die in dieser Liste aufgeführten Scripte bereits
5156 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5158 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5159 Script "b" existiert, das von Änderungen in "a" abhängt, und
5160 eine neue Kontrolldatei für "c" erstellt wird, die von
5161 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5162 Tag "b" als Abhängigkeit zu definieren.</para>
5164 <para>Es ist nicht erlaubt, sich selbst referenzierende
5165 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5166 und "c" -> "a").</para>
5171 <term><varname>priority</varname></term>
5174 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5175 der Scripte ausgeführt werden, die die gleichen
5176 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5177 der Wert 1000 benutzt.</para>
5179 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5180 "depends" benutzt werden. kivitendo sortiert die auszuführenden
5181 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5182 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5183 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5184 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5185 Priorität alphabetisch nach dem "tag".</para>
5190 <term><varname>ignore</varname></term>
5193 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
5194 Skript bei der Anmeldung ignoriert und entsprechend nicht
5201 <sect2 id="db-upgrade-files.dbupgrade-tool"
5202 xreflabel="Hilfsscript dbupgrade2_tool.pl">
5203 <title>Hilfsscript dbupgrade2_tool.pl</title>
5205 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
5206 existiert ein Hilfsscript namens
5207 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
5208 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
5209 liest alle Datenbankupgradescripte aus dem Verzeichnis
5210 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
5211 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
5212 von der Kommandozeile überprüft werden können.</para>
5214 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
5215 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
5216 sich aber auch Informationen auf verschiedene Art ausgeben
5221 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
5222 --list</command>"</para>
5224 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
5225 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
5226 würde. Es werden neben der Listenposition der Tag, die
5227 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
5231 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
5232 --tree</command>"</para>
5234 <para>Listet alle Tags in Baumform basierend auf den
5235 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
5236 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
5237 beim übergeordneten Script als Abhängigkeit eingetragen
5241 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
5242 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
5243 --rtree</command>"</para>
5245 <para>Listet alle Tags in Baumform basierend auf den
5246 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
5247 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
5248 die das übergeordnete Script als Abhängigkeit eingetragen
5253 <para>Baumform mit Postscriptausgabe:
5254 "<command>./scripts/dbupgrade2_tool.pl
5255 --graphviz</command>"</para>
5257 <para>Benötigt das Tool "<command>graphviz</command>", um mit
5258 seiner Hilfe die <link
5259 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
5260 Baumform</link> in eine Postscriptdatei namens
5261 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
5262 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
5263 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
5264 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
5269 <para>Scripte, von denen kein anderes Script abhängt:
5270 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
5272 <para>Listet die Tags aller Scripte auf, von denen keine anderen
5273 Scripte abhängen.</para>
5279 <sect1 id="translations-languages" xreflabel="Translations and languages">
5280 <title>Translations and languages</title>
5282 <sect2 id="translations-languages.introduction"
5283 xreflabel="Introduction to translations and languages">
5284 <title>Introduction</title>
5287 <para>Dieser Abschnitt ist in Englisch geschrieben, um
5288 internationalen Übersetzern die Arbeit zu erleichtern.</para>
5291 <para>This section describes how localization packages in kivitendo
5292 are built. Currently the only language fully supported is German, and
5293 since most of the internal messages are held in English the English
5294 version is usable too.</para>
5296 <para>A stub version of French is included but not functunal at this
5300 <sect2 id="translations-languages.file-structure"
5301 xreflabel="File structure">
5302 <title>File structure</title>
5304 <para>The structure of locales in kivitendo is:</para>
5306 <programlisting>kivitendo/locale/<langcode>/</programlisting>
5308 <para>where <langcode> stands for an abbreviation of the
5309 language package. The builtin packages use two letter <ulink
5310 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
5311 but the actual name is not relevant for the program and can easily be
5313 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
5314 tags</ulink> (i.e. "en_GB"). In fact the original language packages
5315 from SQL Ledger are named in this way.</para>
5317 <para>In such a language directory the following files are
5322 <term>LANGUAGE</term>
5325 <para>This file is mandatory.</para>
5327 <para>The <filename>LANGUAGE</filename> file contains the self
5328 descripted name of the language. It should contain a native
5329 representation first, and in parenthesis an english translation
5330 after that. Example:</para>
5332 <programlisting>Deutsch (German)</programlisting>
5337 <term>charset</term>
5340 <para>This file should be present.</para>
5342 <para>The <filename>charset</filename> file describes which
5343 charset a language package is written in and applies to all
5344 other language files in the package. It is possible to write
5345 some language packages without an explicit charset, but it is
5346 still strongly recommended. You'll never know in what
5347 environment your language package will be used, and neither
5348 UTF-8 nor Latin1 are guaranteed.</para>
5350 <para>The whole content of this file is a string that can be
5351 recognized as a valid charset encoding. Example:</para>
5353 <programlisting>UTF-8</programlisting>
5361 <para>This file is mandatory.</para>
5363 <para>The central translation file. It is essentially an inline
5364 Perl script autogenerated by <command>locales.pl</command>. To
5365 generate it, generate the directory and the two files mentioned
5366 above, and execute the following command:</para>
5368 <programlisting>scripts/locales.pl <langcode></programlisting>
5370 <para>Otherwise you can simply copy one of the other languages.
5371 You will be told how many are missing like this:</para>
5373 <programlisting>$ scripts/locales.pl en
5374 English - 0.6% - 2015/2028 missing</programlisting>
5376 <para>A file named "<filename>missing</filename>" will be
5377 generated and can be edited. You can also edit the
5378 "<filename>all</filename>" file directly. Edit everything you
5379 like to fit the target language and execute
5380 <command>locales.pl</command> again. See how the missing words
5386 <term>Num2text</term>
5389 <para>Legacy code from SQL Ledger. It provides a means for
5390 numbers to be converted into natural language, like
5391 <literal>1523 => one thousand five hundred twenty
5392 three</literal>. If you want to provide it, it must be inlinable
5393 Perl code which provides a <function>num2text</function> sub. If
5394 an <function>init</function> sub exists it will be executed
5397 <para>Only used in the check and receipt printing module.</para>
5402 <term>special_chars</term>
5405 <para>kivitendo comes with a lot of interfaces to different
5406 formats, some of which are rather picky with their accepted
5407 charset. The <filename>special_chars</filename> file contains a
5408 listing of chars not suited for different file format and
5409 provides substitutions. It is written in "Simple Ini" style,
5410 containing a block for every file format.</para>
5412 <para>First entry should be the order of substitution for
5413 entries as a whitespace separated list. All entries are
5414 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
5415 and <literal>\\</literal> all work.</para>
5417 <para>After that every entry is a special char that should be
5418 translated when writing text into such a file.</para>
5420 <para>Example:</para>
5422 <programlisting>[Template/XML]
5423 order=& < > \n
5427 \n=<br></programlisting>
5429 <para>Note the importance of the order in this example.
5430 Substituting < and > befor & would lead to $gt; become
5433 <para>For a list of valid formats, see the German
5434 <filename>special_chars</filename> entry. As of this writing the
5435 following are recognized:</para>
5437 <programlisting>HTML
5442 Template/OpenDocument
5443 filenames</programlisting>
5445 <para>The last of which is very machine dependant. Remember that
5446 a lot of characters are forbidden by some filesystems, for
5447 exmaple MS Windows doesn't like ':' in its files where Linux
5448 doesn't mind that. If you want the files created with your
5449 language pack to be portable, find all chars that could cause
5455 <term>missing</term>
5458 <para>This file is not a part of the language package
5461 <para>This is a file generated by
5462 <command>scripts/locales.pl</command> while processing your
5463 locales. It's only to have the missing entries singled out and
5464 does not belong to a language package.</para>
5472 <para>This file is not a part of the language package
5475 <para>Another file generated by
5476 <command>scripts/locales.pl</command>. If for any reason a
5477 translation does not appear anymore and can be deleted, it gets
5478 moved here. The last 50 or so entries deleted are saved here in
5479 case you made a typo, so that you don't have to translate
5480 everything again. If a tranlsation is missing, the lost file is
5481 checked first. If you maintain a language package, you might
5482 want to keep this safe somewhere.</para>
5489 <sect1 id="devel.testsuite">
5490 <title>Die kivitendo-Test-Suite</title>
5492 <sect2 id="devel.testsuite.intro">
5493 <title>Einführung</title>
5495 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul <literal>Test::More</literal>.</para>
5497 <para>Die grundlegenden Fakten sind:</para>
5500 <listitem><para>Alle Tests liegen im Unterverzeichnis <filename>t/</filename>.</para></listitem>
5502 <listitem><para>Ein Script (bzw. ein Test) in <filename>f/</filename> enthält einen oder mehrere Testfälle.</para></listitem>
5504 <listitem><para>Alle Dateinamen von Tests enden auf <literal>.t</literal>. Es sind selbstständig ausführbare Perl-Scripte.</para></listitem>
5506 <listitem><para>Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in <filename>f/</filename>, deren
5507 Dateiname auf <literal>.t</literal> endet.</para></listitem>
5511 <sect2 id="devel.testsuite.prerequisites">
5512 <title>Voraussetzungen</title>
5514 <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>
5517 <listitem><para><literal>Test::Deep</literal> (Debian-Paketname: <literal>libtest-deep-perl</literal>; Fedora Core:
5518 <literal>perl-Test-Deep</literal>; openSuSE: <literal>perl-Test-Deep</literal>)</para></listitem>
5522 <sect2 id="devel.testsuite.execution">
5524 Existierende Tests ausführen
5527 <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
5528 gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript <filename>t/test.sh</filename>.</para>
5530 <para>Will man die komplette Test-Suite ausführen, so muss man einfach nur <filename>t/test.sh</filename> ohne weitere Parameter aus
5531 dem kivitendo-Basisverzeichnis heraus ausführen.</para>
5533 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an <filename>t/test.sh</filename>. Beispielsweise:</para>
5535 <programlisting>t/test.sh t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
5539 <sect2 id="devel.testsuite.meaning_of_scripts">
5541 Bedeutung der verschiedenen Test-Scripte
5544 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch
5545 während der Entwicklung nützliche Tests sind:</para>
5548 <listitem><para><filename>t/001compile.t</filename> -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab</para></listitem>
5549 <listitem><para><filename>t/002goodperl.t</filename> -- überprüft alle Perl-Dateien auf Anwesenheit von '<literal>use strict</literal>'-Anweisungen</para></listitem>
5550 <listitem><para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von <function>system()</function> und <function>exec()</function> auf Gültigkeit</para></listitem>
5551 <listitem><para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien Tab-Zeichen enthalten</para></listitem>
5552 <listitem><para><filename>t/006spelling.t</filename> -- sucht nach häufigen Rechtschreibfehlern</para></listitem>
5553 <listitem><para><filename>t/011pod.t</filename> -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit</para></listitem>
5556 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module.</para>
5559 <sect2 id="devel.testsuite.create_new">
5561 Neue Test-Scripte erstellen
5564 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende
5565 Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden.</para>
5567 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
5569 Ideen für neue Test-Scripte, die keine konkreten Funktionen testen
5572 <para> Ideen, die abgesehen von Funktions noch nicht umgesetzt wurden:</para>
5575 <listitem><para>Überprüfung auf fehlende symbolische Links</para></listitem>
5576 <listitem><para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten)</para></listitem>
5577 <listitem><para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para></listitem>
5578 <listitem><para>Überprüfung auf Leerzeichen am Ende von Zeilen</para></listitem>
5579 <listitem><para>Test, ob alle zu übersetzenden Strings in <filename>locale/de/all</filename> vorhanden sind</para></listitem>
5580 <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>
5584 <sect3 id="devel.testsuite.directory_and_test_names">
5586 Konvention für Verzeichnis- und Dateinamen
5589 <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>
5592 <listitem><para>Die Dateiendung muss <filename>.t</filename> lauten.</para></listitem>
5594 <listitem><para>Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise
5595 <filename>bad_function_params.t</filename>).</para></listitem>
5597 <listitem><para>Unterverzeichnisse sollten grob nach dem Themenbereich benannt sind, mit dem sich die Scripte darin befassen
5598 (beispielsweise <filename>background_jobs</filename> für Tests rund um Hintergrund-Jobs).</para></listitem>
5600 <listitem><para>Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist
5601 (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben.</para></listitem>
5605 <sect3 id="devel.testsuite.minimal_example">
5607 Minimales Skelett für eigene Scripte
5610 <para>Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden:</para>
5612 <programlisting>use Test::More tests => 0;
5616 use Support::TestSetup;
5618 Support::TestSetup::login();</programlisting>
5620 <para>Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie
5621 <varname>$::auth</varname>, <varname>$::form</varname> oder <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
5622 <filename>config/kivitendo.conf</filename> im Abschnitt <literal>testing.login</literal> ein gültiger Login-Name eingetragen
5623 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
5625 <para>Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile <code>Support::TestSetup::login();</code>
5626 weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.</para>
5631 <sect1 id="devel.style-guide">
5632 <title>Stil-Richtlinien</title>
5634 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
5635 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
5636 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
5637 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
5639 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
5642 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
5643 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
5648 <para>Es werden keine echten Tabs sondern Leerzeichen
5653 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
5655 <programlisting>foreach my $row (@data) {
5657 # do something with $row
5661 $row->{modules} = MODULE->retrieve(
5662 id => $row->{id},
5663 date => $use_now ? localtime() : $row->{time},
5667 $report->add($row);
5672 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
5673 Zeile wie der letzte Befehl. Beispiele:</para>
5675 <programlisting>sub debug {
5681 <programlisting>if ($form->{item_rows} > 0) {
5687 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
5688 der Befehl / die öffnende schließende Klammer, die den Block
5689 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
5690 Beispiele wie bei 3. gelten.</para>
5694 <para>Die Wörter "<function>else</function>",
5695 "<function>elsif</function>", "<function>while</function>" befinden
5696 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
5699 <programlisting>if ($form->{sum} > 1000) {
5701 } elsif ($form->{sum} > 0) {
5709 } until ($a > 0);</programlisting>
5713 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
5714 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
5715 und grep-ähnliche Operatoren. Beispiel:</para>
5717 <programlisting>$main::lxdebug->message("Could not find file.");
5718 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
5722 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
5724 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
5725 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
5726 Blöcke schon. Beispiel:</para>
5728 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
5733 $form->{sum} += $form->{"row_$i"};
5734 $form->{ $form->{index} } += 1;
5736 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
5740 <para>Mehrzeilige Befehle</para>
5744 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
5745 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
5746 werden, in der die ersten Funktionsparameter in der ersten Zeile
5747 stehen. Beispiel:</para>
5749 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
5750 $form->{some_col_value});</programlisting>
5754 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
5755 besten in einer übersichtlichen Tabellenstruktur organisiert
5756 wird. Beispiel:</para>
5758 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
5759 : $form->{oldcount} ? $form->{oldcount} + 1
5760 : $form->{rowcount} - $form->{rowbase};</programlisting>
5766 <para>Kommentare</para>
5770 <para>Kommentare, die alleine in einer Zeile stehen, sollten
5771 soweit wie der Code eingerückt sein.</para>
5775 <para>Seitliche hängende Kommentare sollten einheitlich
5776 formatiert werden.</para>
5780 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
5781 auf Englisch zu verfassen. So wie ich keine Lust habe,
5782 französischen Quelltext zu lesen, sollte auch der kivitendo
5783 Quelltext für nicht-Deutschsprachige lesbar sein.
5786 <programlisting>my $found = 0;
5794 $i = 0 # initialize $i
5796 $i *= $const; # do something crazy
5797 $i = $n; # recover $i</programlisting>
5803 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
5804 Interpolation gewünscht ist. Beispiel:</para>
5806 <programlisting>$form->{sum} = 0;
5807 $form->{"row_$i"} = $form->{"row_$i"} - 5;
5808 $some_hash{42} = 54;</programlisting>
5812 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
5813 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
5814 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
5815 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
5817 <para>Als Beispiel sei die Funktion
5818 <function>print_options</function> aus
5819 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
5823 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
5824 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
5827 <para>Emacs und vim haben beide recht einfache Methoden zur
5828 Entfernung von trailing whitespace. Emacs kennt das Kommande
5829 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
5830 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
5831 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
5836 <para>Es wird kein <command>perltidy</command> verwendet.</para>
5838 <para>In der Vergangenheit wurde versucht,
5839 <command>perltidy</command> zu verwenden, um einen einheitlichen
5840 Stil zu erlangen. Es hat sich aber gezeigt, dass
5841 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
5842 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
5843 den Interessierten sind hier die
5844 <command>perltidy</command>-Optionen, die grob den beschriebenen
5845 Richtlinien entsprechen:</para>
5847 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
5848 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
5849 -lp -vt=1 -vtc=1</programlisting>
5853 <para><varname>STDERR</varname> ist tabu. Unkonditionale
5854 Debugmeldungen auch.</para>
5856 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
5857 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
5858 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
5860 <para>Die <classname>LXDebug</classname>-Methode
5861 "<function>message</function>" nimmt als ersten Paramter außerdem
5862 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
5863 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
5864 und werden in den meisten Fällen auch vom Repository
5865 zurückgewiesen.</para>
5869 <para>Alle neuen Module müssen use strict verwenden.</para>
5871 <para><varname>$form</varname>, <varname>$auth</varname>,
5872 <varname>$locale</varname>, <varname>$lxdebug</varname> und
5873 <varname>%myconfig</varname> werden derzeit aus dem main package
5874 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
5875 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
5880 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
5881 <title>Dokumentation erstellen</title>
5883 <sect2 id="devel.build-doc.introduction">
5884 <title>Einführung</title>
5886 <para>Diese Dokumentation ist in <productname>DocBook</productname>
5887 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
5888 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
5889 Editor nutzt, der spezielle Unterstützung für
5890 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
5891 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
5892 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
5896 <sect2 id="devel.build-doc.required-software">
5897 <title>Benötigte Software</title>
5899 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
5900 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
5901 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
5902 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
5903 <command>scripts/build_doc.sh</command>.</para>
5905 <para>Das Script benötigt zur Konvertierung verschiedene
5906 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
5912 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
5913 in einer halbwegs aktuellen Version</para>
5917 <para>Das Java-Build-System <ulink
5918 url="http://ant.apache.org/">Apache Ant</ulink></para>
5922 <para>Das Dokumentations-System Dobudish für
5923 <productname>DocBook</productname> 4.5, eine Zusammenstellung
5924 diverser Stylesheets und Grafiken zur Konvertierung von
5925 <productname>DocBook</productname> XML in andere Formate. Das
5926 Paket, das benötigt wird, ist zum Zeitpunkt der
5927 Dokumentationserstellung
5928 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
5929 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
5934 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
5935 sind auf allen gängigen Plattformen verfügbar. Beispiel für
5936 Debian/Ubuntu:</para>
5938 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
5940 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
5941 <filename>doc/build</filename> entpackt werden. Beispiel unter der
5942 Annahme, das <productname>Dobudish</productname> in
5943 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
5945 <programlisting>cd doc/build
5946 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
5949 <sect2 id="devel.build-doc.build">
5950 <title>PDFs und HTML-Seiten erstellen</title>
5952 <para>Die eigentliche Konvertierung erfolgt nach Installation der
5953 benötigten Software mit einem einfachen Aufruf direkt aus dem
5954 kivitendo-Installationsverzeichnis heraus:</para>
5956 <programlisting>./scripts/build_doc.sh</programlisting>
5959 <sect2 id="devel.build-doc.repository">
5960 <title>Einchecken in das Git-Repository</title>
5962 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
5963 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
5964 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
5965 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
5967 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
5968 symbolischen Links gehören hingegen nicht in das Repository.</para>