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 3.0.0: 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, und <literal>Rose::DB::Object</literal> ist zu alt)</para>
86 <para>7.0 "Wheezy"</para>
92 <para>Ubuntu 12.04 LTS "Precise Pangolin", 12.10 "Quantal Quetzal" und 13.04 "Precise Pangolin"</para>
96 <para>openSUSE 12.2 und 12.3</para>
100 <para>SuSE Linux Enterprice Server 11</para>
104 <para>Fedora 16 bis 19</para>
109 <sect2 id="Pakete" xreflabel="Pakete">
110 <title>Benötigte Perl-Pakete installieren</title>
112 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
113 Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.4)
116 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht Bestandteil einer Standard-Perl-Installation sind. Um zu
117 überprüfen, ob die erforderlichen Pakete installiert und aktuell genug sind, wird ein Script mitgeliefert, das wie folgt aufgerufen
120 <programlisting>./scripts/installation_check.pl</programlisting>
122 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
125 <listitem><para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para></listitem>
127 <listitem><para><literal>Archive::Zip</literal></para></listitem>
129 <listitem><para><literal>Config::Std</literal></para></listitem>
131 <listitem><para><literal>DateTime</literal></para></listitem>
133 <listitem><para><literal>DBI</literal></para></listitem>
135 <listitem><para><literal>DBD::Pg</literal></para></listitem>
137 <listitem><para><literal>Email::Address</literal></para></listitem>
139 <listitem><para><literal>Email::MIME</literal></para></listitem>
141 <listitem><para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71 inklusive; siehe <xref linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para></listitem>
143 <listitem><para><literal>File::Copy::Recursive</literal></para></listitem>
145 <listitem><para><literal>JSON</literal></para></listitem>
147 <listitem><para><literal>List::MoreUtils</literal></para></listitem>
149 <listitem><para><literal>Net::SMTP::SSL</literal> (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "<xref
150 linkend="config.sending-email.smtp"/>")</para></listitem>
152 <listitem><para><literal>Net::SSLGlue</literal> (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "<xref
153 linkend="config.sending-email.smtp"/>")</para></listitem>
155 <listitem><para><literal>Params::Validate</literal></para></listitem>
157 <listitem><para><literal>PDF::API2</literal></para></listitem>
159 <listitem><para><literal>Rose::Object</literal></para></listitem>
161 <listitem><para><literal>Rose::DB</literal></para></listitem>
163 <listitem><para><literal>Rose::DB::Object</literal> Version 0.788 oder neuer</para></listitem>
165 <listitem><para><literal>Template</literal></para></listitem>
167 <listitem><para><literal>Text::CSV_XS</literal></para></listitem>
169 <listitem><para><literal>Text::Iconv</literal></para></listitem>
171 <listitem><para><literal>URI</literal></para></listitem>
173 <listitem><para><literal>XML::Writer</literal></para></listitem>
175 <listitem><para><literal>YAML</literal></para></listitem>
178 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen: <literal>File::Copy::Recursive</literal>.</para>
180 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen: <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
181 <literal>Net::SSLGlue</literal>.</para>
183 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
184 hinzugekommen, <literal>URI</literal> und
185 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
188 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
189 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
190 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
191 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
193 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
194 hinzugekommen.</para>
196 <para><literal>Email::Address</literal> und
197 <literal>List::MoreUtils</literal> sind schon länger feste
198 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
199 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
200 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
201 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
205 <title>Debian und Ubuntu</title>
207 <para>Alle benötigten Perl-Pakete stehen für Debian und Ubuntu als Debian-Pakete zur Verfügung. Sie können mit folgendem Befehl
208 installiert werden:</para>
210 <programlisting>apt-get install apache2 libarchive-zip-perl libclone-perl \
211 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
212 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
213 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
214 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
215 librose-db-perl librose-object-perl libsort-naturally-perl \
216 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
217 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
218 libfile-copy-recursive-perl postgresql</programlisting>
222 <title>Fedora Core</title>
224 <para>Für Fedora Core stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl installeirt werden:</para>
226 <programlisting>yum install httpd perl-Archive-Zip perl-Clone perl-DBD-Pg \
227 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
228 perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
229 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
230 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
231 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
232 perl-XML-Writer perl-YAML perl-parent postgresql-server</programlisting>
234 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
236 <programlisting>yum install perl-CPAN
237 cpan Config::Std</programlisting>
242 <title>openSUSE</title>
244 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
245 installiert werden:</para>
247 <programlisting>zypper install apache2 perl-Archive-Zip perl-Clone \
248 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
249 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
250 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
251 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
252 perl-URI perl-XML-Writer perl-YAML postgresql-server</programlisting>
254 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
256 <programlisting>yum install perl-CPAN
257 cpan Rose::Db::Object</programlisting>
263 <sect1 id="Manuelle-Installation-des-Programmpaketes"
264 xreflabel="Manuelle Installation des Programmpaketes">
265 <title>Manuelle Installation des Programmpaketes</title>
267 <para>Die kivitendo ERP Installationsdatei (<filename>kivitendo-erp-3.0.0.tgz</filename>) wird im Dokumentenverzeichnis des Webservers
268 (z.B. <filename>/var/www/html/</filename>, <filename>/srv/www/htdocs</filename> oder <filename>/var/www/</filename>) entpackt:</para>
270 <programlisting>cd /var/www
271 tar xvzf kivitendo-erp-3.0.0.tgz</programlisting>
273 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
275 <programlisting>cd kivitendo-erp</programlisting>
277 <para>Alternativ können Sie auch einen Alias in der
278 Webserverkonfiguration benutzen, um auf das tatsächliche
279 Installationsverzeichnis zu verweisen.</para>
281 <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
282 beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
283 Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
284 core <constant>apache</constant> oder bei OpenSUSE <constant>wwwrun</constant>).</para>
286 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
287 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
289 <programlisting>chown -R www-data users spool webdav</programlisting>
291 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
292 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>
294 <programlisting>chown www-data templates users</programlisting>
297 <sect1 id="config.config-file">
298 <title>kivitendo-Konfigurationsdatei</title>
300 <sect2 id="config.config-file.introduction"
301 xreflabel="Einführung in die Konfigurationsdatei">
302 <title>Einführung</title>
304 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei,
305 die benötigt wird: <filename>config/kivitendo.conf</filename> (kurz:
306 "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
307 von kivitendo bzw. der Migration von älteren Versionen angelegt
310 <para>Als Vorlage dient die Datei
311 <filename>config/kivitendo.conf.default</filename> (kurz: "die
312 Default-Datei"):</para>
314 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
316 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
317 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
318 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
319 Abschnitte und Werte enthalten, die von denen der Default-Datei
324 Vor der Umbenennung in kivitendo hieß diese Datei noch <filename>config/lx_office.conf</filename>. Aus Gründen der Kompatibilität
325 wird diese Datei eingelesen, sofern die Datei <filename>config/kivitendo.conf</filename> nicht existiert.
329 <para>Diese Hauptkonfigurationsdatei ist dann eine
330 installationsspezifische Datei, d.h. sie enthält bspw. lokale
331 Passwörter und wird auch nicht im Versionsmanagement (git)
334 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
335 Mandaten, bzw. Datenbanken gleich.</para>
338 <sect2 id="config.config-file.sections-parameters">
339 <title>Abschnitte und Parameter</title>
341 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
342 entsprechend kommentiert sind:</para>
345 <listitem><para><literal>authentication</literal> (siehe Abschnitt "<xref
346 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>" in diesem Kapitel)</para></listitem>
348 <listitem><para><literal>authentication/database</literal></para></listitem>
350 <listitem><para><literal>authentication/ldap</literal></para></listitem>
352 <listitem><para><literal>system</literal></para></listitem>
354 <listitem><para><literal>features</literal> (siehe Kapitel "<xref linkend="features"/>")</para></listitem>
356 <listitem><para><literal>paths</literal></para></listitem>
358 <listitem><para><literal>applications</literal></para></listitem>
360 <listitem><para><literal>environment</literal></para></listitem>
362 <listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>
364 <listitem><para><literal>print_templates</literal></para></listitem>
366 <listitem><para><literal>task_server</literal></para></listitem>
368 <listitem><para><literal>periodic_invoices</literal></para></listitem>
370 <listitem><para><literal>console</literal></para></listitem>
372 <listitem><para><literal>debug</literal></para></listitem>
375 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
376 einzustellen oder zu kontrollieren sind, sind:</para>
378 <programlisting>[authentication]
379 admin_password = geheim
381 [authentication/database]
386 password =</programlisting>
388 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
389 <varname>[periodic_invoices]</varname> den Login eines Benutzers
390 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
391 mit Informationen über die erstellten Rechnungen bekommt.</para>
393 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten Ausführung bestimmter Aufgaben mit, den <link
394 linkend="config.task-server">Taskserver</link>. Er wird u.a. für Features wie die <link
395 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link> benötigt, erledigt aber auch andere erforderliche Aufgaben
396 und muss daher in Betrieb genommen werden. Der Taskserver benötigt zwei Konfigurationseinstellungen, die unter
397 <varname>[task_server]</varname> anzugeben sind: ein Mandant (entweder der Mandantenname oder eine Datenbank-ID, Variable
398 <varname>client</varname>), aus dem die Datenbankkonfiguration entnommen wird, sowie ein Login (Variable <varname>login</varname>)
399 eines Benutzers, der für gewisse Dinge wie die Rechnungserstellung als Verkäufer eingetragen wird.</para>
401 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
402 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
405 <sect2 id="config.config-file.prior-versions">
406 <title>Versionen vor 2.6.3</title>
408 <para>In älteren kivitendo Versionen gab es im Verzeichnis
409 <filename>config</filename> die Dateien
410 <filename>authentication.pl</filename> und
411 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
412 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
413 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
414 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
416 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
417 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
418 manuell übertragen und die alten Konfigurationsdateien anschließend
419 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
420 entsprechende Fehlermeldung an.</para>
424 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
425 <title>Anpassung der PostgreSQL-Konfiguration</title>
427 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
429 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
430 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
432 <para>kivitendo setzt zwingend voraus, dass die Datenbank Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen Serverinstallationen
433 braucht man hier meist nicht einzugreifen.</para>
435 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so
436 braucht man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
438 <programlisting>su postgres
440 exit </programlisting>
442 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
443 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
444 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
447 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
449 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
450 Versionsnummer angepasst werden.</para>
452 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
454 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
455 <literal>\l</literal> geprüft werden.</para>
458 <sect2 id="Änderungen-an-Konfigurationsdateien">
459 <title>Änderungen an Konfigurationsdateien</title>
461 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
462 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
463 <filename>/var/lib/pgsql/data/</filename> oder
464 <filename>/etc/postgresql/</filename>, muss sichergestellt werden,
465 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
466 Parameter <varname>listen_address</varname> gesteuert. Laufen
467 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
468 <literal>localhost</literal> verwendet werden. Andernfalls müssen
469 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
470 was mit dem Wert <literal>*</literal> geschieht.</para>
472 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
473 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
474 sein sollte, müssen die Berichtigungen für den Zugriff geändert
475 werden. Hier gibt es mehrere Möglichkeiten. sinnvoll ist es nur die
476 nögiten Verbindungen immer zuzulassen, für eine lokal laufenden
477 Datenbank zum Beispiel:</para>
479 <programlisting>local all kivitendo password
480 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
483 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
484 <title>Erweiterung für servergespeicherte Prozeduren</title>
486 <para>In der Datenbank <literal>template1</literal> muss die
487 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
488 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
489 <programlisting>su - postgres
490 psql template1</programlisting>
492 führen Sie die folgenden Kommandos aus:</para>
494 <programlisting>create language 'plpgsql';
498 <sect2 id="Datenbankbenutzer-anlegen">
499 <title>Datenbankbenutzer anlegen</title>
501 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
502 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
503 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
506 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit nein
507 beantworten, genauso ist die Berechtigung neue User (Roles) zu
508 generieren nicht nötig.</para>
509 <programlisting>su - postgres
510 createuser -d -P kivitendo
511 exit</programlisting>
513 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
514 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.
515 den hier gewählten Benutzernamen.</para>
519 <sect1 id="Apache-Konfiguration">
520 <title>Webserver-Konfiguration</title>
523 <title>Grundkonfiguration mittels CGI</title>
526 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
527 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
528 <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
531 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
532 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
533 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
534 anderen Datei hinzu, die beim Starten des Webservers eingelesen
537 <programlisting>AddHandler cgi-script .pl
538 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
540 <Directory /var/www/kivitendo-erp>
541 Options ExecCGI Includes FollowSymlinks
544 <Directory /var/www/kivitendo-erp/users>
547 </Directory></programlisting>
549 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
550 das kivitendo-Archiv entpacket haben.</para>
553 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
554 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
557 <para>Auf einigen Webservern werden manchmal die Grafiken und
558 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
559 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
561 <programlisting>EnableSendfile Off</programlisting>
564 <sect2 id="Apache-Konfiguration.FCGI"
565 xreflabel="Konfiguration für FastCGI/FCGI">
566 <title>Konfiguration für FastCGI/FCGI</title>
568 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
569 <title>Was ist FastCGI?</title>
571 <para>Direkt aus <ulink
572 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
575 <para><citation> FastCGI ist ein Standard für die Einbindung
576 externer Software zur Generierung dynamischer Webseiten in einem
577 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
578 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
579 umgehen. </citation></para>
582 <sect3 id="Apache-Konfiguration.FCGI.Warum">
583 <title>Warum FastCGI?</title>
585 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
586 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
587 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
588 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
589 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
590 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
591 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
592 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
593 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
594 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
595 deutlich länger dauert als früher, und dass davon 90% für das Laden
596 der Module verwendet wird.</para>
598 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
599 wird nur die eigentliche Programmlogik ausgeführt.</para>
602 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
603 <title>Getestete Kombinationen aus Webservern und Plugin</title>
605 <para>Folgende Kombinationen sind getestet:</para>
609 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
613 <para>Apache 2.2.11 (Ubuntu) und mod_fastcgi.</para>
617 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
618 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
619 mod_fastcgi nicht mehr explizit eingegangen.</para>
621 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
625 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern
626 bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrere Installation gibt, muss zwingend Version 0.68 oder
627 aber Version 0.72 und neuer eingesetzt werden.</para>
629 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie sich die Vorgängerversion wie folgt
632 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
636 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
637 <title>Konfiguration des Webservers</title>
639 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
640 laufen zu lassen, empfliehlt es sich die Installation ersteinmal
641 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
642 debuggen die beim ersten aufsetzen auftreten können. Sollte die
643 Installation schon funktionieren, lesen Sie weiter.</para>
645 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
646 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
648 <programlisting>a2enmod fcgid</programlisting>
650 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
651 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
652 und <function>Directory</function>-Direktiven. Dabei wird zwischen
653 dem Installationspfad von kivitendo im Dateisystem
654 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
655 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
656 ("<filename>/url/for/kivitendo-erp</filename>").</para>
658 <para>Folgender Konfigurationsschnipsel funktioniert mit
661 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
662 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
664 <Directory /path/to/kivitendo-erp>
666 Options ExecCGI Includes FollowSymlinks
671 <DirectoryMatch /path/to/kivitendo-erp/users>
674 </DirectoryMatch></programlisting>
676 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
677 die maximale Größe eines Requests. Diese sollte wie folgt
678 hochgesetzt werden:</para>
680 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
682 <para>Das ganze sollte dann so aussehen:</para>
684 <programlisting>AddHandler fcgid-script .fpl
685 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
686 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
687 FcgidMaxRequestLen 10485760
689 <Directory /path/to/kivitendo-erp>
691 Options ExecCGI Includes FollowSymlinks
696 <DirectoryMatch /path/to/kivitendo-erp/users>
699 </DirectoryMatch></programlisting>
701 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
702 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
703 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
704 gibt es hier kleine Performance-Einbußen.</para>
706 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
707 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
708 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
710 <programlisting># Zugriff über CGI
711 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
713 # Zugriff mit mod_fcgid:
714 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
715 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
717 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
718 die normale Version erreichbar, und unter
719 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
720 FastCGI-Version.</para>
725 <sect1 id="config.task-server">
726 <title>Der Task-Server</title>
728 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und
729 diese zu festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess wird u.a. für die Erzeugung der wiederkehrenden
730 Rechnungen und weitere essenzielle Aufgaben benutzt.</para>
732 <sect2 id="Konfiguration-des-Task-Servers">
733 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
735 <para>Die Konfiguration erfolgt über den Abschnitt
736 <literal>[task_server]</literal> in der Datei
737 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
738 Optionen sind:</para>
742 <term><varname>client</varname></term>
745 <para>Name oder Datenbank-ID eines vorhandenen kivitendo-Mandanten, der benutzt wird, um die zu verwendende
746 Datenbankverbindung auszulesen. Der Mandant muss in der Administration angelegt werden. Diese Option muss angegeben
749 <para>Diese Option kam mit Release v3.x.0 hinzu und muss daher in Konfigurationen, die von älteren Versionen aktualisiert
750 wurden, ergänzt werden.</para>
755 <term><varname>login</varname></term>
758 <para>gültiger kivitendo-Benutzername, der z.B. als Verkäufer beim Erzeugen wiederkehrender Rechnungen benötigt wird. Der
759 Benutzer muss in der Administration angelegt werden. Diese Option muss angegeben werden.</para>
764 <term><varname>run_as</varname></term>
767 <para>Wird der Server vom Systembenutzer <literal>root</literal>
768 gestartet, so wechselt er auf den mit <literal>run_as</literal>
769 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
770 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
772 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
773 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
774 unter dem auch der Webserver läuft.</para>
779 <term><varname>debug</varname></term>
782 <para>Schaltet Debug-Informationen an und aus.</para>
788 <sect2 id="Einbinden-in-den-Boot-Prozess">
789 <title>Automatisches Starten des Task-Servers beim Booten</title>
791 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
792 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
793 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
795 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
796 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
797 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
798 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
799 anstelle eines symbolischen Links verwendet werden können.</para>
802 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, ältere Fedora Core)</title>
804 <para>Kopieren Sie die Datei
805 <filename>scripts/boot/system-v/kivitendo-server</filename>
806 nach <filename>/etc/init.d/kivitendo-server</filename>. Passen
807 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
808 <literal>DAEMON=....</literal>). Binden Sie das Script in den
809 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
813 <para>Debian-basierende Systeme:</para>
815 <programlisting>update-rc.d kivitendo-task-server defaults
816 # Nur bei Debian Squeeze und neuer:
817 insserv kivitendo-task-server</programlisting>
821 <para>Ältere OpenSUSE und ältere Fedora Core:</para>
823 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
827 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
830 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
834 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
836 <para>Kopieren Sie die Datei
837 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
838 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
839 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
840 <literal>exec ....</literal>).</para>
842 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
845 <programlisting>service kivitendo-task-server start</programlisting>
849 <title>systemd-basierende Systeme (z.B. neure OpenSUSE, neuere Fedora Core)</title>
851 <para>Verlinken Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
852 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
853 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>). Binden Sie das Script in den Boot-Prozess ein.
856 <para>Alle hierzu benötigten Befehle sehen so aus:</para>
858 <programlisting>cd /var/www/kivitendo-erp/scripts/boot/systemd
859 ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
861 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
864 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
868 <sect2 id="Prozesskontrolle">
869 <title>Wie der Task-Server gestartet und beendet wird</title>
871 <para>Der Task-Server wird wie folgt kontrolliert:</para>
873 <programlisting>./scripts/task_server.pl Befehl</programlisting>
875 <para><literal>Befehl</literal> ist dabei eine der folgenden
880 <para><literal>start</literal> startet eine neue Instanz des
881 Task-Servers. Die Prozess-ID wird innerhalb des
882 <filename>users</filename>-Verzeichnisses abgelegt.</para>
886 <para><literal>stop</literal> beendet einen laufenden
891 <para><literal>restart</literal> beendet und startet ihn
896 <para><literal>status</literal> berichtet, ob der Task-Server
901 <para>Der Task-Server wechselt beim Starten automatisch in das
902 kivitendo-Installationsverzeichnis.</para>
904 <para>Dieselben Optionen können auch für die SystemV-basierenden
905 Runlevel-Scripte benutzt werden (siehe oben).</para>
907 <sect2 id="Prozesskontrolle2">
908 <title>Task-Server mit mehreren Mandanten</title>
910 <para>Beim Task-Server werden der zu verwendende Mandant und Login-Name des Benutzers, unter dem der Task-Server laufen soll, in die
911 Konfigurationsdatei geschrieben. Hat man mehrere Mandanten, muss man auch mehrere Konfigurationsdateien anlegen.</para>
913 <para>Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf, wo in der Kategorie <varname>[task_server]</varname> die
914 gewünschten Werte für <varname>client</varname> und <varname>login</varname> eingetragen werden.</para>
916 <para>Der alternative Task-Server wird dann mit folgendem Befehl
919 <programlisting>./scripts/task_server.pl -c config/DATEINAME.conf</programlisting>
923 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
924 <title>Benutzerauthentifizierung und Administratorpasswort</title>
926 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
927 über die Verwaltung von Gruppen und weitere Einstellungen</para>
929 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
930 <title>Grundlagen zur Benutzerauthentifizierung</title>
932 <para>kivitendo verwaltet die Benutzerinformationen in einer
933 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
934 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
935 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
936 können, müssen aber nicht unterschiedlich sein.</para>
938 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
939 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
940 abgelegt werden.</para>
942 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
943 entweder gegen die Authentifizierungsdatenbank oder gegen einen
944 LDAP-Server überprüft werden.</para>
946 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
947 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
948 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
949 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
950 einer Version vor v2.6.0 angelegt werden. Eine
951 Beispielkonfigurationsdatei
952 <filename>config/kivitendo.conf.default</filename> existiert, die als
953 Vorlage benutzt werden kann.</para>
956 <sect2 id="Administratorpasswort">
957 <title>Administratorpasswort</title>
959 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
960 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
961 nur dort und nicht mehr im Administrationsinterface selber geändert
962 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
963 Abschnitt <varname>[authentication]</varname>.</para>
966 <sect2 id="Authentifizierungsdatenbank">
967 <title>Authentifizierungsdatenbank</title>
969 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
970 Parametern in <varname>[authentication/database]</varname>
971 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
975 <term><literal>host</literal></term>
978 <para>Der Rechnername oder die IP-Adresse des
979 Datenbankservers</para>
984 <term><literal>port</literal></term>
987 <para>Die Portnummer des Datenbankservers, meist 5432</para>
992 <term><literal>db</literal></term>
995 <para>Der Name der Authentifizierungsdatenbank</para>
1000 <term><literal>user</literal></term>
1003 <para>Der Benutzername, mit dem sich kivitendo beim
1004 Datenbankserver anmeldet (z.B.
1005 "<literal>postgres</literal>")</para>
1010 <term><literal>password</literal></term>
1013 <para>Das Passwort für den Datenbankbenutzer</para>
1018 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1019 automatisch anlegen (mehr dazu siehe unten).</para>
1022 <sect2 id="Passwortüberprüfung">
1023 <title>Passwortüberprüfung</title>
1025 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1026 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1027 Active-Directory-Server. Welche davon benutzt wird, regelt der
1028 Parameter <varname>module</varname> im Abschnitt
1029 <varname>[authentication]</varname>.</para>
1031 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1032 gespeichert werden, so muss der Parameter <varname>module</varname>
1033 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1034 der Administrator als auch die Benutzer selber ihre Psaswörter in
1035 kivitendo ändern.</para>
1037 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1038 benutzt werden, so muss der Parameter <varname>module</varname> auf
1039 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1040 zusätzliche Informationen über den LDAP-Server im Abschnitt
1041 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1045 <term><literal>host</literal></term>
1048 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1049 Active-Directory-Servers. Diese Angabe ist zwingend
1050 erforderlich.</para>
1055 <term><literal>port</literal></term>
1058 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1063 <term><literal>tls</literal></term>
1066 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1067 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1068 ‘<literal>0</literal>’ belassen</para>
1073 <term><literal>attribute</literal></term>
1076 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1077 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1078 meist ‘<literal>sAMAccountName</literal>’, für andere
1079 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1080 zwingend erforderlich.</para>
1085 <term><literal>base_dn</literal></term>
1088 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1089 Diese Angabe ist zwingend erforderlich.</para>
1094 <term><literal>filter</literal></term>
1097 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1098 <literal><%login%></literal>, so wird dieses durch den vom
1099 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1100 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1101 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1106 <term><literal>bind_dn</literal> und
1107 <literal>bind_password</literal></term>
1110 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1111 durchsucht werden kann (z.B. ist dies bei
1112 Active-Directory-Servern der Fall), so kann diese hier angegeben
1113 werden. Für Active-Directory-Server kann als
1114 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1115 z.B. ‘<literal>cn=Martin
1116 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1117 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1118 also ‘<literal>Martin Mustermann</literal>’.</para>
1124 <sect2 id="Name-des-Session-Cookies">
1125 <title>Name des Session-Cookies</title>
1127 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1128 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1129 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1130 Parameter <varname>cookie_name</varname> im Abschnitt
1131 <varname>[authentication]</varname>gesetzt.</para>
1133 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1134 Server existiert.</para>
1137 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1138 <title>Anlegen der Authentifizierungsdatenbank</title>
1140 <para>Nachdem alle Einstellungen in
1141 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1142 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1143 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1144 der folgenden URL erreichbar sein sollte:</para>
1147 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1151 <sect1 id="Benutzer--und-Gruppenverwaltung">
1152 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1154 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und Datenbanken angelegt werden. Dieses geschieht im
1155 Administrationsmenü, das Sie unter folgender URL finden:</para>
1158 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1160 <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
1161 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1163 <sect2 id="Zusammenhänge">
1164 <title>Zusammenhänge</title>
1166 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung in einer oder zwei Datenbanken gespeichert werden.</para>
1168 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat
1169 Zugriff auf welche Mandanten, und welche Gruppe verfügt über welche Rechte. Diese Informationen werden in der
1170 Authentifizierungsdatenbank gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter in der Konfigurationsdatei
1171 <filename>config/kivitendo.conf</filename> gespeichert werden.</para>
1173 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines Mandanten: Stammdaten (Kunden, Lieferanten, Waren), Belege
1174 (Angebote, Liferscheine, Rechnungen), Einstellungen. Diese werden in einer Mandantendatenbank gespeichert. Die
1175 Verbindungsinformationen einer solchen Mandantendatenbank werden im Administrationsbereich konfiguriert, indem man einen Mandanten
1176 anlegt und dort die Parameter einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1178 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich, die Authentifizierungsdatenbank und eine der
1179 Mandantendatenbanken in ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit mehr als einem Mandanten, wird
1180 empfohlen, für die Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die nicht gleichzeitig für einen Mandanten
1181 verwendet wird.</para>
1183 <para>kivitendo verwendet eine Datenbank zum Speichern all seiner
1184 Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um
1185 mit kivitendo arbeiten zu können, muss eine Person einen
1186 Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine
1187 Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist
1188 möglich und normal, dass mehreren Benutzern die selbe Datenbank
1189 zugewiesen wird, sodass sie alle mit den selben Daten arbeiten
1193 <sect2 id="Mandanten-Benutzer-Gruppen">
1194 <title>Mandanten, Benutzer und Gruppen</title>
1196 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen, die sich frei zueinander zuordnen lassen.</para>
1198 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1199 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1200 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank. Diese sollte über die <link
1201 linkend="Datenbanken-anlegen">Datenbankverwaltung</link> geschehen.</para>
1203 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten soll. Sie erhält einen Loginnamen sowie ein
1204 Passwort. Weiterhin legt der Administrator fest, an welchen Mandanten sich ein Benutzer anmelden kann, was beim Login verifiziert
1207 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür
1208 vom Administrator gewisse Rechte zugeordnet. Weiterhin legt der Administrator fest, für welche Mandanten eine Gruppe gilt, und
1209 welche Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer dann an einem Mandanten an, so erhält er alle Rechte von
1210 allen denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in denen der Benutzer zum Anderen Mitglied ist, </para>
1212 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und Benutzer angelegt werden, kann im Prinzip beliebig gewählt
1213 werden. Die folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1215 <orderedlist numeration="arabic">
1217 <para>Datenbank anlegen</para>
1221 <para>Gruppen anlegen</para>
1225 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1229 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1234 <sect2 id="Datenbanken-anlegen">
1235 <title>Datenbanken anlegen</title>
1237 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1238 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1239 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1242 <sect2 id="Gruppen-anlegen">
1243 <title>Gruppen anlegen</title>
1245 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1246 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1247 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1248 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1250 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank gespeichert, gelten aber nicht automatisch für alle
1251 Mandanten. Der Administrator legt vielmehr fest, für welche Mandanten eine Gruppe gültig ist. Dies kann entweder beim Bearbeiten der
1252 Gruppe geschehen ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn man einen Mandanten bearbeitet ("für diesen
1253 Mandanten sind die Gruppen A, B und C gültig").</para>
1255 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder dieser Gruppe festgelegt werden ("in dieser Gruppe sind die
1256 Benutzer X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten eines Benutzers geschehen ("dieser Benutzer ist
1257 Mitglied in den Gruppen A, B und C").</para>
1260 <sect2 id="Benutzer-anlegen">
1261 <title>Benutzer anlegen</title>
1263 <para>Beim Anlegen von Benutzern werden für viele Parameter Standardeinstellungen vorgenommen, die den Gepflogenheiten des deutschen
1264 Raumes entsprechen.</para>
1266 <para>Zwingend anzugeben ist der Loginname. Wenn die Passwortauthentifizierung über die Datenbank eingestellt ist, so kann hier auch
1267 das Benutzerpasswort gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1270 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier auch konfiguriert werden, auf welche Mandanten der Benutzer
1271 Zugriff hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können sowohl beim Benutzer vorgenommen werden ("dieser
1272 Benutzer hat Zugriff auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen X, Y und Z") als auch beim Mandanten ("auf
1273 diesen Mandanten haben Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe sind Benutzer A, B und C
1274 Mitglieder").</para>
1277 <sect2 id="Mandanten-anlegen">
1278 <title>Mandanten anlegen</title>
1280 <para>Ein Mandant besteht aus Administrationssicht primär aus einem eindeutigen Namen. Weiterhin wird hier hinterlegt, welche
1281 Datenbank als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten einer der eben angelegten Datenbanken eingetragen
1284 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch konfiguriert werden, welche Benutzer Zugriff auf den
1285 Mandanten haben bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen können sowohl beim Mandanten vorgenommen werden
1286 ("auf diesen Mandanten haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die Gruppen X, Y und Z gültig") als auch
1287 beim Benutzer ("dieser Benutzer hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese Gruppe ist für Mandanten A, B und
1292 <sect1 id="config.sending-email" xreflabel="E-Mail-Versand aus kivitendo heraus">
1293 <title>E-Mail-Versand aus kivitendo heraus</title>
1295 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden, z.B. um ein Angebot direkt an einen Kunden zu
1296 verschicken. Damit dies funktioniert, muss eingestellt werden, über welchen Server die E-Mails verschickt werden sollen. kivitendo
1297 unterstützt dabei zwei Mechanismen: Versand über einen lokalen E-Mail-Server (z.B. mit <productname>Postfix</productname> oder
1298 <productname>Exim</productname>, was auch die standardmäßig aktive Methode ist) sowie Versand über einen SMTP-Server (z.B. der des
1299 eigenen Internet-Providers).</para>
1301 <para>Welche Methode und welcher Server verwendet werden, wird über die Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1302 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1304 <sect2 id="config.sending-email.sendmail" xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1305 <title>Versand über lokalen E-Mail-Server</title>
1307 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie
1308 z.B. <productname>Postfix</productname>, <productname>Exim</productname> oder <productname>Sendmail</productname> läuft.</para>
1310 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1311 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1313 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet wird, dient der Parameter '<literal>sendmail =
1314 ...</literal>'. Der Standardwert verweist auf das Programm <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1315 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1317 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen dieses sprengen. Hierfür sei auf die Dokumentation des
1318 E-Mail-Servers verwiesen.</para>
1321 <sect2 id="config.sending-email.smtp" xreflabel="E-Mail-Versand über einen SMTP-Server">
1322 <title>Versand über einen SMTP-Server</title>
1324 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server vorhanden oder zwar einer vorhanden, dieser aber nicht
1325 konfiguriert ist.</para>
1327 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1328 Parameter dienen dabei der weiteren Konfiguration:</para>
1332 <term><varname>hostname</varname></term>
1334 <listitem><para>Name oder IP-Adresse des SMTP-Servers. Standardwert: '<literal>localhost</literal>'</para></listitem>
1338 <term><varname>port</varname></term>
1340 <listitem><para>Portnummer. Der Standardwert hängt von der verwendeten Verschlüsselungsmethode ab. Gilt '<literal>security =
1341 none</literal>' oder '<literal>security = tls</literal>', so ist 25 die Standardportnummer. Für '<literal>security =
1342 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht geändert werden.</para></listitem>
1346 <term><varname>security</varname></term>
1348 <listitem><para>Wahl der zu verwendenden Verschlüsselung der Verbindung mit dem Server. Standardwert ist
1349 '<literal>none</literal>', wodurch keine Verschlüsselung verwendet wird. Mit '<literal>tls</literal>' wird TLS-Verschlüsselung
1350 eingeschaltet, und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL eingeschaltet. Achtung: Für
1351 '<literal>tls</literal>' und '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt (siehe unten).</para></listitem>
1355 <term><varname>login</varname> und <varname>password</varname></term>
1357 <listitem><para>Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername
1358 und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von
1359 Verschlüsselung aktiviert werden.</para></listitem>
1363 <para>Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind:</para>
1366 <listitem><para>TLS-Verschlüsselung: Modul <literal>Net::SSLGlue</literal> (Debian-Paketname
1367 <literal>libnet-sslglue-perl</literal>, Fedora Core: <literal>perl-Net-SSLGlue</literal>, openSUSE:
1368 <literal>perl-Net-SSLGlue</literal></para></listitem>
1370 <listitem><para>SSL-Verschlüsselung: Modul <literal>Net::SMTP::SSL</literal> (Debian-Paketname
1371 <literal>libnet-smtp-ssl-perl</literal>, Fedora Core: <literal>perl-Net-SMTP-SSL</literal>, openSUSE:
1372 <literal>perl-Net-SMTP-SSL</literal></para></listitem>
1377 <sect1 id="Drucken-mit-kivitendo">
1378 <title>Drucken mit kivitendo</title>
1380 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. Um drucken zu können, braucht der Server ein geeignetes
1381 LaTeX System. Am einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter Debianoiden Betriebssystemen installiert man
1382 die Pakete mit:</para>
1384 <para><programlisting>aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1385 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1387 <para>TODO: RPM-Pakete.</para>
1389 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1391 <listitem><para>Standard</para></listitem>
1392 <listitem><para>f-tex</para></listitem>
1393 <listitem><para>RB</para></listitem>
1396 <sect2 id="Vorlagenverzeichnis-anlegen" xreflabel="Vorlagenverzeichnis anlegen">
1397 <title>Vorlagenverzeichnis anlegen</title>
1398 <para>Im Administrationsbereich lässt sich bei einem Benutzer/Mandanten einer dieser Vorlagensätze als Basis für die zu
1399 druckenden Dokumente auswählen. Rufen Sie dazu die <guimenu>Benutzerverwaltung</guimenu> auf.</para>
1401 <para>Wählen Sie dort einen Benutzer aus oder legen Sie einen neuen an. In der Benutzerbearbeiten-Maske müssen Sie zwei Dinge
1405 <listitem><para><option>Name</option>: Der Verzeichnisname für den neuen Vorlagensatz. Dieser kann im Rahmen der üblichen
1406 Bedingungen für Verzeichnisnamen frei gewählt werden.</para></listitem>
1407 <listitem><para><option>Vorlagen auswählen</option>: Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll
1408 (<filename>Standard</filename>, <filename>f-tex</filename> oder <filename>RB</filename>.)</para></listitem>
1411 <para>Der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Benutzern verwendet werden.</para>
1413 <para>Die Abhängigkeiten kann man prüfen mit:</para>
1415 <programlisting>/scripts/installation_check.pl -l</programlisting>
1418 <sect2 id="Vorlagen-Standard">
1419 <title>Standard</title>
1421 <para>Der Standard-Vorlagensatz von Kivitendo. Wie unter <ulink url="http://demo.kivitendo.org">http://demo.kivitendo.org</ulink> zu
1427 <title>f-tex</title>
1429 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt.</para>
1431 <sect3 id="f-tex-Feature-Übersicht">
1432 <title>Feature-Übersicht</title>
1434 <listitem><para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage für alle briefartigen Dokumente verwendet. Also
1435 Angebot, Rechnung, Performarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc..</para></listitem>
1437 <listitem><para>Leichte Anpassung an das Firmen-Layout durch verwendung eines Hintergrund-PDF. Dieses kann leicht mit dem
1438 eigenen Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp, Adobe*)</para></listitem>
1440 <listitem><para>Hintergrund-PDF umschaltbar auf "nur erste Seite" (Standard) oder "alle Seiten" (Option
1441 "<option>bgPdfFirstPageOnly</option>" in Datei <filename>letter.lco</filename>)</para></listitem>
1443 <listitem><para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1444 versendeten Dokumenten eingebunden (Option "<option>bgPdfEmailOnly</option>" in Datei
1445 <filename>letter.lco</filename>).</para></listitem>
1447 <listitem><para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch, Wiederholung von Kopfzeilen, Zwischensummen
1448 etc. (danke an Kai-Martin Knaak für die Vorarbeit)</para></listitem>
1450 <listitem><para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom Land des eigenen Unternehmens abweicht (also die
1451 Rechnung das Land verlässt).</para></listitem>
1453 <listitem><para>Multisprachfähig leicht um weitere Sprachen zu erweitern, alle Übersetzungen in der Datei
1454 <filename>translatinos.tex</filename>.</para></listitem>
1456 <listitem><para>Auflistung von Bruttopreisen für Endverbraucher.</para></listitem>
1460 <sect3 id="f-tex-Installation">
1461 <title>Die Installation</title>
1463 <listitem><para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref linkend="Vorlagenverzeichnis-anlegen"/>. Das
1464 Vorlagensystem funktioniert jetzt schon, hat allerdings noch einen Beispiel-Briefkopf.</para></listitem>
1466 <listitem><para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach <filename>./letter_head.pdf</filename>.</para></listitem>
1467 <listitem><para>Editiere den Bereich "<option>settings</option>" in der datei <filename>letter.lco</filename>.</para></listitem>
1470 <para>oder etwas Detaillierter:</para>
1473 Es wird eine Datei <filename>sample.lco</filename> erstellt und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
1474 ist dies die Datei die für die Firmenspezifischen Anpassungen gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig
1475 ist, wird in dieser Datei auf ein Hintergrundpdf verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen
1476 vorzunehmen und <filename>sample.lco</filename> unverändert zu lassen. Die die Anpassung über eine
1477 <filename>*.lco</filename>-Datei die letztlich auf <filename>letter.lco</filename> verlinkt ist ist aber auch möglich.
1481 Es wird eine Datei <filename>sample_head.pdf</filename> mit ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
1482 verlinkt. Damit gibt es schon mal eine Funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei
1483 <filename>sample_haed.pdf</filename> an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
1484 Template Verzeichniss ablegen und statt <filename>sample_head.pdf</filename> nach <filename>letter_head.pdf</filename>
1489 letzlich muss <filename>letter_head.pdf</filename> auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
1490 enthält. Bei Updates oder nach erneutem
1494 Es wird eine Datei <filename>mydata.tex.example</filename> ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
1495 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das Land verwendet. Die Datei muss also nicht angefasst
1496 werden. Die Anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig).
1499 Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc. sollten über die Hintergrund-PDF-Datei oder die
1500 <filename>*.lco</filename>-Datei erfolgen.
1504 <sect3 id="f-tex-Funktionsübersicht">
1505 <title>f-tex Funktionsübersicht</title>
1507 Das Konzept von kivitendo sieht vor, für jedes Dokument (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine LaTeX-Vorlage
1508 vorzuhalten, dies ist sehr Wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
1509 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
1510 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche LaTeX-Vorlage verwendet, welche über Codeweichen die
1511 Besonderheiten der jeweiligen Dokumente Berücksichtigt.
1515 <listitem><para>Tabellen mit oder ohne Preis</para></listitem>
1516 <listitem><para>Sprache der Tabellenüberschriften etc.</para></listitem>
1517 <listitem><para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus Angebotsnummer)</para></listitem>
1518 <listitem><para>Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus Gewerblicher
1519 Kunde)</para></listitem>
1522 <para>Nachteil:</para>
1525 LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
1526 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann natürlich
1527 auch innerhalb der Tabellendarstellung gut persönliche Anpassungen vornehmen. Aber man kann sich hier bei Veränderungen sehr
1528 schnell häftig in den Fuss schiessen.
1531 <para>Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund PDF auf Basis der
1532 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen, und sich an der Form der dargestellten Tabellen wie sie
1533 ausgeliefert werden, erfreuen.
1536 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine kontinuierliche Schritte gehen.</para>
1540 <sect3 id="f-tex-Bruttopreise">
1541 <title>Bruttopreise für Endverbraucher</title>
1543 <para>Der auszuweisende Bruttopreis wird innerhalb der LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen "alle
1544 Preise Brutto" auszuwählen, aber:</para>
1547 <para>hierfür müssen die Preise auch in Brutto in der Datenbank stehen (ja - das lässt sich über die Preisgruppen und die
1548 Zuordung einer Default-Preisgruppe handhaben)</para>
1551 <para>man darf beim Anlegen des Vorgangs nicht vergessen Dieses Häkchen zu setzen. (das ist in der Praxis wenn man sowohl
1552 Endverbraucher- wie Gewerbekunden beliefert der eigentliche Knackpunkt)</para>
1557 Es gibt mit f-tex eine weitere Alternative. Die Information ob Brutto oder Nettorechnung wird mit den Zahlarten
1558 verknüpft. Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben werden sollen, enden mit "_E" (für
1559 Endverbraucher). Falls identische Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt man diese einfach doppelt
1560 an (einmal mit der Namensendung "_E"). Gewinn:</para>
1563 <listitem><para>Die Entscheidung, ob Netopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste Verbunden.</para></listitem>
1564 <listitem><para>Die Default-Zahlart kann im Kundendatensatz hinterlegt werden, und man muss nicht mehr daran denken, "alle Preise
1565 Netto" auszuwählen.</para></listitem>
1566 <listitem><para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken reviediert werden,
1567 ohne dass sich der Auftragswert ändert.</para></listitem>
1571 <sect3 id="f-tex-lieferadressen">
1572 <title>Lieferadressen</title>
1574 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen im Adressfeld zum Einsatz. Wenn die
1575 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende Adressvariable eingesetzt. Wenn also die Lieferadresse in
1576 Straße, Hausnummer und Ort abweicht, müssen auch nur diese Felder in der Lieferadresse ausgefüllt werden. Für den Firmenname wird
1577 der Wert der Hauptadresse angezeigt.
1582 <sect2 id="Vorlagen-RB">
1585 <para>Vollständiger Dokumentensatz mit alternativem Design</para>
1589 <sect2 id="allgemeine-hinweise-zu-latex">
1590 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
1591 <para>In den allermeisten Installationen sollte drucken jetzt schon
1592 funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
1593 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
1594 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1599 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1600 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1601 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1605 <para>! Package inputenc Error: Unicode char \u8:... set up for
1606 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1607 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1608 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1609 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1610 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1614 <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
1615 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1616 Prüfen Sie den Namen in der Konfiguration (Standard:
1617 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1618 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1621 <para>Wenn sich das Problem nicht auf Grund der ausgabe im Webbrowser verifizieren lässt:</para>
1624 <para> editiere [kivitendo-home]/config/kivitendo.conf und ändere "keep_temp_files" auf 1</para>
1625 <para><programlisting>keep_temp_files = 1;</programlisting></para>
1628 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
1631 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
1634 <para>wechsele in das users Verzeichnis von kivitendo</para>
1635 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
1638 <para>LaTeX Suchpfad anpassen:</para>
1639 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
1642 <para>Finde herraus welche Datei kivitendo beim letzten Durchlauf erstellt hat</para>
1643 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
1644 <para>Es sollte die letzte Datei ganz unten sein</para>
1647 <para>für besseren Hinweis auf Fehler texdatei nochmals übersetzen</para>
1648 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
1649 <para>in der *.tex datei nach dem Fehler suchen.</para>
1655 <sect1 id="OpenDocument-Vorlagen">
1656 <title>OpenDocument-Vorlagen</title>
1658 <para>kivitendo unterstützt die Verwendung von Vorlagen im
1659 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1660 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1661 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1662 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1663 <filename>config/kivitendo.conf</filename> die Variable
1664 <literal>opendocument</literal> im Abschnitt
1665 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1666 Dieses ist die Standardeinstellung.</para>
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
1696 Für die Verbindung zu OpenOffice wird normalerweise der Python-Interpreter <filename>/usr/bin/python</filename> benutzt. Sollte
1697 dies nicht der richtige sein, so kann man mit zwei Konfigurationsvariablen entscheiden, welcher Python-Interpreter genutzt
1698 wird. Mit der Option <literal>python_uno</literal> aus dem Abschnitt <literal>applications</literal> wird der Interpreter selber
1699 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert <literal>/usr/bin/python</literal>.
1703 Zusätzlich ist es möglich, Pfade anzugeben, in denen Python neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
1704 z.B. falls sich diese in einem gesonderten OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
1705 <literal>python_uno_path</literal> und befindet sich im Abschnitt <literal>environment</literal>. Sie ist standardmäßig
1706 leer. Werden hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte voneinander getrennt werden. Der Inhalt wird an den
1707 Python-Interpreter über die Umgebungsvariable <literal>PYTHONPATH</literal> übergeben.
1711 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1712 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1713 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1714 Dokumentenvorlage enthalten sein und
1715 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1716 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1717 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1718 ebenfalls enthalten sein muss.</para>
1720 <para>Als letztes muss herausgefunden werden, welchen Namen
1721 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1722 gibt. Unter Debian ist dies momentan
1723 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1724 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1725 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1726 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1727 folgender Befehl auszuführen:</para>
1729 <para><literal>mv users/.openoffice.org2
1730 users/.openoffice</literal></para>
1732 <para>Dieses Verzeichnis, wie auch das komplette
1733 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1734 sein. Dieses wurde bereits erledigt (siehe <xref
1735 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1736 erneut überprüft werden, wenn die Konvertierung nach PDF
1740 <sect1 id="config.eur">
1741 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1744 <sect2 id="config.eur.introduction"
1745 xreflabel="Einführung in die Konfiguration zur EUR">
1746 <title>Einführung</title>
1748 <para>kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1749 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals noch <filename>config/lx_office.conf</filename>)
1750 befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden.</para>
1752 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1753 die Mandantendatenbank verschoben und dabei auch gleich in drei
1754 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1755 steuern lässt.</para>
1758 <sect2 id="config.eur.parameters"
1759 xreflabel="Konfigurationsparameter für EUR">
1760 <title>Konfigurationsparameter</title>
1762 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1763 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1767 <term><varname>profit_determination</varname></term>
1770 <para>Dieser Parameter legt die Berechnungsmethode für die
1771 Gewinnermittlung fest. Er enthält entweder
1772 <literal>balance</literal> für
1773 Betriebsvermögensvergleich/Bilanzierung oder
1774 <literal>income</literal> für die
1775 Einnahmen-Überschuss-Rechnung.</para>
1780 <term><varname>accounting_method</varname></term>
1783 <para>Dieser Parameter steuert die Buchungs- und
1784 Berechnungsmethoden für die Versteuerungsart. Er enthält
1785 entweder <literal>accrual</literal> für die Soll-Versteuerung
1786 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1791 <term><varname>inventory_system</varname></term>
1794 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1795 enthält entweder <literal>perpetual</literal> für die
1796 Bestandsmethode oder <literal>periodic</literal> für die
1797 Aufwandsmethode.</para>
1802 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1803 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1804 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1805 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1806 Bestandsmethode.</para>
1808 <para>Die Konfiguration "<varname>eur</varname>" unter
1809 <varname>[system]</varname> in der <link
1810 linkend="config.config-file">Konfigurationsdatei</link>
1811 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
1812 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1815 <sect2 id="config.eur.setting-parameters">
1816 <title>Festlegen der Parameter</title>
1818 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1819 der Admininstration können diese Optionen nun unabhängig voneinander
1820 eingestellt werden.</para>
1822 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1823 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1826 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1827 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
1828 angezeigt. Unter <guimenu>System</guimenu>
1829 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> können
1830 die Einstellungen auch geändert werden. Dabei ist zu beachten,
1831 dass eine Änderung vorhandene Daten so belässt und damit
1832 evtl. die Ergebnisse verfälscht. Dies gilt vor Allem für die
1833 Warenbuchungsmethode (siehe auch
1834 <link linkend="config.eur.inventory-system-perpetual">
1835 Bemerkungen zu Bestandsmethode</link>).</para>
1838 <sect2 id="config.eur.inventory-system-perpetual">
1839 <title>Bemerkungen zu Bestandsmethode</title>
1841 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1842 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
1843 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1844 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1845 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1846 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1847 Einkaufsrechnungen berechnet wird.</para>
1849 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1850 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1851 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1855 <sect2 id="config.eur.knonw-issues">
1856 <title>Bekannte Probleme</title>
1858 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1859 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1860 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1861 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1862 die Konfigurationsvariable
1863 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1866 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1867 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1871 <sect1 id="config.skr04-update-3804">
1872 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1874 <sect2 id="config.skr04-update-3804.introduction">
1875 <title>Einführung</title>
1877 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1878 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1879 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1880 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1881 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1882 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1883 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1884 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1885 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1886 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1887 Screenshots dargestellt.</para>
1889 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1890 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1891 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1892 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1895 <sect2 id="config.skr04-update-3804.create-chart">
1896 <title>Konto 3804 manuell anlegen</title>
1898 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
1899 anzulegen und zu konfigurieren. Zuerst wird in
1900 <guimenu>System</guimenu> ->
1901 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
1902 erfassen</guimenuitem> das Konto angelegt.</para>
1905 <screeninfo>Konto 3804 erfassen</screeninfo>
1909 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
1915 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
1916 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
1917 wie im folgenden Screenshot angezeigt anpassen.
1921 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
1925 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
1931 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
1932 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
1936 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
1940 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
1946 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
1947 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
1948 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
1949 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
1953 <screeninfo>Konto 4315 anpassen</screeninfo>
1957 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
1963 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
1964 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
1968 <screeninfo>Steuerliste vergleichen</screeninfo>
1972 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
1979 <sect1 id="config.client">
1980 <title>Einstellungen pro Mandant</title>
1982 <para>Einige Einstellungen können von einem Benutzer mit dem
1983 <link linkend="Zusammenhänge">Recht</link> "Administration
1984 (Für die Verwaltung der aktuellen Instanz aus einem Userlogin heraus)"
1985 gemacht werden. Diese Einstellungen sind dann für die aktuellen
1986 Mandanten-Datenbank gültig. Die Einstellungen sind
1987 unter <guimenu>System</guimenu>
1988 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
1990 <para>Bitte beachten Sie die Hinweise zu den einzelnen
1991 Einstellungen. Einige Einstellungen sollten nicht ohne Weiteres
1992 im laufenden Betrieb geändert werden (siehe
1993 auch <link linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
1994 Bestandsmethode</link>).</para>
1996 <para>Die Einstellungen <literal>show_bestbefore</literal>
1997 und <literal>payments_changeable</literal> aus dem
1998 Abschnitt <literal>features</literal> und die Einstellungen im
1999 Abschnitt <literal>datev_check</literal> (sofern schon vorhanden)
2000 der <link linkend="config.config-file">kivitendo-Konfigurationsdatei</link>
2001 werden bei einem Datenbankupdate einer älteren Version automatisch
2002 übernommen. Diese Einträge können danach aus der Konfigurationsdatei
2003 entfernt werden.</para>
2006 <sect1 id="kivitendo-ERP-verwenden">
2007 <title>kivitendo ERP verwenden</title>
2009 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
2010 folgender URL erreichbar:</para>
2013 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
2015 <para>Die Administrationsseite erreichen Sie unter:</para>
2018 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
2022 <chapter id="features" xreflabel="Features und Funktionen">
2023 <title>Features und Funktionen</title>
2025 <sect1 id="features.periodic-invoices"
2026 xreflabel="Wiedekehrende Rechnungen">
2027 <title>Wiederkehrende Rechnungen</title>
2029 <sect2 id="features.periodic-invoices.introduction"
2030 xreflabel="Einführung in wiederkehrende Rechnungen">
2031 <title>Einführung</title>
2033 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
2034 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
2035 Die konfigurierten Aufträge werden später automatisch in Rechnungen
2036 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
2037 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
2038 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
2039 wiederzufinden sind.</para>
2042 <sect2 id="features.periodic-invoices.configuration"
2043 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
2044 <title>Konfiguration</title>
2046 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
2047 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
2048 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
2049 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
2050 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
2053 <para>Folgende Parameter kann man konfigurieren:</para>
2060 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
2061 erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
2062 neuen Monats).</para>
2064 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
2065 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
2066 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
2067 nächsten Periodenwechsel für alle Perioden, seit der letzten
2068 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
2069 verhindern, muss man vorher das Startdatum neu setzen.</para>
2071 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
2072 erstellt. Man kann sich diese Aufträge aber gesondert in den
2073 Berichten anzeigen lassen.</para>
2078 <term>Periodizität</term>
2081 <para>Ob monatlich, quartalsweise oder jährlich auf neue
2082 Rechnungen überprüft werden soll. Für jede Periode seit dem
2083 Startdatum wird überprüft, ob für die Periode (beginnend immer
2084 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
2085 wurde. Unter Umständen können bei einem Startdatum in der
2086 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
2091 <term>Buchen auf</term>
2094 <para>Das Forderungskonto, in der Regel "Forderungen aus
2095 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
2096 Buchungsgruppen der betreffenden Waren.</para>
2101 <term>Startdatum</term>
2104 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
2110 <term>Enddatum</term>
2113 <para>ab wann keine Rechnungen mehr erstellt werden
2119 <term>Automatische Verlängerung um x Monate</term>
2122 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
2123 eingetragenen Enddatums weiterhin erstellt werden, so kann man
2124 hier die Anzahl der Monate eingeben, um die das Enddatum
2125 automatisch nach hinten geschoben wird.</para>
2130 <term>Drucken</term>
2133 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
2134 Rechnungen auch gleich ausdrucken lassen.</para>
2139 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
2140 Informationen zu den erstellten Rechnungen verschickt werden.
2141 Konfiguriert wird dies in der <link
2142 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
2143 <filename>config/kivitendo.conf</filename> im Abschnitt
2144 <varname>[periodic_invoices]</varname>.</para>
2147 <sect2 id="features.periodic-invoices.variables">
2148 <title>Spezielle Variablen</title>
2151 Um die erzeugten Rechnungen individualisieren zu können, werden beim Umwandeln des Auftrags in eine Rechnung einige speziell
2152 formatierte Variablen durch für die jeweils aktuelle Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B. den
2153 Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei die Syntax <literal><%variablenname%></literal>.
2157 Diese Variablen werden in den folgenden Elementen des Auftrags ersetzt:
2161 <listitem><para>Bemerkungen</para></listitem>
2162 <listitem><para>Interne Bemerkungen</para></listitem>
2163 <listitem><para>Vorgangsbezeichnung</para></listitem>
2164 <listitem><para>In den Beschreibungs- und Langtextfeldern aller Positionen</para></listitem>
2167 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
2171 <term><varname><%current_quarter%></varname>, <varname><%previous_quarter%></varname>, <varname><%next_quarter%></varname></term>
2175 Aktuelles, vorheriges und nächstes Quartal als Zahl zwischen <literal>1</literal> und <literal>4</literal>.
2181 <term><varname><%current_month%></varname>, <varname><%previous_month%></varname>, <varname><%next_month%></varname></term>
2185 Aktueller, vorheriger und nächster Monat als Zahl zwischen <literal>1</literal> und <literal>12</literal>.
2191 <term><varname><%current_month_long%></varname>, <varname><%previous_month_long%></varname>, <varname><%next_month_long%></varname></term>
2195 Aktueller, vorheriger und nächster Monat als Name (<literal>Januar</literal>, <literal>Februar</literal> etc.).
2201 <term><varname><%current_year%></varname>, <varname><%previous_year%></varname>, <varname><%next_year%></varname></term>
2205 Aktuelles, vorheriges und nächstes Jahr als vierstellige Jahreszahl (<literal>2013</literal> etc.).
2211 <term><varname><%period_start_date%></varname>, <varname><%period_end_date%></varname></term>
2215 Formatiertes Datum des ersten und letzten Tages im Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im ersten
2216 Quartal von 2013 wären dies der <literal>01.01.2013</literal> und <literal>31.03.2013</literal>).
2223 <sect2 id="features.periodic-invoices.reports">
2224 <title>Auflisten</title>
2226 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
2227 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
2228 Rechnungen inaktiv", mit denen man sich einen Überglick über die
2229 wiederkehrenden Rechnungen verschaffen kann.</para>
2232 <sect2 id="features.periodic-invoices.task-server">
2233 <title>Erzeugung der eigentlichen Rechnungen</title>
2235 <para>Die zeitliche und periodische Überprüfung, ob eine
2236 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
2237 durch den <link linkend="config.task-server">Taskserver</link>, einen
2238 externen Dienst, der automatisch beim Start des Servers gestartet
2239 werden sollte.</para>
2242 <sect2 id="features.periodic-invoices.create-for-current-month">
2243 <title>Erste Rechnung für aktuellen Monat erstellen</title>
2245 <para>Will man im laufenden Monat eine monatlich wiederkehrende
2246 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
2247 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
2248 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
2249 generiert hat. Alternativ setzt man das Startdatum auf den
2250 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
2251 manuell über den Workflow.</para>
2255 <sect1 id="dokumentenvorlagen-und-variablen">
2256 <title>Dokumentenvorlagen und verfügbare Variablen</title>
2258 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
2259 <title>Einführung</title>
2261 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
2262 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
2263 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
2264 <function><%variablenname%></function> verwendet wird. Für
2265 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
2267 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
2269 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
2270 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
2271 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
2272 alle Vorlagenarten.</para>
2274 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
2275 verfügbar als hier aufgelistet werden. Die meisten davon können
2276 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
2277 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
2278 diese wie folgt erhalten werden:</para>
2282 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
2283 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
2287 <para>In <filename>Form.pm</filename> die Funktion
2288 <function>parse_template</function> suchen und hier die Zeile
2289 <command>print(STDERR Dumper($self));</command> einfügen.</para>
2293 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
2294 ein PDF für eine Rechnung erzeugen.</para>
2298 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
2299 der Variablen <varname>$self</varname> in der Form <varname>'key'
2300 => 'value',</varname>. Alle <varname>key</varname>s sind
2306 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
2307 <title>Variablen ausgeben</title>
2309 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
2310 Tags geschrieben werden, also z.B.
2311 <varname><%variablenname%></varname>.</para>
2313 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
2314 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
2315 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
2316 werden die folgenden Flags unterstützt:</para>
2320 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
2321 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
2322 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
2323 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
2327 <para><option>NOESCAPE</option> unterdrückt das Escapen von
2328 Sonderzeichen für die Vorlagensprache. Wenn also in einer
2329 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
2330 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
2331 ist dieses Flag sinnvoll.</para>
2335 <para>Beispiel:</para>
2337 <programlisting><%quototal NOFORMAT%></programlisting>
2340 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
2341 <title>Verwendung in Druckbefehlen</title>
2343 <para>In der Admininstration können Drucker definiert werden. Auch im
2344 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
2345 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
2346 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
2347 <function>`...`</function> nicht zu unerwünschtem Verhalten
2350 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
2351 für das die Telefonnummer eines Ansprechpartners als Teil der
2352 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
2353 z.B. wie folgt aussehen:</para>
2355 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
2358 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
2359 xreflabel="Anfang und Ende der Tags verändern">
2360 <title>Anfang und Ende der Tags verändern</title>
2362 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
2363 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
2364 Prozentzeichen und dem Größerzeichen endet, beispielsweise
2365 <function><%customer%></function>. Da diese Form aber z.B. in
2366 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
2367 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
2368 Stil umgestellt werden.</para>
2370 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
2371 Format gültigen Kommentarzeichen anfangen, dann
2372 <function>config:</function> enthalten, die entsprechende Option
2373 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
2374 enden. Beispiel für LaTeX:</para>
2376 <programlisting>% config: tag-style=($ $)</programlisting>
2378 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
2379 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
2380 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
2382 <programlisting><!-- config: tag-style=($ $) --></programlisting>
2385 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
2386 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
2388 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
2389 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
2390 "<filename>.ext</filename>" geeignet zu ersetzen:
2391 "<filename>.tex</filename>" für LaTeX-Vorlagen und
2392 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
2396 <term><filename>bin_list.ext</filename></term>
2399 <para>Lagerliste</para>
2404 <term><filename>check.ext</filename></term>
2412 <term><filename>invoice.ext</filename></term>
2415 <para>Rechnung</para>
2420 <term><filename>packing_list.ext</filename></term>
2423 <para>Packliste</para>
2428 <term><filename>pick_list.ext</filename></term>
2431 <para>Sammelliste</para>
2436 <term><filename>purchase_delivery_order.ext</filename></term>
2439 <para>Lieferschein (Einkauf)</para>
2444 <term><filename>purcharse_order.ext</filename></term>
2447 <para>Bestellung an Lieferanten</para>
2452 <term><filename>request_quotation.ext</filename></term>
2455 <para>Anfrage an Lieferanten</para>
2460 <term><filename>sales_delivery_order.ext</filename></term>
2463 <para>Lieferschein (Verkauf)</para>
2468 <term><filename>sales_order.ext</filename></term>
2471 <para>Bestellung</para>
2476 <term><filename>sales_quotation.ext</filename></term>
2479 <para>Angebot an Kunden</para>
2484 <term><filename>zahlungserinnerung.ext</filename></term>
2487 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2492 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2495 <para>Rechnung über Mahngebühren (Dateiname im Programm
2496 konfigurierbar)</para>
2502 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2503 <title>Sprache, Drucker und E-Mail</title>
2505 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2506 eingearbeitet. So wird aus der Vorlage
2507 <filename>sales_order.ext</filename> bei Sprache
2508 <function>de</function> und Druckerkürzel <function>lpr2</function>
2509 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2510 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2511 bekommen dann noch das Kürzel <filename>_email</filename>, der
2512 vollständige Vorlagenname wäre dann
2513 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2514 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2515 werden. Diese wird verwendet, wenn keine der anderen Varianten
2516 gefunden wird.</para>
2518 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2519 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2520 verschickt wird, ist:</para>
2524 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2528 <para><filename>sales_order_de_lpr2.tex</filename></para>
2532 <para><filename>sales_order.tex</filename></para>
2536 <para><filename>default.tex</filename></para>
2540 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2541 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2543 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2546 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2547 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2550 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2551 xreflabel="Metainformationen zur angeforderten Vorlage">
2552 <title>Metainformationen zur angeforderten Vorlage</title>
2554 <para>Diese Variablen liefern Informationen darüber welche Variante
2555 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2556 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2557 Formulare einbinden möchten.</para>
2561 <term><varname>template_meta.formname</varname></term>
2564 <para>Basisname der Vorlage. Identisch mit der <link
2565 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2566 zu den Dateinamen</link> ohne die Erweiterung. Ein
2567 Verkaufsauftrag enthält hier
2568 <constant>sales_order</constant>.</para>
2573 <term><varname>template_meta.language.description</varname></term>
2576 <para>Beschreibung der verwendeten Sprache</para>
2581 <term><varname>template_meta.language.template_code</varname></term>
2584 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2585 Kürzel das im Dateinamen verwendetet wird.</para>
2590 <term><varname>template_meta.language.output_numberformat</varname></term>
2593 <para>Zahlenformat der verwendeten Sprache in der Form
2594 "<constant>1.000,00</constant>". Experimentell! Nur
2595 interessant für Vorlagen die mit unformatierten Werten
2601 <term><varname>template_meta.language.output_dateformat</varname></term>
2604 <para>Datumsformat der verwendeten Sprache in der Form
2605 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2606 interessant für Vorlagen die mit unformatierten Werten
2612 <term><varname>template_meta.format</varname></term>
2615 <para>Das angeforderte Format. Kann im Moment die Werte
2616 <constant>pdf</constant>, <constant>postscript</constant>,
2617 <constant>html</constant>, <constant>opendocument</constant>,
2618 <constant>opendocument_pdf</constant> und
2619 <constant>excel</constant> enthalten.</para>
2624 <term><varname>template_meta.extension</varname></term>
2627 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2628 <constant>format</constant> entschieden.</para>
2633 <term><varname>template_meta.media</varname></term>
2636 <para>Ausgabemedium. Kann zur Zeit die Werte
2637 <constant>screen</constant> für Bildschirm,
2638 <constant>email</constant> für E-Mmail (triggert das
2639 <constant>_email</constant> Kürzel im Dateinamen),
2640 <constant>printer</constant> für Drucker, und
2641 <constant>queue</constant> für Warteschlange enthalten.</para>
2646 <term><varname>template_meta.printer.description</varname></term>
2649 <para>Beschreibung des ausgewählten Druckers</para>
2654 <term><varname>template_meta.printer.template_code</varname></term>
2657 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2658 dem Kürzel das im Dateinamen verwendetet wird.</para>
2663 <term><varname>template_meta.tmpfile</varname></term>
2666 <para>Datei-Prefix für temporäre Dateien.</para>
2672 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2673 <title>Stammdaten von Kunden und Lieferanten</title>
2677 <term><varname>account_number</varname></term>
2680 <para>Kontonummer</para>
2685 <term><varname>bank</varname></term>
2688 <para>Name der Bank</para>
2693 <term><varname>bank_code</varname></term>
2696 <para>Bankleitzahl</para>
2701 <term><varname>bic</varname></term>
2704 <para>Bank-Identifikations-Code (Bank Identifier Code,
2710 <term><varname>business</varname></term>
2713 <para>Kunden-/Lieferantentyp</para>
2718 <term><varname>city</varname></term>
2726 <term><varname>contact</varname></term>
2729 <para>Kontakt</para>
2734 <term><varname>country</varname></term>
2742 <term><varname>c_vendor_id</varname></term>
2745 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
2750 <term><varname>v_customer_id</varname></term>
2753 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
2758 <term><varname>cp_email</varname></term>
2761 <para>Email des Ansprechpartners</para>
2766 <term><varname>cp_givenname</varname></term>
2769 <para>Vorname des Ansprechpartners</para>
2774 <term><varname>cp_greeting</varname></term>
2777 <para>Anrede des Ansprechpartners</para>
2782 <term><varname>cp_name</varname></term>
2785 <para>Name des Ansprechpartners</para>
2790 <term><varname>cp_phone1</varname></term>
2793 <para>Telefonnummer 1 des Ansprechpartners</para>
2798 <term><varname>cp_phone2</varname></term>
2801 <para>Telefonnummer 2 des Ansprechpartners</para>
2806 <term><varname>cp_title</varname></term>
2809 <para>Titel des Ansprechpartners</para>
2814 <term><varname>creditlimit</varname></term>
2817 <para>Kreditlimit</para>
2822 <term><varname>customeremail</varname></term>
2825 <para>Email des Kunden; nur für Kunden</para>
2830 <term><varname>customerfax</varname></term>
2833 <para>Faxnummer des Kunden; nur für Kunden</para>
2838 <term><varname>customernotes</varname></term>
2841 <para>Bemerkungen beim Kunden; nur für Kunden</para>
2846 <term><varname>customernumber</varname></term>
2849 <para>Kundennummer; nur für Kunden</para>
2854 <term><varname>customerphone</varname></term>
2857 <para>Telefonnummer des Kunden; nur für Kunden</para>
2862 <term><varname>discount</varname></term>
2870 <term><varname>email</varname></term>
2873 <para>Emailadresse</para>
2878 <term><varname>fax</varname></term>
2881 <para>Faxnummer</para>
2886 <term><varname>homepage</varname></term>
2889 <para>Homepage</para>
2894 <term><varname>iban</varname></term>
2897 <para>Internationale Kontonummer (International Bank Account
2898 Number, IBAN)</para>
2903 <term><varname>language</varname></term>
2906 <para>Sprache</para>
2911 <term><varname>name</varname></term>
2914 <para>Firmenname</para>
2919 <term><varname>payment_description</varname></term>
2922 <para>Name der Zahlart</para>
2927 <term><varname>payment_terms</varname></term>
2930 <para>Zahlungskonditionen</para>
2935 <term><varname>phone</varname></term>
2938 <para>Telefonnummer</para>
2943 <term><varname>shiptocity</varname></term>
2946 <para>Stadt (Lieferadresse) <link
2947 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2952 <term><varname>shiptocontact</varname></term>
2955 <para>Kontakt (Lieferadresse) <link
2956 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2961 <term><varname>shiptocountry</varname></term>
2964 <para>Land (Lieferadresse) <link
2965 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2970 <term><varname>shiptodepartment1</varname></term>
2973 <para>Abteilung 1 (Lieferadresse) <link
2974 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2979 <term><varname>shiptodepartment2</varname></term>
2982 <para>Abteilung 2 (Lieferadresse) <link
2983 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2988 <term><varname>shiptoemail</varname></term>
2991 <para>Email (Lieferadresse) <link
2992 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2997 <term><varname>shiptofax</varname></term>
3000 <para>Fax (Lieferadresse) <link
3001 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3006 <term><varname>shiptoname</varname></term>
3009 <para>Firmenname (Lieferadresse) <link
3010 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3015 <term><varname>shiptophone</varname></term>
3018 <para>Telefonnummer (Lieferadresse) <link
3019 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3024 <term><varname>shiptostreet</varname></term>
3027 <para>Straße und Hausnummer (Lieferadresse) <link
3028 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3033 <term><varname>shiptozipcode</varname></term>
3036 <para>Postleitzahl (Lieferadresse) <link
3037 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3042 <term><varname>street</varname></term>
3045 <para>Straße und Hausnummer</para>
3050 <term><varname>taxnumber</varname></term>
3053 <para>Steuernummer</para>
3058 <term><varname>ustid</varname></term>
3061 <para>Umsatzsteuer-Identifikationsnummer</para>
3066 <term><varname>vendoremail</varname></term>
3069 <para>Email des Lieferanten; nur für Lieferanten</para>
3074 <term><varname>vendorfax</varname></term>
3077 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
3082 <term><varname>vendornotes</varname></term>
3085 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
3090 <term><varname>vendornumber</varname></term>
3093 <para>Lieferantennummer; nur für Lieferanten</para>
3098 <term><varname>vendorphone</varname></term>
3101 <para>Telefonnummer des Lieferanten; nur für
3107 <term><varname>zipcode</varname></term>
3110 <para>Postleitzahl</para>
3115 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
3116 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
3117 Stammdaten nicht eingetragen, so haben die Variablen
3118 <varname>shipto*</varname> den gleichen Wert wie die die
3119 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
3120 einige <varname>shipto*</varname>-Variablen so nicht in den
3121 Stammdaten wiederfinden sondern schlicht Kopien der
3122 Lieferdatenvariablen sind (z.B.
3123 <varname>shiptocontact</varname>).</para>
3127 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
3128 <title>Informationen über den Bearbeiter</title>
3132 <term><varname>employee_address</varname></term>
3135 <para>Adressfeld</para>
3140 <term><varname>employee_businessnumber</varname></term>
3143 <para>Firmennummer</para>
3148 <term><varname>employee_company</varname></term>
3151 <para>Firmenname</para>
3156 <term><varname>employee_co_ustid</varname></term>
3159 <para>Usatzsteuer-Identifikationsnummer</para>
3164 <term><varname>employee_duns</varname></term>
3167 <para>DUNS-Nummer</para>
3172 <term><varname>employee_email</varname></term>
3180 <term><varname>employee_fax</varname></term>
3188 <term><varname>employee_name</varname></term>
3191 <para>voller Name</para>
3196 <term><varname>employee_signature</varname></term>
3199 <para>Signatur</para>
3204 <term><varname>employee_taxnumber</varname></term>
3207 <para>Steuernummer</para>
3212 <term><varname>employee_tel</varname></term>
3215 <para>Telefonnummer</para>
3221 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
3222 <title>Informationen über den Bearbeiter</title>
3226 <term><varname>salesman_address</varname></term>
3229 <para>Adressfeld</para>
3234 <term><varname>salesman_businessnumber</varname></term>
3237 <para>Firmennummer</para>
3242 <term><varname>salesman_company</varname></term>
3245 <para>Firmenname</para>
3250 <term><varname>salesman_co_ustid</varname></term>
3253 <para>Usatzsteuer-Identifikationsnummer</para>
3258 <term><varname>salesman_duns</varname></term>
3261 <para>DUNS-Nummer</para>
3266 <term><varname>salesman_email</varname></term>
3274 <term><varname>salesman_fax</varname></term>
3282 <term><varname>salesman_name</varname></term>
3285 <para>voller Name</para>
3290 <term><varname>salesman_signature</varname></term>
3293 <para>Signatur</para>
3298 <term><varname>salesman_taxnumber</varname></term>
3301 <para>Steuernummer</para>
3306 <term><varname>salesman_tel</varname></term>
3309 <para>Telefonnummer</para>
3315 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
3316 <title>Variablen für die einzelnen Steuern</title>
3320 <term><varname>tax</varname></term>
3328 <term><varname>taxbase</varname></term>
3331 <para>zu versteuernder Betrag</para>
3336 <term><varname>taxdescription</varname></term>
3339 <para>Name der Steuer</para>
3344 <term><varname>taxrate</varname></term>
3347 <para>Steuersatz</para>
3354 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
3355 <title>Variablen in Rechnungen</title>
3357 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
3358 <title>Allgemeine Variablen</title>
3362 <term><varname>creditremaining</varname></term>
3365 <para>Verbleibender Kredit</para>
3370 <term><varname>currency</varname></term>
3373 <para>Währung</para>
3378 <term><varname>cusordnumber</varname></term>
3381 <para>Bestellnummer beim Kunden</para>
3386 <term><varname>deliverydate</varname></term>
3389 <para>Lieferdatum</para>
3394 <term><varname>duedate</varname></term>
3397 <para>Fälligkeitsdatum</para>
3402 <term><varname>globalprojectnumber</varname></term>
3405 <para>Projektnummer des ganzen Beleges</para>
3410 <term><varname>globalprojectdescription</varname></term>
3413 <para>Projekbeschreibung des ganzen Beleges</para>
3418 <term><varname>intnotes</varname></term>
3421 <para>Interne Bemerkungen</para>
3426 <term><varname>invdate</varname></term>
3429 <para>Rechnungsdatum</para>
3434 <term><varname>invnumber</varname></term>
3437 <para>Rechnungsnummer</para>
3442 <term><varname>invtotal</varname></term>
3445 <para>gesamter Rechnungsbetrag</para>
3450 <term><varname>notes</varname></term>
3453 <para>Bemerkungen der Rechnung</para>
3458 <term><varname>orddate</varname></term>
3461 <para>Auftragsdatum</para>
3466 <term><varname>ordnumber</varname></term>
3469 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3470 erstellt wurde</para>
3475 <term><varname>payment_description</varname></term>
3478 <para>Name der Zahlart</para>
3483 <term><varname>payment_terms</varname></term>
3486 <para>Zahlungskonditionen</para>
3491 <term><varname>quodate</varname></term>
3494 <para>Angebotsdatum</para>
3499 <term><varname>quonumber</varname></term>
3502 <para>Angebotsnummer</para>
3507 <term><varname>shippingpoint</varname></term>
3510 <para>Versandort</para>
3515 <term><varname>shipvia</varname></term>
3518 <para>Transportmittel</para>
3523 <term><varname>subtotal</varname></term>
3526 <para>Zwischensumme aller Posten ohne Steuern</para>
3531 <term><varname>total</varname></term>
3534 <para>Restsumme der Rechnung (Summe abzüglich bereits
3535 bezahlter Posten)</para>
3540 <term><varname>transaction_description</varname></term>
3543 <para>Vorgangsbezeichnung</para>
3548 <term><varname>transdate</varname></term>
3551 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3552 erstellt wurde</para>
3558 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3559 <title>Variablen für jeden Posten auf der Rechnung</title>
3563 <term><varname>bin</varname></term>
3566 <para>Stellage</para>
3571 <term><varname>description</varname></term>
3574 <para>Artikelbeschreibung</para>
3579 <term><varname>discount</varname></term>
3582 <para>Rabatt als Betrag</para>
3587 <term><varname>discount_sub</varname></term>
3590 <para>Zwischensumme mit Rabatt</para>
3595 <term><varname>drawing</varname></term>
3598 <para>Zeichnung</para>
3603 <term><varname>ean</varname></term>
3606 <para>EAN-Code</para>
3611 <term><varname>image</varname></term>
3619 <term><varname>linetotal</varname></term>
3622 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3627 <term><varname>longdescription</varname></term>
3630 <para>Langtext</para>
3635 <term><varname>microfiche</varname></term>
3638 <para>Mikrofilm</para>
3643 <term><varname>netprice</varname></term>
3646 <para>Nettopreis</para>
3651 <term><varname>nodiscount_linetotal</varname></term>
3654 <para>Zeilensumme ohne Rabatt</para>
3659 <term><varname>nodiscount_sub</varname></term>
3662 <para>Zwischensumme ohne Rabatt</para>
3667 <term><varname>number</varname></term>
3670 <para>Artikelnummer</para>
3675 <term><varname>ordnumber_oe</varname></term>
3678 <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
3679 aus einem Sammelauftrag erstellt wurde</para>
3684 <term><varname>p_discount</varname></term>
3687 <para>Rabatt in Prozent</para>
3692 <term><varname>partnotes</varname></term>
3695 <para>Die beim Artikel gespeicherten Bemerkungen</para>
3700 <term><varname>partsgroup</varname></term>
3703 <para>Warengruppe</para>
3708 <term><varname>price_factor</varname></term>
3711 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
3717 <term><varname>price_factor_name</varname></term>
3720 <para>Der Name des Preisfaktors, sofern einer eingestellt
3726 <term><varname>projectnumber</varname></term>
3729 <para>Projektnummer</para>
3734 <term><varname>projectdescription</varname></term>
3737 <para>Projektbeschreibung</para>
3742 <term><varname>qty</varname></term>
3750 <term><varname>reqdate</varname></term>
3753 <para>Lieferdatum</para>
3758 <term><varname>runningnumber</varname></term>
3761 <para>Position auf der Rechnung (1, 2, 3...)</para>
3766 <term><varname>sellprice</varname></term>
3769 <para>Verkaufspreis</para>
3774 <term><varname>serialnumber</varname></term>
3777 <para>Seriennummer</para>
3782 <term><varname>tax_rate</varname></term>
3785 <para>Steuersatz</para>
3790 <term><varname>transdate_oe</varname></term>
3793 <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
3794 aus einem Sammelauftrag erstellt wurde</para>
3799 <term><varname>unit</varname></term>
3802 <para>Einheit</para>
3807 <term><varname>weight</varname></term>
3810 <para>Gewicht</para>
3815 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
3816 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
3817 einer <function>foreach</function>-Schleife ausgegeben werden, da
3818 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
3819 können. Die Variablen dafür lauten:</para>
3823 <term><varname>make</varname></term>
3826 <para>Lieferant</para>
3831 <term><varname>model</varname></term>
3834 <para>Lieferantenartikelnummer</para>
3840 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
3841 <title>Variablen für die einzelnen Zahlungseingänge</title>
3845 <term><varname>payment</varname></term>
3853 <term><varname>paymentaccount</varname></term>
3861 <term><varname>paymentdate</varname></term>
3869 <term><varname>paymentmemo</varname></term>
3877 <term><varname>paymentsource</varname></term>
3886 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
3887 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
3889 <para>Die vom Benutzer definierten Variablen für Kunden und
3890 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
3891 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
3892 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
3893 Variablennamen zusammen.</para>
3895 <para>Beispiel: Der Benutzer hat eine Variable namens
3896 <varname>number_of_employees</varname> definiert, die die Anzahl der
3897 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
3898 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
3903 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
3904 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
3906 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
3907 <title>Namen der Vorlagen</title>
3909 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
3910 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
3911 Erstellung einer Rechnung über die Mahngebühren und Zinsen
3912 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
3913 Vorlagenname für diese Mahnstufe mit dem Zusatz
3914 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
3915 für die ausgewählte Sprache und den ausgewählten Drucker
3919 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
3920 <title>Allgemeine Variablen in Mahnungen</title>
3922 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3923 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3924 Kunden stehen als Variablen <varname>name</varname>,
3925 <varname>street</varname>, <varname>zipcode</varname>,
3926 <varname>city</varname>, <varname>country</varname>,
3927 <varname>department_1</varname>, <varname>department_2</varname>,
3928 und <varname>email</varname> zur Verfügung.</para>
3930 <para>Weitere Variablen beinhalten:</para>
3934 <term><varname>dunning_date</varname></term>
3937 <para>Datum der Mahnung</para>
3942 <term><varname>dunning_duedate</varname></term>
3945 <para>Fälligkeitsdatum für diese Mahhnung</para>
3950 <term><varname>dunning_id</varname></term>
3953 <para>Mahnungsnummer</para>
3958 <term><varname>fee</varname></term>
3961 <para>Kummulative Mahngebühren</para>
3966 <term><varname>interest_rate</varname></term>
3969 <para>Zinssatz per anno in Prozent</para>
3974 <term><varname>total_amount</varname></term>
3977 <para>Gesamter noch zu zahlender Betrag als
3978 <function>fee</function> + <function>total_interest</function>
3979 + <function>total_open_amount</function></para>
3984 <term><varname>total_interest</varname></term>
3987 <para>Zinsen per anno über alle Rechnungen</para>
3992 <term><varname>total_open_amount</varname></term>
3995 <para>Summe über alle offene Beträge der Rechnungen</para>
4001 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
4002 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
4006 <term><varname>dn_amount</varname></term>
4009 <para>Rechnungssumme (brutto)</para>
4014 <term><varname>dn_duedate</varname></term>
4017 <para>Originales Fälligkeitsdatum der Rechnung</para>
4022 <term><varname>dn_dunning_date</varname></term>
4025 <para>Datum der Mahnung</para>
4030 <term><varname>dn_dunning_duedate</varname></term>
4033 <para>Fälligkeitsdatum der Mahnung</para>
4038 <term><varname>dn_fee</varname></term>
4041 <para>Kummulative Mahngebühr</para>
4046 <term><varname>dn_interest</varname></term>
4049 <para>Zinsen per anno für diese Rechnung</para>
4054 <term><varname>dn_invnumber</varname></term>
4057 <para>Rechnungsnummer</para>
4062 <term><varname>dn_linetotal</varname></term>
4065 <para>Noch zu zahlender Betrag (ergibt sich aus
4066 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
4067 + <varname>dn_interest</varname>)</para>
4072 <term><varname>dn_netamount</varname></term>
4075 <para>Rechnungssumme (netto)</para>
4080 <term><varname>dn_open_amount</varname></term>
4083 <para>Offener Rechnungsbetrag</para>
4088 <term><varname>dn_ordnumber</varname></term>
4091 <para>Bestellnummer</para>
4096 <term><varname>dn_transdate</varname></term>
4099 <para>Rechnungsdatum</para>
4104 <term><varname>dn_curr</varname></term>
4107 <para>Währung, in der die Rechnung erstellt wurde. (Die
4108 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
4114 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
4115 <title>Variablen in automatisch erzeugten Rechnungen über
4116 Mahngebühren</title>
4118 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4119 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4120 Kunden stehen als Variablen <varname>name</varname>,
4121 <varname>street</varname>, <varname>zipcode</varname>,
4122 <varname>city</varname>, <varname>country</varname>,
4123 <varname>department_1</varname>, <varname>department_2</varname>,
4124 und <varname>email</varname> zur Verfügung.</para>
4126 <para>Weitere Variablen beinhalten:</para>
4130 <term><varname>duedate</varname></term>
4133 <para>Fälligkeitsdatum der Rechnung</para>
4138 <term><varname>dunning_id</varname></term>
4141 <para>Mahnungsnummer</para>
4146 <term><varname>fee</varname></term>
4149 <para>Mahngebühren</para>
4154 <term><varname>interest</varname></term>
4162 <term><varname>invamount</varname></term>
4165 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
4166 <varname>interest</varname>)</para>
4171 <term><varname>invdate</varname></term>
4174 <para>Rechnungsdatum</para>
4179 <term><varname>invnumber</varname></term>
4182 <para>Rechnungsnummer</para>
4189 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
4190 <title>Variablen in anderen Vorlagen</title>
4193 <title>Einführung</title>
4195 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
4196 Rechnung. Allerdings heißen die Variablen, die mit
4197 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
4198 fangen sie mit <varname>quo</varname> für "quotation" an:
4199 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
4200 wiederum fangen sie mit <varname>ord</varname> für "order" an:
4201 <varname>ordnumber</varname> für Bestellnummer etc.</para>
4203 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
4204 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
4205 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
4206 Vorlage keine Bedeutung haben oder noch nicht belegt sein
4209 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
4210 in Rechnungen aufgeführt.</para>
4213 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
4214 <title>Angebote und Preisanfragen</title>
4218 <term><varname>quonumber</varname></term>
4221 <para>Angebots- bzw. Anfragenummer</para>
4226 <term><varname>reqdate</varname></term>
4229 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
4230 Preisanfragen)</para>
4235 <term><varname>transdate</varname></term>
4238 <para>Angebots- bzw. Anfragedatum</para>
4244 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
4245 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
4249 <term><varname>ordnumber</varname></term>
4252 <para>Auftragsnummer</para>
4257 <term><varname>reqdate</varname></term>
4260 <para>Lieferdatum</para>
4265 <term><varname>transdate</varname></term>
4268 <para>Auftragsdatum</para>
4274 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
4275 <title>Lieferscheine (Verkauf und Einkauf)</title>
4279 <term><varname>cusordnumber</varname></term>
4282 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
4283 des Lieferanten (im Einkauf)</para>
4288 <term><varname>donumber</varname></term>
4291 <para>Lieferscheinnummer</para>
4296 <term><varname>transdate</varname></term>
4299 <para>Lieferscheindatum</para>
4304 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
4305 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
4306 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
4307 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
4308 <function>foreach</function>-Schleife ausgegeben werden. Diese
4309 Variablen sind:</para>
4313 <term><varname>si_bin</varname></term>
4316 <para>Lagerplatz</para>
4321 <term><varname>si_chargenumber</varname></term>
4324 <para>Chargennummer</para>
4329 <term><varname>si_bestbefore</varname></term>
4332 <para>Mindesthaltbarkeit</para>
4337 <term><varname>si_number</varname></term>
4340 <para>Artikelnummer</para>
4345 <term><varname>si_qty</varname></term>
4348 <para>Anzahl bzw. Menge</para>
4353 <term><varname>si_runningnumber</varname></term>
4356 <para>Positionsnummer (1, 2, 3 etc)</para>
4361 <term><varname>si_unit</varname></term>
4364 <para>Einheit</para>
4369 <term><varname>si_warehouse</varname></term>
4378 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
4379 <title>Variablen für Sammelrechnung</title>
4383 <term><varname>c0total</varname></term>
4386 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
4392 <term><varname>c30total</varname></term>
4395 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
4396 und < 60 Tage</para>
4401 <term><varname>c60total</varname></term>
4404 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
4405 und < 90 Tage</para>
4410 <term><varname>c90total</varname></term>
4413 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
4419 <term><varname>total</varname></term>
4422 <para>Gesamtbetrag aller Rechnungen</para>
4427 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
4431 <term><varname>invnumber</varname></term>
4434 <para>Rechnungsnummer</para>
4439 <term><varname>invdate</varname></term>
4442 <para>Rechnungsdatum</para>
4447 <term><varname>duedate</varname></term>
4450 <para>Fälligkeitsdatum</para>
4455 <term><varname>amount</varname></term>
4458 <para>Summe der Rechnung</para>
4463 <term><varname>open</varname></term>
4466 <para>Noch offener Betrag der Rechnung</para>
4471 <term><varname>c0</varname></term>
4474 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4480 <term><varname>c30</varname></term>
4483 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4489 <term><varname>c60</varname></term>
4492 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4498 <term><varname>c90</varname></term>
4501 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4509 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4510 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4512 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4513 <title>Einfürhung</title>
4515 <para>Der Parser kennt neben den Variablen einige weitere
4516 Konstrukte, die gesondert behandelt werden. Diese sind wie
4517 Variablennamen in spezieller Weise markiert:
4518 <command><%anweisung%> ... <%end%></command></para>
4520 <para>Anmerkung zum <command><%end%></command>: Der besseren
4521 Verständlichkeit halber kann man nach dem <command>end</command>
4522 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4523 Anweisung (z.B. <command>if</command> oder
4524 <command>foreach</command>) damit abgeschlossen wird.</para>
4526 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4527 <command><%if type == "sales_quotation"%></command>, so könnte
4528 er mit <command><%end%></command> genauso abgeschlossen werden
4529 wie mit <command><%end if%></command> oder auch
4530 <command><%end type == "sales_quotation"%></command>.</para>
4533 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4534 <title>Der if-Block</title>
4536 <programlisting><%if variablenname%>
4538 <%end%></programlisting>
4540 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4541 und dem "end" werden nur ausgegeben, wenn die Variable
4542 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4544 <para>Handelt es sich bei der benannten Variable um ein Array, also um einen Variablennamen, über den man mit
4545 <command><%foreach variablenname%></command> iteriert, so wird mit diesem Konstrukt darauf getestet, ob das Array Elemente
4546 enthält. Somit würde im folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt ihrer Überschrift "Zahlungseingänge"
4547 ausgegeben, wenn tatsächlich welche getätigt wurden:</para>
4549 <programlisting><%if payment%>
4551 <%foreach payment%>
4552 Am <%paymentdate%>: <%payment%> €
4553 <%end foreach%>
4554 <%end if%></programlisting>
4556 <para>Die Bedingung kann auch negiert werden, indem das Wort
4557 <function>not</function> nach dem <filename>if</filename> verwendet
4558 wird. Beispiel:</para>
4560 <programlisting><%if not cp_greeting%>
4562 <%end%></programlisting>
4564 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4565 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4566 einer Variablen mit einer festen Zeichenkette oder einer anderen
4567 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4568 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4569 die rechte Seite des Vergleichsoperators in Anführungszeichen
4570 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4571 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4574 <programlisting><%if var1 == "Wert"%></programlisting>
4576 <para>Testet die Variable <varname>var1</varname> auf
4577 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4578 Mittels <function>!=</function> anstelle von <function>==</function>
4579 würde auf Ungleichheit getestet.</para>
4581 <programlisting><%if var1 == var2%></programlisting>
4583 <para>Testet die Variable <varname>var1</varname> auf
4584 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4585 <function>!=</function> anstelle von <function>==</function> würde
4586 auf Ungleichheit getestet.</para>
4588 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4589 auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
4590 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4591 dieselbe Syntax wie oben nur mit <function>=~</function> und
4592 <function>!~</function> als Vergleichsoperatoren.</para>
4594 <para>Beispiel für einen Test, ob die Variable
4595 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4596 <constant>schwierig</constant> enthält:</para>
4598 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4601 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4602 <title>Der foreach-Block</title>
4604 <programlisting><%foreach variablenname%>
4606 <%end%></programlisting>
4608 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4609 wie das Perl-Array der Variablen <varname>variablenname</varname>
4610 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4611 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4612 benutzt. In jedem Durchlauf werden die <link
4613 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4614 Variablen</link> jeweils auf den Wert für die aktuelle Position
4617 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
4619 <programlisting><%foreach number%>
4620 Position: <%runningnumber%>
4621 Anzahl: <%qty%>
4622 Artikelnummer: <%number%>
4623 Beschreibung: <%description%>
4625 <%end%></programlisting>
4627 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
4628 <function><%foreach%></function>-Block innerhalb einer
4629 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
4630 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
4631 Inhalt zwischen <function><%foreach%></function> und
4632 <function><%end%></function> wiederholt, nicht aber die
4633 komplette Zeile, in der er steht.</para>
4637 <sect2 id="dokumentenvorlagen-und-variablen.markup">
4638 <title>Markup-Code zur Textformatierung innerhalb von
4641 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
4642 anders formatiert haben möchte, so ist dies begrenzt möglich.
4643 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
4644 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
4645 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
4646 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
4647 (HTML oder PDF über LaTeX) umgesetzt.</para>
4649 <para>Die unterstützen Formatierungen sind:</para>
4653 <term><b>Text</b></term>
4656 <para>Text wird in Fettdruck gesetzt.</para>
4661 <term><i>Text</i></term>
4664 <para>Text wird kursiv gesetzt.</para>
4669 <term><u>Text</u></term>
4672 <para>Text wird unterstrichen.</para>
4677 <term><s>Text</s></term>
4680 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
4681 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
4686 <term><bullet></term>
4689 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
4695 <para>Der Befehl <command><bullet></command> funktioniert
4696 momentan auch nur in Latex-Vorlagen.</para>
4700 <sect1 id="excel-templates">
4701 <title>Excel-Vorlagen</title>
4703 <sect2 id="excel-templates.summary">
4704 <title>Zusammenfassung</title>
4706 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
4707 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
4711 <sect2 id="excel-templates.usage">
4712 <title>Bedienung</title>
4714 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
4715 werden. Die Konfigurationsoption heißt <varname>excel_templates =
4716 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
4718 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
4719 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
4720 werden. In den normalen Verkaufsmasken taucht nun
4721 <constant>Excel</constant> als auswählbares Format auf und kann von da
4722 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
4724 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
4725 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
4726 <filename>sales_quotation.xls</filename> gespeichert.</para>
4729 <sect2 id="excel-templates.syntax">
4730 <title>Variablensyntax</title>
4732 <para>Einfache Syntax:
4733 <command><<varname>></command></para>
4735 <para>Dabei sind <constant><<</constant> und
4736 <constant>>></constant> die Delimiter. Da Excel auf festen
4737 Breiten besteht, kann der Tag künstlich verlängert werden, indem
4738 weitere <constant><</constant> oder <constant>></constant>
4739 eingefügt werden. Der Tag muss nicht symmetrisch sein.
4742 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4744 <para>Um die Limitierung der festen Breite zu reduzieren, können
4745 weitere Variablen in einem Block interpoliert werden. Whitespace wird
4746 dazwishen dann erhalten. Beispiel:</para>
4748 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4750 <para>Die Variablen werden interpoliert, und linksbündig mit
4751 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
4752 lang, werden überzählige Zeichen abgeschnitten.</para>
4754 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
4755 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
4757 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4759 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
4760 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
4764 <sect2 id="excel-templates.limitations">
4765 <title>Einschränkungen</title>
4767 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
4768 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
4769 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
4770 Text zu ersetzen.</para>
4772 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
4773 <command><%if%></command> und
4774 <command><%foreach%></command> nicht vorhanden. Der Delimiter
4775 <constant><% %></constant> kommt in den Headerinformationen
4776 evtl. vor. Deshalb wurde auf den sichereren Delimiter
4777 <constant><<</constant> und <constant>>></constant>
4784 <title>Entwicklerdokumentation</title>
4786 <sect1 id="devel.globals" xreflabel="Globale Variablen">
4787 <title>Globale Variablen</title>
4790 <title>Wie sehen globale Variablen in Perl aus?</title>
4792 <para>Globale Variablen liegen in einem speziellen namespace namens
4793 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
4794 globs global und die meisten speziellen Variablen sind...
4797 <para>Daraus ergeben sich folgende Formen:</para>
4801 <term><literal>$main::form</literal></term>
4804 <para>expliziter Namespace "main"</para>
4809 <term><literal>$::form</literal></term>
4812 <para>impliziter Namespace "main"</para>
4817 <term><literal>open FILE, "file.txt"</literal></term>
4820 <para><varname>FILE</varname> ist global</para>
4825 <term><literal>$_</literal></term>
4828 <para>speziell</para>
4833 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
4834 Schlüsselwort wie "<function>global</function>", mit dem man
4835 importieren kann. <function>my</function>, <function>our</function>
4836 und <function>local</function> machen was anderes.</para>
4840 <term><literal>my $form</literal></term>
4843 <para>lexikalische Variable, gültig bis zum Ende des
4849 <term><literal>our $form</literal></term>
4852 <para><varname>$form</varname> referenziert ab hier
4853 <varname>$PACKAGE::form</varname>.</para>
4858 <term><literal>local $form</literal></term>
4861 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
4862 des scopes zurückgesetzt</para>
4869 <title>Warum sind globale Variablen ein Problem?</title>
4871 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
4873 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
4874 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
4875 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
4876 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
4877 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
4878 Datenbankverbindungen, weil die sehr lange zum Initialisieren
4881 <para>Das zweite Problem ist <function>strict</function>. Unter
4882 <function>strict</function> werden alle Variablen die nicht explizit
4883 mit <function>Package</function>, <function>my</function> oder
4884 <function>our</function> angegeben werden als Tippfehler angemarkert,
4885 dies hat, seit der Einführung, u.a. schon so manche langwierige
4886 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
4887 angegeben werden, werden die nicht geprüft, und somit kann sich
4888 schnell ein Tippfehler einschleichen.</para>
4892 <title>Kanonische globale Variablen</title>
4894 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
4895 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
4896 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
4897 umhergereicht werden.</para>
4899 <para>Diese Variablen sind im Moment die folgenden neun:</para>
4903 <para><varname>$::form</varname></para>
4907 <para><varname>%::myconfig</varname></para>
4911 <para><varname>$::locale</varname></para>
4915 <para><varname>$::lxdebug</varname></para>
4919 <para><varname>$::auth</varname></para>
4923 <para><varname>$::lx_office_conf</varname></para>
4927 <para><varname>$::instance_conf</varname></para>
4931 <para><varname>$::dispatcher</varname></para>
4935 <para><varname>$::request</varname></para>
4939 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
4940 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
4941 Eigenschaften (Konventionen):</para>
4944 <title>$::form</title>
4948 <para>Ist ein Objekt der Klasse
4949 "<classname>Form</classname>"</para>
4953 <para>Wird nach jedem Request gelöscht</para>
4957 <para>Muss auch in Tests und Konsolenscripts vorhanden
4962 <para>Enthält am Anfang eines Requests die Requestparameter vom
4967 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
4968 cachen, das wird aber momentan absichtlich zerstört</para>
4972 <para><varname>$::form</varname> wurde unter <productname>SQL
4973 Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
4974 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
4975 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
4976 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
4977 <function>IS->retrieve_customer()</function> in Sicherheit
4980 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
4981 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
4982 3552, Stand version 2.7beta), um dies hinterher wieder auf den
4983 richtigen Wert zu setzen:</para>
4985 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
4986 $::myconfig{numberformat} = $numberformat;
4987 # (...) div Berechnungen
4988 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
4990 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
4991 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
4992 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
4993 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
4994 Es geht ziemlich sicher etwas kaputt.</para>
4996 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
4997 in den <productname>Template::Toolkit</productname> Templates
4998 außerhalb der Controller: der Ausdruck <function>[% var
4999 %]</function> greift auf <varname>$::form->{var}</varname> zu.
5000 Unter Controllern ist der Standard Scope anders, da lautet der
5001 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
5002 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
5003 <function><%var%></function> zeigt auf
5004 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
5005 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
5008 <programlisting>[%- IF business %]
5009 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
5010 [%- END %]</programlisting>
5012 <para>Entweder wird hier dann $::form->{business} ausgewertet
5013 oder aber der Funktion
5014 <function>$form->parse_html_template</function> wird explizit
5015 noch ein zusätzlicher Hash übergeben, der dann auch in den
5016 (Web-)Templates zu Verfügung steht, bspw. so:</para>
5018 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
5020 <para>Innerhalb von Schleifen wird
5021 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
5022 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
5023 welches über alle Positionen eines Lieferscheins in Schleife
5026 <programlisting>for $i (1 .. $form->{rowcount}) {
5028 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
5029 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
5030 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
5036 <title>%::myconfig</title>
5040 <para>Das einzige Hash unter den globalen Variablen</para>
5044 <para>Wird spätestens benötigt wenn auf die Datenbank
5045 zugegriffen wird</para>
5049 <para>Wird bei jedem Request neu erstellt.</para>
5053 <para>Enthält die Userdaten des aktuellen Logins</para>
5057 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
5058 extern serialisiert werden, weil da auch der Datenbankzugriff
5059 für diesen user drinsteht.</para>
5063 <para>Enthält unter anderem Listenbegrenzung vclimit,
5064 Datumsformat dateformat und Nummernformat numberformat</para>
5068 <para>Enthält Datenbankzugriffinformationen</para>
5072 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
5073 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
5074 aktuellen Users entscheiden müssen, befragen
5075 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
5076 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
5077 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
5078 Informationen über den Benutzer die über die
5079 Administrator-Schnittstelle eingegeben wurden.</para>
5083 <title>$::locale</title>
5087 <para>Objekt der Klasse "Locale"</para>
5091 <para>Wird pro Request erstellt</para>
5095 <para>Muss auch für Tests und Scripte immer verfügbar
5100 <para>Cached intern über Requestgrenzen hinweg benutzte
5105 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
5106 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
5110 <title>$::lxdebug</title>
5114 <para>Objekt der Klasse "LXDebug"</para>
5118 <para>Wird global gecached</para>
5122 <para>Muss immer verfügbar sein, in nahezu allen
5127 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
5128 bereit, wie "<function>enter_sub</function>" und
5129 "<function>leave_sub</function>", mit denen in den alten Modulen ein
5130 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
5131 der man die Wallclockzeit seit Requeststart loggen kann, sowie
5132 "<function>message</function>" und "<function>dump</function>" mit
5133 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
5136 <para>Beispielsweise so:</para>
5138 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
5139 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
5143 <title>$::auth</title>
5147 <para>Objekt der Klasse "SL::Auth"</para>
5151 <para>Wird global gecached</para>
5155 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
5159 <para>Wird nach jedem Request resettet.</para>
5163 <para><varname>$::auth</varname> stellt Funktionen bereit um die
5164 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
5165 vom aktuellen User abhängen wird das Objekt aus
5166 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
5167 Request kurz resettet.</para>
5169 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten. Dessen Einstellungen können über
5170 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert ist ein Hash mit den Werten aus der Tabelle
5171 <literal>auth.clients</literal>.</para>
5175 <title>$::lx_office_conf</title>
5179 <para>Objekt der Klasse
5180 "<classname>SL::LxOfficeConf</classname>"</para>
5184 <para>Global gecached</para>
5188 <para>Repräsentation der
5189 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
5193 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
5194 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
5195 das Programm die Konfiguration ändern kann oder sollte.</para>
5197 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
5198 Debug- und Trace-Log-Datei wie folgt konfiguriert und
5201 <programlisting>[debug]
5202 file = /tmp/kivitendo-debug.log</programlisting>
5204 <para>ist der Key <varname>file</varname> im Programm als
5205 <varname>$::lx_office_conf->{debug}{file}</varname>
5209 <para>Zugriff auf die Konfiguration erfolgt im Moment über
5210 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
5215 <title>$::instance_conf</title>
5219 <para>Objekt der Klasse
5220 "<classname>SL::InstanceConfiguration</classname>"</para>
5224 <para>wird pro Request neu erstellt</para>
5228 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
5229 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
5230 ist hier eine Mandantendatenbank. Beispielsweise überprüft
5231 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
5232 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
5236 <title>$::dispatcher</title>
5240 <para>Objekt der Klasse
5241 "<varname>SL::Dispatcher</varname>"</para>
5245 <para>wird pro Serverprozess erstellt.</para>
5249 <para>enthält Informationen über die technische Verbindung zum
5254 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
5255 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
5256 Objekt untergebracht.</para>
5260 <title>$::request</title>
5264 <para>Hashref (evtl später Objekt)</para>
5268 <para>Wird pro Request neu initialisiert.</para>
5272 <para>Keine Unterstruktur garantiert.</para>
5276 <para><varname>$::request</varname> ist ein generischer Platz um
5277 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
5278 at a distance benutzt werden, sondern um lokales memoizing zu
5279 ermöglichen, das garantiert am Ende des Requests zerstört
5282 <para>Vieles von dem, was im moment in <varname>$::form</varname>
5283 liegt, sollte eigentlich hier liegen. Die groben
5284 Differentialkriterien sind:</para>
5288 <para>Kommt es vom User, und soll unverändert wieder an den
5289 User? Dann <varname>$::form</varname>, steht da eh schon</para>
5293 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
5294 Requests gebraucht werden? Dann
5295 <varname>$::request</varname></para>
5299 <para>Muss ich von anderen Teilen des Programms lesend drauf
5300 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
5301 Wrappermethode</para>
5308 <title>Ehemalige globale Variablen</title>
5310 <para>Die folgenden Variablen waren einmal im Programm, und wurden
5314 <title>$::cgi</title>
5318 <para>war nötig, weil cookie Methoden nicht als
5319 Klassenfunktionen funktionieren</para>
5323 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
5324 Klassennamespace gehalten wird und über Requestgrenzen
5329 <para>liegt jetzt unter
5330 <varname>$::request->{cgi}</varname></para>
5336 <title>$::all_units</title>
5340 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
5341 ein paar hundert mal pro Request eine Liste der Einheiten
5342 brauchen, und de als Parameter durch einen Riesenstack von
5343 Funktionen geschleift werden müssten.</para>
5347 <para>Liegt jetzt unter
5348 <varname>$::request->{cache}{all_units}</varname></para>
5353 <function>AM->retrieve_all_units()</function> gesetzt oder
5360 <title>%::called_subs</title>
5364 <para>wurde benutzt um callsub deep recursions
5369 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
5370 möglichen Rekursioenen darstellt, und da nie welche
5375 <para>komplette recursion protection wurde entfernt.</para>
5382 <sect1 id="devel.fcgi">
5383 <title>Entwicklung unter FastCGI</title>
5385 <sect2 id="devel.fcgi.general">
5386 <title>Allgemeines</title>
5388 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
5389 werden, muss der Webserver neu gestartet werden.</para>
5391 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
5392 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
5393 müssen folgende Aspekte beachtet werden.</para>
5396 <sect2 id="devel.fcgi.exiting">
5397 <title>Programmende und Ausnahmen</title>
5399 <para>Betrifft die Funktionen <function>warn</function>,
5400 <function>die</function>, <function>exit</function>,
5401 <function>carp</function> und <function>confess</function>.</para>
5403 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
5404 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
5405 am Laufen zu halten. Man kann mit <function>die</function>,
5406 <function>confess</function> oder <function>carp</function> Fehler
5407 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
5408 eigene <function>$::form-</function>error()> tut im Prinzip das
5409 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
5410 <function>exit</function> hingegen werden nicht abgefangen.
5411 <function>warn</function> wird direkt nach STDERR, also in Server Log
5412 eine Nachricht schreiben (sofern in der Konfiguration nicht die
5413 Warnungen in das kivitendo Log umgeleitet wurden), und
5414 <function>exit</function> wird die Ausführung beenden.</para>
5416 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
5417 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
5418 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
5419 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
5422 <sect2 id="devel.fcgi.globals">
5423 <title>Globale Variablen</title>
5425 <para>Um zu vermeiden, dass Informationen von einem Request in einen
5426 anderen gelangen, müssen alle globalen Variablen vor einem Request
5427 sauber initialisiert werden. Das ist besonders wichtig im
5428 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
5429 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
5432 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
5433 abgetrennten Block, der alle kanonischen globalen Variablen listet und
5434 erklärt. Bitte keine anderen einführen ohne das sauber zu
5435 dokumentieren.</para>
5437 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
5438 man sicher geht, dass man die richtige erwischt.</para>
5441 <sect2 id="devel.fcgi.performance">
5442 <title>Performance und Statistiken</title>
5444 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
5445 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
5446 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
5447 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
5448 sind es je nach Menge der definierten Variablen 1-2s. Ab der
5449 Moose/Rose::DB Version sind es 5-6s.</para>
5451 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
5452 den kritischen Pfaden, unter 0,15 sonst.</para>
5456 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
5457 <title>SQL-Upgradedateien</title>
5459 <sect2 id="db-upgrade-files.introduction"
5460 xreflabel="Einführung in die Datenbank-Upgradedateien">
5461 <title>Einführung</title>
5463 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte gesteuert, die sich im Verzeichnis <filename>sql/Pg-upgrade2</filename>
5464 befinden. In diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren, die neben den eigentlich auszuführenden SQL- oder
5465 Perl-Befehlen einige Kontrollinformationen enthält.</para>
5467 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten, sodass Datenbankscripte zwar in einer sicheren Reihenfolge
5468 ausgeführt werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt werden, wenn die Tabelle mit <literal>CREATE
5469 TABLE</literal> angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man keine Versionsnummern braucht.</para>
5471 <para>kivitendo merkt sich dabei, welches der Upgradescripte in <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
5472 führt diese nicht erneut aus. Dazu dient die Tabelle "<literal>schema_info</literal>", die bei der Anmeldung automatisch angelegt
5476 <sect2 id="db-upgrade-files.format"
5477 xreflabel="Format der Upgradedateien">
5478 <title>Format der Kontrollinformationen</title>
5480 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5481 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5482 hat dabei das folgende Format:</para>
5484 <para>Für SQL-Upgradedateien:</para>
5486 <programlisting>-- @key: value</programlisting>
5488 <para>Für Perl-Upgradedateien:</para>
5490 <programlisting># @key: value</programlisting>
5492 <para>Leerzeichen vor "<varname>value</varname>" werden
5495 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5499 <term><varname>tag</varname></term>
5502 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5503 Dieser "tag" kann von anderen Kontrolldateien in ihren
5504 Abhängigkeiten verwendet werden (Schlüsselwort
5505 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5506 in der Datenbank eingetragen wird.</para>
5508 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5509 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5511 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5512 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5513 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5519 <term><varname>charset</varname></term>
5522 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5523 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
5524 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte hingegen müssen immer in UTF-8 encodiert sein und sollten
5525 demnach auch ein "<literal>use utf8;</literal>" enthalten.</para>
5530 <term><varname>description</varname></term>
5533 <para>Benötigt. Eine Beschreibung, was in diesem Update
5534 passiert. Diese wird dem Benutzer beim eigentlichen
5535 Datenbankupdate angezeigt. Während der Tag in englisch gehalten
5536 sein sollte, sollte die Beschreibung auf Deutsch
5542 <term><varname>depends</varname></term>
5545 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5546 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
5547 dass die in dieser Liste aufgeführten Scripte bereits
5548 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5550 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5551 Script "b" existiert, das von Änderungen in "a" abhängt, und
5552 eine neue Kontrolldatei für "c" erstellt wird, die von
5553 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5554 Tag "b" als Abhängigkeit zu definieren.</para>
5556 <para>Es ist nicht erlaubt, sich selbst referenzierende
5557 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5558 und "c" -> "a").</para>
5563 <term><varname>priority</varname></term>
5566 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5567 der Scripte ausgeführt werden, die die gleichen
5568 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5569 der Wert 1000 benutzt.</para>
5571 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5572 "depends" benutzt werden. kivitendo sortiert die auszuführenden
5573 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5574 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5575 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5576 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5577 Priorität alphabetisch nach dem "tag".</para>
5582 <term><varname>ignore</varname></term>
5585 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
5586 Skript bei der Anmeldung ignoriert und entsprechend nicht
5593 <sect2 id="db-upgrade-files.format-perl-files" xreflabel="Format von Perl-Upgradedateien">
5594 <title>Format von in Perl geschriebenen Datenbankupgradescripten</title>
5596 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so ausgeführt sondern müssen sich an gewisse Konventionen
5597 halten. Dafür bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
5599 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse dar, die vom Elternobjekt
5600 "<literal>SL::DBUpgrade2::Base</literal>" erben und eine Funktion namens "<literal>run</literal>" zur Verfügung stellen muss. Das
5601 Script wird ausgeführt, indem eine Instanz dieser Klasse erzeugt und darauf die erwähnte "<literal>run</literal>" aufgerufen
5604 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert für "<literal>@tag</literal>" ableitet. Dabei werden alle
5605 Zeichen, die in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche ersetzt. Insgesamt sieht der Paketname wie folgt
5606 aus: "<literal>SL::DBUpgrade2::tag</literal>".</para>
5608 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
5609 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
5611 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie folgt aus:</para>
5613 <programlisting># @tag: beispiel-upgrade-file42
5614 # @description: Ein schönes Beispielscript
5615 # @depends: release_3_0_0
5616 package SL::DBUpgrade2::beispiel_upgrade_file42;
5621 use parent qw(SL::DBUpgrade2::Base);
5626 # hier Aktionen ausführen
5635 <sect2 id="db-upgrade-files.dbupgrade-tool"
5636 xreflabel="Hilfsscript dbupgrade2_tool.pl">
5637 <title>Hilfsscript dbupgrade2_tool.pl</title>
5639 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
5640 existiert ein Hilfsscript namens
5641 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
5642 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
5643 liest alle Datenbankupgradescripte aus dem Verzeichnis
5644 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
5645 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
5646 von der Kommandozeile überprüft werden können.</para>
5648 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
5649 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
5650 sich aber auch Informationen auf verschiedene Art ausgeben
5655 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
5656 --list</command>"</para>
5658 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
5659 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
5660 würde. Es werden neben der Listenposition der Tag, die
5661 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
5665 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
5666 --tree</command>"</para>
5668 <para>Listet alle Tags in Baumform basierend auf den
5669 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
5670 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
5671 beim übergeordneten Script als Abhängigkeit eingetragen
5675 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
5676 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
5677 --rtree</command>"</para>
5679 <para>Listet alle Tags in Baumform basierend auf den
5680 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
5681 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
5682 die das übergeordnete Script als Abhängigkeit eingetragen
5687 <para>Baumform mit Postscriptausgabe:
5688 "<command>./scripts/dbupgrade2_tool.pl
5689 --graphviz</command>"</para>
5691 <para>Benötigt das Tool "<command>graphviz</command>", um mit
5692 seiner Hilfe die <link
5693 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
5694 Baumform</link> in eine Postscriptdatei namens
5695 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
5696 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
5697 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
5698 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
5703 <para>Scripte, von denen kein anderes Script abhängt:
5704 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
5706 <para>Listet die Tags aller Scripte auf, von denen keine anderen
5707 Scripte abhängen.</para>
5713 <sect1 id="translations-languages" xreflabel="Translations and languages">
5714 <title>Translations and languages</title>
5716 <sect2 id="translations-languages.introduction"
5717 xreflabel="Introduction to translations and languages">
5718 <title>Introduction</title>
5721 <para>Dieser Abschnitt ist in Englisch geschrieben, um
5722 internationalen Übersetzern die Arbeit zu erleichtern.</para>
5725 <para>This section describes how localization packages in kivitendo
5726 are built. Currently the only language fully supported is German, and
5727 since most of the internal messages are held in English the English
5728 version is usable too.</para>
5730 <para>A stub version of French is included but not functunal at this
5734 <sect2 id="translations-languages.character-set"
5735 xreflabel="Character set">
5736 <title>Character set</title>
5738 <para>All files included in a language pack must use UTF-8 as their encoding.</para>
5741 <sect2 id="translations-languages.file-structure"
5742 xreflabel="File structure">
5743 <title>File structure</title>
5745 <para>The structure of locales in kivitendo is:</para>
5747 <programlisting>kivitendo/locale/<langcode>/</programlisting>
5749 <para>where <langcode> stands for an abbreviation of the
5750 language package. The builtin packages use two letter <ulink
5751 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
5752 but the actual name is not relevant for the program and can easily be
5754 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
5755 tags</ulink> (i.e. "en_GB"). In fact the original language packages
5756 from SQL Ledger are named in this way.</para>
5758 <para>In such a language directory the following files are
5763 <term>LANGUAGE</term>
5766 <para>This file is mandatory.</para>
5768 <para>The <filename>LANGUAGE</filename> file contains the self
5769 descripted name of the language. It should contain a native
5770 representation first, and in parenthesis an english translation
5771 after that. Example:</para>
5773 <programlisting>Deutsch (German)</programlisting>
5781 <para>This file is mandatory.</para>
5783 <para>The central translation file. It is essentially an inline
5784 Perl script autogenerated by <command>locales.pl</command>. To
5785 generate it, generate the directory and the two files mentioned
5786 above, and execute the following command:</para>
5788 <programlisting>scripts/locales.pl <langcode></programlisting>
5790 <para>Otherwise you can simply copy one of the other languages.
5791 You will be told how many are missing like this:</para>
5793 <programlisting>$ scripts/locales.pl en
5794 English - 0.6% - 2015/2028 missing</programlisting>
5796 <para>A file named "<filename>missing</filename>" will be
5797 generated and can be edited. You can also edit the
5798 "<filename>all</filename>" file directly. Edit everything you
5799 like to fit the target language and execute
5800 <command>locales.pl</command> again. See how the missing words
5806 <term>Num2text</term>
5809 <para>Legacy code from SQL Ledger. It provides a means for
5810 numbers to be converted into natural language, like
5811 <literal>1523 => one thousand five hundred twenty
5812 three</literal>. If you want to provide it, it must be inlinable
5813 Perl code which provides a <function>num2text</function> sub. If
5814 an <function>init</function> sub exists it will be executed
5817 <para>Only used in the check and receipt printing module.</para>
5822 <term>special_chars</term>
5825 <para>kivitendo comes with a lot of interfaces to different
5826 formats, some of which are rather picky with their accepted
5827 charset. The <filename>special_chars</filename> file contains a
5828 listing of chars not suited for different file format and
5829 provides substitutions. It is written in "Simple Ini" style,
5830 containing a block for every file format.</para>
5832 <para>First entry should be the order of substitution for
5833 entries as a whitespace separated list. All entries are
5834 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
5835 and <literal>\\</literal> all work.</para>
5837 <para>After that every entry is a special char that should be
5838 translated when writing text into such a file.</para>
5840 <para>Example:</para>
5842 <programlisting>[Template/XML]
5843 order=& < > \n
5847 \n=<br></programlisting>
5849 <para>Note the importance of the order in this example.
5850 Substituting < and > befor & would lead to $gt; become
5853 <para>For a list of valid formats, see the German
5854 <filename>special_chars</filename> entry. As of this writing the
5855 following are recognized:</para>
5857 <programlisting>HTML
5862 Template/OpenDocument
5863 filenames</programlisting>
5865 <para>The last of which is very machine dependant. Remember that
5866 a lot of characters are forbidden by some filesystems, for
5867 exmaple MS Windows doesn't like ':' in its files where Linux
5868 doesn't mind that. If you want the files created with your
5869 language pack to be portable, find all chars that could cause
5875 <term>missing</term>
5878 <para>This file is not a part of the language package
5881 <para>This is a file generated by
5882 <command>scripts/locales.pl</command> while processing your
5883 locales. It's only to have the missing entries singled out and
5884 does not belong to a language package.</para>
5892 <para>This file is not a part of the language package
5895 <para>Another file generated by
5896 <command>scripts/locales.pl</command>. If for any reason a
5897 translation does not appear anymore and can be deleted, it gets
5898 moved here. The last 50 or so entries deleted are saved here in
5899 case you made a typo, so that you don't have to translate
5900 everything again. If a tranlsation is missing, the lost file is
5901 checked first. If you maintain a language package, you might
5902 want to keep this safe somewhere.</para>
5909 <sect1 id="devel.testsuite">
5910 <title>Die kivitendo-Test-Suite</title>
5912 <sect2 id="devel.testsuite.intro">
5913 <title>Einführung</title>
5915 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul <literal>Test::More</literal>.</para>
5917 <para>Die grundlegenden Fakten sind:</para>
5920 <listitem><para>Alle Tests liegen im Unterverzeichnis <filename>t/</filename>.</para></listitem>
5922 <listitem><para>Ein Script (bzw. ein Test) in <filename>t/</filename> enthält einen oder mehrere Testfälle.</para></listitem>
5924 <listitem><para>Alle Dateinamen von Tests enden auf <literal>.t</literal>. Es sind selbstständig ausführbare Perl-Scripte.</para></listitem>
5926 <listitem><para>Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in <filename>t/</filename>, deren
5927 Dateiname auf <literal>.t</literal> endet.</para></listitem>
5931 <sect2 id="devel.testsuite.prerequisites">
5932 <title>Voraussetzungen</title>
5934 <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>
5937 <listitem><para><literal>Test::Deep</literal> (Debian-Paketname: <literal>libtest-deep-perl</literal>; Fedora Core:
5938 <literal>perl-Test-Deep</literal>; openSUSE: <literal>perl-Test-Deep</literal>)</para></listitem>
5939 <listitem><para><literal>Test::Exception</literal> (Debian-Paketname: <literal>libtest-exception-perl</literal>; Fedora Core:
5940 <literal>perl-Test-Exception</literal>; openSUSE: <literal>perl-Test-Exception</literal>)</para></listitem>
5941 <listitem><para><literal>Test::Output</literal> (Debian-Paketname: <literal>libtest-output-perl</literal>; Fedora Core:
5942 <literal>perl-Test-Output</literal>; openSUSE: <literal>perl-Test-Output</literal>)</para></listitem>
5943 <listitem><para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses Modul ist ab Perl 5.10.1 Bestandteil der
5944 Perl-Distribution und kann für frühere Versionen aus dem <ulink url="http://www.cpan.org">CPAN</ulink> bezogen
5945 werden.</para></listitem>
5946 <listitem><para><literal>LWP::Simple</literal> aus dem Paket <literal>libwww-perl</literal> (Debian-Panetname:
5947 <literal>libwww-perl</literal>; Fedora Core: <literal>perl-libwww-perl</literal>; openSUSE:
5948 <literal>perl-libwww-perl</literal>)</para></listitem>
5949 <listitem><para><literal>URI::Find</literal> (Debian-Panetname: <literal>liburi-find-perl</literal>; Fedora Core:
5950 <literal>perl-URI-Find</literal>; openSUSE: <literal>perl-URI-Find</literal>)</para></listitem>
5953 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
5954 müssen in der Konfigurationsdatei im Abschnit <literal>testing/database</literal> Datenbankverbindungsparameter angegeben
5955 werden. Der hier angegebene Benutzer muss weiterhin das Recht haben, Datenbanken anzulegen und zu löschen.</para>
5958 <sect2 id="devel.testsuite.execution">
5960 Existierende Tests ausführen
5963 <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
5964 gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript <filename>t/test.pl</filename>.</para>
5966 <para>Will man die komplette Test-Suite ausführen, so muss man einfach nur <filename>t/test.pl</filename> ohne weitere Parameter aus
5967 dem kivitendo-Basisverzeichnis heraus ausführen.</para>
5969 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an <filename>t/test.pl</filename>. Beispielsweise:</para>
5971 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
5975 <sect2 id="devel.testsuite.meaning_of_scripts">
5977 Bedeutung der verschiedenen Test-Scripte
5980 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch
5981 während der Entwicklung nützliche Tests sind:</para>
5984 <listitem><para><filename>t/001compile.t</filename> -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab</para></listitem>
5985 <listitem><para><filename>t/002goodperl.t</filename> -- überprüft alle Perl-Dateien auf Anwesenheit von '<literal>use strict</literal>'-Anweisungen</para></listitem>
5986 <listitem><para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von <function>system()</function> und <function>exec()</function> auf Gültigkeit</para></listitem>
5987 <listitem><para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien Tab-Zeichen enthalten</para></listitem>
5988 <listitem><para><filename>t/006spelling.t</filename> -- sucht nach häufigen Rechtschreibfehlern</para></listitem>
5989 <listitem><para><filename>t/011pod.t</filename> -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit</para></listitem>
5992 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module.</para>
5995 <sect2 id="devel.testsuite.create_new">
5997 Neue Test-Scripte erstellen
6000 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende
6001 Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden.</para>
6003 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
6005 Ideen für neue Test-Scripte, die keine konkreten Funktionen testen
6008 <para> Ideen, die abgesehen von Funktionen noch nicht umgesetzt wurden:</para>
6011 <listitem><para>Überprüfung auf fehlende symbolische Links</para></listitem>
6012 <listitem><para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten)</para></listitem>
6013 <listitem><para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para></listitem>
6014 <listitem><para>Überprüfung auf Leerzeichen am Ende von Zeilen</para></listitem>
6015 <listitem><para>Test, ob alle zu übersetzenden Strings in <filename>locale/de/all</filename> vorhanden sind</para></listitem>
6016 <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>
6020 <sect3 id="devel.testsuite.directory_and_test_names">
6022 Konvention für Verzeichnis- und Dateinamen
6025 <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>
6028 <listitem><para>Die Dateiendung muss <filename>.t</filename> lauten.</para></listitem>
6030 <listitem><para>Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise
6031 <filename>bad_function_params.t</filename>).</para></listitem>
6033 <listitem><para>Unterverzeichnisse sollten grob nach dem Themenbereich benannt sein, mit dem sich die Scripte darin befassen
6034 (beispielsweise <filename>background_jobs</filename> für Tests rund um Hintergrund-Jobs).</para></listitem>
6036 <listitem><para>Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist
6037 (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben.</para></listitem>
6041 <sect3 id="devel.testsuite.minimal_example">
6043 Minimales Skelett für eigene Scripte
6046 <para>Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden:</para>
6048 <programlisting>use Test::More tests => 0;
6052 use Support::TestSetup;
6054 Support::TestSetup::login();</programlisting>
6056 <para>Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie
6057 <varname>$::auth</varname>, <varname>$::form</varname> oder <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
6058 <filename>config/kivitendo.conf</filename> im Abschnitt <literal>testing.login</literal> ein gültiger Login-Name eingetragen
6059 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
6061 <para>Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile <code>Support::TestSetup::login();</code>
6062 weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.</para>
6067 <sect1 id="devel.style-guide">
6068 <title>Stil-Richtlinien</title>
6070 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
6071 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
6072 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
6073 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
6075 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
6078 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
6079 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
6084 <para>Es werden keine echten Tabs sondern Leerzeichen
6089 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
6091 <programlisting>foreach my $row (@data) {
6093 # do something with $row
6097 $row->{modules} = MODULE->retrieve(
6098 id => $row->{id},
6099 date => $use_now ? localtime() : $row->{time},
6103 $report->add($row);
6108 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
6109 Zeile wie der letzte Befehl. Beispiele:</para>
6111 <programlisting>sub debug {
6117 <programlisting>if ($form->{item_rows} > 0) {
6123 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
6124 der Befehl / die öffnende schließende Klammer, die den Block
6125 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
6126 Beispiele wie bei 3. gelten.</para>
6130 <para>Die Wörter "<function>else</function>",
6131 "<function>elsif</function>", "<function>while</function>" befinden
6132 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
6135 <programlisting>if ($form->{sum} > 1000) {
6137 } elsif ($form->{sum} > 0) {
6145 } until ($a > 0);</programlisting>
6149 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
6150 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
6151 und grep-ähnliche Operatoren. Beispiel:</para>
6153 <programlisting>$main::lxdebug->message("Could not find file.");
6154 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
6158 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
6160 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
6161 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
6162 Blöcke schon. Beispiel:</para>
6164 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
6169 $form->{sum} += $form->{"row_$i"};
6170 $form->{ $form->{index} } += 1;
6172 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
6176 <para>Mehrzeilige Befehle</para>
6180 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
6181 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
6182 werden, in der die ersten Funktionsparameter in der ersten Zeile
6183 stehen. Beispiel:</para>
6185 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
6186 $form->{some_col_value});</programlisting>
6190 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
6191 besten in einer übersichtlichen Tabellenstruktur organisiert
6192 wird. Beispiel:</para>
6194 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
6195 : $form->{oldcount} ? $form->{oldcount} + 1
6196 : $form->{rowcount} - $form->{rowbase};</programlisting>
6202 <para>Kommentare</para>
6206 <para>Kommentare, die alleine in einer Zeile stehen, sollten
6207 soweit wie der Code eingerückt sein.</para>
6211 <para>Seitliche hängende Kommentare sollten einheitlich
6212 formatiert werden.</para>
6216 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
6217 auf Englisch zu verfassen. So wie ich keine Lust habe,
6218 französischen Quelltext zu lesen, sollte auch der kivitendo
6219 Quelltext für nicht-Deutschsprachige lesbar sein.
6222 <programlisting>my $found = 0;
6230 $i = 0 # initialize $i
6232 $i *= $const; # do something crazy
6233 $i = $n; # recover $i</programlisting>
6239 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
6240 Interpolation gewünscht ist. Beispiel:</para>
6242 <programlisting>$form->{sum} = 0;
6243 $form->{"row_$i"} = $form->{"row_$i"} - 5;
6244 $some_hash{42} = 54;</programlisting>
6248 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
6249 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
6250 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
6251 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
6253 <para>Als Beispiel sei die Funktion
6254 <function>print_options</function> aus
6255 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
6259 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
6260 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
6263 <para>Emacs und vim haben beide recht einfache Methoden zur
6264 Entfernung von trailing whitespace. Emacs kennt das Kommande
6265 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
6266 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
6267 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
6272 <para>Es wird kein <command>perltidy</command> verwendet.</para>
6274 <para>In der Vergangenheit wurde versucht,
6275 <command>perltidy</command> zu verwenden, um einen einheitlichen
6276 Stil zu erlangen. Es hat sich aber gezeigt, dass
6277 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
6278 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
6279 den Interessierten sind hier die
6280 <command>perltidy</command>-Optionen, die grob den beschriebenen
6281 Richtlinien entsprechen:</para>
6283 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
6284 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
6285 -lp -vt=1 -vtc=1</programlisting>
6289 <para><varname>STDERR</varname> ist tabu. Unkonditionale
6290 Debugmeldungen auch.</para>
6292 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
6293 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
6294 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
6296 <para>Die <classname>LXDebug</classname>-Methode
6297 "<function>message</function>" nimmt als ersten Paramter außerdem
6298 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
6299 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
6300 und werden in den meisten Fällen auch vom Repository
6301 zurückgewiesen.</para>
6305 <para>Alle neuen Module müssen use strict verwenden.</para>
6307 <para><varname>$form</varname>, <varname>$auth</varname>,
6308 <varname>$locale</varname>, <varname>$lxdebug</varname> und
6309 <varname>%myconfig</varname> werden derzeit aus dem main package
6310 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
6311 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
6316 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
6317 <title>Dokumentation erstellen</title>
6319 <sect2 id="devel.build-doc.introduction">
6320 <title>Einführung</title>
6322 <para>Diese Dokumentation ist in <productname>DocBook</productname>
6323 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
6324 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
6325 Editor nutzt, der spezielle Unterstützung für
6326 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
6327 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
6328 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
6332 <sect2 id="devel.build-doc.required-software">
6333 <title>Benötigte Software</title>
6335 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
6336 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
6337 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
6338 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
6339 <command>scripts/build_doc.sh</command>.</para>
6341 <para>Das Script benötigt zur Konvertierung verschiedene
6342 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
6348 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
6349 in einer halbwegs aktuellen Version</para>
6353 <para>Das Java-Build-System <ulink
6354 url="http://ant.apache.org/">Apache Ant</ulink></para>
6358 <para>Das Dokumentations-System Dobudish für
6359 <productname>DocBook</productname> 4.5, eine Zusammenstellung
6360 diverser Stylesheets und Grafiken zur Konvertierung von
6361 <productname>DocBook</productname> XML in andere Formate. Das
6362 Paket, das benötigt wird, ist zum Zeitpunkt der
6363 Dokumentationserstellung
6364 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
6365 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
6370 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
6371 sind auf allen gängigen Plattformen verfügbar. Beispiel für
6372 Debian/Ubuntu:</para>
6374 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
6376 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
6377 <filename>doc/build</filename> entpackt werden. Beispiel unter der
6378 Annahme, das <productname>Dobudish</productname> in
6379 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
6381 <programlisting>cd doc/build
6382 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
6385 <sect2 id="devel.build-doc.build">
6386 <title>PDFs und HTML-Seiten erstellen</title>
6388 <para>Die eigentliche Konvertierung erfolgt nach Installation der
6389 benötigten Software mit einem einfachen Aufruf direkt aus dem
6390 kivitendo-Installationsverzeichnis heraus:</para>
6392 <programlisting>./scripts/build_doc.sh</programlisting>
6395 <sect2 id="devel.build-doc.repository">
6396 <title>Einchecken in das Git-Repository</title>
6398 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
6399 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
6400 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
6401 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
6403 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
6404 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob