1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <book id="kivitendo-documentation" lang="de">
5 <title>kivitendo: Installation, Konfiguration, Entwicklung</title>
7 <chapter id="Aktuelle-Hinweise">
8 <title>Aktuelle Hinweise</title>
10 <para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>
14 <para>im kivitendo-Forum: <ulink
15 url="https://forum.kivitendo.org/">https://forum.kivitendo.org/</ulink></para>
21 <title>Installation und Grundkonfiguration</title>
23 <sect1 id="Installation-Übersicht">
24 <title>Übersicht</title>
27 Die Installation von kivitendo umfasst mehrere Schritte. Die folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
28 Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit minimalen Features möglichst schnell zum Laufen zu kriegen.
32 <listitem><para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo benötigt gewisse Ressourcen und benutzt weitere
33 Programme. Das Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert diese. Auch die Liste der benötigten Perl-Module
34 befindet sich hier.</para></listitem>
36 <listitem><para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst die "<xref
37 linkend="Manuelle-Installation-des-Programmpaketes"/>" sowie grundlegende Einstellungen, die der "<xref
38 linkend="config.config-file"/>" erläutert.</para></listitem>
40 <listitem><para><emphasis>Konfiguration externer Programme</emphasis>: hierzu gehören die Datenbank ("<xref
41 linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der Webserver ("<xref
42 linkend="Apache-Konfiguration"/>"). </para></listitem>
44 <listitem><para><emphasis>Benutzerinformationen speichern können</emphasis>: man benötigt mindestens eine Datenbank, in der
45 Informationen zur Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man das als Administrator macht, verrät "<xref
46 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para></listitem>
48 <listitem><para><emphasis>Benutzer, Gruppen und Datenbanken anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
49 linkend="Benutzer--und-Gruppenverwaltung"/>".</para></listitem>
51 <listitem><para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann kann es losgehen: "<xref
52 linkend="kivitendo-ERP-verwenden"/>"</para></listitem>
56 Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls wichtig und dienen sollten vor einer ernsthaften Inbetriebnahme gelesen
61 <sect1 id="Benötigte-Software-und-Pakete">
62 <title>Benötigte Software und Pakete</title>
64 <sect2 id="Betriebssystem">
65 <title>Betriebssystem</title>
67 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
68 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
69 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
70 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
71 ohne große Probleme auf den derzeit aktuellen verbreiteten
72 Distributionen läuft.</para>
74 <para>Mitte 2012 sind das folgende Systeme, von denen bekannt ist,
75 dass kivitendo auf ihnen läuft:</para>
83 <para>6.0 Squeeze (hier muss allerdings das Modul FCGI in der Version >= 0.72 compiled werden)</para>
86 <para>7.0 Wheezy</para>
92 <para>Ubuntu 10.04 LTS Lucid Lynx bis 12.10 Oneiric Ocelot</para>
96 <para>openSUSE 11.2 und 11.3</para>
100 <para>SuSE Linux Enterprice Server 11</para>
104 <para>Fedora 13 bis 16</para>
109 <sect2 id="Pakete" xreflabel="Pakete">
110 <title>Pakete</title>
112 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
113 Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2)
116 <para>Zusätzlich benötigt kivitendo die folgenden Perl-Pakete, die
117 nicht Bestandteil einer Standard-Perl-Installation sind:</para>
120 <listitem><para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para></listitem>
122 <listitem><para><literal>Archive::Zip</literal></para></listitem>
124 <listitem><para><literal>Config::Std</literal></para></listitem>
126 <listitem><para><literal>DateTime</literal></para></listitem>
128 <listitem><para><literal>DBI</literal></para></listitem>
130 <listitem><para><literal>DBD::Pg</literal></para></listitem>
132 <listitem><para><literal>Email::Address</literal></para></listitem>
134 <listitem><para><literal>Email::MIME</literal></para></listitem>
136 <listitem><para><literal>JSON</literal></para></listitem>
138 <listitem><para><literal>List::MoreUtils</literal></para></listitem>
140 <listitem><para><literal>Net::SMTP::SSL</literal> (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "<xref
141 linkend="config.sending-email.smtp"/>")</para></listitem>
143 <listitem><para><literal>Net::SSLGlue</literal> (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "<xref
144 linkend="config.sending-email.smtp"/>")</para></listitem>
146 <listitem><para><literal>Params::Validate</literal></para></listitem>
148 <listitem><para><literal>PDF::API2</literal></para></listitem>
150 <listitem><para><literal>Rose::Object</literal></para></listitem>
152 <listitem><para><literal>Rose::DB</literal></para></listitem>
154 <listitem><para><literal>Rose::DB::Object</literal></para></listitem>
156 <listitem><para><literal>Template</literal></para></listitem>
158 <listitem><para><literal>Text::CSV_XS</literal></para></listitem>
160 <listitem><para><literal>Text::Iconv</literal></para></listitem>
162 <listitem><para><literal>URI</literal></para></listitem>
164 <listitem><para><literal>XML::Writer</literal></para></listitem>
166 <listitem><para><literal>YAML</literal></para></listitem>
169 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen: <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
170 <literal>Net::SSLGlue</literal>.</para>
172 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
173 hinzugekommen, <literal>URI</literal> und
174 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
177 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
178 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
179 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
180 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
182 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
183 hinzugekommen.</para>
185 <para><literal>Email::Address</literal> und
186 <literal>List::MoreUtils</literal> sind schon länger feste
187 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
188 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
189 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
190 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
193 <para>Die zu installierenden Pakete können in den verschiedenen
194 Distributionen unterschiedlich heißen.</para>
196 <para>Für Debian oder Ubuntu benötigen Sie diese Pakete:</para>
198 <programlisting>apt-get install apache2 postgresql libarchive-zip-perl \
199 libdatetime-perl libdbi-perl libdbd-pg-perl libpg-perl \
200 libemail-address-perl libemail-mime-perl liblist-moreutils-perl libpdf-api2-perl \
201 librose-object-perl librose-db-perl librose-db-object-perl \
202 libtemplate-perl libtext-csv-xs-perl libtext-iconv-perl liburi-perl \
203 libxml-writer-perl libyaml-perl libconfig-std-perl \
204 libparams-validate-perl libjson-perl libclass-accessor-perl \
205 libnet-sslglue-perl libnet-smtp-ssl-perl</programlisting>
207 <para>Für Fedora Core benötigen Sie diese Pakete:</para>
209 <programlisting>yum install httpd postgresql-server perl-parent perl-DateTime \
210 perl-DBI perl-DBD-Pg perl-Email-Address perl-Email-MIME perl-List-MoreUtils \
211 perl-PDF-API2 perl-Rose-Object perl-Rose-DB perl-Rose-DB-Object \
212 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
213 perl-XML-Writer perl-YAML perl-Net-SSLGlue perl-Net-SMTP-SSL</programlisting>
215 <para>Für OpenSuSE benötigen Sie diese Pakete:</para>
217 <programlisting>zypper install apache2 postgresql-server perl-Archive-Zip \
218 perl-DateTime perl-DBI perl-DBD-Pg perl-Email-MIME perl-MailTools perl-List-MoreUtils \
219 perl-PDF-API2 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
220 perl-URI perl-XML-Writer perl-YAML perl-Net-SSLGlue perl-Net-SMTP-SSL</programlisting>
222 <para>kivitendo enthält ein Script, mit dem überprüft werden kann, ob
223 alle benötigten Perl-Module installiert sind. Der Aufruf lautet wie
226 <programlisting>./scripts/installation_check.pl</programlisting>
230 <sect1 id="Manuelle-Installation-des-Programmpaketes"
231 xreflabel="Manuelle Installation des Programmpaketes">
232 <title>Manuelle Installation des Programmpaketes</title>
234 <para>Die kivitendo ERP Installationsdatei (kivitendo-erp-2.6.3.tgz) wird
235 im Dokumentenverzeichnis des Webservers (z.B.
236 <filename>/var/www/html/</filename>,
237 <filename>/srv/www/htdocs</filename> oder
238 <filename>/var/www/</filename>) entpackt:</para>
240 <programlisting>cd /var/www
241 tar xvzf kivitendo-erp-2.6.3.tgz</programlisting>
243 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
245 <programlisting>cd kivitendo-erp</programlisting>
247 <para>Alternativ können Sie auch einen Alias in der
248 Webserverkonfiguration benutzen, um auf das tatsächliche
249 Installationsverzeichnis zu verweisen.</para>
251 <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
252 beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
253 Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
254 core <constant>apache</constant> oder bei OpenSuSE <constant>wwwrun</constant>).</para>
256 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
257 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
259 <programlisting>chown -R www-data users spool webdav</programlisting>
261 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
262 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>
264 <programlisting>chown www-data templates users</programlisting>
267 <sect1 id="config.config-file">
268 <title>kivitendo-Konfigurationsdatei</title>
270 <sect2 id="config.config-file.introduction"
271 xreflabel="Einführung in die Konfigurationsdatei">
272 <title>Einführung</title>
274 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei,
275 die benötigt wird: <filename>config/kivitendo.conf</filename> (kurz:
276 "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
277 von kivitendo bzw. der Migration von älteren Versionen angelegt
280 <para>Als Vorlage dient die Datei
281 <filename>config/kivitendo.conf.default</filename> (kurz: "die
282 Default-Datei"):</para>
284 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
286 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
287 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
288 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
289 Abschnitte und Werte enthalten, die von denen der Default-Datei
294 Vor der Umbenennung in kivitendo hieß diese Datei noch <filename>config/lx_office.conf</filename>. Aus Gründen der Kompatibilität
295 wird diese Datei eingelesen, sofern die Datei <filename>config/kivitendo.conf</filename> nicht existiert.
299 <para>Diese Hauptkonfigurationsdatei ist dann eine
300 installationsspezifische Datei, d.h. sie enthält bspw. lokale
301 Passwörter und wird auch nicht im Versionsmanagement (git)
304 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
305 Mandaten, bzw. Datenbanken gleich.</para>
308 <sect2 id="config.config-file.sections-parameters">
309 <title>Abschnitte und Parameter</title>
311 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
312 entsprechend kommentiert sind:</para>
315 <listitem><para><literal>authentication</literal> (siehe Abschnitt "<xref
316 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>" in diesem Kapitel)</para></listitem>
318 <listitem><para><literal>authentication/database</literal></para></listitem>
320 <listitem><para><literal>authentication/ldap</literal></para></listitem>
322 <listitem><para><literal>system</literal></para></listitem>
324 <listitem><para><literal>features</literal> (siehe Kapitel "<xref linkend="features"/>")</para></listitem>
326 <listitem><para><literal>paths</literal></para></listitem>
328 <listitem><para><literal>applications</literal></para></listitem>
330 <listitem><para><literal>environment</literal></para></listitem>
332 <listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>
334 <listitem><para><literal>print_templates</literal></para></listitem>
336 <listitem><para><literal>task_server</literal></para></listitem>
338 <listitem><para><literal>periodic_invoices</literal></para></listitem>
340 <listitem><para><literal>console</literal></para></listitem>
342 <listitem><para><literal>debug</literal></para></listitem>
345 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
346 einzustellen oder zu kontrollieren sind, sind:</para>
348 <programlisting>[authentication]
349 admin_password = geheim
351 [authentication/database]
359 dbcharset = UTF-8</programlisting>
361 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
362 <varname>[periodic_invoices]</varname> den Login eines Benutzers
363 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
364 mit Informationen über die erstellten Rechnungen bekommt.</para>
366 <para>Nutzt man den <link
367 linkend="config.task-server">Taskserver</link> für <link
368 linkend="features.periodic-invoices">wiederkehrende Rechnungen</link>,
369 muss unter <varname>[task_server]</varname> ein Login eines Benutzers
370 angegeben werden, mit dem sich der Taskserver an kivitendo bei der
371 Datenbank anmeldet, die dem Benutzer zugewiesen ist.</para>
373 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
374 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
377 <sect2 id="config.config-file.prior-versions">
378 <title>Versionen vor 2.6.3</title>
380 <para>In älteren kivitendo Versionen gab es im Verzeichnis
381 <filename>config</filename> die Dateien
382 <filename>authentication.pl</filename> und
383 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
384 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
385 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
386 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
388 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
389 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
390 manuell übertragen und die alten Konfigurationsdateien anschließend
391 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
392 entsprechende Fehlermeldung an.</para>
396 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
397 <title>Anpassung der PostgreSQL-Konfiguration</title>
399 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
401 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
402 <title>Zeichensätze/die Verwendung von UTF-8</title>
404 <para>Bei aktuellen Serverinstallationen braucht man hier meist nicht
407 <para>Dieses kann überprüft werden: ist das Encoding der Datenbank
408 “template1” “UTF8”, so braucht man nichts weiteres diesbezüglich
409 unternehmen. Zum Testen:
411 <programlisting>su postgres
413 exit </programlisting>
415 Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
416 UTF-8-Encoding anzulegen und diesen zu verwenden. Unter Debian und
417 Ubuntu kann dies z.B. für PostgreSQL 8.2 mit dem folgenden Befehl
420 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2 clustername</programlisting>
422 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
423 Versionsnummer angepasst werden.</para>
425 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
427 <para>Wurde PostgreSQL nicht mit UTF-8 als Encoding initialisiert und
428 ist ein Neuanlegen eines weiteren Clusters nicht möglich, so kann
429 kivitendo mit ISO-8859-15 als Encoding betrieben werden.</para>
431 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
432 <literal>\l</literal> geprüft werden.</para>
435 <sect2 id="Änderungen-an-Konfigurationsdateien">
436 <title>Änderungen an Konfigurationsdateien</title>
438 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
439 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
440 <filename>/var/lib/pgsql/data/</filename> oder
441 <filename>/etc/postgresql/</filename>, muss sichergestellt werden,
442 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
443 Parameter <varname>listen_address</varname> gesteuert. Laufen
444 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
445 <literal>localhost</literal> verwendet werden. Andernfalls müssen
446 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
447 was mit dem Wert <literal>*</literal> geschieht.</para>
449 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
450 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
451 sein sollte, müssen die Berichtigungen für den Zugriff geändert
452 werden. Hier gibt es mehrere Möglichkeiten. sinnvoll ist es nur die
453 nögiten Verbindungen immer zuzulassen, für eine lokal laufenden
454 Datenbank zum Beispiel:</para>
456 <programlisting>local all kivitendo password
457 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
460 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
461 <title>Erweiterung für servergespeicherte Prozeduren</title>
463 <para>In der Datenbank <literal>template1</literal> muss die
464 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
465 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
466 <programlisting>su - postgres
467 psql template1</programlisting>
469 führen Sie die folgenden Kommandos aus:</para>
471 <programlisting>create language 'plpgsql';
475 <sect2 id="Datenbankbenutzer-anlegen">
476 <title>Datenbankbenutzer anlegen</title>
478 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
479 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
480 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
483 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit nein
484 beantworten, genauso ist die Berechtigung neue User (Roles) zu
485 generieren nicht nötig.</para>
486 <programlisting>su - postgres
487 createuser -d -P kivitendo
488 exit</programlisting>
490 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
491 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.
492 den hier gewählten Benutzernamen.</para>
496 <sect1 id="Apache-Konfiguration">
497 <title>Webserver-Konfiguration</title>
500 <title>Grundkonfiguration mittels CGI</title>
503 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
504 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
505 <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
508 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
509 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
510 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
511 anderen Datei hinzu, die beim Starten des Webservers eingelesen
514 <programlisting>AddHandler cgi-script .pl
515 Alias /kivitendo-erp/ /var/www/kiviteno-erp/
517 <Directory /var/www/kivitendo-erp>
518 Options ExecCGI Includes FollowSymlinks
521 <Directory /var/www/kivitendo-erp/users>
524 </Directory></programlisting>
526 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
527 das kivitendo-Archiv entpacket haben.</para>
530 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
531 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
534 <para>Auf einigen Webservern werden manchmal die Grafiken und
535 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
536 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
538 <programlisting>EnableSendfile Off</programlisting>
541 <sect2 id="Apache-Konfiguration.FCGI"
542 xreflabel="Konfiguration für FastCGI/FCGI">
543 <title>Konfiguration für FastCGI/FCGI</title>
545 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
546 <title>Was ist FastCGI?</title>
548 <para>Direkt aus <ulink
549 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
552 <para><citation> FastCGI ist ein Standard für die Einbindung
553 externer Software zur Generierung dynamischer Webseiten in einem
554 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
555 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
556 umgehen. </citation></para>
559 <sect3 id="Apache-Konfiguration.FCGI.Warum">
560 <title>Warum FastCGI?</title>
562 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
563 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
564 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
565 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
566 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
567 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
568 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
569 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
570 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
571 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
572 deutlich länger dauert als früher, und dass davon 90% für das Laden
573 der Module verwendet wird.</para>
575 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
576 wird nur die eigentliche Programmlogik ausgeführt.</para>
579 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
580 <title>Getestete Kombinationen aus Webservern und Plugin</title>
582 <para>Folgende Kombinationen sind getestet:</para>
586 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
590 <para>Apache 2.2.11 (Ubuntu) und mod_fastcgi.</para>
594 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
595 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
596 mod_fastcgi nicht mehr explizit eingegangen.</para>
598 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
602 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern
603 bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrere Installation gibt, muss zwingend Version 0.68 oder
604 aber Version 0.72 und neuer eingesetzt werden.</para>
606 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie sich die Vorgängerversion wie folgt
609 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
613 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
614 <title>Konfiguration des Webservers</title>
616 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
617 laufen zu lassen, empfliehlt es sich die Installation ersteinmal
618 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
619 debuggen die beim ersten aufsetzen auftreten können. Sollte die
620 Installation schon funktionieren, lesen Sie weiter.</para>
622 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
623 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
625 <programlisting>a2enmod fcgid</programlisting>
627 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
628 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
629 und <function>Directory</function>-Direktiven. Dabei wird zwischen
630 dem Installationspfad von kivitendo im Dateisystem
631 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
632 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
633 ("<filename>/url/for/kivitendo-erp</filename>").</para>
635 <para>Folgender Konfigurationsschnipsel funktioniert mit
638 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
639 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
641 <Directory /path/to/kivitendo-erp>
643 Options ExecCGI Includes FollowSymlinks
648 <DirectoryMatch /path/to/kivitendo-erp/users>
651 </DirectoryMatch></programlisting>
653 <para>Seit mod_fcgid-Version 2.6.3 gelten sehr kleine Grenzen für
654 die maximale Größe eines Requests. Diese sollte wie folgt
655 hochgesetzt werden:</para>
657 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
659 <para>Das ganze sollte dann so aussehen:</para>
661 <programlisting>AddHandler fcgid-script .fpl
662 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
663 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
664 FcgidMaxRequestLen 10485760
666 <Directory /path/to/kivitendo-erp>
668 Options ExecCGI Includes FollowSymlinks
673 <DirectoryMatch /path/to/kivitendo-erp/users>
676 </DirectoryMatch></programlisting>
678 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
679 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
680 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
681 gibt es hier kleine Performance-Einbußen.</para>
683 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
684 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
685 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
687 <programlisting># Zugriff über CGI
688 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
690 # Zugriff mit mod_fcgid:
691 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
692 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
694 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
695 die normale Version erreichbar, und unter
696 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
697 FastCGI-Version.</para>
702 <sect1 id="config.task-server">
703 <title>Der Task-Server</title>
705 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
706 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
707 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
708 wird bisher nur für die Erzeugung der wiederkehrenden Rechnungen
709 benutzt, wird aber in Zukunft deutlich mehr Aufgaben übertragen
712 <sect2 id="Konfiguration-des-Task-Servers">
713 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
715 <para>Die Konfiguration erfolgt über den Abschnitt
716 <literal>[task_server]</literal> in der Datei
717 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
718 Optionen sind:</para>
722 <term><varname>login</varname></term>
725 <para>gültiger kivitendo-Benutzername, der benutzt wird, um die
726 zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss
727 in der Administration angelegt werden. Diese Option muss
728 angegeben werden.</para>
733 <term><varname>run_as</varname></term>
736 <para>Wird der Server vom Systembenutzer <literal>root</literal>
737 gestartet, so wechselt er auf den mit <literal>run_as</literal>
738 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
739 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
741 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
742 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
743 unter dem auch der Webserver läuft.</para>
748 <term><varname>debug</varname></term>
751 <para>Schaltet Debug-Informationen an und aus.</para>
757 <sect2 id="Einbinden-in-den-Boot-Prozess">
758 <title>Automatisches Starten des Task-Servers beim Booten</title>
760 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
761 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
762 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
764 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
765 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
766 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
767 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
768 anstelle eines symbolischen Links verwendet werden können.</para>
771 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSuSE, ältere Fedora Core)</title>
773 <para>Kopieren Sie die Datei
774 <filename>scripts/boot/system-v/kivitendo-server</filename>
775 nach <filename>/etc/init.d/kivitendo-server</filename>. Passen
776 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
777 <literal>DAEMON=....</literal>). Binden Sie das Script in den
778 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
782 <para>Debian-basierende Systeme:</para>
784 <programlisting>update-rc.d kivitendo-task-server defaults
785 # Nur bei Debian Squeeze und neuer:
786 insserv kivitendo-task-server</programlisting>
790 <para>Ältere OpenSuSE und ältere Fedora Core:</para>
792 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
796 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
799 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
803 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
805 <para>Kopieren Sie die Datei
806 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
807 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
808 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
809 <literal>exec ....</literal>).</para>
811 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
814 <programlisting>service kivitendo-task-server start</programlisting>
818 <title>systemd-basierende Systeme (z.B. neure OpenSuSE, neuere Fedora Core)</title>
820 <para>Verlinken Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
821 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
822 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>). Binden Sie das Script in den Boot-Prozess ein.
825 <para>Alle hierzu benötigten Befehle sehen so aus:</para>
827 <programlisting>cd /var/www/kivitendo-erp/scripts/boot/systemd
828 ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
830 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
833 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
837 <sect2 id="Prozesskontrolle">
838 <title>Wie der Task-Server gestartet und beendet wird</title>
840 <para>Der Task-Server wird wie folgt kontrolliert:</para>
842 <programlisting>./scripts/task_server.pl Befehl</programlisting>
844 <para><literal>Befehl</literal> ist dabei eine der folgenden
849 <para><literal>start</literal> startet eine neue Instanz des
850 Task-Servers. Die Prozess-ID wird innerhalb des
851 <filename>users</filename>-Verzeichnisses abgelegt.</para>
855 <para><literal>stop</literal> beendet einen laufenden
860 <para><literal>restart</literal> beendet und startet ihn
865 <para><literal>status</literal> berichtet, ob der Task-Server
870 <para>Der Task-Server wechselt beim Starten automatisch in das
871 kivitendo-Installationsverzeichnis.</para>
873 <para>Dieselben Optionen können auch für die SystemV-basierenden
874 Runlevel-Scripte benutzt werden (siehe oben).</para>
876 <sect2 id="Prozesskontrolle2">
877 <title>Task-Server mit mehreren Mandanten</title>
879 <para>Beim Task-Server wird der Login-Name des Benutzers, unter dem der
880 Task-Server laufen soll, in die Konfigurationsdatei geschrieben. Hat
881 man mehrere Mandanten muß man auch mehrere Konfigurationsdateien
884 <para>Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf,
885 wo in der Kategorie [task_server] der gewünschte "login" steht.</para>
887 <para>Der alternative Task-Server wird dann mit folgendem Befehl
890 <programlisting>./scripts/task_server.pl -c config/DATEINAME.conf</programlisting>
894 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
895 <title>Benutzerauthentifizierung und Administratorpasswort</title>
897 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
898 über die Verwaltung von Gruppen und weitere Einstellungen</para>
900 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
901 <title>Grundlagen zur Benutzerauthentifizierung</title>
903 <para>kivitendo verwaltet die Benutzerinformationen in einer
904 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
905 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
906 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
907 können, müssen aber nicht unterschiedlich sein.</para>
909 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
910 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
911 abgelegt werden.</para>
913 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
914 entweder gegen die Authentifizierungsdatenbank oder gegen einen
915 LDAP-Server überprüft werden.</para>
917 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
918 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
919 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
920 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
921 einer Version vor v2.6.0 angelegt werden. Eine
922 Beispielkonfigurationsdatei
923 <filename>config/kivitendo.conf.default</filename> existiert, die als
924 Vorlage benutzt werden kann.</para>
927 <sect2 id="Administratorpasswort">
928 <title>Administratorpasswort</title>
930 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
931 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
932 nur dort und nicht mehr im Administrationsinterface selber geändert
933 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
934 Abschnitt <varname>[authentication]</varname>.</para>
937 <sect2 id="Authentifizierungsdatenbank">
938 <title>Authentifizierungsdatenbank</title>
940 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
941 Parametern in <varname>[authentication/database]</varname>
942 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
946 <term><literal>host</literal></term>
949 <para>Der Rechnername oder die IP-Adresse des
950 Datenbankservers</para>
955 <term><literal>port</literal></term>
958 <para>Die Portnummer des Datenbankservers, meist 5432</para>
963 <term><literal>db</literal></term>
966 <para>Der Name der Authentifizierungsdatenbank</para>
971 <term><literal>user</literal></term>
974 <para>Der Benutzername, mit dem sich kivitendo beim
975 Datenbankserver anmeldet (z.B.
976 "<literal>postgres</literal>")</para>
981 <term><literal>password</literal></term>
984 <para>Das Passwort für den Datenbankbenutzer</para>
989 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
990 automatisch anlegen (mehr dazu siehe unten).</para>
993 <sect2 id="Passwortüberprüfung">
994 <title>Passwortüberprüfung</title>
996 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
997 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
998 Active-Directory-Server. Welche davon benutzt wird, regelt der
999 Parameter <varname>module</varname> im Abschnitt
1000 <varname>[authentication]</varname>.</para>
1002 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1003 gespeichert werden, so muss der Parameter <varname>module</varname>
1004 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1005 der Administrator als auch die Benutzer selber ihre Psaswörter in
1006 kivitendo ändern.</para>
1008 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1009 benutzt werden, so muss der Parameter <varname>module</varname> auf
1010 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1011 zusätzliche Informationen über den LDAP-Server im Abschnitt
1012 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1016 <term><literal>host</literal></term>
1019 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1020 Active-Directory-Servers. Diese Angabe ist zwingend
1021 erforderlich.</para>
1026 <term><literal>port</literal></term>
1029 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1034 <term><literal>tls</literal></term>
1037 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1038 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1039 ‘<literal>0</literal>’ belassen</para>
1044 <term><literal>attribute</literal></term>
1047 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1048 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1049 meist ‘<literal>sAMAccountName</literal>’, für andere
1050 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1051 zwingend erforderlich.</para>
1056 <term><literal>base_dn</literal></term>
1059 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1060 Diese Angabe ist zwingend erforderlich.</para>
1065 <term><literal>filter</literal></term>
1068 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1069 <literal><%login%></literal>, so wird dieses durch den vom
1070 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1071 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1072 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1077 <term><literal>bind_dn</literal> und
1078 <literal>bind_password</literal></term>
1081 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1082 durchsucht werden kann (z.B. ist dies bei
1083 Active-Directory-Servern der Fall), so kann diese hier angegeben
1084 werden. Für Active-Directory-Server kann als
1085 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1086 z.B. ‘<literal>cn=Martin
1087 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1088 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1089 also ‘<literal>Martin Mustermann</literal>’.</para>
1095 <sect2 id="Name-des-Session-Cookies">
1096 <title>Name des Session-Cookies</title>
1098 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1099 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1100 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1101 Parameter <varname>cookie_name</varname> im Abschnitt
1102 <varname>[authentication]</varname>gesetzt.</para>
1104 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1105 Server existiert.</para>
1108 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1109 <title>Anlegen der Authentifizierungsdatenbank</title>
1111 <para>Nachdem alle Einstellungen in
1112 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1113 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1114 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1115 der folgenden URL erreichbar sein sollte:</para>
1118 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
1122 <sect1 id="Benutzer--und-Gruppenverwaltung">
1123 <title>Benutzer- und Gruppenverwaltung</title>
1125 <para>Nach der Installation müssen Benutzer, Gruppen und Datenbanken
1126 angelegt werden. Dieses geschieht im Administrationsmenü, das Sie unter
1127 folgender URL finden:</para>
1130 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
1132 <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
1133 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1135 <sect2 id="Zusammenhänge">
1136 <title>Zusammenhänge</title>
1138 <para>kivitendo verwendet eine Datenbank zum Speichern all seiner
1139 Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um
1140 mit kivitendo arbeiten zu können, muss eine Person einen
1141 Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine
1142 Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist
1143 möglich und normal, dass mehreren Benutzern die selbe Datenbank
1144 zugewiesen wird, sodass sie alle mit den selben Daten arbeiten
1147 <para>Die Basisdaten der Benutzer, die in der Administration
1148 eingegeben werden können, werden in einer zweiten Datenbank
1149 gespeichert, der bereits erwähnten Authentifizierungsdatenbank. Diese
1150 ist also den Produktivdaten enthaltenden Datenbanken vorgeschaltet.
1151 Pro kivitendo-Installation gibt es nur eine
1152 Authentifizierungsdatenbank, aber beliebig viele Datenbanken mit
1155 <para>kivitendo kann seinen Benutzern Zugriff auf bestimmte
1156 Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht
1157 gestattet, so werden der entsprechenden Menüpunkte auch nicht
1158 angezeigt. Diese Rechte werden ebenfalls in der
1159 Authentifizierungsdatenbank gespeichert.</para>
1161 <para>Um Rechte verteilen zu können, verwendet kivitendo ein
1162 Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche
1163 erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder
1164 mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen
1165 Funktionen, die mindestens einer Gruppe erlaubt sind, in der der
1166 Benutzer Mitglied ist.</para>
1168 <para>Die allgemeine Reihenfolge, in der Datenbanken, Gruppen und
1169 Benutzer angelegt werden sollten, lautet:</para>
1171 <orderedlist numeration="arabic">
1173 <para>Datenbank anlegen</para>
1177 <para>Gruppen anlegen</para>
1181 <para>Benutzer anlegen</para>
1185 <para>Benutzer den Gruppen zuordnen</para>
1190 <sect2 id="Datenbanken-anlegen">
1191 <title>Datenbanken anlegen</title>
1193 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1194 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1195 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1197 <para>Wenn Sie für die kivitendo-Installation nicht Unicode (UTF-8) sondern den europäischen Schriftsatz ISO-8859-15 benutzen
1198 wollen, so müssen Sie vor dem Anlegen der Datenbank in der Datei <filename>config/kivitendo.conf</filename> die Variable
1199 <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf den Wert ‘<literal>ISO-8859-15</literal>’ setzen.</para>
1201 <para>Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz
1202 verwenden müssen, da diese Einstellungen momentan global in kivitendo
1203 vorgenommen wird und nicht nach Datenbank unterschieden werden kann.
1204 Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz
1205 angelegt worden sein.</para>
1208 <sect2 id="Gruppen-anlegen">
1209 <title>Gruppen anlegen</title>
1211 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1212 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1213 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1214 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1216 <para>Benutzergruppen sind unabhängig von Datenbanken, da sie in der
1217 Authentifizierungsdatenbank gespeichert werden. Sie gelten für alle
1218 Datenbanken, die in dieser Installation verwaltet werden.</para>
1221 <sect2 id="Benutzer-anlegen">
1222 <title>Benutzer anlegen</title>
1224 <para>Beim Anlegen von Benutzern werden für viele Parameter
1225 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1226 deutschen Raumes entsprechen.</para>
1228 <para>Zwingend anzugeben sind der Loginname sowie die komplette
1229 Datenbankkonfiguration. Wenn die Passwortauthentifizierung über die
1230 Datenbank eingestellt ist, so kann hier auch das Benutzerpasswort
1231 gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung
1232 aktiv, so ist das Passwort-Feld deaktiviert.</para>
1234 <para>In der Datenbankkonfiguration müssen die Zugriffsdaten einer der
1235 eben angelegten Datenbanken eingetragen werden.</para>
1238 <sect2 id="Gruppenmitgliedschaften-verwalten">
1239 <title>Gruppenmitgliedschaften verwalten</title>
1241 <para>Nach dem Anlegen von Benutzern und Gruppen müssen Benutzer den
1242 Gruppen zugewiesen werden. Dazu gibt es zwei Möglichkeiten:</para>
1244 <orderedlist numeration="arabic">
1246 <para>In der Gruppenverwaltung wählt man eine Gruppe aus. Im
1247 folgenden Dialog kann man dann einzeln die Benutzer der Gruppe
1252 <para>In der Gruppenverwaltung wählt man das Tool zur Verwaltung
1253 der Gruppenmitgliedschaft. Hier wird eine Matrix angezeigt, die
1254 alle im System angelegten Gruppen und Benutzer enthält. Durch
1255 Setzen der Häkchen wird der Benutzer in der ausgewählten Zeile der
1256 Gruppe in der ausgewählten Spalte hinzugefügt.</para>
1261 <sect2 id="Migration-alter-Installationen">
1262 <title>Migration alter Installationen</title>
1264 <para>Wenn kivitendo 2.6.3 über eine ältere Version installiert wird,
1265 in der die Benutzerdaten noch im Dateisystem im Verzeichnis
1266 <literal>users</literal> verwaltet wurden, so bietet kivitendo die
1267 Möglichkeit, diese Benutzerdaten automatisch in die
1268 Authentifizierungsdatenbank zu übernehmen. Dies geschieht, wenn man
1269 sich nach dem Update der Installation das erste Mal im
1270 Administrationsbereich anmeldet. Findet kivitendo die Datei
1271 <literal>users/members</literal>, so wird der Migrationsprozess
1274 <para>Der Migrationsprozess ist nahezu vollautomatisch. Alle
1275 Benutzerdaten können übernommen werden. Nach den Benutzerdaten bietet
1276 kivitendo noch die Möglichkeit an, dass automatisch eine
1277 Benutzergruppe angelegt wird. Dieser Gruppe wird Zugriff auf alle
1278 Funktionen von kivitendo gewährt. Alle migrierten Benutzern werden
1279 Mitglied in dieser Gruppe. Damit wird das Verhalten von kivitendo bis
1280 Version 2.4.3 inklusive wiederhergestellt, und die Benutzer können
1281 sich sofort wieder anmelden und mit dem System arbeiten.</para>
1285 <sect1 id="config.sending-email" xreflabel="E-Mail-Versand aus kivitendo heraus">
1286 <title>E-Mail-Versand aus kivitendo heraus</title>
1288 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden, z.B. um ein Angebot direkt an einen Kunden zu
1289 verschicken. Damit dies funktioniert, muss eingestellt werden, über welchen Server die E-Mails verschickt werden sollen. kivitendo
1290 unterstützt dabei zwei Mechanismen: Versand über einen lokalen E-Mail-Server (z.B. mit <productname>Postfix</productname> oder
1291 <productname>Exim</productname>, was auch die standardmäßig aktive Methode ist) sowie Versand über einen SMTP-Server (z.B. der des
1292 eigenen Internet-Providers).</para>
1294 <para>Welche Methode und welcher Server verwendet werden, wird über die Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1295 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1297 <sect2 id="config.sending-email.sendmail" xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1298 <title>Versand über lokalen E-Mail-Server</title>
1300 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie
1301 z.B. <productname>Postfix</productname>, <productname>Exim</productname> oder <productname>Sendmail</productname> läuft.</para>
1303 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1304 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1306 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet wird, dient der Parameter '<literal>sendmail =
1307 ...</literal>'. Der Standardwert verweist auf das Programm <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1308 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1310 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen dieses sprengen. Hierfür sei auf die Dokumentation des
1311 E-Mail-Servers verwiesen.</para>
1314 <sect2 id="config.sending-email.smtp" xreflabel="E-Mail-Versand über einen SMTP-Server">
1315 <title>Versand über einen SMTP-Server</title>
1317 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server vorhanden oder zwar einer vorhanden, dieser aber nicht
1318 konfiguriert ist.</para>
1320 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1321 Parameter dienen dabei der weiteren Konfiguration:</para>
1325 <term><varname>hostname</varname></term>
1327 <listitem><para>Name oder IP-Adresse des SMTP-Servers. Standardwert: '<literal>localhost</literal>'</para></listitem>
1331 <term><varname>port</varname></term>
1333 <listitem><para>Portnummer. Der Standardwert hängt von der verwendeten Verschlüsselungsmethode ab. Gilt '<literal>security =
1334 none</literal>' oder '<literal>security = tls</literal>', so ist 25 die Standardportnummer. Für '<literal>security =
1335 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht geändert werden.</para></listitem>
1339 <term><varname>security</varname></term>
1341 <listitem><para>Wahl der zu verwendenden Verschlüsselung der Verbindung mit dem Server. Standardwert ist
1342 '<literal>none</literal>', wodurch keine Verschlüsselung verwendet wird. Mit '<literal>tls</literal>' wird TLS-Verschlüsselung
1343 eingeschaltet, und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL eingeschaltet. Achtung: Für
1344 '<literal>tls</literal>' und '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt (siehe unten).</para></listitem>
1348 <term><varname>login</varname> und <varname>password</varname></term>
1350 <listitem><para>Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername
1351 und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von
1352 Verschlüsselung aktiviert werden.</para></listitem>
1356 <para>Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind:</para>
1359 <listitem><para>TLS-Verschlüsselung: Modul <literal>Net::SSLGlue</literal> (Debian-Paketname
1360 <literal>libnet-sslglue-perl</literal>, Fedora Core: <literal>perl-Net-SSLGlue</literal>, openSuSE:
1361 <literal>perl-Net-SSLGlue</literal></para></listitem>
1363 <listitem><para>SSL-Verschlüsselung: Modul <literal>Net::SMTP::SSL</literal> (Debian-Paketname
1364 <literal>libnet-smtp-ssl-perl</literal>, Fedora Core: <literal>perl-Net-SMTP-SSL</literal>, openSuSE:
1365 <literal>perl-Net-SMTP-SSL</literal></para></listitem>
1370 <sect1 id="Drucken-mit-kivitendo">
1371 <title>Drucken mit kivitendo</title>
1373 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. Um drucken zu können, braucht der Server ein geeignetes
1374 LaTeX System. Am einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter Debianoiden Betriebssystemen installiert man
1375 die Pakete mit:</para>
1377 <para><programlisting>aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1378 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1380 <para>TODO: RPM-Pakete.</para>
1382 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1384 <listitem><para>Standard</para></listitem>
1385 <listitem><para>f-tex</para></listitem>
1386 <listitem><para>RB</para></listitem>
1389 <sect2 id="Vorlagenverzeichnis-anlegen" xreflabel="Vorlagenverzeichnis anlegen">
1390 <title>Vorlagenverzeichnis anlegen</title>
1391 <para>Im Administrationsbereich lässt sich bei einem Benutzer/Mandanten einer dieser Vorlagensätze als Basis für die zu
1392 druckenden Dokumente auswählen. Rufen Sie dazu die <guimenu>Benutzerverwaltung</guimenu> auf.</para>
1394 <para>Wählen Sie dort einen Benutzer aus oder legen Sie einen neuen an. In der Benutzerbearbeiten-Maske müssen Sie zwei Dinge
1398 <listitem><para><option>Name</option>: Der Verzeichnisname für den neuen Vorlagensatz. Dieser kann im Rahmen der üblichen
1399 Bedingungen für Verzeichnisnamen frei gewählt werden.</para></listitem>
1400 <listitem><para><option>Vorlagen auswählen</option>: Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll
1401 (<filename>Standard</filename>, <filename>f-tex</filename> oder <filename>RB</filename>.)</para></listitem>
1404 <para>Der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Benutzern verwendet werden.</para>
1406 <para>Die Abhängigkeiten kann man prüfen mit:</para>
1408 <programlisting>/scripts/installation_check.pl -l</programlisting>
1411 <sect2 id="Vorlagen-Standard">
1412 <title>Standard</title>
1414 <para>Der Standard-Vorlagensatz von Kivitendo. Wie unter <ulink url="http://demo.kivitendo.org">http://demo.kivitendo.org</ulink> zu
1420 <title>f-tex</title>
1422 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt.</para>
1424 <sect3 id="f-tex-Feature-Übersicht">
1425 <title>Feature-Übersicht</title>
1427 <listitem><para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage für alle briefartigen Dokumente verwendet. Also
1428 Angebot, Rechnung, Performarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc..</para></listitem>
1430 <listitem><para>Leichte Anpassung an das Firmen-Layout durch verwendung eines Hintergrund-PDF. Dieses kann leicht mit dem
1431 eigenen Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp, Adobe*)</para></listitem>
1433 <listitem><para>Hintergrund-PDF umschaltbar auf "nur erste Seite" (Standard) oder "alle Seiten" (Option
1434 "<option>bgPdfFirstPageOnly</option>" in Datei <filename>letter.lco</filename>)</para></listitem>
1436 <listitem><para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1437 versendeten Dokumenten eingebunden (Option "<option>bgPdfEmailOnly</option>" in Datei
1438 <filename>letter.lco</filename>).</para></listitem>
1440 <listitem><para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch, Wiederholung von Kopfzeilen, Zwischensummen
1441 etc. (danke an Kai-Martin Knaak für die Vorarbeit)</para></listitem>
1443 <listitem><para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom Land des eigenen Unternehmens abweicht (also die
1444 Rechnung das Land verlässt).</para></listitem>
1446 <listitem><para>Multisprachfähig leicht um weitere Sprachen zu erweitern, alle Übersetzungen in der Datei
1447 <filename>translatinos.tex</filename>.</para></listitem>
1449 <listitem><para>Auflistung von Bruttopreisen für Endverbraucher.</para></listitem>
1453 <sect3 id="f-tex-Installation">
1454 <title>Die Installation</title>
1456 <listitem><para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref linkend="Vorlagenverzeichnis-anlegen"/>. Das
1457 Vorlagensystem funktioniert jetzt schon, hat allerdings noch einen Beispiel-Briefkopf.</para></listitem>
1459 <listitem><para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach <filename>./letter_head.pdf</filename>.</para></listitem>
1460 <listitem><para>Editiere den Bereich "<option>settings</option>" in der datei <filename>letter.lco</filename>.</para></listitem>
1463 <para>oder etwas Detaillierter:</para>
1466 Es wird eine Datei <filename>sample.lco</filename> erstellt und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
1467 ist dies die Datei die für die Firmenspezifischen Anpassungen gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig
1468 ist, wird in dieser Datei auf ein Hintergrundpdf verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen
1469 vorzunehmen und <filename>sample.lco</filename> unverändert zu lassen. Die die Anpassung über eine
1470 <filename>*.lco</filename>-Datei die letztlich auf <filename>letter.lco</filename> verlinkt ist ist aber auch möglich.
1474 Es wird eine Datei <filename>sample_head.pdf</filename> mit ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
1475 verlinkt. Damit gibt es schon mal eine Funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei
1476 <filename>sample_haed.pdf</filename> an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
1477 Template Verzeichniss ablegen und statt <filename>sample_head.pdf</filename> nach <filename>letter_head.pdf</filename>
1482 letzlich muss <filename>letter_head.pdf</filename> auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
1483 enthält. Bei Updates oder nach erneutem
1487 Es wird eine Datei <filename>mydata.tex.example</filename> ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
1488 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das Land verwendet. Die Datei muss also nicht angefasst
1489 werden. Die Anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig).
1492 Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc. sollten über die Hintergrund-PDF-Datei oder die
1493 <filename>*.lco</filename>-Datei erfolgen.
1497 <sect3 id="f-tex-Funktionsübersicht">
1498 <title>f-tex Funktionsübersicht</title>
1500 Das Konzept von kivitendo sieht vor, für jedes Dokument (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine LaTeX-Vorlage
1501 vorzuhalten, dies ist sehr Wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
1502 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
1503 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche LaTeX-Vorlage verwendet, welche über Codeweichen die
1504 Besonderheiten der jeweiligen Dokumente Berücksichtigt.
1508 <listitem><para>Tabellen mit oder ohne Preis</para></listitem>
1509 <listitem><para>Sprache der Tabellenüberschriften etc.</para></listitem>
1510 <listitem><para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus Angebotsnummer)</para></listitem>
1511 <listitem><para>Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus Gewerblicher
1512 Kunde)</para></listitem>
1515 <para>Nachteil:</para>
1518 LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
1519 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann natürlich
1520 auch innerhalb der Tabellendarstellung gut persönliche Anpassungen vornehmen. Aber man kann sich hier bei Veränderungen sehr
1521 schnell häftig in den Fuss schiessen.
1524 <para>Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund PDF auf Basis der
1525 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen, und sich an der Form der dargestellten Tabellen wie sie
1526 ausgeliefert werden, erfreuen.
1529 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine kontinuierliche Schritte gehen.</para>
1533 <sect3 id="f-tex-Bruttopreise">
1534 <title>Bruttopreise für Endverbraucher</title>
1536 <para>Der auszuweisende Bruttopreis wird innerhalb der LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen "alle
1537 Preise Brutto" auszuwählen, aber:</para>
1540 <para>hierfür müssen die Preise auch in Brutto in der Datenbank stehen (ja - das lässt sich über die Preisgruppen und die
1541 Zuordung einer Default-Preisgruppe handhaben)</para>
1544 <para>man darf beim Anlegen des Vorgangs nicht vergessen Dieses Häkchen zu setzen. (das ist in der Praxis wenn man sowohl
1545 Endverbraucher- wie Gewerbekunden beliefert der eigentliche Knackpunkt)</para>
1550 Es gibt mit f-tex eine weitere Alternative. Die Information ob Brutto oder Nettorechnung wird mit den Zahlarten
1551 verknüpft. Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben werden sollen, enden mit "_E" (für
1552 Endverbraucher). Falls identische Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt man diese einfach doppelt
1553 an (einmal mit der Namensendung "_E"). Gewinn:</para>
1556 <listitem><para>Die Entscheidung, ob Netopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste Verbunden.</para></listitem>
1557 <listitem><para>Die Default-Zahlart kann im Kundendatensatz hinterlegt werden, und man muss nicht mehr daran denken, "alle Preise
1558 Netto" auszuwählen.</para></listitem>
1559 <listitem><para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken reviediert werden,
1560 ohne dass sich der Auftragswert ändert.</para></listitem>
1564 <sect3 id="f-tex-lieferadressen">
1565 <title>Lieferadressen</title>
1567 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen im Adressfeld zum Einsatz. Wenn die
1568 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende Adressvariable eingesetzt. Wenn also die Lieferadresse in
1569 Straße, Hausnummer und Ort abweicht, müssen auch nur diese Felder in der Lieferadresse ausgefüllt werden. Für den Firmenname wird
1570 der Wert der Hauptadresse angezeigt.
1575 <sect2 id="Vorlagen-RB">
1578 <para>Vollständiger Dokumentensatz mit alternativem Design</para>
1582 <sect2 id="allgemeine-hinweise-zu-latex">
1583 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
1584 <para>In den allermeisten Installationen sollte drucken jetzt schon
1585 funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
1586 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
1587 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1592 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1593 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1594 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1598 <para>! Package inputenc Error: Unicode char \u8:... set up for
1599 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1600 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1601 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1602 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1603 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1607 <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
1608 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1609 Prüfen Sie den Namen in der Konfiguration (Standard:
1610 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1611 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1614 <para>Wenn sich das Problem nicht auf Grund der ausgabe im Webbrowser verifizieren lässt:</para>
1617 <para> editiere [kivitendo-home]/config/kivitendo.conf und ändere "keep_tmp_files" auf 1</para>
1618 <para><programlisting>keep_temp_files = 1;</programlisting></para>
1621 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
1624 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
1627 <para>wechsele in das users Verzeichnis von kivitendo</para>
1628 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
1631 <para>LaTeX Suchpfad anpassen:</para>
1632 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
1635 <para>Finde herraus welche Datei kivitendo beim letzten Durchlauf erstellt hat</para>
1636 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
1637 <para>Es sollte die letzte Datei ganz unten sein</para>
1640 <para>für besseren Hinweis auf Fehler texdatei nochmals übersetzen</para>
1641 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
1642 <para>in der *.tex datei nach dem Fehler suchen.</para>
1648 <sect1 id="OpenDocument-Vorlagen">
1649 <title>OpenDocument-Vorlagen</title>
1651 <para>kivitendo unterstützt die Verwendung von Vorlagen im
1652 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1653 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1654 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1655 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1656 <filename>config/kivitendo.conf</filename> die Variable
1657 <literal>opendocument</literal> im Abschnitt
1658 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1659 Dieses ist die Standardeinstellung.</para>
1661 <para>Weiterhin muss in der Datei
1662 <filename>config/kivitendo.conf</filename> die Variable
1663 <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf
1664 die Zeichenkodierung gesetzt werden, die auch bei der Speicherung der
1665 Daten in der Datenbank verwendet wird. Diese ist in den meisten Fällen
1668 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1669 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1670 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1671 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1672 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1673 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1675 <para>Nach der Installation müssen in der Datei
1676 <filename>config/kivitendo.conf</filename> zwei weitere Variablen
1677 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1678 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1679 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1680 enthalten. Beide stehen im Abschnitt
1681 <literal>applications</literal>.</para>
1683 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
1684 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1685 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1686 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1687 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1688 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1689 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1690 werden muss. Der Nachteil ist, dass diese Methode Python und die
1691 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1694 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1695 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1696 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1697 Dokumentenvorlage enthalten sein und
1698 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1699 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1700 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1701 ebenfalls enthalten sein muss.</para>
1703 <para>Als letztes muss herausgefunden werden, welchen Namen
1704 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1705 gibt. Unter Debian ist dies momentan
1706 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1707 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1708 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1709 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1710 folgender Befehl auszuführen:</para>
1712 <para><literal>mv users/.openoffice.org2
1713 users/.openoffice</literal></para>
1715 <para>Dieses Verzeichnis, wie auch das komplette
1716 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1717 sein. Dieses wurde bereits erledigt (siehe <xref
1718 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1719 erneut überprüft werden, wenn die Konvertierung nach PDF
1723 <sect1 id="config.eur">
1724 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1727 <sect2 id="config.eur.introduction"
1728 xreflabel="Einführung in die Konfiguration zur EUR">
1729 <title>Einführung</title>
1731 <para>kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1732 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals noch <filename>config/lx_office.conf</filename>)
1733 befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden.</para>
1735 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1736 die Mandantendatenbank verschoben und dabei auch gleich in drei
1737 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1738 steuern lässt.</para>
1741 <sect2 id="config.eur.parameters"
1742 xreflabel="Konfigurationsparameter für EUR">
1743 <title>Konfigurationsparameter</title>
1745 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1746 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1750 <term><varname>profit_determination</varname></term>
1753 <para>Dieser Parameter legt die Berechnungsmethode für die
1754 Gewinnermittlung fest. Er enthält entweder
1755 <literal>balance</literal> für
1756 Betriebsvermögensvergleich/Bilanzierung oder
1757 <literal>income</literal> für die
1758 Einnahmen-Überschuss-Rechnung.</para>
1763 <term><varname>accounting_method</varname></term>
1766 <para>Dieser Parameter steuert die Buchungs- und
1767 Berechnungsmethoden für die Versteuerungsart. Er enthält
1768 entweder <literal>accrual</literal> für die Soll-Versteuerung
1769 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1774 <term><varname>inventory_system</varname></term>
1777 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1778 enthält entweder <literal>perpetual</literal> für die
1779 Bestandsmethode oder <literal>periodic</literal> für die
1780 Aufwandsmethode.</para>
1785 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1786 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1787 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1788 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1789 Bestandsmethode.</para>
1791 <para>Die Konfiguration "<varname>eur</varname>" unter
1792 <varname>[system]</varname> in der <link
1793 linkend="config.config-file">Konfigurationsdatei</link>
1794 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
1795 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1798 <sect2 id="config.eur.setting-parameters">
1799 <title>Festlegen der Parameter</title>
1801 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1802 der Admininstration können diese Optionen nun unabhängig voneinander
1803 eingestellt werden.</para>
1805 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1806 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1809 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1810 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
1811 angezeigt. Unter <guimenu>System</guimenu>
1812 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> können
1813 die Einstellungen auch geändert werden. Dabei ist zu beachten,
1814 dass eine Änderung vorhandene Daten so belässt und damit
1815 evtl. die Ergebnisse verfälscht. Dies gilt vor Allem für die
1816 Warenbuchungsmethode (siehe auch
1817 <link linkend="config.eur.inventory-system-perpetual">
1818 Bemerkungen zu Bestandsmethode</link>).</para>
1821 <sect2 id="config.eur.inventory-system-perpetual">
1822 <title>Bemerkungen zu Bestandsmethode</title>
1824 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1825 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
1826 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1827 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1828 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1829 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1830 Einkaufsrechnungen berechnet wird.</para>
1832 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1833 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1834 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1838 <sect2 id="config.eur.knonw-issues">
1839 <title>Bekannte Probleme</title>
1841 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1842 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1843 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1844 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1845 die Konfigurationsvariable
1846 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1849 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1850 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1854 <sect1 id="config.skr04-update-3804">
1855 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1857 <sect2 id="config.skr04-update-3804.introduction">
1858 <title>Einführung</title>
1860 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1861 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1862 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1863 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1864 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1865 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1866 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1867 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1868 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1869 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1870 Screenshots dargestellt.</para>
1872 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1873 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1874 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1875 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1878 <sect2 id="config.skr04-update-3804.create-chart">
1879 <title>Konto 3804 manuell anlegen</title>
1881 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
1882 anzulegen und zu konfigurieren. Zuerst wird in
1883 <guimenu>System</guimenu> ->
1884 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
1885 erfassen</guimenuitem> das Konto angelegt.</para>
1888 <screeninfo>Konto 3804 erfassen</screeninfo>
1892 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
1898 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
1899 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
1900 wie im folgenden Screenshot angezeigt anpassen.
1904 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
1908 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
1914 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
1915 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
1919 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
1923 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
1929 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
1930 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
1931 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
1932 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
1936 <screeninfo>Konto 4315 anpassen</screeninfo>
1940 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
1946 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
1947 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
1951 <screeninfo>Steuerliste vergleichen</screeninfo>
1955 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
1962 <sect1 id="config.client">
1963 <title>Einstellungen pro Mandant</title>
1965 <para>Einige Einstellungen können von einem Benutzer mit dem
1966 <link linkend="Zusammenhänge">Recht</link> "Administration
1967 (Für die Verwaltung der aktuellen Instanz aus einem Userlogin heraus)"
1968 gemacht werden. Diese Einstellungen sind dann für die aktuellen
1969 Mandanten-Datenbank gültig. Die Einstellungen sind
1970 unter <guimenu>System</guimenu>
1971 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
1973 <para>Bitte beachten Sie die Hinweise zu den einzelnen
1974 Einstellungen. Einige Einstellungen sollten nicht ohne Weiteres
1975 im laufenden Betrieb geändert werden (siehe
1976 auch <link linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
1977 Bestandsmethode</link>).</para>
1979 <para>Die Einstellungen <literal>show_bestbefore</literal>
1980 und <literal>payments_changeable</literal> aus dem
1981 Abschnitt <literal>features</literal> und die Einstellungen im
1982 Abschnitt <literal>datev_check</literal> (sofern schon vorhanden)
1983 der <link linkend="config.config-file">kivitendo-Konfigurationsdatei</link>
1984 werden bei einem Datenbankupdate einer älteren Version automatisch
1985 übernommen. Diese Einträge können danach aus der Konfigurationsdatei
1986 entfernt werden.</para>
1989 <sect1 id="kivitendo-ERP-verwenden">
1990 <title>kivitendo ERP verwenden</title>
1992 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
1993 folgender URL erreichbar:</para>
1996 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
1998 <para>Die Administrationsseite erreichen Sie unter:</para>
2001 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
2005 <chapter id="features" xreflabel="Features und Funktionen">
2006 <title>Features und Funktionen</title>
2008 <sect1 id="features.periodic-invoices"
2009 xreflabel="Wiedekehrende Rechnungen">
2010 <title>Wiederkehrende Rechnungen</title>
2012 <sect2 id="features.periodic-invoices.introduction"
2013 xreflabel="Einführung in wiederkehrende Rechnungen">
2014 <title>Einführung</title>
2016 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
2017 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
2018 Die konfigurierten Aufträge werden später automatisch in Rechnungen
2019 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
2020 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
2021 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
2022 wiederzufinden sind.</para>
2025 <sect2 id="features.periodic-invoices.configuration"
2026 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
2027 <title>Konfiguration</title>
2029 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
2030 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
2031 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
2032 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
2033 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
2036 <para>Folgende Parameter kann man konfigurieren:</para>
2043 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
2044 erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
2045 neuen Monats).</para>
2047 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
2048 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
2049 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
2050 nächsten Periodenwechsel für alle Perioden, seit der letzten
2051 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
2052 verhindern, muss man vorher das Startdatum neu setzen.</para>
2054 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
2055 erstellt. Man kann sich diese Aufträge aber gesondert in den
2056 Berichten anzeigen lassen.</para>
2061 <term>Periodizität</term>
2064 <para>Ob monatlich, quartalsweise oder jährlich auf neue
2065 Rechnungen überprüft werden soll. Für jede Periode seit dem
2066 Startdatum wird überprüft, ob für die Periode (beginnend immer
2067 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
2068 wurde. Unter Umständen können bei einem Startdatum in der
2069 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
2074 <term>Buchen auf</term>
2077 <para>Das Forderungskonto, in der Regel "Forderungen aus
2078 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
2079 Buchungsgruppen der betreffenden Waren.</para>
2084 <term>Startdatum</term>
2087 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
2093 <term>Enddatum</term>
2096 <para>ab wann keine Rechnungen mehr erstellt werden
2102 <term>Automatische Verlängerung um x Monate</term>
2105 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
2106 eingetragenen Enddatums weiterhin erstellt werden, so kann man
2107 hier die Anzahl der Monate eingeben, um die das Enddatum
2108 automatisch nach hinten geschoben wird.</para>
2113 <term>Drucken</term>
2116 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
2117 Rechnungen auch gleich ausdrucken lassen.</para>
2122 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
2123 Informationen zu den erstellten Rechnungen verschickt werden.
2124 Konfiguriert wird dies in der <link
2125 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
2126 <filename>config/kivitendo.conf</filename> im Abschnitt
2127 <varname>[periodic_invoices]</varname>.</para>
2130 <sect2 id="features.periodic-invoices.reports">
2131 <title>Auflisten</title>
2133 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
2134 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
2135 Rechnungen inaktiv", mit denen man sich einen Überglick über die
2136 wiederkehrenden Rechnungen verschaffen kann.</para>
2139 <sect2 id="features.periodic-invoices.task-server">
2140 <title>Erzeugung der eigentlichen Rechnungen</title>
2142 <para>Die zeitliche und periodische Überprüfung, ob eine
2143 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
2144 durch den <link linkend="config.task-server">Taskserver</link>, einen
2145 externen Dienst, der automatisch beim Start des Servers gestartet
2146 werden sollte.</para>
2149 <sect2 id="features.periodic-invoices.create-for-current-month">
2150 <title>Erste Rechnung für aktuellen Monat erstellen</title>
2152 <para>Will man im laufenden Monat eine monatlich wiederkehrende
2153 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
2154 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
2155 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
2156 generiert hat. Alternativ setzt man das Startdatum auf den
2157 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
2158 manuell über den Workflow.</para>
2162 <sect1 id="dokumentenvorlagen-und-variablen">
2163 <title>Dokumentenvorlagen und verfügbare Variablen</title>
2165 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
2166 <title>Einführung</title>
2168 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
2169 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
2170 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
2171 <function><%variablenname%></function> verwendet wird. Für
2172 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
2174 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
2176 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
2177 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
2178 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
2179 alle Vorlagenarten.</para>
2181 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
2182 verfügbar als hier aufgelistet werden. Die meisten davon können
2183 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
2184 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
2185 diese wie folgt erhalten werden:</para>
2189 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
2190 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
2194 <para>In <filename>Form.pm</filename> die Funktion
2195 <function>parse_template</function> suchen und hier die Zeile
2196 <command>print(STDERR Dumper($self));</command> einfügen.</para>
2200 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
2201 ein PDF für eine Rechnung erzeugen.</para>
2205 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
2206 der Variablen <varname>$self</varname> in der Form <varname>'key'
2207 => 'value',</varname>. Alle <varname>key</varname>s sind
2213 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
2214 <title>Variablen ausgeben</title>
2216 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
2217 Tags geschrieben werden, also z.B.
2218 <varname><%variablenname%></varname>.</para>
2220 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
2221 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
2222 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
2223 werden die folgenden Flags unterstützt:</para>
2227 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
2228 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
2229 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
2230 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
2234 <para><option>NOESCAPE</option> unterdrückt das Escapen von
2235 Sonderzeichen für die Vorlagensprache. Wenn also in einer
2236 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
2237 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
2238 ist dieses Flag sinnvoll.</para>
2242 <para>Beispiel:</para>
2244 <programlisting><%quototal NOFORMAT%></programlisting>
2247 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
2248 <title>Verwendung in Druckbefehlen</title>
2250 <para>In der Admininstration können Drucker definiert werden. Auch im
2251 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
2252 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
2253 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
2254 <function>`...`</function> nicht zu unerwünschtem Verhalten
2257 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
2258 für das die Telefonnummer eines Ansprechpartners als Teil der
2259 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
2260 z.B. wie folgt aussehen:</para>
2262 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
2265 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
2266 xreflabel="Anfang und Ende der Tags verändern">
2267 <title>Anfang und Ende der Tags verändern</title>
2269 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
2270 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
2271 Prozentzeichen und dem Größerzeichen endet, beispielsweise
2272 <function><%customer%></function>. Da diese Form aber z.B. in
2273 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
2274 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
2275 Stil umgestellt werden.</para>
2277 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
2278 Format gültigen Kommentarzeichen anfangen, dann
2279 <function>config:</function> enthalten, die entsprechende Option
2280 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
2281 enden. Beispiel für LaTeX:</para>
2283 <programlisting>% config: tag-style=($ $)</programlisting>
2285 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
2286 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
2287 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
2289 <programlisting><!-- config: tag-style=($ $) --></programlisting>
2292 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
2293 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
2295 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
2296 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
2297 "<filename>.ext</filename>" geeignet zu ersetzen:
2298 "<filename>.tex</filename>" für LaTeX-Vorlagen und
2299 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
2303 <term><filename>bin_list.ext</filename></term>
2306 <para>Lagerliste</para>
2311 <term><filename>check.ext</filename></term>
2319 <term><filename>invoice.ext</filename></term>
2322 <para>Rechnung</para>
2327 <term><filename>packing_list.ext</filename></term>
2330 <para>Packliste</para>
2335 <term><filename>pick_list.ext</filename></term>
2338 <para>Sammelliste</para>
2343 <term><filename>purchase_delivery_order.ext</filename></term>
2346 <para>Lieferschein (Einkauf)</para>
2351 <term><filename>purcharse_order.ext</filename></term>
2354 <para>Bestellung an Lieferanten</para>
2359 <term><filename>request_quotation.ext</filename></term>
2362 <para>Anfrage an Lieferanten</para>
2367 <term><filename>sales_delivery_order.ext</filename></term>
2370 <para>Lieferschein (Verkauf)</para>
2375 <term><filename>sales_order.ext</filename></term>
2378 <para>Bestellung</para>
2383 <term><filename>sales_quotation.ext</filename></term>
2386 <para>Angebot an Kunden</para>
2391 <term><filename>zahlungserinnerung.ext</filename></term>
2394 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2399 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2402 <para>Rechnung über Mahngebühren (Dateiname im Programm
2403 konfigurierbar)</para>
2409 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2410 <title>Sprache, Drucker und E-Mail</title>
2412 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2413 eingearbeitet. So wird aus der Vorlage
2414 <filename>sales_order.ext</filename> bei Sprache
2415 <function>de</function> und Druckerkürzel <function>lpr2</function>
2416 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2417 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2418 bekommen dann noch das Kürzel <filename>_email</filename>, der
2419 vollständige Vorlagenname wäre dann
2420 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2421 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2422 werden. Diese wird verwendet, wenn keine der anderen Varianten
2423 gefunden wird.</para>
2425 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2426 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2427 verschickt wird, ist:</para>
2431 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2435 <para><filename>sales_order_de_lpr2.tex</filename></para>
2439 <para><filename>sales_order.tex</filename></para>
2443 <para><filename>default.tex</filename></para>
2447 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2448 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2450 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2453 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2454 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2457 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2458 xreflabel="Metainformationen zur angeforderten Vorlage">
2459 <title>Metainformationen zur angeforderten Vorlage</title>
2461 <para>Diese Variablen liefern Informationen darüber welche Variante
2462 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2463 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2464 Formulare einbinden möchten.</para>
2468 <term><varname>template_meta.formname</varname></term>
2471 <para>Basisname der Vorlage. Identisch mit der <link
2472 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2473 zu den Dateinamen</link> ohne die Erweiterung. Ein
2474 Verkaufsauftrag enthält hier
2475 <constant>sales_order</constant>.</para>
2480 <term><varname>template_meta.language.description</varname></term>
2483 <para>Beschreibung der verwendeten Sprache</para>
2488 <term><varname>template_meta.language.template_code</varname></term>
2491 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2492 Kürzel das im Dateinamen verwendetet wird.</para>
2497 <term><varname>template_meta.language.output_numberformat</varname></term>
2500 <para>Zahlenformat der verwendeten Sprache in der Form
2501 "<constant>1.000,00</constant>". Experimentell! Nur
2502 interessant für Vorlagen die mit unformatierten Werten
2508 <term><varname>template_meta.language.output_dateformat</varname></term>
2511 <para>Datumsformat der verwendeten Sprache in der Form
2512 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2513 interessant für Vorlagen die mit unformatierten Werten
2519 <term><varname>template_meta.format</varname></term>
2522 <para>Das angeforderte Format. Kann im Moment die Werte
2523 <constant>pdf</constant>, <constant>postscript</constant>,
2524 <constant>html</constant>, <constant>opendocument</constant>,
2525 <constant>opendocument_pdf</constant> und
2526 <constant>excel</constant> enthalten.</para>
2531 <term><varname>template_meta.extension</varname></term>
2534 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2535 <constant>format</constant> entschieden.</para>
2540 <term><varname>template_meta.media</varname></term>
2543 <para>Ausgabemedium. Kann zur Zeit die Werte
2544 <constant>screen</constant> für Bildschirm,
2545 <constant>email</constant> für E-Mmail (triggert das
2546 <constant>_email</constant> Kürzel im Dateinamen),
2547 <constant>printer</constant> für Drucker, und
2548 <constant>queue</constant> für Warteschlange enthalten.</para>
2553 <term><varname>template_meta.printer.description</varname></term>
2556 <para>Beschreibung des ausgewählten Druckers</para>
2561 <term><varname>template_meta.printer.template_code</varname></term>
2564 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2565 dem Kürzel das im Dateinamen verwendetet wird.</para>
2570 <term><varname>template_meta.tmpfile</varname></term>
2573 <para>Datei-Prefix für temporäre Dateien.</para>
2579 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2580 <title>Stammdaten von Kunden und Lieferanten</title>
2584 <term><varname>account_number</varname></term>
2587 <para>Kontonummer</para>
2592 <term><varname>bank</varname></term>
2595 <para>Name der Bank</para>
2600 <term><varname>bank_code</varname></term>
2603 <para>Bankleitzahl</para>
2608 <term><varname>bic</varname></term>
2611 <para>Bank-Identifikations-Code (Bank Identifier Code,
2617 <term><varname>business</varname></term>
2620 <para>Kunden-/Lieferantentyp</para>
2625 <term><varname>city</varname></term>
2633 <term><varname>contact</varname></term>
2636 <para>Kontakt</para>
2641 <term><varname>country</varname></term>
2649 <term><varname>cp_email</varname></term>
2652 <para>Email des Ansprechpartners</para>
2657 <term><varname>cp_givenname</varname></term>
2660 <para>Vorname des Ansprechpartners</para>
2665 <term><varname>cp_greeting</varname></term>
2668 <para>Anrede des Ansprechpartners</para>
2673 <term><varname>cp_name</varname></term>
2676 <para>Name des Ansprechpartners</para>
2681 <term><varname>cp_phone1</varname></term>
2684 <para>Telefonnummer 1 des Ansprechpartners</para>
2689 <term><varname>cp_phone2</varname></term>
2692 <para>Telefonnummer 2 des Ansprechpartners</para>
2697 <term><varname>cp_title</varname></term>
2700 <para>Titel des Ansprechpartners</para>
2705 <term><varname>creditlimit</varname></term>
2708 <para>Kreditlimit</para>
2713 <term><varname>customeremail</varname></term>
2716 <para>Email des Kunden; nur für Kunden</para>
2721 <term><varname>customerfax</varname></term>
2724 <para>Faxnummer des Kunden; nur für Kunden</para>
2729 <term><varname>customernotes</varname></term>
2732 <para>Bemerkungen beim Kunden; nur für Kunden</para>
2737 <term><varname>customernumber</varname></term>
2740 <para>Kundennummer; nur für Kunden</para>
2745 <term><varname>customerphone</varname></term>
2748 <para>Telefonnummer des Kunden; nur für Kunden</para>
2753 <term><varname>discount</varname></term>
2761 <term><varname>email</varname></term>
2764 <para>Emailadresse</para>
2769 <term><varname>fax</varname></term>
2772 <para>Faxnummer</para>
2777 <term><varname>homepage</varname></term>
2780 <para>Homepage</para>
2785 <term><varname>iban</varname></term>
2788 <para>Internationale Kontonummer (International Bank Account
2789 Number, IBAN)</para>
2794 <term><varname>language</varname></term>
2797 <para>Sprache</para>
2802 <term><varname>name</varname></term>
2805 <para>Firmenname</para>
2810 <term><varname>payment_description</varname></term>
2813 <para>Name der Zahlart</para>
2818 <term><varname>payment_terms</varname></term>
2821 <para>Zahlungskonditionen</para>
2826 <term><varname>phone</varname></term>
2829 <para>Telefonnummer</para>
2834 <term><varname>shiptocity</varname></term>
2837 <para>Stadt (Lieferadresse) <link
2838 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2843 <term><varname>shiptocontact</varname></term>
2846 <para>Kontakt (Lieferadresse) <link
2847 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2852 <term><varname>shiptocountry</varname></term>
2855 <para>Land (Lieferadresse) <link
2856 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2861 <term><varname>shiptodepartment1</varname></term>
2864 <para>Abteilung 1 (Lieferadresse) <link
2865 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2870 <term><varname>shiptodepartment2</varname></term>
2873 <para>Abteilung 2 (Lieferadresse) <link
2874 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2879 <term><varname>shiptoemail</varname></term>
2882 <para>Email (Lieferadresse) <link
2883 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2888 <term><varname>shiptofax</varname></term>
2891 <para>Fax (Lieferadresse) <link
2892 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2897 <term><varname>shiptoname</varname></term>
2900 <para>Firmenname (Lieferadresse) <link
2901 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2906 <term><varname>shiptophone</varname></term>
2909 <para>Telefonnummer (Lieferadresse) <link
2910 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2915 <term><varname>shiptostreet</varname></term>
2918 <para>Straße und Hausnummer (Lieferadresse) <link
2919 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2924 <term><varname>shiptozipcode</varname></term>
2927 <para>Postleitzahl (Lieferadresse) <link
2928 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2933 <term><varname>street</varname></term>
2936 <para>Straße und Hausnummer</para>
2941 <term><varname>taxnumber</varname></term>
2944 <para>Steuernummer</para>
2949 <term><varname>ustid</varname></term>
2952 <para>Umsatzsteuer-Identifikationsnummer</para>
2957 <term><varname>vendoremail</varname></term>
2960 <para>Email des Lieferanten; nur für Lieferanten</para>
2965 <term><varname>vendorfax</varname></term>
2968 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
2973 <term><varname>vendornotes</varname></term>
2976 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
2981 <term><varname>vendornumber</varname></term>
2984 <para>Lieferantennummer; nur für Lieferanten</para>
2989 <term><varname>vendorphone</varname></term>
2992 <para>Telefonnummer des Lieferanten; nur für
2998 <term><varname>zipcode</varname></term>
3001 <para>Postleitzahl</para>
3006 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
3007 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
3008 Stammdaten nicht eingetragen, so haben die Variablen
3009 <varname>shipto*</varname> den gleichen Wert wie die die
3010 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
3011 einige <varname>shipto*</varname>-Variablen so nicht in den
3012 Stammdaten wiederfinden sondern schlicht Kopien der
3013 Lieferdatenvariablen sind (z.B.
3014 <varname>shiptocontact</varname>).</para>
3018 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
3019 <title>Informationen über den Bearbeiter</title>
3023 <term><varname>employee_address</varname></term>
3026 <para>Adressfeld</para>
3031 <term><varname>employee_businessnumber</varname></term>
3034 <para>Firmennummer</para>
3039 <term><varname>employee_company</varname></term>
3042 <para>Firmenname</para>
3047 <term><varname>employee_co_ustid</varname></term>
3050 <para>Usatzsteuer-Identifikationsnummer</para>
3055 <term><varname>employee_duns</varname></term>
3058 <para>DUNS-Nummer</para>
3063 <term><varname>employee_email</varname></term>
3071 <term><varname>employee_fax</varname></term>
3079 <term><varname>employee_name</varname></term>
3082 <para>voller Name</para>
3087 <term><varname>employee_signature</varname></term>
3090 <para>Signatur</para>
3095 <term><varname>employee_taxnumber</varname></term>
3098 <para>Steuernummer</para>
3103 <term><varname>employee_tel</varname></term>
3106 <para>Telefonnummer</para>
3112 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
3113 <title>Informationen über den Bearbeiter</title>
3117 <term><varname>salesman_address</varname></term>
3120 <para>Adressfeld</para>
3125 <term><varname>salesman_businessnumber</varname></term>
3128 <para>Firmennummer</para>
3133 <term><varname>salesman_company</varname></term>
3136 <para>Firmenname</para>
3141 <term><varname>salesman_co_ustid</varname></term>
3144 <para>Usatzsteuer-Identifikationsnummer</para>
3149 <term><varname>salesman_duns</varname></term>
3152 <para>DUNS-Nummer</para>
3157 <term><varname>salesman_email</varname></term>
3165 <term><varname>salesman_fax</varname></term>
3173 <term><varname>salesman_name</varname></term>
3176 <para>voller Name</para>
3181 <term><varname>salesman_signature</varname></term>
3184 <para>Signatur</para>
3189 <term><varname>salesman_taxnumber</varname></term>
3192 <para>Steuernummer</para>
3197 <term><varname>salesman_tel</varname></term>
3200 <para>Telefonnummer</para>
3206 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
3207 <title>Variablen für die einzelnen Steuern</title>
3211 <term><varname>tax</varname></term>
3219 <term><varname>taxbase</varname></term>
3222 <para>zu versteuernder Betrag</para>
3227 <term><varname>taxdescription</varname></term>
3230 <para>Name der Steuer</para>
3235 <term><varname>taxrate</varname></term>
3238 <para>Steuersatz</para>
3245 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
3246 <title>Variablen in Rechnungen</title>
3248 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
3249 <title>Allgemeine Variablen</title>
3253 <term><varname>creditremaining</varname></term>
3256 <para>Verbleibender Kredit</para>
3261 <term><varname>currency</varname></term>
3264 <para>Währung</para>
3269 <term><varname>cusordnumber</varname></term>
3272 <para>Bestellnummer beim Kunden</para>
3277 <term><varname>deliverydate</varname></term>
3280 <para>Lieferdatum</para>
3285 <term><varname>duedate</varname></term>
3288 <para>Fälligkeitsdatum</para>
3293 <term><varname>globalprojectnumber</varname></term>
3296 <para>Projektnummer des ganzen Beleges</para>
3301 <term><varname>globalprojectdescription</varname></term>
3304 <para>Projekbeschreibung des ganzen Beleges</para>
3309 <term><varname>intnotes</varname></term>
3312 <para>Interne Bemerkungen</para>
3317 <term><varname>invdate</varname></term>
3320 <para>Rechnungsdatum</para>
3325 <term><varname>invnumber</varname></term>
3328 <para>Rechnungsnummer</para>
3333 <term><varname>invtotal</varname></term>
3336 <para>gesamter Rechnungsbetrag</para>
3341 <term><varname>notes</varname></term>
3344 <para>Bemerkungen der Rechnung</para>
3349 <term><varname>orddate</varname></term>
3352 <para>Auftragsdatum</para>
3357 <term><varname>ordnumber</varname></term>
3360 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3361 erstellt wurde</para>
3366 <term><varname>payment_description</varname></term>
3369 <para>Name der Zahlart</para>
3374 <term><varname>payment_terms</varname></term>
3377 <para>Zahlungskonditionen</para>
3382 <term><varname>quodate</varname></term>
3385 <para>Angebotsdatum</para>
3390 <term><varname>quonumber</varname></term>
3393 <para>Angebotsnummer</para>
3398 <term><varname>shippingpoint</varname></term>
3401 <para>Versandort</para>
3406 <term><varname>shipvia</varname></term>
3409 <para>Transportmittel</para>
3414 <term><varname>subtotal</varname></term>
3417 <para>Zwischensumme aller Posten ohne Steuern</para>
3422 <term><varname>total</varname></term>
3425 <para>Restsumme der Rechnung (Summe abzüglich bereits
3426 bezahlter Posten)</para>
3431 <term><varname>transaction_description</varname></term>
3434 <para>Vorgangsbezeichnung</para>
3439 <term><varname>transdate</varname></term>
3442 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3443 erstellt wurde</para>
3449 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3450 <title>Variablen für jeden Posten auf der Rechnung</title>
3454 <term><varname>bin</varname></term>
3457 <para>Stellage</para>
3462 <term><varname>description</varname></term>
3465 <para>Artikelbeschreibung</para>
3470 <term><varname>discount</varname></term>
3473 <para>Rabatt als Betrag</para>
3478 <term><varname>discount_sub</varname></term>
3481 <para>Zwischensumme mit Rabatt</para>
3486 <term><varname>drawing</varname></term>
3489 <para>Zeichnung</para>
3494 <term><varname>ean</varname></term>
3497 <para>EAN-Code</para>
3502 <term><varname>image</varname></term>
3510 <term><varname>linetotal</varname></term>
3513 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3518 <term><varname>longdescription</varname></term>
3521 <para>Langtext</para>
3526 <term><varname>microfiche</varname></term>
3529 <para>Mikrofilm</para>
3534 <term><varname>netprice</varname></term>
3537 <para>Nettopreis</para>
3542 <term><varname>nodiscount_linetotal</varname></term>
3545 <para>Zeilensumme ohne Rabatt</para>
3550 <term><varname>nodiscount_sub</varname></term>
3553 <para>Zwischensumme ohne Rabatt</para>
3558 <term><varname>number</varname></term>
3561 <para>Artikelnummer</para>
3566 <term><varname>ordnumber_oe</varname></term>
3569 <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
3570 aus einem Sammelauftrag erstellt wurde</para>
3575 <term><varname>p_discount</varname></term>
3578 <para>Rabatt in Prozent</para>
3583 <term><varname>partnotes</varname></term>
3586 <para>Die beim Artikel gespeicherten Bemerkungen</para>
3591 <term><varname>partsgroup</varname></term>
3594 <para>Warengruppe</para>
3599 <term><varname>price_factor</varname></term>
3602 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
3608 <term><varname>price_factor_name</varname></term>
3611 <para>Der Name des Preisfaktors, sofern einer eingestellt
3617 <term><varname>projectnumber</varname></term>
3620 <para>Projektnummer</para>
3625 <term><varname>projectdescription</varname></term>
3628 <para>Projektbeschreibung</para>
3633 <term><varname>qty</varname></term>
3641 <term><varname>reqdate</varname></term>
3644 <para>Lieferdatum</para>
3649 <term><varname>runningnumber</varname></term>
3652 <para>Position auf der Rechnung (1, 2, 3...)</para>
3657 <term><varname>sellprice</varname></term>
3660 <para>Verkaufspreis</para>
3665 <term><varname>serialnumber</varname></term>
3668 <para>Seriennummer</para>
3673 <term><varname>tax_rate</varname></term>
3676 <para>Steuersatz</para>
3681 <term><varname>transdate_oe</varname></term>
3684 <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
3685 aus einem Sammelauftrag erstellt wurde</para>
3690 <term><varname>unit</varname></term>
3693 <para>Einheit</para>
3698 <term><varname>weight</varname></term>
3701 <para>Gewicht</para>
3706 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
3707 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
3708 einer <function>foreach</function>-Schleife ausgegeben werden, da
3709 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
3710 können. Die Variablen dafür lauten:</para>
3714 <term><varname>make</varname></term>
3717 <para>Lieferant</para>
3722 <term><varname>model</varname></term>
3725 <para>Lieferantenartikelnummer</para>
3731 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
3732 <title>Variablen für die einzelnen Zahlungseingänge</title>
3736 <term><varname>payment</varname></term>
3744 <term><varname>paymentaccount</varname></term>
3752 <term><varname>paymentdate</varname></term>
3760 <term><varname>paymentmemo</varname></term>
3768 <term><varname>paymentsource</varname></term>
3777 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
3778 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
3780 <para>Die vom Benutzer definierten Variablen für Kunden und
3781 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
3782 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
3783 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
3784 Variablennamen zusammen.</para>
3786 <para>Beispiel: Der Benutzer hat eine Variable namens
3787 <varname>number_of_employees</varname> definiert, die die Anzahl der
3788 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
3789 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
3794 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
3795 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
3797 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
3798 <title>Namen der Vorlagen</title>
3800 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
3801 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
3802 Erstellung einer Rechnung über die Mahngebühren und Zinsen
3803 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
3804 Vorlagenname für diese Mahnstufe mit dem Zusatz
3805 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
3806 für die ausgewählte Sprache und den ausgewählten Drucker
3810 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
3811 <title>Allgemeine Variablen in Mahnungen</title>
3813 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3814 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3815 Kunden stehen als Variablen <varname>name</varname>,
3816 <varname>street</varname>, <varname>zipcode</varname>,
3817 <varname>city</varname>, <varname>country</varname>,
3818 <varname>department_1</varname>, <varname>department_2</varname>,
3819 und <varname>email</varname> zur Verfügung.</para>
3821 <para>Weitere Variablen beinhalten:</para>
3825 <term><varname>dunning_date</varname></term>
3828 <para>Datum der Mahnung</para>
3833 <term><varname>dunning_duedate</varname></term>
3836 <para>Fälligkeitsdatum für diese Mahhnung</para>
3841 <term><varname>dunning_id</varname></term>
3844 <para>Mahnungsnummer</para>
3849 <term><varname>fee</varname></term>
3852 <para>Kummulative Mahngebühren</para>
3857 <term><varname>interest_rate</varname></term>
3860 <para>Zinssatz per anno in Prozent</para>
3865 <term><varname>total_amount</varname></term>
3868 <para>Gesamter noch zu zahlender Betrag als
3869 <function>fee</function> + <function>total_interest</function>
3870 + <function>total_open_amount</function></para>
3875 <term><varname>total_interest</varname></term>
3878 <para>Zinsen per anno über alle Rechnungen</para>
3883 <term><varname>total_open_amount</varname></term>
3886 <para>Summe über alle offene Beträge der Rechnungen</para>
3892 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
3893 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
3897 <term><varname>dn_amount</varname></term>
3900 <para>Rechnungssumme (brutto)</para>
3905 <term><varname>dn_duedate</varname></term>
3908 <para>Originales Fälligkeitsdatum der Rechnung</para>
3913 <term><varname>dn_dunning_date</varname></term>
3916 <para>Datum der Mahnung</para>
3921 <term><varname>dn_dunning_duedate</varname></term>
3924 <para>Fälligkeitsdatum der Mahnung</para>
3929 <term><varname>dn_fee</varname></term>
3932 <para>Kummulative Mahngebühr</para>
3937 <term><varname>dn_interest</varname></term>
3940 <para>Zinsen per anno für diese Rechnung</para>
3945 <term><varname>dn_invnumber</varname></term>
3948 <para>Rechnungsnummer</para>
3953 <term><varname>dn_linetotal</varname></term>
3956 <para>Noch zu zahlender Betrag (ergibt sich aus
3957 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
3958 + <varname>dn_interest</varname>)</para>
3963 <term><varname>dn_netamount</varname></term>
3966 <para>Rechnungssumme (netto)</para>
3971 <term><varname>dn_open_amount</varname></term>
3974 <para>Offener Rechnungsbetrag</para>
3979 <term><varname>dn_ordnumber</varname></term>
3982 <para>Bestellnummer</para>
3987 <term><varname>dn_transdate</varname></term>
3990 <para>Rechnungsdatum</para>
3995 <term><varname>dn_curr</varname></term>
3998 <para>Währung, in der die Rechnung erstellt wurde. (Die
3999 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
4005 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
4006 <title>Variablen in automatisch erzeugten Rechnungen über
4007 Mahngebühren</title>
4009 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4010 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4011 Kunden stehen als Variablen <varname>name</varname>,
4012 <varname>street</varname>, <varname>zipcode</varname>,
4013 <varname>city</varname>, <varname>country</varname>,
4014 <varname>department_1</varname>, <varname>department_2</varname>,
4015 und <varname>email</varname> zur Verfügung.</para>
4017 <para>Weitere Variablen beinhalten:</para>
4021 <term><varname>duedate</varname></term>
4024 <para>Fälligkeitsdatum der Rechnung</para>
4029 <term><varname>dunning_id</varname></term>
4032 <para>Mahnungsnummer</para>
4037 <term><varname>fee</varname></term>
4040 <para>Mahngebühren</para>
4045 <term><varname>interest</varname></term>
4053 <term><varname>invamount</varname></term>
4056 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
4057 <varname>interest</varname>)</para>
4062 <term><varname>invdate</varname></term>
4065 <para>Rechnungsdatum</para>
4070 <term><varname>invnumber</varname></term>
4073 <para>Rechnungsnummer</para>
4080 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
4081 <title>Variablen in anderen Vorlagen</title>
4084 <title>Einführung</title>
4086 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
4087 Rechnung. Allerdings heißen die Variablen, die mit
4088 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
4089 fangen sie mit <varname>quo</varname> für "quotation" an:
4090 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
4091 wiederum fangen sie mit <varname>ord</varname> für "order" an:
4092 <varname>ordnumber</varname> für Bestellnummer etc.</para>
4094 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
4095 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
4096 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
4097 Vorlage keine Bedeutung haben oder noch nicht belegt sein
4100 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
4101 in Rechnungen aufgeführt.</para>
4104 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
4105 <title>Angebote und Preisanfragen</title>
4109 <term><varname>quonumber</varname></term>
4112 <para>Angebots- bzw. Anfragenummer</para>
4117 <term><varname>reqdate</varname></term>
4120 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
4121 Preisanfragen)</para>
4126 <term><varname>transdate</varname></term>
4129 <para>Angebots- bzw. Anfragedatum</para>
4135 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
4136 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
4140 <term><varname>ordnumber</varname></term>
4143 <para>Auftragsnummer</para>
4148 <term><varname>reqdate</varname></term>
4151 <para>Lieferdatum</para>
4156 <term><varname>transdate</varname></term>
4159 <para>Auftragsdatum</para>
4165 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
4166 <title>Lieferscheine (Verkauf und Einkauf)</title>
4170 <term><varname>cusordnumber</varname></term>
4173 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
4174 des Lieferanten (im Einkauf)</para>
4179 <term><varname>donumber</varname></term>
4182 <para>Lieferscheinnummer</para>
4187 <term><varname>transdate</varname></term>
4190 <para>Lieferscheindatum</para>
4195 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
4196 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
4197 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
4198 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
4199 <function>foreach</function>-Schleife ausgegeben werden. Diese
4200 Variablen sind:</para>
4204 <term><varname>si_bin</varname></term>
4207 <para>Lagerplatz</para>
4212 <term><varname>si_chargenumber</varname></term>
4215 <para>Chargennummer</para>
4220 <term><varname>si_bestbefore</varname></term>
4223 <para>Mindesthaltbarkeit</para>
4228 <term><varname>si_number</varname></term>
4231 <para>Artikelnummer</para>
4236 <term><varname>si_qty</varname></term>
4239 <para>Anzahl bzw. Menge</para>
4244 <term><varname>si_runningnumber</varname></term>
4247 <para>Positionsnummer (1, 2, 3 etc)</para>
4252 <term><varname>si_unit</varname></term>
4255 <para>Einheit</para>
4260 <term><varname>si_warehouse</varname></term>
4269 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
4270 <title>Variablen für Sammelrechnung</title>
4274 <term><varname>c0total</varname></term>
4277 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
4283 <term><varname>c30total</varname></term>
4286 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
4287 und < 60 Tage</para>
4292 <term><varname>c60total</varname></term>
4295 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
4296 und < 90 Tage</para>
4301 <term><varname>c90total</varname></term>
4304 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
4310 <term><varname>total</varname></term>
4313 <para>Gesamtbetrag aller Rechnungen</para>
4318 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
4322 <term><varname>invnumber</varname></term>
4325 <para>Rechnungsnummer</para>
4330 <term><varname>invdate</varname></term>
4333 <para>Rechnungsdatum</para>
4338 <term><varname>duedate</varname></term>
4341 <para>Fälligkeitsdatum</para>
4346 <term><varname>amount</varname></term>
4349 <para>Summe der Rechnung</para>
4354 <term><varname>open</varname></term>
4357 <para>Noch offener Betrag der Rechnung</para>
4362 <term><varname>c0</varname></term>
4365 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4371 <term><varname>c30</varname></term>
4374 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4380 <term><varname>c60</varname></term>
4383 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4389 <term><varname>c90</varname></term>
4392 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4400 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4401 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4403 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4404 <title>Einfürhung</title>
4406 <para>Der Parser kennt neben den Variablen einige weitere
4407 Konstrukte, die gesondert behandelt werden. Diese sind wie
4408 Variablennamen in spezieller Weise markiert:
4409 <command><%anweisung%> ... <%end%></command></para>
4411 <para>Anmerkung zum <command><%end%></command>: Der besseren
4412 Verständlichkeit halber kann man nach dem <command>end</command>
4413 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4414 Anweisung (z.B. <command>if</command> oder
4415 <command>foreach</command>) damit abgeschlossen wird.</para>
4417 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4418 <command><%if type == "sales_quotation"%></command>, so könnte
4419 er mit <command><%end%></command> genauso abgeschlossen werden
4420 wie mit <command><%end if%></command> oder auch
4421 <command><%end type == "sales_quotation"%></command>.</para>
4424 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4425 <title>Der if-Block</title>
4427 <programlisting><%if variablenname%>
4429 <%end%></programlisting>
4431 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4432 und dem "end" werden nur ausgegeben, wenn die Variable
4433 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4435 <para>Handelt es sich bei der benannten Variable um ein Array, also um einen Variablennamen, über den man mit
4436 <command><%foreach variablenname%></command> iteriert, so wird mit diesem Konstrukt darauf getestet, ob das Array Elemente
4437 enthält. Somit würde im folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt ihrer Überschrift "Zahlungseingänge"
4438 ausgegeben, wenn tatsächlich welche getätigt wurden:</para>
4440 <programlisting><%if payment%>
4442 <%foreach payment%>
4443 Am <%paymentdate%>: <%payment%> €
4444 <%end foreach%>
4445 <%end if%></programlisting>
4447 <para>Die Bedingung kann auch negiert werden, indem das Wort
4448 <function>not</function> nach dem <filename>if</filename> verwendet
4449 wird. Beispiel:</para>
4451 <programlisting><%if not cp_greeting%>
4453 <%end%></programlisting>
4455 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4456 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4457 einer Variablen mit einer festen Zeichenkette oder einer anderen
4458 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4459 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4460 die rechte Seite des Vergleichsoperators in Anführungszeichen
4461 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4462 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4465 <programlisting><%if var1 == "Wert"%></programlisting>
4467 <para>Testet die Variable <varname>var1</varname> auf
4468 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4469 Mittels <function>!=</function> anstelle von <function>==</function>
4470 würde auf Ungleichheit getestet.</para>
4472 <programlisting><%if var1 == var2%></programlisting>
4474 <para>Testet die Variable <varname>var1</varname> auf
4475 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4476 <function>!=</function> anstelle von <function>==</function> würde
4477 auf Ungleichheit getestet.</para>
4479 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4480 auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
4481 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4482 dieselbe Syntax wie oben nur mit <function>=~</function> und
4483 <function>!~</function> als Vergleichsoperatoren.</para>
4485 <para>Beispiel für einen Test, ob die Variable
4486 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4487 <constant>schwierig</constant> enthält:</para>
4489 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4492 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4493 <title>Der foreach-Block</title>
4495 <programlisting><%foreach variablenname%>
4497 <%end%></programlisting>
4499 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4500 wie das Perl-Array der Variablen <varname>variablenname</varname>
4501 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4502 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4503 benutzt. In jedem Durchlauf werden die <link
4504 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4505 Variablen</link> jeweils auf den Wert für die aktuelle Position
4508 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
4510 <programlisting><%foreach number%>
4511 Position: <%runningnumber%>
4512 Anzahl: <%qty%>
4513 Artikelnummer: <%number%>
4514 Beschreibung: <%description%>
4516 <%end%></programlisting>
4518 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
4519 <function><%foreach%></function>-Block innerhalb einer
4520 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
4521 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
4522 Inhalt zwischen <function><%foreach%></function> und
4523 <function><%end%></function> wiederholt, nicht aber die
4524 komplette Zeile, in der er steht.</para>
4528 <sect2 id="dokumentenvorlagen-und-variablen.markup">
4529 <title>Markup-Code zur Textformatierung innerhalb von
4532 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
4533 anders formatiert haben möchte, so ist dies begrenzt möglich.
4534 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
4535 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
4536 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
4537 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
4538 (HTML oder PDF über LaTeX) umgesetzt.</para>
4540 <para>Die unterstützen Formatierungen sind:</para>
4544 <term><b>Text</b></term>
4547 <para>Text wird in Fettdruck gesetzt.</para>
4552 <term><i>Text</i></term>
4555 <para>Text wird kursiv gesetzt.</para>
4560 <term><u>Text</u></term>
4563 <para>Text wird unterstrichen.</para>
4568 <term><s>Text</s></term>
4571 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
4572 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
4577 <term><bullet></term>
4580 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
4586 <para>Der Befehl <command><bullet></command> funktioniert
4587 momentan auch nur in Latex-Vorlagen.</para>
4591 <sect1 id="excel-templates">
4592 <title>Excel-Vorlagen</title>
4594 <sect2 id="excel-templates.summary">
4595 <title>Zusammenfassung</title>
4597 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
4598 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
4602 <sect2 id="excel-templates.usage">
4603 <title>Bedienung</title>
4605 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
4606 werden. Die Konfigurationsoption heißt <varname>excel_templates =
4607 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
4609 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
4610 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
4611 werden. In den normalen Verkaufsmasken taucht nun
4612 <constant>Excel</constant> als auswählbares Format auf und kann von da
4613 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
4615 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
4616 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
4617 <filename>sales_quotation.xls</filename> gespeichert.</para>
4620 <sect2 id="excel-templates.syntax">
4621 <title>Variablensyntax</title>
4623 <para>Einfache Syntax:
4624 <command><<varname>></command></para>
4626 <para>Dabei sind <constant><<</constant> und
4627 <constant>>></constant> die Delimiter. Da Excel auf festen
4628 Breiten besteht, kann der Tag künstlich verlängert werden, indem
4629 weitere <constant><</constant> oder <constant>></constant>
4630 eingefügt werden. Der Tag muss nicht symmetrisch sein.
4633 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4635 <para>Um die Limitierung der festen Breite zu reduzieren, können
4636 weitere Variablen in einem Block interpoliert werden. Whitespace wird
4637 dazwishen dann erhalten. Beispiel:</para>
4639 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4641 <para>Die Variablen werden interpoliert, und linksbündig mit
4642 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
4643 lang, werden überzählige Zeichen abgeschnitten.</para>
4645 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
4646 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
4648 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4650 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
4651 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
4655 <sect2 id="excel-templates.limitations">
4656 <title>Einschränkungen</title>
4658 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
4659 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
4660 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
4661 Text zu ersetzen.</para>
4663 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
4664 <command><%if%></command> und
4665 <command><%foreach%></command> nicht vorhanden. Der Delimiter
4666 <constant><% %></constant> kommt in den Headerinformationen
4667 evtl. vor. Deshalb wurde auf den sichereren Delimiter
4668 <constant><<</constant> und <constant>>></constant>
4675 <title>Entwicklerdokumentation</title>
4677 <sect1 id="devel.globals" xreflabel="Globale Variablen">
4678 <title>Globale Variablen</title>
4681 <title>Wie sehen globale Variablen in Perl aus?</title>
4683 <para>Globale Variablen liegen in einem speziellen namespace namens
4684 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
4685 globs global und die meisten speziellen Variablen sind...
4688 <para>Daraus ergeben sich folgende Formen:</para>
4692 <term><literal>$main::form</literal></term>
4695 <para>expliziter Namespace "main"</para>
4700 <term><literal>$::form</literal></term>
4703 <para>impliziter Namespace "main"</para>
4708 <term><literal>open FILE, "file.txt"</literal></term>
4711 <para><varname>FILE</varname> ist global</para>
4716 <term><literal>$_</literal></term>
4719 <para>speziell</para>
4724 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
4725 Schlüsselwort wie "<function>global</function>", mit dem man
4726 importieren kann. <function>my</function>, <function>our</function>
4727 und <function>local</function> machen was anderes.</para>
4731 <term><literal>my $form</literal></term>
4734 <para>lexikalische Variable, gültig bis zum Ende des
4740 <term><literal>our $form</literal></term>
4743 <para><varname>$form</varname> referenziert ab hier
4744 <varname>$PACKAGE::form</varname>.</para>
4749 <term><literal>local $form</literal></term>
4752 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
4753 des scopes zurückgesetzt</para>
4760 <title>Warum sind globale Variablen ein Problem?</title>
4762 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
4764 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
4765 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
4766 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
4767 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
4768 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
4769 Datenbankverbindungen, weil die sehr lange zum Initialisieren
4772 <para>Das zweite Problem ist <function>strict</function>. Unter
4773 <function>strict</function> werden alle Variablen die nicht explizit
4774 mit <function>Package</function>, <function>my</function> oder
4775 <function>our</function> angegeben werden als Tippfehler angemarkert,
4776 dies hat, seit der Einführung, u.a. schon so manche langwierige
4777 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
4778 angegeben werden, werden die nicht geprüft, und somit kann sich
4779 schnell ein Tippfehler einschleichen.</para>
4783 <title>Kanonische globale Variablen</title>
4785 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
4786 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
4787 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
4788 umhergereicht werden.</para>
4790 <para>Diese Variablen sind im Moment die folgenden neun:</para>
4794 <para><varname>$::form</varname></para>
4798 <para><varname>%::myconfig</varname></para>
4802 <para><varname>$::locale</varname></para>
4806 <para><varname>$::lxdebug</varname></para>
4810 <para><varname>$::auth</varname></para>
4814 <para><varname>$::lx_office_conf</varname></para>
4818 <para><varname>$::instance_conf</varname></para>
4822 <para><varname>$::dispatcher</varname></para>
4826 <para><varname>$::request</varname></para>
4830 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
4831 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
4832 Eigenschaften (Konventionen):</para>
4835 <title>$::form</title>
4839 <para>Ist ein Objekt der Klasse
4840 "<classname>Form</classname>"</para>
4844 <para>Wird nach jedem Request gelöscht</para>
4848 <para>Muss auch in Tests und Konsolenscripts vorhanden
4853 <para>Enthält am Anfang eines Requests die Requestparameter vom
4858 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
4859 cachen, das wird aber momentan absichtlich zerstört</para>
4863 <para><varname>$::form</varname> wurde unter <productname>SQL
4864 Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
4865 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
4866 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
4867 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
4868 <function>IS->retrieve_customer()</function> in Sicherheit
4871 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
4872 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
4873 3552, Stand version 2.7beta), um dies hinterher wieder auf den
4874 richtigen Wert zu setzen:</para>
4876 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
4877 $::myconfig{numberformat} = $numberformat;
4878 # (...) div Berechnungen
4879 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
4881 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
4882 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
4883 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
4884 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
4885 Es geht ziemlich sicher etwas kaputt.</para>
4887 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
4888 in den <productname>Template::Toolkit</productname> Templates
4889 außerhalb der Controller: der Ausdruck <function>[% var
4890 %]</function> greift auf <varname>$::form->{var}</varname> zu.
4891 Unter Controllern ist der Standard Scope anders, da lautet der
4892 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
4893 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
4894 <function><%var%></function> zeigt auf
4895 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
4896 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
4899 <programlisting>[%- IF business %]
4900 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
4901 [%- END %]</programlisting>
4903 <para>Entweder wird hier dann $::form->{business} ausgewertet
4904 oder aber der Funktion
4905 <function>$form->parse_html_template</function> wird explizit
4906 noch ein zusätzlicher Hash übergeben, der dann auch in den
4907 (Web-)Templates zu Verfügung steht, bspw. so:</para>
4909 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
4911 <para>Innerhalb von Schleifen wird
4912 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
4913 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
4914 welches über alle Positionen eines Lieferscheins in Schleife
4917 <programlisting>for $i (1 .. $form->{rowcount}) {
4919 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
4920 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
4921 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
4927 <title>%::myconfig</title>
4931 <para>Das einzige Hash unter den globalen Variablen</para>
4935 <para>Wird spätestens benötigt wenn auf die Datenbank
4936 zugegriffen wird</para>
4940 <para>Wird bei jedem Request neu erstellt.</para>
4944 <para>Enthält die Userdaten des aktuellen Logins</para>
4948 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
4949 extern serialisiert werden, weil da auch der Datenbankzugriff
4950 für diesen user drinsteht.</para>
4954 <para>Enthält unter anderem Listenbegrenzung vclimit,
4955 Datumsformat dateformat und Nummernformat numberformat</para>
4959 <para>Enthält Datenbankzugriffinformationen</para>
4963 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
4964 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
4965 aktuellen Users entscheiden müssen, befragen
4966 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
4967 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
4968 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
4969 Informationen über den Benutzer die über die
4970 Administrator-Schnittstelle (admin.pl) eingegeben wurden.</para>
4974 <title>$::locale</title>
4978 <para>Objekt der Klasse "Locale"</para>
4982 <para>Wird pro Request erstellt</para>
4986 <para>Muss auch für Tests und Scripte immer verfügbar
4991 <para>Cached intern über Requestgrenzen hinweg benutzte
4996 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
4997 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
5001 <title>$::lxdebug</title>
5005 <para>Objekt der Klasse "LXDebug"</para>
5009 <para>Wird global gecached</para>
5013 <para>Muss immer verfügbar sein, in nahezu allen
5018 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
5019 bereit, wie "<function>enter_sub</function>" und
5020 "<function>leave_sub</function>", mit denen in den alten Modulen ein
5021 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
5022 der man die Wallclockzeit seit Requeststart loggen kann, sowie
5023 "<function>message</function>" und "<function>dump</function>" mit
5024 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
5027 <para>Beispielsweise so:</para>
5029 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
5030 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
5034 <title>$::auth</title>
5038 <para>Objekt der Klasse "SL::Auth"</para>
5042 <para>Wird global gecached</para>
5046 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
5050 <para>Wird nach jedem Request resettet.</para>
5054 <para><varname>$::auth</varname> stellt Funktionen bereit um die
5055 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
5056 vom aktuellen User abhängen wird das Objekt aus
5057 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
5058 Request kurz resettet.</para>
5062 <title>$::lx_office_conf</title>
5066 <para>Objekt der Klasse
5067 "<classname>SL::LxOfficeConf</classname>"</para>
5071 <para>Global gecached</para>
5075 <para>Repräsentation der
5076 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
5080 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
5081 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
5082 das Programm die Konfiguration ändern kann oder sollte.</para>
5084 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
5085 Debug- und Trace-Log-Datei wie folgt konfiguriert und
5088 <programlisting>[debug]
5089 file = /tmp/kivitendo-debug.log</programlisting>
5091 <para>ist der Key <varname>file</varname> im Programm als
5092 <varname>$::lx_office_conf->{debug}{file}</varname>
5096 <para>Zugriff auf die Konfiguration erfolgt im Moment über
5097 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
5102 <title>$::instance_conf</title>
5106 <para>Objekt der Klasse
5107 "<classname>SL::InstanceConfiguration</classname>"</para>
5111 <para>wird pro Request neu erstellt</para>
5115 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
5116 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
5117 ist hier eine Mandantendatenbank. Beispielsweise überprüft
5118 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
5119 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
5123 <title>$::dispatcher</title>
5127 <para>Objekt der Klasse
5128 "<varname>SL::Dispatcher</varname>"</para>
5132 <para>wird pro Serverprozess erstellt.</para>
5136 <para>enthält Informationen über die technische Verbindung zum
5141 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
5142 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
5143 Objekt untergebracht.</para>
5147 <title>$::request</title>
5151 <para>Hashref (evtl später Objekt)</para>
5155 <para>Wird pro Request neu initialisiert.</para>
5159 <para>Keine Unterstruktur garantiert.</para>
5163 <para><varname>$::request</varname> ist ein generischer Platz um
5164 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
5165 at a distance benutzt werden, sondern um lokales memoizing zu
5166 ermöglichen, das garantiert am Ende des Requests zerstört
5169 <para>Vieles von dem, was im moment in <varname>$::form</varname>
5170 liegt, sollte eigentlich hier liegen. Die groben
5171 Differentialkriterien sind:</para>
5175 <para>Kommt es vom User, und soll unverändert wieder an den
5176 User? Dann <varname>$::form</varname>, steht da eh schon</para>
5180 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
5181 Requests gebraucht werden? Dann
5182 <varname>$::request</varname></para>
5186 <para>Muss ich von anderen Teilen des Programms lesend drauf
5187 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
5188 Wrappermethode</para>
5195 <title>Ehemalige globale Variablen</title>
5197 <para>Die folgenden Variablen waren einmal im Programm, und wurden
5201 <title>$::cgi</title>
5205 <para>war nötig, weil cookie Methoden nicht als
5206 Klassenfunktionen funktionieren</para>
5210 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
5211 Klassennamespace gehalten wird und über Requestgrenzen
5216 <para>liegt jetzt unter
5217 <varname>$::request->{cgi}</varname></para>
5223 <title>$::all_units</title>
5227 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
5228 ein paar hundert mal pro Request eine Liste der Einheiten
5229 brauchen, und de als Parameter durch einen Riesenstack von
5230 Funktionen geschleift werden müssten.</para>
5234 <para>Liegt jetzt unter
5235 <varname>$::request->{cache}{all_units}</varname></para>
5240 <function>AM->retrieve_all_units()</function> gesetzt oder
5247 <title>%::called_subs</title>
5251 <para>wurde benutzt um callsub deep recursions
5256 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
5257 möglichen Rekursioenen darstellt, und da nie welche
5262 <para>komplette recursion protection wurde entfernt.</para>
5269 <sect1 id="devel.fcgi">
5270 <title>Entwicklung unter FastCGI</title>
5272 <sect2 id="devel.fcgi.general">
5273 <title>Allgemeines</title>
5275 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
5276 werden, muss der Webserver neu gestartet werden.</para>
5278 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
5279 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
5280 müssen folgende Aspekte beachtet werden.</para>
5283 <sect2 id="devel.fcgi.exiting">
5284 <title>Programmende und Ausnahmen</title>
5286 <para>Betrifft die Funktionen <function>warn</function>,
5287 <function>die</function>, <function>exit</function>,
5288 <function>carp</function> und <function>confess</function>.</para>
5290 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
5291 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
5292 am Laufen zu halten. Man kann mit <function>die</function>,
5293 <function>confess</function> oder <function>carp</function> Fehler
5294 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
5295 eigene <function>$::form-</function>error()> tut im Prinzip das
5296 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
5297 <function>exit</function> hingegen werden nicht abgefangen.
5298 <function>warn</function> wird direkt nach STDERR, also in Server Log
5299 eine Nachricht schreiben (sofern in der Konfiguration nicht die
5300 Warnungen in das kivitendo Log umgeleitet wurden), und
5301 <function>exit</function> wird die Ausführung beenden.</para>
5303 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
5304 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
5305 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
5306 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
5309 <sect2 id="devel.fcgi.globals">
5310 <title>Globale Variablen</title>
5312 <para>Um zu vermeiden, dass Informationen von einem Request in einen
5313 anderen gelangen, müssen alle globalen Variablen vor einem Request
5314 sauber initialisiert werden. Das ist besonders wichtig im
5315 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
5316 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
5319 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
5320 abgetrennten Block, der alle kanonischen globalen Variablen listet und
5321 erklärt. Bitte keine anderen einführen ohne das sauber zu
5322 dokumentieren.</para>
5324 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
5325 man sicher geht, dass man die richtige erwischt.</para>
5328 <sect2 id="devel.fcgi.performance">
5329 <title>Performance und Statistiken</title>
5331 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
5332 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
5333 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
5334 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
5335 sind es je nach Menge der definierten Variablen 1-2s. Ab der
5336 Moose/Rose::DB Version sind es 5-6s.</para>
5338 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
5339 den kritischen Pfaden, unter 0,15 sonst.</para>
5342 <sect2 id="devel.fcgi.known-issues">
5343 <title>Bekannte Probleme</title>
5345 <sect3 id="devel.fcgi.known-issues.encoding">
5346 <title>Encoding Awareness</title>
5348 <para>UTF-8 kodierte Installationen sind sehr anfällig gegen
5349 fehlerhfate Encodings unter FCGI. latin9 Installationen behandeln
5350 falsch kodierte Zeichen eher unwissend, und geben sie einfach
5351 weiter. UTF-8 verweigert bei fehlerhaften Programmpfaden kurzerhand
5352 das Ausliefern. Es wird noch daran gearbeitet, alle Fehler da zu
5358 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
5359 <title>SQL-Upgradedateien</title>
5361 <sect2 id="db-upgrade-files.introduction"
5362 xreflabel="Einführung in die Datenbank-Upgradedateien">
5363 <title>Einführung</title>
5365 <para>Der alte Mechanismus für SQL-Upgradescripte, der auf einer
5366 Versionsnummer beruht und dann in sql/Pg-upgrade nach einem Script für
5367 diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele
5368 Entwicklung im stable- und unstable-Baum betrifft.</para>
5370 <para>Dieser Mechanismus wurde für kivitendo 2.4.1 deutlich erweitert.
5371 Es werden weiterhin alle Scripte aus sql/Pg-upgrade ausgeführt.
5372 Zusätzlich gibt es aber ein zweites Verzeichnis, sql/Pg-upgrade2. In
5373 diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren,
5374 die neben den eigentlich auszuführenden SQL- oder Perl-Befehlen einige
5375 Kontrollinformationen enthält.</para>
5377 <para>Neu sind die Kontrollinformationen, die Abhängigkeiten und
5378 Prioritäten definieren können werden, sodass Datenbankscripte zwar in
5379 einer sicheren Reihenfolge ausgeführt werden (z.B. darf ein "ALTER
5380 TABLE" erst ausgeführt werden, wenn die Tabelle mit "CREATE TABLE"
5381 angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man
5382 keine Versionsnummern mehr braucht.</para>
5384 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
5385 sql/Pg-upgrade2 bereits durchgeführt wurde und führt diese nicht
5386 erneut aus. Dazu dient die Tabelle "schema_info", die bei der
5387 Anmeldung automatisch angelegt wird.</para>
5390 <sect2 id="db-upgrade-files.format"
5391 xreflabel="Format der Upgradedateien">
5392 <title>Format der Kontrollinformationen</title>
5394 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5395 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5396 hat dabei das folgende Format:</para>
5398 <para>Für SQL-Upgradedateien:</para>
5400 <programlisting>-- @key: value</programlisting>
5402 <para>Für Perl-Upgradedateien:</para>
5404 <programlisting># @key: value</programlisting>
5406 <para>Leerzeichen vor "<varname>value</varname>" werden
5409 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5413 <term><varname>tag</varname></term>
5416 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5417 Dieser "tag" kann von anderen Kontrolldateien in ihren
5418 Abhängigkeiten verwendet werden (Schlüsselwort
5419 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5420 in der Datenbank eingetragen wird.</para>
5422 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5423 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5425 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5426 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5427 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5433 <term><varname>charset</varname></term>
5436 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
5437 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5438 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
5439 Abwesenheit des Tags der Zeichensatz
5440 "<literal>ISO-8859-15</literal>" angenommen.</para>
5445 <term><varname>description</varname></term>
5448 <para>Benötigt. Eine Beschreibung, was in diesem Update
5449 passiert. Diese wird dem Benutzer beim eigentlichen
5450 Datenbankupdate angezeigt. Während der Tag in englisch gehalten
5451 sein sollte, sollte die Beschreibung auf Deutsch
5457 <term><varname>depends</varname></term>
5460 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5461 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
5462 dass die in dieser Liste aufgeführten Scripte bereits
5463 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5465 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5466 Script "b" existiert, das von Änderungen in "a" abhängt, und
5467 eine neue Kontrolldatei für "c" erstellt wird, die von
5468 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5469 Tag "b" als Abhängigkeit zu definieren.</para>
5471 <para>Es ist nicht erlaubt, sich selbst referenzierende
5472 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5473 und "c" -> "a").</para>
5478 <term><varname>priority</varname></term>
5481 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5482 der Scripte ausgeführt werden, die die gleichen
5483 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5484 der Wert 1000 benutzt.</para>
5486 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5487 "depends" benutzt werden. kivitendo sortiert die auszuführenden
5488 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5489 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5490 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5491 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5492 Priorität alphabetisch nach dem "tag".</para>
5497 <term><varname>ignore</varname></term>
5500 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
5501 Skript bei der Anmeldung ignoriert und entsprechend nicht
5508 <sect2 id="db-upgrade-files.dbupgrade-tool"
5509 xreflabel="Hilfsscript dbupgrade2_tool.pl">
5510 <title>Hilfsscript dbupgrade2_tool.pl</title>
5512 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
5513 existiert ein Hilfsscript namens
5514 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
5515 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
5516 liest alle Datenbankupgradescripte aus dem Verzeichnis
5517 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
5518 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
5519 von der Kommandozeile überprüft werden können.</para>
5521 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
5522 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
5523 sich aber auch Informationen auf verschiedene Art ausgeben
5528 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
5529 --list</command>"</para>
5531 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
5532 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
5533 würde. Es werden neben der Listenposition der Tag, die
5534 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
5538 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
5539 --tree</command>"</para>
5541 <para>Listet alle Tags in Baumform basierend auf den
5542 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
5543 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
5544 beim übergeordneten Script als Abhängigkeit eingetragen
5548 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
5549 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
5550 --rtree</command>"</para>
5552 <para>Listet alle Tags in Baumform basierend auf den
5553 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
5554 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
5555 die das übergeordnete Script als Abhängigkeit eingetragen
5560 <para>Baumform mit Postscriptausgabe:
5561 "<command>./scripts/dbupgrade2_tool.pl
5562 --graphviz</command>"</para>
5564 <para>Benötigt das Tool "<command>graphviz</command>", um mit
5565 seiner Hilfe die <link
5566 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
5567 Baumform</link> in eine Postscriptdatei namens
5568 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
5569 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
5570 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
5571 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
5576 <para>Scripte, von denen kein anderes Script abhängt:
5577 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
5579 <para>Listet die Tags aller Scripte auf, von denen keine anderen
5580 Scripte abhängen.</para>
5586 <sect1 id="translations-languages" xreflabel="Translations and languages">
5587 <title>Translations and languages</title>
5589 <sect2 id="translations-languages.introduction"
5590 xreflabel="Introduction to translations and languages">
5591 <title>Introduction</title>
5594 <para>Dieser Abschnitt ist in Englisch geschrieben, um
5595 internationalen Übersetzern die Arbeit zu erleichtern.</para>
5598 <para>This section describes how localization packages in kivitendo
5599 are built. Currently the only language fully supported is German, and
5600 since most of the internal messages are held in English the English
5601 version is usable too.</para>
5603 <para>A stub version of French is included but not functunal at this
5607 <sect2 id="translations-languages.file-structure"
5608 xreflabel="File structure">
5609 <title>File structure</title>
5611 <para>The structure of locales in kivitendo is:</para>
5613 <programlisting>kivitendo/locale/<langcode>/</programlisting>
5615 <para>where <langcode> stands for an abbreviation of the
5616 language package. The builtin packages use two letter <ulink
5617 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
5618 but the actual name is not relevant for the program and can easily be
5620 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
5621 tags</ulink> (i.e. "en_GB"). In fact the original language packages
5622 from SQL Ledger are named in this way.</para>
5624 <para>In such a language directory the following files are
5629 <term>LANGUAGE</term>
5632 <para>This file is mandatory.</para>
5634 <para>The <filename>LANGUAGE</filename> file contains the self
5635 descripted name of the language. It should contain a native
5636 representation first, and in parenthesis an english translation
5637 after that. Example:</para>
5639 <programlisting>Deutsch (German)</programlisting>
5644 <term>charset</term>
5647 <para>This file should be present.</para>
5649 <para>The <filename>charset</filename> file describes which
5650 charset a language package is written in and applies to all
5651 other language files in the package. It is possible to write
5652 some language packages without an explicit charset, but it is
5653 still strongly recommended. You'll never know in what
5654 environment your language package will be used, and neither
5655 UTF-8 nor Latin1 are guaranteed.</para>
5657 <para>The whole content of this file is a string that can be
5658 recognized as a valid charset encoding. Example:</para>
5660 <programlisting>UTF-8</programlisting>
5668 <para>This file is mandatory.</para>
5670 <para>The central translation file. It is essentially an inline
5671 Perl script autogenerated by <command>locales.pl</command>. To
5672 generate it, generate the directory and the two files mentioned
5673 above, and execute the following command:</para>
5675 <programlisting>scripts/locales.pl <langcode></programlisting>
5677 <para>Otherwise you can simply copy one of the other languages.
5678 You will be told how many are missing like this:</para>
5680 <programlisting>$ scripts/locales.pl en
5681 English - 0.6% - 2015/2028 missing</programlisting>
5683 <para>A file named "<filename>missing</filename>" will be
5684 generated and can be edited. You can also edit the
5685 "<filename>all</filename>" file directly. Edit everything you
5686 like to fit the target language and execute
5687 <command>locales.pl</command> again. See how the missing words
5693 <term>Num2text</term>
5696 <para>Legacy code from SQL Ledger. It provides a means for
5697 numbers to be converted into natural language, like
5698 <literal>1523 => one thousand five hundred twenty
5699 three</literal>. If you want to provide it, it must be inlinable
5700 Perl code which provides a <function>num2text</function> sub. If
5701 an <function>init</function> sub exists it will be executed
5704 <para>Only used in the check and receipt printing module.</para>
5709 <term>special_chars</term>
5712 <para>kivitendo comes with a lot of interfaces to different
5713 formats, some of which are rather picky with their accepted
5714 charset. The <filename>special_chars</filename> file contains a
5715 listing of chars not suited for different file format and
5716 provides substitutions. It is written in "Simple Ini" style,
5717 containing a block for every file format.</para>
5719 <para>First entry should be the order of substitution for
5720 entries as a whitespace separated list. All entries are
5721 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
5722 and <literal>\\</literal> all work.</para>
5724 <para>After that every entry is a special char that should be
5725 translated when writing text into such a file.</para>
5727 <para>Example:</para>
5729 <programlisting>[Template/XML]
5730 order=& < > \n
5734 \n=<br></programlisting>
5736 <para>Note the importance of the order in this example.
5737 Substituting < and > befor & would lead to $gt; become
5740 <para>For a list of valid formats, see the German
5741 <filename>special_chars</filename> entry. As of this writing the
5742 following are recognized:</para>
5744 <programlisting>HTML
5749 Template/OpenDocument
5750 filenames</programlisting>
5752 <para>The last of which is very machine dependant. Remember that
5753 a lot of characters are forbidden by some filesystems, for
5754 exmaple MS Windows doesn't like ':' in its files where Linux
5755 doesn't mind that. If you want the files created with your
5756 language pack to be portable, find all chars that could cause
5762 <term>missing</term>
5765 <para>This file is not a part of the language package
5768 <para>This is a file generated by
5769 <command>scripts/locales.pl</command> while processing your
5770 locales. It's only to have the missing entries singled out and
5771 does not belong to a language package.</para>
5779 <para>This file is not a part of the language package
5782 <para>Another file generated by
5783 <command>scripts/locales.pl</command>. If for any reason a
5784 translation does not appear anymore and can be deleted, it gets
5785 moved here. The last 50 or so entries deleted are saved here in
5786 case you made a typo, so that you don't have to translate
5787 everything again. If a tranlsation is missing, the lost file is
5788 checked first. If you maintain a language package, you might
5789 want to keep this safe somewhere.</para>
5796 <sect1 id="devel.testsuite">
5797 <title>Die kivitendo-Test-Suite</title>
5799 <sect2 id="devel.testsuite.intro">
5800 <title>Einführung</title>
5802 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul <literal>Test::More</literal>.</para>
5804 <para>Die grundlegenden Fakten sind:</para>
5807 <listitem><para>Alle Tests liegen im Unterverzeichnis <filename>t/</filename>.</para></listitem>
5809 <listitem><para>Ein Script (bzw. ein Test) in <filename>f/</filename> enthält einen oder mehrere Testfälle.</para></listitem>
5811 <listitem><para>Alle Dateinamen von Tests enden auf <literal>.t</literal>. Es sind selbstständig ausführbare Perl-Scripte.</para></listitem>
5813 <listitem><para>Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in <filename>f/</filename>, deren
5814 Dateiname auf <literal>.t</literal> endet.</para></listitem>
5818 <sect2 id="devel.testsuite.prerequisites">
5819 <title>Voraussetzungen</title>
5821 <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>
5824 <listitem><para><literal>Test::Deep</literal> (Debian-Paketname: <literal>libtest-deep-perl</literal>; Fedora Core:
5825 <literal>perl-Test-Deep</literal>; openSuSE: <literal>perl-Test-Deep</literal>)</para></listitem>
5826 <listitem><para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses Modul ist ab Perl 5.10.1 Bestandteil der
5827 Perl-Distribution und kann für frühere Versionen aus dem <ulink url="http://www.cpan.org">CPAN</ulink> bezogen
5828 werden.</para></listitem>
5832 <sect2 id="devel.testsuite.execution">
5834 Existierende Tests ausführen
5837 <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
5838 gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript <filename>t/test.sh</filename>.</para>
5840 <para>Will man die komplette Test-Suite ausführen, so muss man einfach nur <filename>t/test.sh</filename> ohne weitere Parameter aus
5841 dem kivitendo-Basisverzeichnis heraus ausführen.</para>
5843 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an <filename>t/test.sh</filename>. Beispielsweise:</para>
5845 <programlisting>t/test.sh t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
5849 <sect2 id="devel.testsuite.meaning_of_scripts">
5851 Bedeutung der verschiedenen Test-Scripte
5854 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch
5855 während der Entwicklung nützliche Tests sind:</para>
5858 <listitem><para><filename>t/001compile.t</filename> -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab</para></listitem>
5859 <listitem><para><filename>t/002goodperl.t</filename> -- überprüft alle Perl-Dateien auf Anwesenheit von '<literal>use strict</literal>'-Anweisungen</para></listitem>
5860 <listitem><para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von <function>system()</function> und <function>exec()</function> auf Gültigkeit</para></listitem>
5861 <listitem><para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien Tab-Zeichen enthalten</para></listitem>
5862 <listitem><para><filename>t/006spelling.t</filename> -- sucht nach häufigen Rechtschreibfehlern</para></listitem>
5863 <listitem><para><filename>t/011pod.t</filename> -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit</para></listitem>
5866 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module.</para>
5869 <sect2 id="devel.testsuite.create_new">
5871 Neue Test-Scripte erstellen
5874 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende
5875 Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden.</para>
5877 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
5879 Ideen für neue Test-Scripte, die keine konkreten Funktionen testen
5882 <para> Ideen, die abgesehen von Funktions noch nicht umgesetzt wurden:</para>
5885 <listitem><para>Überprüfung auf fehlende symbolische Links</para></listitem>
5886 <listitem><para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten)</para></listitem>
5887 <listitem><para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para></listitem>
5888 <listitem><para>Überprüfung auf Leerzeichen am Ende von Zeilen</para></listitem>
5889 <listitem><para>Test, ob alle zu übersetzenden Strings in <filename>locale/de/all</filename> vorhanden sind</para></listitem>
5890 <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>
5894 <sect3 id="devel.testsuite.directory_and_test_names">
5896 Konvention für Verzeichnis- und Dateinamen
5899 <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>
5902 <listitem><para>Die Dateiendung muss <filename>.t</filename> lauten.</para></listitem>
5904 <listitem><para>Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise
5905 <filename>bad_function_params.t</filename>).</para></listitem>
5907 <listitem><para>Unterverzeichnisse sollten grob nach dem Themenbereich benannt sind, mit dem sich die Scripte darin befassen
5908 (beispielsweise <filename>background_jobs</filename> für Tests rund um Hintergrund-Jobs).</para></listitem>
5910 <listitem><para>Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist
5911 (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben.</para></listitem>
5915 <sect3 id="devel.testsuite.minimal_example">
5917 Minimales Skelett für eigene Scripte
5920 <para>Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden:</para>
5922 <programlisting>use Test::More tests => 0;
5926 use Support::TestSetup;
5928 Support::TestSetup::login();</programlisting>
5930 <para>Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie
5931 <varname>$::auth</varname>, <varname>$::form</varname> oder <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
5932 <filename>config/kivitendo.conf</filename> im Abschnitt <literal>testing.login</literal> ein gültiger Login-Name eingetragen
5933 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
5935 <para>Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile <code>Support::TestSetup::login();</code>
5936 weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.</para>
5941 <sect1 id="devel.style-guide">
5942 <title>Stil-Richtlinien</title>
5944 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
5945 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
5946 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
5947 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
5949 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
5952 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
5953 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
5958 <para>Es werden keine echten Tabs sondern Leerzeichen
5963 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
5965 <programlisting>foreach my $row (@data) {
5967 # do something with $row
5971 $row->{modules} = MODULE->retrieve(
5972 id => $row->{id},
5973 date => $use_now ? localtime() : $row->{time},
5977 $report->add($row);
5982 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
5983 Zeile wie der letzte Befehl. Beispiele:</para>
5985 <programlisting>sub debug {
5991 <programlisting>if ($form->{item_rows} > 0) {
5997 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
5998 der Befehl / die öffnende schließende Klammer, die den Block
5999 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
6000 Beispiele wie bei 3. gelten.</para>
6004 <para>Die Wörter "<function>else</function>",
6005 "<function>elsif</function>", "<function>while</function>" befinden
6006 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
6009 <programlisting>if ($form->{sum} > 1000) {
6011 } elsif ($form->{sum} > 0) {
6019 } until ($a > 0);</programlisting>
6023 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
6024 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
6025 und grep-ähnliche Operatoren. Beispiel:</para>
6027 <programlisting>$main::lxdebug->message("Could not find file.");
6028 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
6032 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
6034 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
6035 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
6036 Blöcke schon. Beispiel:</para>
6038 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
6043 $form->{sum} += $form->{"row_$i"};
6044 $form->{ $form->{index} } += 1;
6046 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
6050 <para>Mehrzeilige Befehle</para>
6054 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
6055 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
6056 werden, in der die ersten Funktionsparameter in der ersten Zeile
6057 stehen. Beispiel:</para>
6059 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
6060 $form->{some_col_value});</programlisting>
6064 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
6065 besten in einer übersichtlichen Tabellenstruktur organisiert
6066 wird. Beispiel:</para>
6068 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
6069 : $form->{oldcount} ? $form->{oldcount} + 1
6070 : $form->{rowcount} - $form->{rowbase};</programlisting>
6076 <para>Kommentare</para>
6080 <para>Kommentare, die alleine in einer Zeile stehen, sollten
6081 soweit wie der Code eingerückt sein.</para>
6085 <para>Seitliche hängende Kommentare sollten einheitlich
6086 formatiert werden.</para>
6090 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
6091 auf Englisch zu verfassen. So wie ich keine Lust habe,
6092 französischen Quelltext zu lesen, sollte auch der kivitendo
6093 Quelltext für nicht-Deutschsprachige lesbar sein.
6096 <programlisting>my $found = 0;
6104 $i = 0 # initialize $i
6106 $i *= $const; # do something crazy
6107 $i = $n; # recover $i</programlisting>
6113 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
6114 Interpolation gewünscht ist. Beispiel:</para>
6116 <programlisting>$form->{sum} = 0;
6117 $form->{"row_$i"} = $form->{"row_$i"} - 5;
6118 $some_hash{42} = 54;</programlisting>
6122 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
6123 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
6124 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
6125 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
6127 <para>Als Beispiel sei die Funktion
6128 <function>print_options</function> aus
6129 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
6133 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
6134 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
6137 <para>Emacs und vim haben beide recht einfache Methoden zur
6138 Entfernung von trailing whitespace. Emacs kennt das Kommande
6139 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
6140 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
6141 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
6146 <para>Es wird kein <command>perltidy</command> verwendet.</para>
6148 <para>In der Vergangenheit wurde versucht,
6149 <command>perltidy</command> zu verwenden, um einen einheitlichen
6150 Stil zu erlangen. Es hat sich aber gezeigt, dass
6151 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
6152 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
6153 den Interessierten sind hier die
6154 <command>perltidy</command>-Optionen, die grob den beschriebenen
6155 Richtlinien entsprechen:</para>
6157 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
6158 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
6159 -lp -vt=1 -vtc=1</programlisting>
6163 <para><varname>STDERR</varname> ist tabu. Unkonditionale
6164 Debugmeldungen auch.</para>
6166 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
6167 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
6168 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
6170 <para>Die <classname>LXDebug</classname>-Methode
6171 "<function>message</function>" nimmt als ersten Paramter außerdem
6172 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
6173 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
6174 und werden in den meisten Fällen auch vom Repository
6175 zurückgewiesen.</para>
6179 <para>Alle neuen Module müssen use strict verwenden.</para>
6181 <para><varname>$form</varname>, <varname>$auth</varname>,
6182 <varname>$locale</varname>, <varname>$lxdebug</varname> und
6183 <varname>%myconfig</varname> werden derzeit aus dem main package
6184 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
6185 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
6190 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
6191 <title>Dokumentation erstellen</title>
6193 <sect2 id="devel.build-doc.introduction">
6194 <title>Einführung</title>
6196 <para>Diese Dokumentation ist in <productname>DocBook</productname>
6197 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
6198 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
6199 Editor nutzt, der spezielle Unterstützung für
6200 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
6201 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
6202 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
6206 <sect2 id="devel.build-doc.required-software">
6207 <title>Benötigte Software</title>
6209 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
6210 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
6211 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
6212 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
6213 <command>scripts/build_doc.sh</command>.</para>
6215 <para>Das Script benötigt zur Konvertierung verschiedene
6216 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
6222 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
6223 in einer halbwegs aktuellen Version</para>
6227 <para>Das Java-Build-System <ulink
6228 url="http://ant.apache.org/">Apache Ant</ulink></para>
6232 <para>Das Dokumentations-System Dobudish für
6233 <productname>DocBook</productname> 4.5, eine Zusammenstellung
6234 diverser Stylesheets und Grafiken zur Konvertierung von
6235 <productname>DocBook</productname> XML in andere Formate. Das
6236 Paket, das benötigt wird, ist zum Zeitpunkt der
6237 Dokumentationserstellung
6238 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
6239 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
6244 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
6245 sind auf allen gängigen Plattformen verfügbar. Beispiel für
6246 Debian/Ubuntu:</para>
6248 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
6250 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
6251 <filename>doc/build</filename> entpackt werden. Beispiel unter der
6252 Annahme, das <productname>Dobudish</productname> in
6253 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
6255 <programlisting>cd doc/build
6256 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
6259 <sect2 id="devel.build-doc.build">
6260 <title>PDFs und HTML-Seiten erstellen</title>
6262 <para>Die eigentliche Konvertierung erfolgt nach Installation der
6263 benötigten Software mit einem einfachen Aufruf direkt aus dem
6264 kivitendo-Installationsverzeichnis heraus:</para>
6266 <programlisting>./scripts/build_doc.sh</programlisting>
6269 <sect2 id="devel.build-doc.repository">
6270 <title>Einchecken in das Git-Repository</title>
6272 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
6273 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
6274 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
6275 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
6277 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
6278 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob