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)</para>
86 <para>7.0 "Wheezy"</para>
92 <para>Ubuntu 10.04 LTS "Lucid Lynx", 12.04 LTS "Precise Pangolin" und 12.10 "Oneiric Ocelot"`</para>
96 <para>openSUSE 12.1 und 12.2</para>
100 <para>SuSE Linux Enterprice Server 11</para>
104 <para>Fedora 16 und 17</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.2)
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></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 v2.7.0 sind die folgenden Pakete hinzugekommen: <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
179 <literal>Net::SSLGlue</literal>.</para>
181 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
182 hinzugekommen, <literal>URI</literal> und
183 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
186 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
187 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
188 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
189 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
191 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
192 hinzugekommen.</para>
194 <para><literal>Email::Address</literal> und
195 <literal>List::MoreUtils</literal> sind schon länger feste
196 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
197 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
198 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
199 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
203 <title>Debian und Ubuntu</title>
205 <para>Alle benötigten Perl-Pakete stehen für Debian und Ubuntu als Debian-Pakete zur Verfügung. Sie können mit folgendem Befehl
206 installiert werden:</para>
208 <programlisting>apt-get install apache2 libarchive-zip-perl libclone-perl \
209 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
210 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
211 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
212 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
213 librose-db-perl librose-object-perl libsort-naturally-perl \
214 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
215 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
216 libfile-copy-recursive-perl postgresql</programlisting>
220 <title>Fedora Core</title>
222 <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>
224 <programlisting>yum install httpd perl-Archive-Zip perl-Clone perl-DBD-Pg \
225 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
226 perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
227 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
228 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
229 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
230 perl-XML-Writer perl-YAML perl-parent postgresql-server</programlisting>
232 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
234 <programlisting>yum install perl-CPAN
235 cpan Config::Std</programlisting>
240 <title>openSUSE</title>
242 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
243 installiert werden:</para>
245 <programlisting>zypper install apache2 perl-Archive-Zip perl-Clone \
246 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
247 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
248 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
249 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
250 perl-URI perl-XML-Writer perl-YAML postgresql-server</programlisting>
252 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
254 <programlisting>yum install perl-CPAN
255 cpan Rose::Db::Object</programlisting>
261 <sect1 id="Manuelle-Installation-des-Programmpaketes"
262 xreflabel="Manuelle Installation des Programmpaketes">
263 <title>Manuelle Installation des Programmpaketes</title>
265 <para>Die kivitendo ERP Installationsdatei (<filename>kivitendo-erp-3.0.0.tgz</filename>) wird im Dokumentenverzeichnis des Webservers
266 (z.B. <filename>/var/www/html/</filename>, <filename>/srv/www/htdocs</filename> oder <filename>/var/www/</filename>) entpackt:</para>
268 <programlisting>cd /var/www
269 tar xvzf kivitendo-erp-3.0.0.tgz</programlisting>
271 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
273 <programlisting>cd kivitendo-erp</programlisting>
275 <para>Alternativ können Sie auch einen Alias in der
276 Webserverkonfiguration benutzen, um auf das tatsächliche
277 Installationsverzeichnis zu verweisen.</para>
279 <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
280 beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
281 Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
282 core <constant>apache</constant> oder bei OpenSUSE <constant>wwwrun</constant>).</para>
284 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
285 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
287 <programlisting>chown -R www-data users spool webdav</programlisting>
289 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
290 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>
292 <programlisting>chown www-data templates users</programlisting>
295 <sect1 id="config.config-file">
296 <title>kivitendo-Konfigurationsdatei</title>
298 <sect2 id="config.config-file.introduction"
299 xreflabel="Einführung in die Konfigurationsdatei">
300 <title>Einführung</title>
302 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei,
303 die benötigt wird: <filename>config/kivitendo.conf</filename> (kurz:
304 "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
305 von kivitendo bzw. der Migration von älteren Versionen angelegt
308 <para>Als Vorlage dient die Datei
309 <filename>config/kivitendo.conf.default</filename> (kurz: "die
310 Default-Datei"):</para>
312 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
314 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
315 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
316 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
317 Abschnitte und Werte enthalten, die von denen der Default-Datei
322 Vor der Umbenennung in kivitendo hieß diese Datei noch <filename>config/lx_office.conf</filename>. Aus Gründen der Kompatibilität
323 wird diese Datei eingelesen, sofern die Datei <filename>config/kivitendo.conf</filename> nicht existiert.
327 <para>Diese Hauptkonfigurationsdatei ist dann eine
328 installationsspezifische Datei, d.h. sie enthält bspw. lokale
329 Passwörter und wird auch nicht im Versionsmanagement (git)
332 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
333 Mandaten, bzw. Datenbanken gleich.</para>
336 <sect2 id="config.config-file.sections-parameters">
337 <title>Abschnitte und Parameter</title>
339 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
340 entsprechend kommentiert sind:</para>
343 <listitem><para><literal>authentication</literal> (siehe Abschnitt "<xref
344 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>" in diesem Kapitel)</para></listitem>
346 <listitem><para><literal>authentication/database</literal></para></listitem>
348 <listitem><para><literal>authentication/ldap</literal></para></listitem>
350 <listitem><para><literal>system</literal></para></listitem>
352 <listitem><para><literal>features</literal> (siehe Kapitel "<xref linkend="features"/>")</para></listitem>
354 <listitem><para><literal>paths</literal></para></listitem>
356 <listitem><para><literal>applications</literal></para></listitem>
358 <listitem><para><literal>environment</literal></para></listitem>
360 <listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>
362 <listitem><para><literal>print_templates</literal></para></listitem>
364 <listitem><para><literal>task_server</literal></para></listitem>
366 <listitem><para><literal>periodic_invoices</literal></para></listitem>
368 <listitem><para><literal>console</literal></para></listitem>
370 <listitem><para><literal>debug</literal></para></listitem>
373 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
374 einzustellen oder zu kontrollieren sind, sind:</para>
376 <programlisting>[authentication]
377 admin_password = geheim
379 [authentication/database]
387 dbcharset = UTF-8</programlisting>
389 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
390 <varname>[periodic_invoices]</varname> den Login eines Benutzers
391 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
392 mit Informationen über die erstellten Rechnungen bekommt.</para>
394 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten Ausführung bestimmter Aufgaben mit, den <link
395 linkend="config.task-server">Taskserver</link>. Er wird u.a. für Features wie die <link
396 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link> benötigt, erledigt aber auch andere erforderliche Aufgaben
397 und muss daher in Betrieb genommen werden. Der Taskserver benötigt zwei Konfigurationseinstellungen, die unter
398 <varname>[task_server]</varname> anzugeben sind: ein Mandant (entweder der Mandantenname oder eine Datenbank-ID, Variable
399 <varname>client</varname>), aus dem die Datenbankkonfiguration entnommen wird, sowie ein Login (Variable <varname>login</varname>)
400 eines Benutzers, der für gewisse Dinge wie die Rechnungserstellung als Verkäufer eingetragen wird.</para>
402 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
403 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
406 <sect2 id="config.config-file.prior-versions">
407 <title>Versionen vor 2.6.3</title>
409 <para>In älteren kivitendo Versionen gab es im Verzeichnis
410 <filename>config</filename> die Dateien
411 <filename>authentication.pl</filename> und
412 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
413 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
414 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
415 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
417 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
418 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
419 manuell übertragen und die alten Konfigurationsdateien anschließend
420 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
421 entsprechende Fehlermeldung an.</para>
425 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
426 <title>Anpassung der PostgreSQL-Konfiguration</title>
428 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
430 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
431 <title>Zeichensätze/die Verwendung von UTF-8</title>
433 <para>Bei aktuellen Serverinstallationen braucht man hier meist nicht
436 <para>Dieses kann überprüft werden: ist das Encoding der Datenbank
437 “template1” “UTF8”, so braucht man nichts weiteres diesbezüglich
438 unternehmen. Zum Testen:
440 <programlisting>su postgres
442 exit </programlisting>
444 Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
445 UTF-8-Encoding anzulegen und diesen zu verwenden. Unter Debian und
446 Ubuntu kann dies z.B. für PostgreSQL 8.2 mit dem folgenden Befehl
449 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2 clustername</programlisting>
451 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
452 Versionsnummer angepasst werden.</para>
454 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
456 <para>Wurde PostgreSQL nicht mit UTF-8 als Encoding initialisiert und
457 ist ein Neuanlegen eines weiteren Clusters nicht möglich, so kann
458 kivitendo mit ISO-8859-15 als Encoding betrieben werden.</para>
460 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
461 <literal>\l</literal> geprüft werden.</para>
464 <sect2 id="Änderungen-an-Konfigurationsdateien">
465 <title>Änderungen an Konfigurationsdateien</title>
467 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
468 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
469 <filename>/var/lib/pgsql/data/</filename> oder
470 <filename>/etc/postgresql/</filename>, muss sichergestellt werden,
471 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
472 Parameter <varname>listen_address</varname> gesteuert. Laufen
473 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
474 <literal>localhost</literal> verwendet werden. Andernfalls müssen
475 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
476 was mit dem Wert <literal>*</literal> geschieht.</para>
478 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
479 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
480 sein sollte, müssen die Berichtigungen für den Zugriff geändert
481 werden. Hier gibt es mehrere Möglichkeiten. sinnvoll ist es nur die
482 nögiten Verbindungen immer zuzulassen, für eine lokal laufenden
483 Datenbank zum Beispiel:</para>
485 <programlisting>local all kivitendo password
486 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
489 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
490 <title>Erweiterung für servergespeicherte Prozeduren</title>
492 <para>In der Datenbank <literal>template1</literal> muss die
493 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
494 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
495 <programlisting>su - postgres
496 psql template1</programlisting>
498 führen Sie die folgenden Kommandos aus:</para>
500 <programlisting>create language 'plpgsql';
504 <sect2 id="Datenbankbenutzer-anlegen">
505 <title>Datenbankbenutzer anlegen</title>
507 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
508 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
509 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
512 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit nein
513 beantworten, genauso ist die Berechtigung neue User (Roles) zu
514 generieren nicht nötig.</para>
515 <programlisting>su - postgres
516 createuser -d -P kivitendo
517 exit</programlisting>
519 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
520 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.
521 den hier gewählten Benutzernamen.</para>
525 <sect1 id="Apache-Konfiguration">
526 <title>Webserver-Konfiguration</title>
529 <title>Grundkonfiguration mittels CGI</title>
532 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
533 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
534 <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
537 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
538 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
539 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
540 anderen Datei hinzu, die beim Starten des Webservers eingelesen
543 <programlisting>AddHandler cgi-script .pl
544 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
546 <Directory /var/www/kivitendo-erp>
547 Options ExecCGI Includes FollowSymlinks
550 <Directory /var/www/kivitendo-erp/users>
553 </Directory></programlisting>
555 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
556 das kivitendo-Archiv entpacket haben.</para>
559 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
560 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
563 <para>Auf einigen Webservern werden manchmal die Grafiken und
564 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
565 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
567 <programlisting>EnableSendfile Off</programlisting>
570 <sect2 id="Apache-Konfiguration.FCGI"
571 xreflabel="Konfiguration für FastCGI/FCGI">
572 <title>Konfiguration für FastCGI/FCGI</title>
574 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
575 <title>Was ist FastCGI?</title>
577 <para>Direkt aus <ulink
578 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
581 <para><citation> FastCGI ist ein Standard für die Einbindung
582 externer Software zur Generierung dynamischer Webseiten in einem
583 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
584 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
585 umgehen. </citation></para>
588 <sect3 id="Apache-Konfiguration.FCGI.Warum">
589 <title>Warum FastCGI?</title>
591 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
592 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
593 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
594 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
595 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
596 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
597 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
598 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
599 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
600 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
601 deutlich länger dauert als früher, und dass davon 90% für das Laden
602 der Module verwendet wird.</para>
604 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
605 wird nur die eigentliche Programmlogik ausgeführt.</para>
608 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
609 <title>Getestete Kombinationen aus Webservern und Plugin</title>
611 <para>Folgende Kombinationen sind getestet:</para>
615 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
619 <para>Apache 2.2.11 (Ubuntu) und mod_fastcgi.</para>
623 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
624 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
625 mod_fastcgi nicht mehr explizit eingegangen.</para>
627 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
631 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern
632 bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrere Installation gibt, muss zwingend Version 0.68 oder
633 aber Version 0.72 und neuer eingesetzt werden.</para>
635 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie sich die Vorgängerversion wie folgt
638 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
642 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
643 <title>Konfiguration des Webservers</title>
645 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
646 laufen zu lassen, empfliehlt es sich die Installation ersteinmal
647 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
648 debuggen die beim ersten aufsetzen auftreten können. Sollte die
649 Installation schon funktionieren, lesen Sie weiter.</para>
651 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
652 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
654 <programlisting>a2enmod fcgid</programlisting>
656 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
657 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
658 und <function>Directory</function>-Direktiven. Dabei wird zwischen
659 dem Installationspfad von kivitendo im Dateisystem
660 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
661 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
662 ("<filename>/url/for/kivitendo-erp</filename>").</para>
664 <para>Folgender Konfigurationsschnipsel funktioniert mit
667 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
668 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
670 <Directory /path/to/kivitendo-erp>
672 Options ExecCGI Includes FollowSymlinks
677 <DirectoryMatch /path/to/kivitendo-erp/users>
680 </DirectoryMatch></programlisting>
682 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
683 die maximale Größe eines Requests. Diese sollte wie folgt
684 hochgesetzt werden:</para>
686 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
688 <para>Das ganze sollte dann so aussehen:</para>
690 <programlisting>AddHandler fcgid-script .fpl
691 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
692 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
693 FcgidMaxRequestLen 10485760
695 <Directory /path/to/kivitendo-erp>
697 Options ExecCGI Includes FollowSymlinks
702 <DirectoryMatch /path/to/kivitendo-erp/users>
705 </DirectoryMatch></programlisting>
707 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
708 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
709 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
710 gibt es hier kleine Performance-Einbußen.</para>
712 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
713 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
714 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
716 <programlisting># Zugriff über CGI
717 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
719 # Zugriff mit mod_fcgid:
720 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
721 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
723 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
724 die normale Version erreichbar, und unter
725 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
726 FastCGI-Version.</para>
731 <sect1 id="config.task-server">
732 <title>Der Task-Server</title>
734 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und
735 diese zu festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess wird u.a. für die Erzeugung der wiederkehrenden
736 Rechnungen und weitere essenzielle Aufgaben benutzt.</para>
738 <sect2 id="Konfiguration-des-Task-Servers">
739 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
741 <para>Die Konfiguration erfolgt über den Abschnitt
742 <literal>[task_server]</literal> in der Datei
743 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
744 Optionen sind:</para>
748 <term><varname>client</varname></term>
751 <para>Name oder Datenbank-ID eines vorhandenen kivitendo-Mandanten, der benutzt wird, um die zu verwendende
752 Datenbankverbindung auszulesen. Der Mandant muss in der Administration angelegt werden. Diese Option muss angegeben
755 <para>Diese Option kam mit Release v3.x.0 hinzu und muss daher in Konfigurationen, die von älteren Versionen aktualisiert
756 wurden, ergänzt werden.</para>
761 <term><varname>login</varname></term>
764 <para>gültiger kivitendo-Benutzername, der z.B. als Verkäufer beim Erzeugen wiederkehrender Rechnungen benötigt wird. Der
765 Benutzer muss in der Administration angelegt werden. Diese Option muss angegeben werden.</para>
770 <term><varname>run_as</varname></term>
773 <para>Wird der Server vom Systembenutzer <literal>root</literal>
774 gestartet, so wechselt er auf den mit <literal>run_as</literal>
775 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
776 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
778 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
779 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
780 unter dem auch der Webserver läuft.</para>
785 <term><varname>debug</varname></term>
788 <para>Schaltet Debug-Informationen an und aus.</para>
794 <sect2 id="Einbinden-in-den-Boot-Prozess">
795 <title>Automatisches Starten des Task-Servers beim Booten</title>
797 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
798 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
799 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
801 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
802 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
803 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
804 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
805 anstelle eines symbolischen Links verwendet werden können.</para>
808 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, ältere Fedora Core)</title>
810 <para>Kopieren Sie die Datei
811 <filename>scripts/boot/system-v/kivitendo-server</filename>
812 nach <filename>/etc/init.d/kivitendo-server</filename>. Passen
813 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
814 <literal>DAEMON=....</literal>). Binden Sie das Script in den
815 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
819 <para>Debian-basierende Systeme:</para>
821 <programlisting>update-rc.d kivitendo-task-server defaults
822 # Nur bei Debian Squeeze und neuer:
823 insserv kivitendo-task-server</programlisting>
827 <para>Ältere OpenSUSE und ältere Fedora Core:</para>
829 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
833 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
836 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
840 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
842 <para>Kopieren Sie die Datei
843 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
844 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
845 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
846 <literal>exec ....</literal>).</para>
848 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
851 <programlisting>service kivitendo-task-server start</programlisting>
855 <title>systemd-basierende Systeme (z.B. neure OpenSUSE, neuere Fedora Core)</title>
857 <para>Verlinken Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
858 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
859 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>). Binden Sie das Script in den Boot-Prozess ein.
862 <para>Alle hierzu benötigten Befehle sehen so aus:</para>
864 <programlisting>cd /var/www/kivitendo-erp/scripts/boot/systemd
865 ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
867 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
870 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
874 <sect2 id="Prozesskontrolle">
875 <title>Wie der Task-Server gestartet und beendet wird</title>
877 <para>Der Task-Server wird wie folgt kontrolliert:</para>
879 <programlisting>./scripts/task_server.pl Befehl</programlisting>
881 <para><literal>Befehl</literal> ist dabei eine der folgenden
886 <para><literal>start</literal> startet eine neue Instanz des
887 Task-Servers. Die Prozess-ID wird innerhalb des
888 <filename>users</filename>-Verzeichnisses abgelegt.</para>
892 <para><literal>stop</literal> beendet einen laufenden
897 <para><literal>restart</literal> beendet und startet ihn
902 <para><literal>status</literal> berichtet, ob der Task-Server
907 <para>Der Task-Server wechselt beim Starten automatisch in das
908 kivitendo-Installationsverzeichnis.</para>
910 <para>Dieselben Optionen können auch für die SystemV-basierenden
911 Runlevel-Scripte benutzt werden (siehe oben).</para>
913 <sect2 id="Prozesskontrolle2">
914 <title>Task-Server mit mehreren Mandanten</title>
916 <para>Beim Task-Server werden der zu verwendende Mandant und Login-Name des Benutzers, unter dem der Task-Server laufen soll, in die
917 Konfigurationsdatei geschrieben. Hat man mehrere Mandanten, muss man auch mehrere Konfigurationsdateien anlegen.</para>
919 <para>Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf, wo in der Kategorie <varname>[task_server]</varname> die
920 gewünschten Werte für <varname>client</varname> und <varname>login</varname> eingetragen werden.</para>
922 <para>Der alternative Task-Server wird dann mit folgendem Befehl
925 <programlisting>./scripts/task_server.pl -c config/DATEINAME.conf</programlisting>
929 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
930 <title>Benutzerauthentifizierung und Administratorpasswort</title>
932 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
933 über die Verwaltung von Gruppen und weitere Einstellungen</para>
935 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
936 <title>Grundlagen zur Benutzerauthentifizierung</title>
938 <para>kivitendo verwaltet die Benutzerinformationen in einer
939 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
940 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
941 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
942 können, müssen aber nicht unterschiedlich sein.</para>
944 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
945 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
946 abgelegt werden.</para>
948 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
949 entweder gegen die Authentifizierungsdatenbank oder gegen einen
950 LDAP-Server überprüft werden.</para>
952 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
953 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
954 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
955 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
956 einer Version vor v2.6.0 angelegt werden. Eine
957 Beispielkonfigurationsdatei
958 <filename>config/kivitendo.conf.default</filename> existiert, die als
959 Vorlage benutzt werden kann.</para>
962 <sect2 id="Administratorpasswort">
963 <title>Administratorpasswort</title>
965 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
966 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
967 nur dort und nicht mehr im Administrationsinterface selber geändert
968 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
969 Abschnitt <varname>[authentication]</varname>.</para>
972 <sect2 id="Authentifizierungsdatenbank">
973 <title>Authentifizierungsdatenbank</title>
975 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
976 Parametern in <varname>[authentication/database]</varname>
977 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
981 <term><literal>host</literal></term>
984 <para>Der Rechnername oder die IP-Adresse des
985 Datenbankservers</para>
990 <term><literal>port</literal></term>
993 <para>Die Portnummer des Datenbankservers, meist 5432</para>
998 <term><literal>db</literal></term>
1001 <para>Der Name der Authentifizierungsdatenbank</para>
1006 <term><literal>user</literal></term>
1009 <para>Der Benutzername, mit dem sich kivitendo beim
1010 Datenbankserver anmeldet (z.B.
1011 "<literal>postgres</literal>")</para>
1016 <term><literal>password</literal></term>
1019 <para>Das Passwort für den Datenbankbenutzer</para>
1024 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1025 automatisch anlegen (mehr dazu siehe unten).</para>
1028 <sect2 id="Passwortüberprüfung">
1029 <title>Passwortüberprüfung</title>
1031 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1032 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1033 Active-Directory-Server. Welche davon benutzt wird, regelt der
1034 Parameter <varname>module</varname> im Abschnitt
1035 <varname>[authentication]</varname>.</para>
1037 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1038 gespeichert werden, so muss der Parameter <varname>module</varname>
1039 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1040 der Administrator als auch die Benutzer selber ihre Psaswörter in
1041 kivitendo ändern.</para>
1043 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1044 benutzt werden, so muss der Parameter <varname>module</varname> auf
1045 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1046 zusätzliche Informationen über den LDAP-Server im Abschnitt
1047 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1051 <term><literal>host</literal></term>
1054 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1055 Active-Directory-Servers. Diese Angabe ist zwingend
1056 erforderlich.</para>
1061 <term><literal>port</literal></term>
1064 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1069 <term><literal>tls</literal></term>
1072 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1073 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1074 ‘<literal>0</literal>’ belassen</para>
1079 <term><literal>attribute</literal></term>
1082 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1083 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1084 meist ‘<literal>sAMAccountName</literal>’, für andere
1085 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1086 zwingend erforderlich.</para>
1091 <term><literal>base_dn</literal></term>
1094 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1095 Diese Angabe ist zwingend erforderlich.</para>
1100 <term><literal>filter</literal></term>
1103 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1104 <literal><%login%></literal>, so wird dieses durch den vom
1105 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1106 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1107 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1112 <term><literal>bind_dn</literal> und
1113 <literal>bind_password</literal></term>
1116 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1117 durchsucht werden kann (z.B. ist dies bei
1118 Active-Directory-Servern der Fall), so kann diese hier angegeben
1119 werden. Für Active-Directory-Server kann als
1120 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1121 z.B. ‘<literal>cn=Martin
1122 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1123 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1124 also ‘<literal>Martin Mustermann</literal>’.</para>
1130 <sect2 id="Name-des-Session-Cookies">
1131 <title>Name des Session-Cookies</title>
1133 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1134 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1135 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1136 Parameter <varname>cookie_name</varname> im Abschnitt
1137 <varname>[authentication]</varname>gesetzt.</para>
1139 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1140 Server existiert.</para>
1143 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1144 <title>Anlegen der Authentifizierungsdatenbank</title>
1146 <para>Nachdem alle Einstellungen in
1147 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1148 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1149 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1150 der folgenden URL erreichbar sein sollte:</para>
1153 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1157 <sect1 id="Benutzer--und-Gruppenverwaltung">
1158 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1160 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und Datenbanken angelegt werden. Dieses geschieht im
1161 Administrationsmenü, das Sie unter folgender URL finden:</para>
1164 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1166 <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
1167 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1169 <sect2 id="Zusammenhänge">
1170 <title>Zusammenhänge</title>
1172 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung in einer oder zwei Datenbanken gespeichert werden.</para>
1174 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat
1175 Zugriff auf welche Mandanten, und welche Gruppe verfügt über welche Rechte. Diese Informationen werden in der
1176 Authentifizierungsdatenbank gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter in der Konfigurationsdatei
1177 <filename>config/kivitendo.conf</filename> gespeichert werden.</para>
1179 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines Mandanten: Stammdaten (Kunden, Lieferanten, Waren), Belege
1180 (Angebote, Liferscheine, Rechnungen), Einstellungen. Diese werden in einer Mandantendatenbank gespeichert. Die
1181 Verbindungsinformationen einer solchen Mandantendatenbank werden im Administrationsbereich konfiguriert, indem man einen Mandanten
1182 anlegt und dort die Parameter einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1184 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich, die Authentifizierungsdatenbank und eine der
1185 Mandantendatenbanken in ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit mehr als einem Mandanten, wird
1186 empfohlen, für die Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die nicht gleichzeitig für einen Mandanten
1187 verwendet wird.</para>
1189 <para>kivitendo verwendet eine Datenbank zum Speichern all seiner
1190 Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um
1191 mit kivitendo arbeiten zu können, muss eine Person einen
1192 Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine
1193 Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist
1194 möglich und normal, dass mehreren Benutzern die selbe Datenbank
1195 zugewiesen wird, sodass sie alle mit den selben Daten arbeiten
1199 <sect2 id="Mandanten-Benutzer-Gruppen">
1200 <title>Mandanten, Benutzer und Gruppen</title>
1202 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen, die sich frei zueinander zuordnen lassen.</para>
1204 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1205 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1206 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank. Diese sollte über die <link
1207 linkend="Datenbanken-anlegen">Datenbankverwaltung</link> geschehen.</para>
1209 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten soll. Sie erhält einen Loginnamen sowie ein
1210 Passwort. Weiterhin legt der Administrator fest, an welchen Mandanten sich ein Benutzer anmelden kann, was beim Login verifiziert
1213 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür
1214 vom Administrator gewisse Rechte zugeordnet. Weiterhin legt der Administrator fest, für welche Mandanten eine Gruppe gilt, und
1215 welche Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer dann an einem Mandanten an, so erhält er alle Rechte von
1216 allen denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in denen der Benutzer zum Anderen Mitglied ist, </para>
1218 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und Benutzer angelegt werden, kann im Prinzip beliebig gewählt
1219 werden. Die folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1221 <orderedlist numeration="arabic">
1223 <para>Datenbank anlegen</para>
1227 <para>Gruppen anlegen</para>
1231 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1235 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1240 <sect2 id="Datenbanken-anlegen">
1241 <title>Datenbanken anlegen</title>
1243 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1244 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1245 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1247 <para>Wenn Sie für die kivitendo-Installation nicht Unicode (UTF-8) sondern den europäischen Schriftsatz ISO-8859-15 benutzen
1248 wollen, so müssen Sie vor dem Anlegen der Datenbank in der Datei <filename>config/kivitendo.conf</filename> die Variable
1249 <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf den Wert ‘<literal>ISO-8859-15</literal>’ setzen.</para>
1251 <para>Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz
1252 verwenden müssen, da diese Einstellungen momentan global in kivitendo
1253 vorgenommen wird und nicht nach Datenbank unterschieden werden kann.
1254 Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz
1255 angelegt worden sein.</para>
1258 <sect2 id="Gruppen-anlegen">
1259 <title>Gruppen anlegen</title>
1261 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1262 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1263 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1264 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1266 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank gespeichert, gelten aber nicht automatisch für alle
1267 Mandanten. Der Administrator legt vielmehr fest, für welche Mandanten eine Gruppe gültig ist. Dies kann entweder beim Bearbeiten der
1268 Gruppe geschehen ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn man einen Mandanten bearbeitet ("für diesen
1269 Mandanten sind die Gruppen A, B und C gültig").</para>
1271 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder dieser Gruppe festgelegt werden ("in dieser Gruppe sind die
1272 Benutzer X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten eines Benutzers geschehen ("dieser Benutzer ist
1273 Mitglied in den Gruppen A, B und C").</para>
1276 <sect2 id="Benutzer-anlegen">
1277 <title>Benutzer anlegen</title>
1279 <para>Beim Anlegen von Benutzern werden für viele Parameter Standardeinstellungen vorgenommen, die den Gepflogenheiten des deutschen
1280 Raumes entsprechen.</para>
1282 <para>Zwingend anzugeben ist der Loginname. Wenn die Passwortauthentifizierung über die Datenbank eingestellt ist, so kann hier auch
1283 das Benutzerpasswort gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1286 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier auch konfiguriert werden, auf welche Mandanten der Benutzer
1287 Zugriff hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können sowohl beim Benutzer vorgenommen werden ("dieser
1288 Benutzer hat Zugriff auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen X, Y und Z") als auch beim Mandanten ("auf
1289 diesen Mandanten haben Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe sind Benutzer A, B und C
1290 Mitglieder").</para>
1293 <sect2 id="Mandanten-anlegen">
1294 <title>Mandanten anlegen</title>
1296 <para>Ein Mandant besteht aus Administrationssicht primär aus einem eindeutigen Namen. Weiterhin wird hier hinterlegt, welche
1297 Datenbank als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten einer der eben angelegten Datenbanken eingetragen
1300 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch konfiguriert werden, welche Benutzer Zugriff auf den
1301 Mandanten haben bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen können sowohl beim Mandanten vorgenommen werden
1302 ("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
1303 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
1308 <sect1 id="config.sending-email" xreflabel="E-Mail-Versand aus kivitendo heraus">
1309 <title>E-Mail-Versand aus kivitendo heraus</title>
1311 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden, z.B. um ein Angebot direkt an einen Kunden zu
1312 verschicken. Damit dies funktioniert, muss eingestellt werden, über welchen Server die E-Mails verschickt werden sollen. kivitendo
1313 unterstützt dabei zwei Mechanismen: Versand über einen lokalen E-Mail-Server (z.B. mit <productname>Postfix</productname> oder
1314 <productname>Exim</productname>, was auch die standardmäßig aktive Methode ist) sowie Versand über einen SMTP-Server (z.B. der des
1315 eigenen Internet-Providers).</para>
1317 <para>Welche Methode und welcher Server verwendet werden, wird über die Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1318 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1320 <sect2 id="config.sending-email.sendmail" xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1321 <title>Versand über lokalen E-Mail-Server</title>
1323 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie
1324 z.B. <productname>Postfix</productname>, <productname>Exim</productname> oder <productname>Sendmail</productname> läuft.</para>
1326 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1327 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1329 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet wird, dient der Parameter '<literal>sendmail =
1330 ...</literal>'. Der Standardwert verweist auf das Programm <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1331 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1333 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen dieses sprengen. Hierfür sei auf die Dokumentation des
1334 E-Mail-Servers verwiesen.</para>
1337 <sect2 id="config.sending-email.smtp" xreflabel="E-Mail-Versand über einen SMTP-Server">
1338 <title>Versand über einen SMTP-Server</title>
1340 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server vorhanden oder zwar einer vorhanden, dieser aber nicht
1341 konfiguriert ist.</para>
1343 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1344 Parameter dienen dabei der weiteren Konfiguration:</para>
1348 <term><varname>hostname</varname></term>
1350 <listitem><para>Name oder IP-Adresse des SMTP-Servers. Standardwert: '<literal>localhost</literal>'</para></listitem>
1354 <term><varname>port</varname></term>
1356 <listitem><para>Portnummer. Der Standardwert hängt von der verwendeten Verschlüsselungsmethode ab. Gilt '<literal>security =
1357 none</literal>' oder '<literal>security = tls</literal>', so ist 25 die Standardportnummer. Für '<literal>security =
1358 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht geändert werden.</para></listitem>
1362 <term><varname>security</varname></term>
1364 <listitem><para>Wahl der zu verwendenden Verschlüsselung der Verbindung mit dem Server. Standardwert ist
1365 '<literal>none</literal>', wodurch keine Verschlüsselung verwendet wird. Mit '<literal>tls</literal>' wird TLS-Verschlüsselung
1366 eingeschaltet, und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL eingeschaltet. Achtung: Für
1367 '<literal>tls</literal>' und '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt (siehe unten).</para></listitem>
1371 <term><varname>login</varname> und <varname>password</varname></term>
1373 <listitem><para>Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername
1374 und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von
1375 Verschlüsselung aktiviert werden.</para></listitem>
1379 <para>Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind:</para>
1382 <listitem><para>TLS-Verschlüsselung: Modul <literal>Net::SSLGlue</literal> (Debian-Paketname
1383 <literal>libnet-sslglue-perl</literal>, Fedora Core: <literal>perl-Net-SSLGlue</literal>, openSUSE:
1384 <literal>perl-Net-SSLGlue</literal></para></listitem>
1386 <listitem><para>SSL-Verschlüsselung: Modul <literal>Net::SMTP::SSL</literal> (Debian-Paketname
1387 <literal>libnet-smtp-ssl-perl</literal>, Fedora Core: <literal>perl-Net-SMTP-SSL</literal>, openSUSE:
1388 <literal>perl-Net-SMTP-SSL</literal></para></listitem>
1393 <sect1 id="Drucken-mit-kivitendo">
1394 <title>Drucken mit kivitendo</title>
1396 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. Um drucken zu können, braucht der Server ein geeignetes
1397 LaTeX System. Am einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter Debianoiden Betriebssystemen installiert man
1398 die Pakete mit:</para>
1400 <para><programlisting>aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1401 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1403 <para>TODO: RPM-Pakete.</para>
1405 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1407 <listitem><para>Standard</para></listitem>
1408 <listitem><para>f-tex</para></listitem>
1409 <listitem><para>RB</para></listitem>
1412 <sect2 id="Vorlagenverzeichnis-anlegen" xreflabel="Vorlagenverzeichnis anlegen">
1413 <title>Vorlagenverzeichnis anlegen</title>
1414 <para>Im Administrationsbereich lässt sich bei einem Benutzer/Mandanten einer dieser Vorlagensätze als Basis für die zu
1415 druckenden Dokumente auswählen. Rufen Sie dazu die <guimenu>Benutzerverwaltung</guimenu> auf.</para>
1417 <para>Wählen Sie dort einen Benutzer aus oder legen Sie einen neuen an. In der Benutzerbearbeiten-Maske müssen Sie zwei Dinge
1421 <listitem><para><option>Name</option>: Der Verzeichnisname für den neuen Vorlagensatz. Dieser kann im Rahmen der üblichen
1422 Bedingungen für Verzeichnisnamen frei gewählt werden.</para></listitem>
1423 <listitem><para><option>Vorlagen auswählen</option>: Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll
1424 (<filename>Standard</filename>, <filename>f-tex</filename> oder <filename>RB</filename>.)</para></listitem>
1427 <para>Der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Benutzern verwendet werden.</para>
1429 <para>Die Abhängigkeiten kann man prüfen mit:</para>
1431 <programlisting>/scripts/installation_check.pl -l</programlisting>
1434 <sect2 id="Vorlagen-Standard">
1435 <title>Standard</title>
1437 <para>Der Standard-Vorlagensatz von Kivitendo. Wie unter <ulink url="http://demo.kivitendo.org">http://demo.kivitendo.org</ulink> zu
1443 <title>f-tex</title>
1445 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt.</para>
1447 <sect3 id="f-tex-Feature-Übersicht">
1448 <title>Feature-Übersicht</title>
1450 <listitem><para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage für alle briefartigen Dokumente verwendet. Also
1451 Angebot, Rechnung, Performarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc..</para></listitem>
1453 <listitem><para>Leichte Anpassung an das Firmen-Layout durch verwendung eines Hintergrund-PDF. Dieses kann leicht mit dem
1454 eigenen Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp, Adobe*)</para></listitem>
1456 <listitem><para>Hintergrund-PDF umschaltbar auf "nur erste Seite" (Standard) oder "alle Seiten" (Option
1457 "<option>bgPdfFirstPageOnly</option>" in Datei <filename>letter.lco</filename>)</para></listitem>
1459 <listitem><para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1460 versendeten Dokumenten eingebunden (Option "<option>bgPdfEmailOnly</option>" in Datei
1461 <filename>letter.lco</filename>).</para></listitem>
1463 <listitem><para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch, Wiederholung von Kopfzeilen, Zwischensummen
1464 etc. (danke an Kai-Martin Knaak für die Vorarbeit)</para></listitem>
1466 <listitem><para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom Land des eigenen Unternehmens abweicht (also die
1467 Rechnung das Land verlässt).</para></listitem>
1469 <listitem><para>Multisprachfähig leicht um weitere Sprachen zu erweitern, alle Übersetzungen in der Datei
1470 <filename>translatinos.tex</filename>.</para></listitem>
1472 <listitem><para>Auflistung von Bruttopreisen für Endverbraucher.</para></listitem>
1476 <sect3 id="f-tex-Installation">
1477 <title>Die Installation</title>
1479 <listitem><para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref linkend="Vorlagenverzeichnis-anlegen"/>. Das
1480 Vorlagensystem funktioniert jetzt schon, hat allerdings noch einen Beispiel-Briefkopf.</para></listitem>
1482 <listitem><para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach <filename>./letter_head.pdf</filename>.</para></listitem>
1483 <listitem><para>Editiere den Bereich "<option>settings</option>" in der datei <filename>letter.lco</filename>.</para></listitem>
1486 <para>oder etwas Detaillierter:</para>
1489 Es wird eine Datei <filename>sample.lco</filename> erstellt und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
1490 ist dies die Datei die für die Firmenspezifischen Anpassungen gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig
1491 ist, wird in dieser Datei auf ein Hintergrundpdf verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen
1492 vorzunehmen und <filename>sample.lco</filename> unverändert zu lassen. Die die Anpassung über eine
1493 <filename>*.lco</filename>-Datei die letztlich auf <filename>letter.lco</filename> verlinkt ist ist aber auch möglich.
1497 Es wird eine Datei <filename>sample_head.pdf</filename> mit ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
1498 verlinkt. Damit gibt es schon mal eine Funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei
1499 <filename>sample_haed.pdf</filename> an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
1500 Template Verzeichniss ablegen und statt <filename>sample_head.pdf</filename> nach <filename>letter_head.pdf</filename>
1505 letzlich muss <filename>letter_head.pdf</filename> auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
1506 enthält. Bei Updates oder nach erneutem
1510 Es wird eine Datei <filename>mydata.tex.example</filename> ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
1511 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das Land verwendet. Die Datei muss also nicht angefasst
1512 werden. Die Anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig).
1515 Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc. sollten über die Hintergrund-PDF-Datei oder die
1516 <filename>*.lco</filename>-Datei erfolgen.
1520 <sect3 id="f-tex-Funktionsübersicht">
1521 <title>f-tex Funktionsübersicht</title>
1523 Das Konzept von kivitendo sieht vor, für jedes Dokument (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine LaTeX-Vorlage
1524 vorzuhalten, dies ist sehr Wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
1525 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
1526 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche LaTeX-Vorlage verwendet, welche über Codeweichen die
1527 Besonderheiten der jeweiligen Dokumente Berücksichtigt.
1531 <listitem><para>Tabellen mit oder ohne Preis</para></listitem>
1532 <listitem><para>Sprache der Tabellenüberschriften etc.</para></listitem>
1533 <listitem><para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus Angebotsnummer)</para></listitem>
1534 <listitem><para>Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus Gewerblicher
1535 Kunde)</para></listitem>
1538 <para>Nachteil:</para>
1541 LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
1542 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann natürlich
1543 auch innerhalb der Tabellendarstellung gut persönliche Anpassungen vornehmen. Aber man kann sich hier bei Veränderungen sehr
1544 schnell häftig in den Fuss schiessen.
1547 <para>Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund PDF auf Basis der
1548 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen, und sich an der Form der dargestellten Tabellen wie sie
1549 ausgeliefert werden, erfreuen.
1552 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine kontinuierliche Schritte gehen.</para>
1556 <sect3 id="f-tex-Bruttopreise">
1557 <title>Bruttopreise für Endverbraucher</title>
1559 <para>Der auszuweisende Bruttopreis wird innerhalb der LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen "alle
1560 Preise Brutto" auszuwählen, aber:</para>
1563 <para>hierfür müssen die Preise auch in Brutto in der Datenbank stehen (ja - das lässt sich über die Preisgruppen und die
1564 Zuordung einer Default-Preisgruppe handhaben)</para>
1567 <para>man darf beim Anlegen des Vorgangs nicht vergessen Dieses Häkchen zu setzen. (das ist in der Praxis wenn man sowohl
1568 Endverbraucher- wie Gewerbekunden beliefert der eigentliche Knackpunkt)</para>
1573 Es gibt mit f-tex eine weitere Alternative. Die Information ob Brutto oder Nettorechnung wird mit den Zahlarten
1574 verknüpft. Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben werden sollen, enden mit "_E" (für
1575 Endverbraucher). Falls identische Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt man diese einfach doppelt
1576 an (einmal mit der Namensendung "_E"). Gewinn:</para>
1579 <listitem><para>Die Entscheidung, ob Netopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste Verbunden.</para></listitem>
1580 <listitem><para>Die Default-Zahlart kann im Kundendatensatz hinterlegt werden, und man muss nicht mehr daran denken, "alle Preise
1581 Netto" auszuwählen.</para></listitem>
1582 <listitem><para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken reviediert werden,
1583 ohne dass sich der Auftragswert ändert.</para></listitem>
1587 <sect3 id="f-tex-lieferadressen">
1588 <title>Lieferadressen</title>
1590 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen im Adressfeld zum Einsatz. Wenn die
1591 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende Adressvariable eingesetzt. Wenn also die Lieferadresse in
1592 Straße, Hausnummer und Ort abweicht, müssen auch nur diese Felder in der Lieferadresse ausgefüllt werden. Für den Firmenname wird
1593 der Wert der Hauptadresse angezeigt.
1598 <sect2 id="Vorlagen-RB">
1601 <para>Vollständiger Dokumentensatz mit alternativem Design</para>
1605 <sect2 id="allgemeine-hinweise-zu-latex">
1606 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
1607 <para>In den allermeisten Installationen sollte drucken jetzt schon
1608 funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
1609 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
1610 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1615 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1616 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1617 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1621 <para>! Package inputenc Error: Unicode char \u8:... set up for
1622 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1623 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1624 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1625 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1626 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1630 <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
1631 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1632 Prüfen Sie den Namen in der Konfiguration (Standard:
1633 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1634 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1637 <para>Wenn sich das Problem nicht auf Grund der ausgabe im Webbrowser verifizieren lässt:</para>
1640 <para> editiere [kivitendo-home]/config/kivitendo.conf und ändere "keep_tmp_files" auf 1</para>
1641 <para><programlisting>keep_temp_files = 1;</programlisting></para>
1644 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
1647 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
1650 <para>wechsele in das users Verzeichnis von kivitendo</para>
1651 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
1654 <para>LaTeX Suchpfad anpassen:</para>
1655 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
1658 <para>Finde herraus welche Datei kivitendo beim letzten Durchlauf erstellt hat</para>
1659 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
1660 <para>Es sollte die letzte Datei ganz unten sein</para>
1663 <para>für besseren Hinweis auf Fehler texdatei nochmals übersetzen</para>
1664 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
1665 <para>in der *.tex datei nach dem Fehler suchen.</para>
1671 <sect1 id="OpenDocument-Vorlagen">
1672 <title>OpenDocument-Vorlagen</title>
1674 <para>kivitendo unterstützt die Verwendung von Vorlagen im
1675 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1676 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1677 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1678 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1679 <filename>config/kivitendo.conf</filename> die Variable
1680 <literal>opendocument</literal> im Abschnitt
1681 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1682 Dieses ist die Standardeinstellung.</para>
1684 <para>Weiterhin muss in der Datei
1685 <filename>config/kivitendo.conf</filename> die Variable
1686 <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf
1687 die Zeichenkodierung gesetzt werden, die auch bei der Speicherung der
1688 Daten in der Datenbank verwendet wird. Diese ist in den meisten Fällen
1691 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1692 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1693 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1694 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1695 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1696 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1698 <para>Nach der Installation müssen in der Datei
1699 <filename>config/kivitendo.conf</filename> zwei weitere Variablen
1700 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1701 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1702 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1703 enthalten. Beide stehen im Abschnitt
1704 <literal>applications</literal>.</para>
1706 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
1707 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1708 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1709 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1710 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1711 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1712 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1713 werden muss. Der Nachteil ist, dass diese Methode Python und die
1714 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1719 Für die Verbindung zu OpenOffice wird normalerweise der Python-Interpreter <filename>/usr/bin/python</filename> benutzt. Sollte
1720 dies nicht der richtige sein, so kann man mit zwei Konfigurationsvariablen entscheiden, welcher Python-Interpreter genutzt
1721 wird. Mit der Option <literal>python_uno</literal> aus dem Abschnitt <literal>applications</literal> wird der Interpreter selber
1722 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert <literal>/usr/bin/python</literal>.
1726 Zusätzlich ist es möglich, Pfade anzugeben, in denen Python neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
1727 z.B. falls sich diese in einem gesonderten OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
1728 <literal>python_uno_path</literal> und befindet sich im Abschnitt <literal>environment</literal>. Sie ist standardmäßig
1729 leer. Werden hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte voneinander getrennt werden. Der Inhalt wird an den
1730 Python-Interpreter über die Umgebungsvariable <literal>PYTHONPATH</literal> übergeben.
1734 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1735 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1736 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1737 Dokumentenvorlage enthalten sein und
1738 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1739 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1740 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1741 ebenfalls enthalten sein muss.</para>
1743 <para>Als letztes muss herausgefunden werden, welchen Namen
1744 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1745 gibt. Unter Debian ist dies momentan
1746 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1747 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1748 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1749 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1750 folgender Befehl auszuführen:</para>
1752 <para><literal>mv users/.openoffice.org2
1753 users/.openoffice</literal></para>
1755 <para>Dieses Verzeichnis, wie auch das komplette
1756 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1757 sein. Dieses wurde bereits erledigt (siehe <xref
1758 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1759 erneut überprüft werden, wenn die Konvertierung nach PDF
1763 <sect1 id="config.eur">
1764 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1767 <sect2 id="config.eur.introduction"
1768 xreflabel="Einführung in die Konfiguration zur EUR">
1769 <title>Einführung</title>
1771 <para>kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1772 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals noch <filename>config/lx_office.conf</filename>)
1773 befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden.</para>
1775 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1776 die Mandantendatenbank verschoben und dabei auch gleich in drei
1777 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1778 steuern lässt.</para>
1781 <sect2 id="config.eur.parameters"
1782 xreflabel="Konfigurationsparameter für EUR">
1783 <title>Konfigurationsparameter</title>
1785 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1786 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1790 <term><varname>profit_determination</varname></term>
1793 <para>Dieser Parameter legt die Berechnungsmethode für die
1794 Gewinnermittlung fest. Er enthält entweder
1795 <literal>balance</literal> für
1796 Betriebsvermögensvergleich/Bilanzierung oder
1797 <literal>income</literal> für die
1798 Einnahmen-Überschuss-Rechnung.</para>
1803 <term><varname>accounting_method</varname></term>
1806 <para>Dieser Parameter steuert die Buchungs- und
1807 Berechnungsmethoden für die Versteuerungsart. Er enthält
1808 entweder <literal>accrual</literal> für die Soll-Versteuerung
1809 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1814 <term><varname>inventory_system</varname></term>
1817 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1818 enthält entweder <literal>perpetual</literal> für die
1819 Bestandsmethode oder <literal>periodic</literal> für die
1820 Aufwandsmethode.</para>
1825 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1826 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1827 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1828 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1829 Bestandsmethode.</para>
1831 <para>Die Konfiguration "<varname>eur</varname>" unter
1832 <varname>[system]</varname> in der <link
1833 linkend="config.config-file">Konfigurationsdatei</link>
1834 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
1835 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1838 <sect2 id="config.eur.setting-parameters">
1839 <title>Festlegen der Parameter</title>
1841 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1842 der Admininstration können diese Optionen nun unabhängig voneinander
1843 eingestellt werden.</para>
1845 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1846 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1849 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1850 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
1851 angezeigt. Unter <guimenu>System</guimenu>
1852 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> können
1853 die Einstellungen auch geändert werden. Dabei ist zu beachten,
1854 dass eine Änderung vorhandene Daten so belässt und damit
1855 evtl. die Ergebnisse verfälscht. Dies gilt vor Allem für die
1856 Warenbuchungsmethode (siehe auch
1857 <link linkend="config.eur.inventory-system-perpetual">
1858 Bemerkungen zu Bestandsmethode</link>).</para>
1861 <sect2 id="config.eur.inventory-system-perpetual">
1862 <title>Bemerkungen zu Bestandsmethode</title>
1864 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1865 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
1866 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1867 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1868 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1869 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1870 Einkaufsrechnungen berechnet wird.</para>
1872 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1873 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1874 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1878 <sect2 id="config.eur.knonw-issues">
1879 <title>Bekannte Probleme</title>
1881 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1882 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1883 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1884 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1885 die Konfigurationsvariable
1886 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1889 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1890 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1894 <sect1 id="config.skr04-update-3804">
1895 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1897 <sect2 id="config.skr04-update-3804.introduction">
1898 <title>Einführung</title>
1900 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1901 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1902 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1903 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1904 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1905 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1906 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1907 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1908 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1909 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1910 Screenshots dargestellt.</para>
1912 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1913 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1914 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1915 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1918 <sect2 id="config.skr04-update-3804.create-chart">
1919 <title>Konto 3804 manuell anlegen</title>
1921 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
1922 anzulegen und zu konfigurieren. Zuerst wird in
1923 <guimenu>System</guimenu> ->
1924 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
1925 erfassen</guimenuitem> das Konto angelegt.</para>
1928 <screeninfo>Konto 3804 erfassen</screeninfo>
1932 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
1938 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
1939 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
1940 wie im folgenden Screenshot angezeigt anpassen.
1944 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
1948 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
1954 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
1955 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
1959 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
1963 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
1969 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
1970 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
1971 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
1972 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
1976 <screeninfo>Konto 4315 anpassen</screeninfo>
1980 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
1986 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
1987 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
1991 <screeninfo>Steuerliste vergleichen</screeninfo>
1995 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
2002 <sect1 id="config.client">
2003 <title>Einstellungen pro Mandant</title>
2005 <para>Einige Einstellungen können von einem Benutzer mit dem
2006 <link linkend="Zusammenhänge">Recht</link> "Administration
2007 (Für die Verwaltung der aktuellen Instanz aus einem Userlogin heraus)"
2008 gemacht werden. Diese Einstellungen sind dann für die aktuellen
2009 Mandanten-Datenbank gültig. Die Einstellungen sind
2010 unter <guimenu>System</guimenu>
2011 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
2013 <para>Bitte beachten Sie die Hinweise zu den einzelnen
2014 Einstellungen. Einige Einstellungen sollten nicht ohne Weiteres
2015 im laufenden Betrieb geändert werden (siehe
2016 auch <link linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
2017 Bestandsmethode</link>).</para>
2019 <para>Die Einstellungen <literal>show_bestbefore</literal>
2020 und <literal>payments_changeable</literal> aus dem
2021 Abschnitt <literal>features</literal> und die Einstellungen im
2022 Abschnitt <literal>datev_check</literal> (sofern schon vorhanden)
2023 der <link linkend="config.config-file">kivitendo-Konfigurationsdatei</link>
2024 werden bei einem Datenbankupdate einer älteren Version automatisch
2025 übernommen. Diese Einträge können danach aus der Konfigurationsdatei
2026 entfernt werden.</para>
2029 <sect1 id="kivitendo-ERP-verwenden">
2030 <title>kivitendo ERP verwenden</title>
2032 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
2033 folgender URL erreichbar:</para>
2036 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
2038 <para>Die Administrationsseite erreichen Sie unter:</para>
2041 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
2045 <chapter id="features" xreflabel="Features und Funktionen">
2046 <title>Features und Funktionen</title>
2048 <sect1 id="features.periodic-invoices"
2049 xreflabel="Wiedekehrende Rechnungen">
2050 <title>Wiederkehrende Rechnungen</title>
2052 <sect2 id="features.periodic-invoices.introduction"
2053 xreflabel="Einführung in wiederkehrende Rechnungen">
2054 <title>Einführung</title>
2056 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
2057 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
2058 Die konfigurierten Aufträge werden später automatisch in Rechnungen
2059 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
2060 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
2061 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
2062 wiederzufinden sind.</para>
2065 <sect2 id="features.periodic-invoices.configuration"
2066 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
2067 <title>Konfiguration</title>
2069 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
2070 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
2071 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
2072 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
2073 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
2076 <para>Folgende Parameter kann man konfigurieren:</para>
2083 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
2084 erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
2085 neuen Monats).</para>
2087 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
2088 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
2089 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
2090 nächsten Periodenwechsel für alle Perioden, seit der letzten
2091 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
2092 verhindern, muss man vorher das Startdatum neu setzen.</para>
2094 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
2095 erstellt. Man kann sich diese Aufträge aber gesondert in den
2096 Berichten anzeigen lassen.</para>
2101 <term>Periodizität</term>
2104 <para>Ob monatlich, quartalsweise oder jährlich auf neue
2105 Rechnungen überprüft werden soll. Für jede Periode seit dem
2106 Startdatum wird überprüft, ob für die Periode (beginnend immer
2107 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
2108 wurde. Unter Umständen können bei einem Startdatum in der
2109 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
2114 <term>Buchen auf</term>
2117 <para>Das Forderungskonto, in der Regel "Forderungen aus
2118 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
2119 Buchungsgruppen der betreffenden Waren.</para>
2124 <term>Startdatum</term>
2127 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
2133 <term>Enddatum</term>
2136 <para>ab wann keine Rechnungen mehr erstellt werden
2142 <term>Automatische Verlängerung um x Monate</term>
2145 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
2146 eingetragenen Enddatums weiterhin erstellt werden, so kann man
2147 hier die Anzahl der Monate eingeben, um die das Enddatum
2148 automatisch nach hinten geschoben wird.</para>
2153 <term>Drucken</term>
2156 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
2157 Rechnungen auch gleich ausdrucken lassen.</para>
2162 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
2163 Informationen zu den erstellten Rechnungen verschickt werden.
2164 Konfiguriert wird dies in der <link
2165 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
2166 <filename>config/kivitendo.conf</filename> im Abschnitt
2167 <varname>[periodic_invoices]</varname>.</para>
2170 <sect2 id="features.periodic-invoices.variables">
2171 <title>Spezielle Variablen</title>
2174 Um die erzeugten Rechnungen individualisieren zu können, werden beim Umwandeln des Auftrags in eine Rechnung einige speziell
2175 formatierte Variablen durch für die jeweils aktuelle Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B. den
2176 Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei die Syntax <literal><%variablenname%></literal>.
2180 Diese Variablen werden in den folgenden Elementen des Auftrags ersetzt:
2184 <listitem><para>Bemerkungen</para></listitem>
2185 <listitem><para>Interne Bemerkungen</para></listitem>
2186 <listitem><para>Vorgangsbezeichnung</para></listitem>
2187 <listitem><para>In den Beschreibungs- und Langtextfeldern aller Positionen</para></listitem>
2190 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
2194 <term><varname><%current_quarter%></varname>, <varname><%previous_quarter%></varname>, <varname><%next_quarter%></varname></term>
2198 Aktuelles, vorheriges und nächstes Quartal als Zahl zwischen <literal>1</literal> und <literal>4</literal>.
2204 <term><varname><%current_month%></varname>, <varname><%previous_month%></varname>, <varname><%next_month%></varname></term>
2208 Aktueller, vorheriger und nächster Monat als Zahl zwischen <literal>1</literal> und <literal>12</literal>.
2214 <term><varname><%current_month_long%></varname>, <varname><%previous_month_long%></varname>, <varname><%next_month_long%></varname></term>
2218 Aktueller, vorheriger und nächster Monat als Name (<literal>Januar</literal>, <literal>Februar</literal> etc.).
2224 <term><varname><%current_year%></varname>, <varname><%previous_year%></varname>, <varname><%next_year%></varname></term>
2228 Aktuelles, vorheriges und nächstes Jahr als vierstellige Jahreszahl (<literal>2013</literal> etc.).
2234 <term><varname><%period_start_date%></varname>, <varname><%period_end_date%></varname></term>
2238 Formatiertes Datum des ersten und letzten Tages im Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im ersten
2239 Quartal von 2013 wären dies der <literal>01.01.2013</literal> und <literal>31.03.2013</literal>).
2246 <sect2 id="features.periodic-invoices.reports">
2247 <title>Auflisten</title>
2249 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
2250 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
2251 Rechnungen inaktiv", mit denen man sich einen Überglick über die
2252 wiederkehrenden Rechnungen verschaffen kann.</para>
2255 <sect2 id="features.periodic-invoices.task-server">
2256 <title>Erzeugung der eigentlichen Rechnungen</title>
2258 <para>Die zeitliche und periodische Überprüfung, ob eine
2259 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
2260 durch den <link linkend="config.task-server">Taskserver</link>, einen
2261 externen Dienst, der automatisch beim Start des Servers gestartet
2262 werden sollte.</para>
2265 <sect2 id="features.periodic-invoices.create-for-current-month">
2266 <title>Erste Rechnung für aktuellen Monat erstellen</title>
2268 <para>Will man im laufenden Monat eine monatlich wiederkehrende
2269 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
2270 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
2271 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
2272 generiert hat. Alternativ setzt man das Startdatum auf den
2273 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
2274 manuell über den Workflow.</para>
2278 <sect1 id="dokumentenvorlagen-und-variablen">
2279 <title>Dokumentenvorlagen und verfügbare Variablen</title>
2281 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
2282 <title>Einführung</title>
2284 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
2285 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
2286 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
2287 <function><%variablenname%></function> verwendet wird. Für
2288 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
2290 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
2292 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
2293 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
2294 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
2295 alle Vorlagenarten.</para>
2297 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
2298 verfügbar als hier aufgelistet werden. Die meisten davon können
2299 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
2300 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
2301 diese wie folgt erhalten werden:</para>
2305 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
2306 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
2310 <para>In <filename>Form.pm</filename> die Funktion
2311 <function>parse_template</function> suchen und hier die Zeile
2312 <command>print(STDERR Dumper($self));</command> einfügen.</para>
2316 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
2317 ein PDF für eine Rechnung erzeugen.</para>
2321 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
2322 der Variablen <varname>$self</varname> in der Form <varname>'key'
2323 => 'value',</varname>. Alle <varname>key</varname>s sind
2329 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
2330 <title>Variablen ausgeben</title>
2332 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
2333 Tags geschrieben werden, also z.B.
2334 <varname><%variablenname%></varname>.</para>
2336 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
2337 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
2338 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
2339 werden die folgenden Flags unterstützt:</para>
2343 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
2344 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
2345 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
2346 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
2350 <para><option>NOESCAPE</option> unterdrückt das Escapen von
2351 Sonderzeichen für die Vorlagensprache. Wenn also in einer
2352 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
2353 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
2354 ist dieses Flag sinnvoll.</para>
2358 <para>Beispiel:</para>
2360 <programlisting><%quototal NOFORMAT%></programlisting>
2363 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
2364 <title>Verwendung in Druckbefehlen</title>
2366 <para>In der Admininstration können Drucker definiert werden. Auch im
2367 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
2368 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
2369 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
2370 <function>`...`</function> nicht zu unerwünschtem Verhalten
2373 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
2374 für das die Telefonnummer eines Ansprechpartners als Teil der
2375 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
2376 z.B. wie folgt aussehen:</para>
2378 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
2381 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
2382 xreflabel="Anfang und Ende der Tags verändern">
2383 <title>Anfang und Ende der Tags verändern</title>
2385 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
2386 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
2387 Prozentzeichen und dem Größerzeichen endet, beispielsweise
2388 <function><%customer%></function>. Da diese Form aber z.B. in
2389 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
2390 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
2391 Stil umgestellt werden.</para>
2393 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
2394 Format gültigen Kommentarzeichen anfangen, dann
2395 <function>config:</function> enthalten, die entsprechende Option
2396 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
2397 enden. Beispiel für LaTeX:</para>
2399 <programlisting>% config: tag-style=($ $)</programlisting>
2401 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
2402 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
2403 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
2405 <programlisting><!-- config: tag-style=($ $) --></programlisting>
2408 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
2409 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
2411 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
2412 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
2413 "<filename>.ext</filename>" geeignet zu ersetzen:
2414 "<filename>.tex</filename>" für LaTeX-Vorlagen und
2415 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
2419 <term><filename>bin_list.ext</filename></term>
2422 <para>Lagerliste</para>
2427 <term><filename>check.ext</filename></term>
2435 <term><filename>invoice.ext</filename></term>
2438 <para>Rechnung</para>
2443 <term><filename>packing_list.ext</filename></term>
2446 <para>Packliste</para>
2451 <term><filename>pick_list.ext</filename></term>
2454 <para>Sammelliste</para>
2459 <term><filename>purchase_delivery_order.ext</filename></term>
2462 <para>Lieferschein (Einkauf)</para>
2467 <term><filename>purcharse_order.ext</filename></term>
2470 <para>Bestellung an Lieferanten</para>
2475 <term><filename>request_quotation.ext</filename></term>
2478 <para>Anfrage an Lieferanten</para>
2483 <term><filename>sales_delivery_order.ext</filename></term>
2486 <para>Lieferschein (Verkauf)</para>
2491 <term><filename>sales_order.ext</filename></term>
2494 <para>Bestellung</para>
2499 <term><filename>sales_quotation.ext</filename></term>
2502 <para>Angebot an Kunden</para>
2507 <term><filename>zahlungserinnerung.ext</filename></term>
2510 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2515 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2518 <para>Rechnung über Mahngebühren (Dateiname im Programm
2519 konfigurierbar)</para>
2525 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2526 <title>Sprache, Drucker und E-Mail</title>
2528 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2529 eingearbeitet. So wird aus der Vorlage
2530 <filename>sales_order.ext</filename> bei Sprache
2531 <function>de</function> und Druckerkürzel <function>lpr2</function>
2532 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2533 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2534 bekommen dann noch das Kürzel <filename>_email</filename>, der
2535 vollständige Vorlagenname wäre dann
2536 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2537 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2538 werden. Diese wird verwendet, wenn keine der anderen Varianten
2539 gefunden wird.</para>
2541 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2542 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2543 verschickt wird, ist:</para>
2547 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2551 <para><filename>sales_order_de_lpr2.tex</filename></para>
2555 <para><filename>sales_order.tex</filename></para>
2559 <para><filename>default.tex</filename></para>
2563 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2564 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2566 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2569 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2570 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2573 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2574 xreflabel="Metainformationen zur angeforderten Vorlage">
2575 <title>Metainformationen zur angeforderten Vorlage</title>
2577 <para>Diese Variablen liefern Informationen darüber welche Variante
2578 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2579 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2580 Formulare einbinden möchten.</para>
2584 <term><varname>template_meta.formname</varname></term>
2587 <para>Basisname der Vorlage. Identisch mit der <link
2588 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2589 zu den Dateinamen</link> ohne die Erweiterung. Ein
2590 Verkaufsauftrag enthält hier
2591 <constant>sales_order</constant>.</para>
2596 <term><varname>template_meta.language.description</varname></term>
2599 <para>Beschreibung der verwendeten Sprache</para>
2604 <term><varname>template_meta.language.template_code</varname></term>
2607 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2608 Kürzel das im Dateinamen verwendetet wird.</para>
2613 <term><varname>template_meta.language.output_numberformat</varname></term>
2616 <para>Zahlenformat der verwendeten Sprache in der Form
2617 "<constant>1.000,00</constant>". Experimentell! Nur
2618 interessant für Vorlagen die mit unformatierten Werten
2624 <term><varname>template_meta.language.output_dateformat</varname></term>
2627 <para>Datumsformat der verwendeten Sprache in der Form
2628 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2629 interessant für Vorlagen die mit unformatierten Werten
2635 <term><varname>template_meta.format</varname></term>
2638 <para>Das angeforderte Format. Kann im Moment die Werte
2639 <constant>pdf</constant>, <constant>postscript</constant>,
2640 <constant>html</constant>, <constant>opendocument</constant>,
2641 <constant>opendocument_pdf</constant> und
2642 <constant>excel</constant> enthalten.</para>
2647 <term><varname>template_meta.extension</varname></term>
2650 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2651 <constant>format</constant> entschieden.</para>
2656 <term><varname>template_meta.media</varname></term>
2659 <para>Ausgabemedium. Kann zur Zeit die Werte
2660 <constant>screen</constant> für Bildschirm,
2661 <constant>email</constant> für E-Mmail (triggert das
2662 <constant>_email</constant> Kürzel im Dateinamen),
2663 <constant>printer</constant> für Drucker, und
2664 <constant>queue</constant> für Warteschlange enthalten.</para>
2669 <term><varname>template_meta.printer.description</varname></term>
2672 <para>Beschreibung des ausgewählten Druckers</para>
2677 <term><varname>template_meta.printer.template_code</varname></term>
2680 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2681 dem Kürzel das im Dateinamen verwendetet wird.</para>
2686 <term><varname>template_meta.tmpfile</varname></term>
2689 <para>Datei-Prefix für temporäre Dateien.</para>
2695 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2696 <title>Stammdaten von Kunden und Lieferanten</title>
2700 <term><varname>account_number</varname></term>
2703 <para>Kontonummer</para>
2708 <term><varname>bank</varname></term>
2711 <para>Name der Bank</para>
2716 <term><varname>bank_code</varname></term>
2719 <para>Bankleitzahl</para>
2724 <term><varname>bic</varname></term>
2727 <para>Bank-Identifikations-Code (Bank Identifier Code,
2733 <term><varname>business</varname></term>
2736 <para>Kunden-/Lieferantentyp</para>
2741 <term><varname>city</varname></term>
2749 <term><varname>contact</varname></term>
2752 <para>Kontakt</para>
2757 <term><varname>country</varname></term>
2765 <term><varname>c_vendor_id</varname></term>
2768 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
2773 <term><varname>v_customer_id</varname></term>
2776 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
2781 <term><varname>cp_email</varname></term>
2784 <para>Email des Ansprechpartners</para>
2789 <term><varname>cp_givenname</varname></term>
2792 <para>Vorname des Ansprechpartners</para>
2797 <term><varname>cp_greeting</varname></term>
2800 <para>Anrede des Ansprechpartners</para>
2805 <term><varname>cp_name</varname></term>
2808 <para>Name des Ansprechpartners</para>
2813 <term><varname>cp_phone1</varname></term>
2816 <para>Telefonnummer 1 des Ansprechpartners</para>
2821 <term><varname>cp_phone2</varname></term>
2824 <para>Telefonnummer 2 des Ansprechpartners</para>
2829 <term><varname>cp_title</varname></term>
2832 <para>Titel des Ansprechpartners</para>
2837 <term><varname>creditlimit</varname></term>
2840 <para>Kreditlimit</para>
2845 <term><varname>customeremail</varname></term>
2848 <para>Email des Kunden; nur für Kunden</para>
2853 <term><varname>customerfax</varname></term>
2856 <para>Faxnummer des Kunden; nur für Kunden</para>
2861 <term><varname>customernotes</varname></term>
2864 <para>Bemerkungen beim Kunden; nur für Kunden</para>
2869 <term><varname>customernumber</varname></term>
2872 <para>Kundennummer; nur für Kunden</para>
2877 <term><varname>customerphone</varname></term>
2880 <para>Telefonnummer des Kunden; nur für Kunden</para>
2885 <term><varname>discount</varname></term>
2893 <term><varname>email</varname></term>
2896 <para>Emailadresse</para>
2901 <term><varname>fax</varname></term>
2904 <para>Faxnummer</para>
2909 <term><varname>homepage</varname></term>
2912 <para>Homepage</para>
2917 <term><varname>iban</varname></term>
2920 <para>Internationale Kontonummer (International Bank Account
2921 Number, IBAN)</para>
2926 <term><varname>language</varname></term>
2929 <para>Sprache</para>
2934 <term><varname>name</varname></term>
2937 <para>Firmenname</para>
2942 <term><varname>payment_description</varname></term>
2945 <para>Name der Zahlart</para>
2950 <term><varname>payment_terms</varname></term>
2953 <para>Zahlungskonditionen</para>
2958 <term><varname>phone</varname></term>
2961 <para>Telefonnummer</para>
2966 <term><varname>shiptocity</varname></term>
2969 <para>Stadt (Lieferadresse) <link
2970 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2975 <term><varname>shiptocontact</varname></term>
2978 <para>Kontakt (Lieferadresse) <link
2979 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2984 <term><varname>shiptocountry</varname></term>
2987 <para>Land (Lieferadresse) <link
2988 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2993 <term><varname>shiptodepartment1</varname></term>
2996 <para>Abteilung 1 (Lieferadresse) <link
2997 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3002 <term><varname>shiptodepartment2</varname></term>
3005 <para>Abteilung 2 (Lieferadresse) <link
3006 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3011 <term><varname>shiptoemail</varname></term>
3014 <para>Email (Lieferadresse) <link
3015 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3020 <term><varname>shiptofax</varname></term>
3023 <para>Fax (Lieferadresse) <link
3024 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3029 <term><varname>shiptoname</varname></term>
3032 <para>Firmenname (Lieferadresse) <link
3033 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3038 <term><varname>shiptophone</varname></term>
3041 <para>Telefonnummer (Lieferadresse) <link
3042 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3047 <term><varname>shiptostreet</varname></term>
3050 <para>Straße und Hausnummer (Lieferadresse) <link
3051 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3056 <term><varname>shiptozipcode</varname></term>
3059 <para>Postleitzahl (Lieferadresse) <link
3060 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3065 <term><varname>street</varname></term>
3068 <para>Straße und Hausnummer</para>
3073 <term><varname>taxnumber</varname></term>
3076 <para>Steuernummer</para>
3081 <term><varname>ustid</varname></term>
3084 <para>Umsatzsteuer-Identifikationsnummer</para>
3089 <term><varname>vendoremail</varname></term>
3092 <para>Email des Lieferanten; nur für Lieferanten</para>
3097 <term><varname>vendorfax</varname></term>
3100 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
3105 <term><varname>vendornotes</varname></term>
3108 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
3113 <term><varname>vendornumber</varname></term>
3116 <para>Lieferantennummer; nur für Lieferanten</para>
3121 <term><varname>vendorphone</varname></term>
3124 <para>Telefonnummer des Lieferanten; nur für
3130 <term><varname>zipcode</varname></term>
3133 <para>Postleitzahl</para>
3138 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
3139 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
3140 Stammdaten nicht eingetragen, so haben die Variablen
3141 <varname>shipto*</varname> den gleichen Wert wie die die
3142 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
3143 einige <varname>shipto*</varname>-Variablen so nicht in den
3144 Stammdaten wiederfinden sondern schlicht Kopien der
3145 Lieferdatenvariablen sind (z.B.
3146 <varname>shiptocontact</varname>).</para>
3150 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
3151 <title>Informationen über den Bearbeiter</title>
3155 <term><varname>employee_address</varname></term>
3158 <para>Adressfeld</para>
3163 <term><varname>employee_businessnumber</varname></term>
3166 <para>Firmennummer</para>
3171 <term><varname>employee_company</varname></term>
3174 <para>Firmenname</para>
3179 <term><varname>employee_co_ustid</varname></term>
3182 <para>Usatzsteuer-Identifikationsnummer</para>
3187 <term><varname>employee_duns</varname></term>
3190 <para>DUNS-Nummer</para>
3195 <term><varname>employee_email</varname></term>
3203 <term><varname>employee_fax</varname></term>
3211 <term><varname>employee_name</varname></term>
3214 <para>voller Name</para>
3219 <term><varname>employee_signature</varname></term>
3222 <para>Signatur</para>
3227 <term><varname>employee_taxnumber</varname></term>
3230 <para>Steuernummer</para>
3235 <term><varname>employee_tel</varname></term>
3238 <para>Telefonnummer</para>
3244 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
3245 <title>Informationen über den Bearbeiter</title>
3249 <term><varname>salesman_address</varname></term>
3252 <para>Adressfeld</para>
3257 <term><varname>salesman_businessnumber</varname></term>
3260 <para>Firmennummer</para>
3265 <term><varname>salesman_company</varname></term>
3268 <para>Firmenname</para>
3273 <term><varname>salesman_co_ustid</varname></term>
3276 <para>Usatzsteuer-Identifikationsnummer</para>
3281 <term><varname>salesman_duns</varname></term>
3284 <para>DUNS-Nummer</para>
3289 <term><varname>salesman_email</varname></term>
3297 <term><varname>salesman_fax</varname></term>
3305 <term><varname>salesman_name</varname></term>
3308 <para>voller Name</para>
3313 <term><varname>salesman_signature</varname></term>
3316 <para>Signatur</para>
3321 <term><varname>salesman_taxnumber</varname></term>
3324 <para>Steuernummer</para>
3329 <term><varname>salesman_tel</varname></term>
3332 <para>Telefonnummer</para>
3338 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
3339 <title>Variablen für die einzelnen Steuern</title>
3343 <term><varname>tax</varname></term>
3351 <term><varname>taxbase</varname></term>
3354 <para>zu versteuernder Betrag</para>
3359 <term><varname>taxdescription</varname></term>
3362 <para>Name der Steuer</para>
3367 <term><varname>taxrate</varname></term>
3370 <para>Steuersatz</para>
3377 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
3378 <title>Variablen in Rechnungen</title>
3380 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
3381 <title>Allgemeine Variablen</title>
3385 <term><varname>creditremaining</varname></term>
3388 <para>Verbleibender Kredit</para>
3393 <term><varname>currency</varname></term>
3396 <para>Währung</para>
3401 <term><varname>cusordnumber</varname></term>
3404 <para>Bestellnummer beim Kunden</para>
3409 <term><varname>deliverydate</varname></term>
3412 <para>Lieferdatum</para>
3417 <term><varname>duedate</varname></term>
3420 <para>Fälligkeitsdatum</para>
3425 <term><varname>globalprojectnumber</varname></term>
3428 <para>Projektnummer des ganzen Beleges</para>
3433 <term><varname>globalprojectdescription</varname></term>
3436 <para>Projekbeschreibung des ganzen Beleges</para>
3441 <term><varname>intnotes</varname></term>
3444 <para>Interne Bemerkungen</para>
3449 <term><varname>invdate</varname></term>
3452 <para>Rechnungsdatum</para>
3457 <term><varname>invnumber</varname></term>
3460 <para>Rechnungsnummer</para>
3465 <term><varname>invtotal</varname></term>
3468 <para>gesamter Rechnungsbetrag</para>
3473 <term><varname>notes</varname></term>
3476 <para>Bemerkungen der Rechnung</para>
3481 <term><varname>orddate</varname></term>
3484 <para>Auftragsdatum</para>
3489 <term><varname>ordnumber</varname></term>
3492 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3493 erstellt wurde</para>
3498 <term><varname>payment_description</varname></term>
3501 <para>Name der Zahlart</para>
3506 <term><varname>payment_terms</varname></term>
3509 <para>Zahlungskonditionen</para>
3514 <term><varname>quodate</varname></term>
3517 <para>Angebotsdatum</para>
3522 <term><varname>quonumber</varname></term>
3525 <para>Angebotsnummer</para>
3530 <term><varname>shippingpoint</varname></term>
3533 <para>Versandort</para>
3538 <term><varname>shipvia</varname></term>
3541 <para>Transportmittel</para>
3546 <term><varname>subtotal</varname></term>
3549 <para>Zwischensumme aller Posten ohne Steuern</para>
3554 <term><varname>total</varname></term>
3557 <para>Restsumme der Rechnung (Summe abzüglich bereits
3558 bezahlter Posten)</para>
3563 <term><varname>transaction_description</varname></term>
3566 <para>Vorgangsbezeichnung</para>
3571 <term><varname>transdate</varname></term>
3574 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3575 erstellt wurde</para>
3581 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3582 <title>Variablen für jeden Posten auf der Rechnung</title>
3586 <term><varname>bin</varname></term>
3589 <para>Stellage</para>
3594 <term><varname>description</varname></term>
3597 <para>Artikelbeschreibung</para>
3602 <term><varname>discount</varname></term>
3605 <para>Rabatt als Betrag</para>
3610 <term><varname>discount_sub</varname></term>
3613 <para>Zwischensumme mit Rabatt</para>
3618 <term><varname>drawing</varname></term>
3621 <para>Zeichnung</para>
3626 <term><varname>ean</varname></term>
3629 <para>EAN-Code</para>
3634 <term><varname>image</varname></term>
3642 <term><varname>linetotal</varname></term>
3645 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3650 <term><varname>longdescription</varname></term>
3653 <para>Langtext</para>
3658 <term><varname>microfiche</varname></term>
3661 <para>Mikrofilm</para>
3666 <term><varname>netprice</varname></term>
3669 <para>Nettopreis</para>
3674 <term><varname>nodiscount_linetotal</varname></term>
3677 <para>Zeilensumme ohne Rabatt</para>
3682 <term><varname>nodiscount_sub</varname></term>
3685 <para>Zwischensumme ohne Rabatt</para>
3690 <term><varname>number</varname></term>
3693 <para>Artikelnummer</para>
3698 <term><varname>ordnumber_oe</varname></term>
3701 <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
3702 aus einem Sammelauftrag erstellt wurde</para>
3707 <term><varname>p_discount</varname></term>
3710 <para>Rabatt in Prozent</para>
3715 <term><varname>partnotes</varname></term>
3718 <para>Die beim Artikel gespeicherten Bemerkungen</para>
3723 <term><varname>partsgroup</varname></term>
3726 <para>Warengruppe</para>
3731 <term><varname>price_factor</varname></term>
3734 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
3740 <term><varname>price_factor_name</varname></term>
3743 <para>Der Name des Preisfaktors, sofern einer eingestellt
3749 <term><varname>projectnumber</varname></term>
3752 <para>Projektnummer</para>
3757 <term><varname>projectdescription</varname></term>
3760 <para>Projektbeschreibung</para>
3765 <term><varname>qty</varname></term>
3773 <term><varname>reqdate</varname></term>
3776 <para>Lieferdatum</para>
3781 <term><varname>runningnumber</varname></term>
3784 <para>Position auf der Rechnung (1, 2, 3...)</para>
3789 <term><varname>sellprice</varname></term>
3792 <para>Verkaufspreis</para>
3797 <term><varname>serialnumber</varname></term>
3800 <para>Seriennummer</para>
3805 <term><varname>tax_rate</varname></term>
3808 <para>Steuersatz</para>
3813 <term><varname>transdate_oe</varname></term>
3816 <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
3817 aus einem Sammelauftrag erstellt wurde</para>
3822 <term><varname>unit</varname></term>
3825 <para>Einheit</para>
3830 <term><varname>weight</varname></term>
3833 <para>Gewicht</para>
3838 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
3839 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
3840 einer <function>foreach</function>-Schleife ausgegeben werden, da
3841 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
3842 können. Die Variablen dafür lauten:</para>
3846 <term><varname>make</varname></term>
3849 <para>Lieferant</para>
3854 <term><varname>model</varname></term>
3857 <para>Lieferantenartikelnummer</para>
3863 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
3864 <title>Variablen für die einzelnen Zahlungseingänge</title>
3868 <term><varname>payment</varname></term>
3876 <term><varname>paymentaccount</varname></term>
3884 <term><varname>paymentdate</varname></term>
3892 <term><varname>paymentmemo</varname></term>
3900 <term><varname>paymentsource</varname></term>
3909 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
3910 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
3912 <para>Die vom Benutzer definierten Variablen für Kunden und
3913 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
3914 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
3915 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
3916 Variablennamen zusammen.</para>
3918 <para>Beispiel: Der Benutzer hat eine Variable namens
3919 <varname>number_of_employees</varname> definiert, die die Anzahl der
3920 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
3921 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
3926 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
3927 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
3929 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
3930 <title>Namen der Vorlagen</title>
3932 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
3933 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
3934 Erstellung einer Rechnung über die Mahngebühren und Zinsen
3935 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
3936 Vorlagenname für diese Mahnstufe mit dem Zusatz
3937 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
3938 für die ausgewählte Sprache und den ausgewählten Drucker
3942 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
3943 <title>Allgemeine Variablen in Mahnungen</title>
3945 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3946 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3947 Kunden stehen als Variablen <varname>name</varname>,
3948 <varname>street</varname>, <varname>zipcode</varname>,
3949 <varname>city</varname>, <varname>country</varname>,
3950 <varname>department_1</varname>, <varname>department_2</varname>,
3951 und <varname>email</varname> zur Verfügung.</para>
3953 <para>Weitere Variablen beinhalten:</para>
3957 <term><varname>dunning_date</varname></term>
3960 <para>Datum der Mahnung</para>
3965 <term><varname>dunning_duedate</varname></term>
3968 <para>Fälligkeitsdatum für diese Mahhnung</para>
3973 <term><varname>dunning_id</varname></term>
3976 <para>Mahnungsnummer</para>
3981 <term><varname>fee</varname></term>
3984 <para>Kummulative Mahngebühren</para>
3989 <term><varname>interest_rate</varname></term>
3992 <para>Zinssatz per anno in Prozent</para>
3997 <term><varname>total_amount</varname></term>
4000 <para>Gesamter noch zu zahlender Betrag als
4001 <function>fee</function> + <function>total_interest</function>
4002 + <function>total_open_amount</function></para>
4007 <term><varname>total_interest</varname></term>
4010 <para>Zinsen per anno über alle Rechnungen</para>
4015 <term><varname>total_open_amount</varname></term>
4018 <para>Summe über alle offene Beträge der Rechnungen</para>
4024 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
4025 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
4029 <term><varname>dn_amount</varname></term>
4032 <para>Rechnungssumme (brutto)</para>
4037 <term><varname>dn_duedate</varname></term>
4040 <para>Originales Fälligkeitsdatum der Rechnung</para>
4045 <term><varname>dn_dunning_date</varname></term>
4048 <para>Datum der Mahnung</para>
4053 <term><varname>dn_dunning_duedate</varname></term>
4056 <para>Fälligkeitsdatum der Mahnung</para>
4061 <term><varname>dn_fee</varname></term>
4064 <para>Kummulative Mahngebühr</para>
4069 <term><varname>dn_interest</varname></term>
4072 <para>Zinsen per anno für diese Rechnung</para>
4077 <term><varname>dn_invnumber</varname></term>
4080 <para>Rechnungsnummer</para>
4085 <term><varname>dn_linetotal</varname></term>
4088 <para>Noch zu zahlender Betrag (ergibt sich aus
4089 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
4090 + <varname>dn_interest</varname>)</para>
4095 <term><varname>dn_netamount</varname></term>
4098 <para>Rechnungssumme (netto)</para>
4103 <term><varname>dn_open_amount</varname></term>
4106 <para>Offener Rechnungsbetrag</para>
4111 <term><varname>dn_ordnumber</varname></term>
4114 <para>Bestellnummer</para>
4119 <term><varname>dn_transdate</varname></term>
4122 <para>Rechnungsdatum</para>
4127 <term><varname>dn_curr</varname></term>
4130 <para>Währung, in der die Rechnung erstellt wurde. (Die
4131 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
4137 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
4138 <title>Variablen in automatisch erzeugten Rechnungen über
4139 Mahngebühren</title>
4141 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4142 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4143 Kunden stehen als Variablen <varname>name</varname>,
4144 <varname>street</varname>, <varname>zipcode</varname>,
4145 <varname>city</varname>, <varname>country</varname>,
4146 <varname>department_1</varname>, <varname>department_2</varname>,
4147 und <varname>email</varname> zur Verfügung.</para>
4149 <para>Weitere Variablen beinhalten:</para>
4153 <term><varname>duedate</varname></term>
4156 <para>Fälligkeitsdatum der Rechnung</para>
4161 <term><varname>dunning_id</varname></term>
4164 <para>Mahnungsnummer</para>
4169 <term><varname>fee</varname></term>
4172 <para>Mahngebühren</para>
4177 <term><varname>interest</varname></term>
4185 <term><varname>invamount</varname></term>
4188 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
4189 <varname>interest</varname>)</para>
4194 <term><varname>invdate</varname></term>
4197 <para>Rechnungsdatum</para>
4202 <term><varname>invnumber</varname></term>
4205 <para>Rechnungsnummer</para>
4212 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
4213 <title>Variablen in anderen Vorlagen</title>
4216 <title>Einführung</title>
4218 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
4219 Rechnung. Allerdings heißen die Variablen, die mit
4220 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
4221 fangen sie mit <varname>quo</varname> für "quotation" an:
4222 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
4223 wiederum fangen sie mit <varname>ord</varname> für "order" an:
4224 <varname>ordnumber</varname> für Bestellnummer etc.</para>
4226 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
4227 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
4228 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
4229 Vorlage keine Bedeutung haben oder noch nicht belegt sein
4232 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
4233 in Rechnungen aufgeführt.</para>
4236 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
4237 <title>Angebote und Preisanfragen</title>
4241 <term><varname>quonumber</varname></term>
4244 <para>Angebots- bzw. Anfragenummer</para>
4249 <term><varname>reqdate</varname></term>
4252 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
4253 Preisanfragen)</para>
4258 <term><varname>transdate</varname></term>
4261 <para>Angebots- bzw. Anfragedatum</para>
4267 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
4268 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
4272 <term><varname>ordnumber</varname></term>
4275 <para>Auftragsnummer</para>
4280 <term><varname>reqdate</varname></term>
4283 <para>Lieferdatum</para>
4288 <term><varname>transdate</varname></term>
4291 <para>Auftragsdatum</para>
4297 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
4298 <title>Lieferscheine (Verkauf und Einkauf)</title>
4302 <term><varname>cusordnumber</varname></term>
4305 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
4306 des Lieferanten (im Einkauf)</para>
4311 <term><varname>donumber</varname></term>
4314 <para>Lieferscheinnummer</para>
4319 <term><varname>transdate</varname></term>
4322 <para>Lieferscheindatum</para>
4327 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
4328 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
4329 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
4330 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
4331 <function>foreach</function>-Schleife ausgegeben werden. Diese
4332 Variablen sind:</para>
4336 <term><varname>si_bin</varname></term>
4339 <para>Lagerplatz</para>
4344 <term><varname>si_chargenumber</varname></term>
4347 <para>Chargennummer</para>
4352 <term><varname>si_bestbefore</varname></term>
4355 <para>Mindesthaltbarkeit</para>
4360 <term><varname>si_number</varname></term>
4363 <para>Artikelnummer</para>
4368 <term><varname>si_qty</varname></term>
4371 <para>Anzahl bzw. Menge</para>
4376 <term><varname>si_runningnumber</varname></term>
4379 <para>Positionsnummer (1, 2, 3 etc)</para>
4384 <term><varname>si_unit</varname></term>
4387 <para>Einheit</para>
4392 <term><varname>si_warehouse</varname></term>
4401 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
4402 <title>Variablen für Sammelrechnung</title>
4406 <term><varname>c0total</varname></term>
4409 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
4415 <term><varname>c30total</varname></term>
4418 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
4419 und < 60 Tage</para>
4424 <term><varname>c60total</varname></term>
4427 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
4428 und < 90 Tage</para>
4433 <term><varname>c90total</varname></term>
4436 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
4442 <term><varname>total</varname></term>
4445 <para>Gesamtbetrag aller Rechnungen</para>
4450 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
4454 <term><varname>invnumber</varname></term>
4457 <para>Rechnungsnummer</para>
4462 <term><varname>invdate</varname></term>
4465 <para>Rechnungsdatum</para>
4470 <term><varname>duedate</varname></term>
4473 <para>Fälligkeitsdatum</para>
4478 <term><varname>amount</varname></term>
4481 <para>Summe der Rechnung</para>
4486 <term><varname>open</varname></term>
4489 <para>Noch offener Betrag der Rechnung</para>
4494 <term><varname>c0</varname></term>
4497 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4503 <term><varname>c30</varname></term>
4506 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4512 <term><varname>c60</varname></term>
4515 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4521 <term><varname>c90</varname></term>
4524 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4532 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4533 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4535 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4536 <title>Einfürhung</title>
4538 <para>Der Parser kennt neben den Variablen einige weitere
4539 Konstrukte, die gesondert behandelt werden. Diese sind wie
4540 Variablennamen in spezieller Weise markiert:
4541 <command><%anweisung%> ... <%end%></command></para>
4543 <para>Anmerkung zum <command><%end%></command>: Der besseren
4544 Verständlichkeit halber kann man nach dem <command>end</command>
4545 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4546 Anweisung (z.B. <command>if</command> oder
4547 <command>foreach</command>) damit abgeschlossen wird.</para>
4549 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4550 <command><%if type == "sales_quotation"%></command>, so könnte
4551 er mit <command><%end%></command> genauso abgeschlossen werden
4552 wie mit <command><%end if%></command> oder auch
4553 <command><%end type == "sales_quotation"%></command>.</para>
4556 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4557 <title>Der if-Block</title>
4559 <programlisting><%if variablenname%>
4561 <%end%></programlisting>
4563 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4564 und dem "end" werden nur ausgegeben, wenn die Variable
4565 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4567 <para>Handelt es sich bei der benannten Variable um ein Array, also um einen Variablennamen, über den man mit
4568 <command><%foreach variablenname%></command> iteriert, so wird mit diesem Konstrukt darauf getestet, ob das Array Elemente
4569 enthält. Somit würde im folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt ihrer Überschrift "Zahlungseingänge"
4570 ausgegeben, wenn tatsächlich welche getätigt wurden:</para>
4572 <programlisting><%if payment%>
4574 <%foreach payment%>
4575 Am <%paymentdate%>: <%payment%> €
4576 <%end foreach%>
4577 <%end if%></programlisting>
4579 <para>Die Bedingung kann auch negiert werden, indem das Wort
4580 <function>not</function> nach dem <filename>if</filename> verwendet
4581 wird. Beispiel:</para>
4583 <programlisting><%if not cp_greeting%>
4585 <%end%></programlisting>
4587 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4588 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4589 einer Variablen mit einer festen Zeichenkette oder einer anderen
4590 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4591 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4592 die rechte Seite des Vergleichsoperators in Anführungszeichen
4593 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4594 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4597 <programlisting><%if var1 == "Wert"%></programlisting>
4599 <para>Testet die Variable <varname>var1</varname> auf
4600 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4601 Mittels <function>!=</function> anstelle von <function>==</function>
4602 würde auf Ungleichheit getestet.</para>
4604 <programlisting><%if var1 == var2%></programlisting>
4606 <para>Testet die Variable <varname>var1</varname> auf
4607 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4608 <function>!=</function> anstelle von <function>==</function> würde
4609 auf Ungleichheit getestet.</para>
4611 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4612 auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
4613 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4614 dieselbe Syntax wie oben nur mit <function>=~</function> und
4615 <function>!~</function> als Vergleichsoperatoren.</para>
4617 <para>Beispiel für einen Test, ob die Variable
4618 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4619 <constant>schwierig</constant> enthält:</para>
4621 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4624 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4625 <title>Der foreach-Block</title>
4627 <programlisting><%foreach variablenname%>
4629 <%end%></programlisting>
4631 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4632 wie das Perl-Array der Variablen <varname>variablenname</varname>
4633 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4634 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4635 benutzt. In jedem Durchlauf werden die <link
4636 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4637 Variablen</link> jeweils auf den Wert für die aktuelle Position
4640 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
4642 <programlisting><%foreach number%>
4643 Position: <%runningnumber%>
4644 Anzahl: <%qty%>
4645 Artikelnummer: <%number%>
4646 Beschreibung: <%description%>
4648 <%end%></programlisting>
4650 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
4651 <function><%foreach%></function>-Block innerhalb einer
4652 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
4653 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
4654 Inhalt zwischen <function><%foreach%></function> und
4655 <function><%end%></function> wiederholt, nicht aber die
4656 komplette Zeile, in der er steht.</para>
4660 <sect2 id="dokumentenvorlagen-und-variablen.markup">
4661 <title>Markup-Code zur Textformatierung innerhalb von
4664 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
4665 anders formatiert haben möchte, so ist dies begrenzt möglich.
4666 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
4667 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
4668 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
4669 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
4670 (HTML oder PDF über LaTeX) umgesetzt.</para>
4672 <para>Die unterstützen Formatierungen sind:</para>
4676 <term><b>Text</b></term>
4679 <para>Text wird in Fettdruck gesetzt.</para>
4684 <term><i>Text</i></term>
4687 <para>Text wird kursiv gesetzt.</para>
4692 <term><u>Text</u></term>
4695 <para>Text wird unterstrichen.</para>
4700 <term><s>Text</s></term>
4703 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
4704 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
4709 <term><bullet></term>
4712 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
4718 <para>Der Befehl <command><bullet></command> funktioniert
4719 momentan auch nur in Latex-Vorlagen.</para>
4723 <sect1 id="excel-templates">
4724 <title>Excel-Vorlagen</title>
4726 <sect2 id="excel-templates.summary">
4727 <title>Zusammenfassung</title>
4729 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
4730 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
4734 <sect2 id="excel-templates.usage">
4735 <title>Bedienung</title>
4737 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
4738 werden. Die Konfigurationsoption heißt <varname>excel_templates =
4739 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
4741 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
4742 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
4743 werden. In den normalen Verkaufsmasken taucht nun
4744 <constant>Excel</constant> als auswählbares Format auf und kann von da
4745 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
4747 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
4748 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
4749 <filename>sales_quotation.xls</filename> gespeichert.</para>
4752 <sect2 id="excel-templates.syntax">
4753 <title>Variablensyntax</title>
4755 <para>Einfache Syntax:
4756 <command><<varname>></command></para>
4758 <para>Dabei sind <constant><<</constant> und
4759 <constant>>></constant> die Delimiter. Da Excel auf festen
4760 Breiten besteht, kann der Tag künstlich verlängert werden, indem
4761 weitere <constant><</constant> oder <constant>></constant>
4762 eingefügt werden. Der Tag muss nicht symmetrisch sein.
4765 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4767 <para>Um die Limitierung der festen Breite zu reduzieren, können
4768 weitere Variablen in einem Block interpoliert werden. Whitespace wird
4769 dazwishen dann erhalten. Beispiel:</para>
4771 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4773 <para>Die Variablen werden interpoliert, und linksbündig mit
4774 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
4775 lang, werden überzählige Zeichen abgeschnitten.</para>
4777 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
4778 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
4780 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4782 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
4783 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
4787 <sect2 id="excel-templates.limitations">
4788 <title>Einschränkungen</title>
4790 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
4791 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
4792 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
4793 Text zu ersetzen.</para>
4795 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
4796 <command><%if%></command> und
4797 <command><%foreach%></command> nicht vorhanden. Der Delimiter
4798 <constant><% %></constant> kommt in den Headerinformationen
4799 evtl. vor. Deshalb wurde auf den sichereren Delimiter
4800 <constant><<</constant> und <constant>>></constant>
4807 <title>Entwicklerdokumentation</title>
4809 <sect1 id="devel.globals" xreflabel="Globale Variablen">
4810 <title>Globale Variablen</title>
4813 <title>Wie sehen globale Variablen in Perl aus?</title>
4815 <para>Globale Variablen liegen in einem speziellen namespace namens
4816 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
4817 globs global und die meisten speziellen Variablen sind...
4820 <para>Daraus ergeben sich folgende Formen:</para>
4824 <term><literal>$main::form</literal></term>
4827 <para>expliziter Namespace "main"</para>
4832 <term><literal>$::form</literal></term>
4835 <para>impliziter Namespace "main"</para>
4840 <term><literal>open FILE, "file.txt"</literal></term>
4843 <para><varname>FILE</varname> ist global</para>
4848 <term><literal>$_</literal></term>
4851 <para>speziell</para>
4856 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
4857 Schlüsselwort wie "<function>global</function>", mit dem man
4858 importieren kann. <function>my</function>, <function>our</function>
4859 und <function>local</function> machen was anderes.</para>
4863 <term><literal>my $form</literal></term>
4866 <para>lexikalische Variable, gültig bis zum Ende des
4872 <term><literal>our $form</literal></term>
4875 <para><varname>$form</varname> referenziert ab hier
4876 <varname>$PACKAGE::form</varname>.</para>
4881 <term><literal>local $form</literal></term>
4884 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
4885 des scopes zurückgesetzt</para>
4892 <title>Warum sind globale Variablen ein Problem?</title>
4894 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
4896 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
4897 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
4898 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
4899 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
4900 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
4901 Datenbankverbindungen, weil die sehr lange zum Initialisieren
4904 <para>Das zweite Problem ist <function>strict</function>. Unter
4905 <function>strict</function> werden alle Variablen die nicht explizit
4906 mit <function>Package</function>, <function>my</function> oder
4907 <function>our</function> angegeben werden als Tippfehler angemarkert,
4908 dies hat, seit der Einführung, u.a. schon so manche langwierige
4909 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
4910 angegeben werden, werden die nicht geprüft, und somit kann sich
4911 schnell ein Tippfehler einschleichen.</para>
4915 <title>Kanonische globale Variablen</title>
4917 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
4918 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
4919 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
4920 umhergereicht werden.</para>
4922 <para>Diese Variablen sind im Moment die folgenden neun:</para>
4926 <para><varname>$::form</varname></para>
4930 <para><varname>%::myconfig</varname></para>
4934 <para><varname>$::locale</varname></para>
4938 <para><varname>$::lxdebug</varname></para>
4942 <para><varname>$::auth</varname></para>
4946 <para><varname>$::lx_office_conf</varname></para>
4950 <para><varname>$::instance_conf</varname></para>
4954 <para><varname>$::dispatcher</varname></para>
4958 <para><varname>$::request</varname></para>
4962 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
4963 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
4964 Eigenschaften (Konventionen):</para>
4967 <title>$::form</title>
4971 <para>Ist ein Objekt der Klasse
4972 "<classname>Form</classname>"</para>
4976 <para>Wird nach jedem Request gelöscht</para>
4980 <para>Muss auch in Tests und Konsolenscripts vorhanden
4985 <para>Enthält am Anfang eines Requests die Requestparameter vom
4990 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
4991 cachen, das wird aber momentan absichtlich zerstört</para>
4995 <para><varname>$::form</varname> wurde unter <productname>SQL
4996 Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
4997 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
4998 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
4999 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
5000 <function>IS->retrieve_customer()</function> in Sicherheit
5003 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
5004 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
5005 3552, Stand version 2.7beta), um dies hinterher wieder auf den
5006 richtigen Wert zu setzen:</para>
5008 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
5009 $::myconfig{numberformat} = $numberformat;
5010 # (...) div Berechnungen
5011 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
5013 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
5014 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
5015 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
5016 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
5017 Es geht ziemlich sicher etwas kaputt.</para>
5019 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
5020 in den <productname>Template::Toolkit</productname> Templates
5021 außerhalb der Controller: der Ausdruck <function>[% var
5022 %]</function> greift auf <varname>$::form->{var}</varname> zu.
5023 Unter Controllern ist der Standard Scope anders, da lautet der
5024 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
5025 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
5026 <function><%var%></function> zeigt auf
5027 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
5028 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
5031 <programlisting>[%- IF business %]
5032 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
5033 [%- END %]</programlisting>
5035 <para>Entweder wird hier dann $::form->{business} ausgewertet
5036 oder aber der Funktion
5037 <function>$form->parse_html_template</function> wird explizit
5038 noch ein zusätzlicher Hash übergeben, der dann auch in den
5039 (Web-)Templates zu Verfügung steht, bspw. so:</para>
5041 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
5043 <para>Innerhalb von Schleifen wird
5044 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
5045 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
5046 welches über alle Positionen eines Lieferscheins in Schleife
5049 <programlisting>for $i (1 .. $form->{rowcount}) {
5051 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
5052 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
5053 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
5059 <title>%::myconfig</title>
5063 <para>Das einzige Hash unter den globalen Variablen</para>
5067 <para>Wird spätestens benötigt wenn auf die Datenbank
5068 zugegriffen wird</para>
5072 <para>Wird bei jedem Request neu erstellt.</para>
5076 <para>Enthält die Userdaten des aktuellen Logins</para>
5080 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
5081 extern serialisiert werden, weil da auch der Datenbankzugriff
5082 für diesen user drinsteht.</para>
5086 <para>Enthält unter anderem Listenbegrenzung vclimit,
5087 Datumsformat dateformat und Nummernformat numberformat</para>
5091 <para>Enthält Datenbankzugriffinformationen</para>
5095 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
5096 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
5097 aktuellen Users entscheiden müssen, befragen
5098 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
5099 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
5100 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
5101 Informationen über den Benutzer die über die
5102 Administrator-Schnittstelle eingegeben wurden.</para>
5106 <title>$::locale</title>
5110 <para>Objekt der Klasse "Locale"</para>
5114 <para>Wird pro Request erstellt</para>
5118 <para>Muss auch für Tests und Scripte immer verfügbar
5123 <para>Cached intern über Requestgrenzen hinweg benutzte
5128 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
5129 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
5133 <title>$::lxdebug</title>
5137 <para>Objekt der Klasse "LXDebug"</para>
5141 <para>Wird global gecached</para>
5145 <para>Muss immer verfügbar sein, in nahezu allen
5150 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
5151 bereit, wie "<function>enter_sub</function>" und
5152 "<function>leave_sub</function>", mit denen in den alten Modulen ein
5153 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
5154 der man die Wallclockzeit seit Requeststart loggen kann, sowie
5155 "<function>message</function>" und "<function>dump</function>" mit
5156 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
5159 <para>Beispielsweise so:</para>
5161 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
5162 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
5166 <title>$::auth</title>
5170 <para>Objekt der Klasse "SL::Auth"</para>
5174 <para>Wird global gecached</para>
5178 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
5182 <para>Wird nach jedem Request resettet.</para>
5186 <para><varname>$::auth</varname> stellt Funktionen bereit um die
5187 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
5188 vom aktuellen User abhängen wird das Objekt aus
5189 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
5190 Request kurz resettet.</para>
5192 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten. Dessen Einstellungen können über
5193 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert ist ein Hash mit den Werten aus der Tabelle
5194 <literal>auth.clients</literal>.</para>
5198 <title>$::lx_office_conf</title>
5202 <para>Objekt der Klasse
5203 "<classname>SL::LxOfficeConf</classname>"</para>
5207 <para>Global gecached</para>
5211 <para>Repräsentation der
5212 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
5216 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
5217 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
5218 das Programm die Konfiguration ändern kann oder sollte.</para>
5220 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
5221 Debug- und Trace-Log-Datei wie folgt konfiguriert und
5224 <programlisting>[debug]
5225 file = /tmp/kivitendo-debug.log</programlisting>
5227 <para>ist der Key <varname>file</varname> im Programm als
5228 <varname>$::lx_office_conf->{debug}{file}</varname>
5232 <para>Zugriff auf die Konfiguration erfolgt im Moment über
5233 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
5238 <title>$::instance_conf</title>
5242 <para>Objekt der Klasse
5243 "<classname>SL::InstanceConfiguration</classname>"</para>
5247 <para>wird pro Request neu erstellt</para>
5251 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
5252 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
5253 ist hier eine Mandantendatenbank. Beispielsweise überprüft
5254 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
5255 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
5259 <title>$::dispatcher</title>
5263 <para>Objekt der Klasse
5264 "<varname>SL::Dispatcher</varname>"</para>
5268 <para>wird pro Serverprozess erstellt.</para>
5272 <para>enthält Informationen über die technische Verbindung zum
5277 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
5278 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
5279 Objekt untergebracht.</para>
5283 <title>$::request</title>
5287 <para>Hashref (evtl später Objekt)</para>
5291 <para>Wird pro Request neu initialisiert.</para>
5295 <para>Keine Unterstruktur garantiert.</para>
5299 <para><varname>$::request</varname> ist ein generischer Platz um
5300 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
5301 at a distance benutzt werden, sondern um lokales memoizing zu
5302 ermöglichen, das garantiert am Ende des Requests zerstört
5305 <para>Vieles von dem, was im moment in <varname>$::form</varname>
5306 liegt, sollte eigentlich hier liegen. Die groben
5307 Differentialkriterien sind:</para>
5311 <para>Kommt es vom User, und soll unverändert wieder an den
5312 User? Dann <varname>$::form</varname>, steht da eh schon</para>
5316 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
5317 Requests gebraucht werden? Dann
5318 <varname>$::request</varname></para>
5322 <para>Muss ich von anderen Teilen des Programms lesend drauf
5323 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
5324 Wrappermethode</para>
5331 <title>Ehemalige globale Variablen</title>
5333 <para>Die folgenden Variablen waren einmal im Programm, und wurden
5337 <title>$::cgi</title>
5341 <para>war nötig, weil cookie Methoden nicht als
5342 Klassenfunktionen funktionieren</para>
5346 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
5347 Klassennamespace gehalten wird und über Requestgrenzen
5352 <para>liegt jetzt unter
5353 <varname>$::request->{cgi}</varname></para>
5359 <title>$::all_units</title>
5363 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
5364 ein paar hundert mal pro Request eine Liste der Einheiten
5365 brauchen, und de als Parameter durch einen Riesenstack von
5366 Funktionen geschleift werden müssten.</para>
5370 <para>Liegt jetzt unter
5371 <varname>$::request->{cache}{all_units}</varname></para>
5376 <function>AM->retrieve_all_units()</function> gesetzt oder
5383 <title>%::called_subs</title>
5387 <para>wurde benutzt um callsub deep recursions
5392 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
5393 möglichen Rekursioenen darstellt, und da nie welche
5398 <para>komplette recursion protection wurde entfernt.</para>
5405 <sect1 id="devel.fcgi">
5406 <title>Entwicklung unter FastCGI</title>
5408 <sect2 id="devel.fcgi.general">
5409 <title>Allgemeines</title>
5411 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
5412 werden, muss der Webserver neu gestartet werden.</para>
5414 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
5415 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
5416 müssen folgende Aspekte beachtet werden.</para>
5419 <sect2 id="devel.fcgi.exiting">
5420 <title>Programmende und Ausnahmen</title>
5422 <para>Betrifft die Funktionen <function>warn</function>,
5423 <function>die</function>, <function>exit</function>,
5424 <function>carp</function> und <function>confess</function>.</para>
5426 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
5427 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
5428 am Laufen zu halten. Man kann mit <function>die</function>,
5429 <function>confess</function> oder <function>carp</function> Fehler
5430 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
5431 eigene <function>$::form-</function>error()> tut im Prinzip das
5432 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
5433 <function>exit</function> hingegen werden nicht abgefangen.
5434 <function>warn</function> wird direkt nach STDERR, also in Server Log
5435 eine Nachricht schreiben (sofern in der Konfiguration nicht die
5436 Warnungen in das kivitendo Log umgeleitet wurden), und
5437 <function>exit</function> wird die Ausführung beenden.</para>
5439 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
5440 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
5441 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
5442 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
5445 <sect2 id="devel.fcgi.globals">
5446 <title>Globale Variablen</title>
5448 <para>Um zu vermeiden, dass Informationen von einem Request in einen
5449 anderen gelangen, müssen alle globalen Variablen vor einem Request
5450 sauber initialisiert werden. Das ist besonders wichtig im
5451 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
5452 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
5455 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
5456 abgetrennten Block, der alle kanonischen globalen Variablen listet und
5457 erklärt. Bitte keine anderen einführen ohne das sauber zu
5458 dokumentieren.</para>
5460 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
5461 man sicher geht, dass man die richtige erwischt.</para>
5464 <sect2 id="devel.fcgi.performance">
5465 <title>Performance und Statistiken</title>
5467 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
5468 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
5469 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
5470 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
5471 sind es je nach Menge der definierten Variablen 1-2s. Ab der
5472 Moose/Rose::DB Version sind es 5-6s.</para>
5474 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
5475 den kritischen Pfaden, unter 0,15 sonst.</para>
5478 <sect2 id="devel.fcgi.known-issues">
5479 <title>Bekannte Probleme</title>
5481 <sect3 id="devel.fcgi.known-issues.encoding">
5482 <title>Encoding Awareness</title>
5484 <para>UTF-8 kodierte Installationen sind sehr anfällig gegen
5485 fehlerhfate Encodings unter FCGI. latin9 Installationen behandeln
5486 falsch kodierte Zeichen eher unwissend, und geben sie einfach
5487 weiter. UTF-8 verweigert bei fehlerhaften Programmpfaden kurzerhand
5488 das Ausliefern. Es wird noch daran gearbeitet, alle Fehler da zu
5494 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
5495 <title>SQL-Upgradedateien</title>
5497 <sect2 id="db-upgrade-files.introduction"
5498 xreflabel="Einführung in die Datenbank-Upgradedateien">
5499 <title>Einführung</title>
5501 <para>Der alte Mechanismus für SQL-Upgradescripte, der auf einer
5502 Versionsnummer beruht und dann in sql/Pg-upgrade nach einem Script für
5503 diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele
5504 Entwicklung im stable- und unstable-Baum betrifft.</para>
5506 <para>Dieser Mechanismus wurde für kivitendo 2.4.1 deutlich erweitert.
5507 Es werden weiterhin alle Scripte aus sql/Pg-upgrade ausgeführt.
5508 Zusätzlich gibt es aber ein zweites Verzeichnis, sql/Pg-upgrade2. In
5509 diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren,
5510 die neben den eigentlich auszuführenden SQL- oder Perl-Befehlen einige
5511 Kontrollinformationen enthält.</para>
5513 <para>Neu sind die Kontrollinformationen, die Abhängigkeiten und
5514 Prioritäten definieren können werden, sodass Datenbankscripte zwar in
5515 einer sicheren Reihenfolge ausgeführt werden (z.B. darf ein "ALTER
5516 TABLE" erst ausgeführt werden, wenn die Tabelle mit "CREATE TABLE"
5517 angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man
5518 keine Versionsnummern mehr braucht.</para>
5520 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
5521 sql/Pg-upgrade2 bereits durchgeführt wurde und führt diese nicht
5522 erneut aus. Dazu dient die Tabelle "schema_info", die bei der
5523 Anmeldung automatisch angelegt wird.</para>
5526 <sect2 id="db-upgrade-files.format"
5527 xreflabel="Format der Upgradedateien">
5528 <title>Format der Kontrollinformationen</title>
5530 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5531 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5532 hat dabei das folgende Format:</para>
5534 <para>Für SQL-Upgradedateien:</para>
5536 <programlisting>-- @key: value</programlisting>
5538 <para>Für Perl-Upgradedateien:</para>
5540 <programlisting># @key: value</programlisting>
5542 <para>Leerzeichen vor "<varname>value</varname>" werden
5545 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5549 <term><varname>tag</varname></term>
5552 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5553 Dieser "tag" kann von anderen Kontrolldateien in ihren
5554 Abhängigkeiten verwendet werden (Schlüsselwort
5555 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5556 in der Datenbank eingetragen wird.</para>
5558 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5559 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5561 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5562 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5563 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5569 <term><varname>charset</varname></term>
5572 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5573 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
5574 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte hingegen müssen immer in UTF-8 encodiert sein und sollten
5575 demnach auch ein "<literal>use utf8;</literal>" enthalten.</para>
5580 <term><varname>description</varname></term>
5583 <para>Benötigt. Eine Beschreibung, was in diesem Update
5584 passiert. Diese wird dem Benutzer beim eigentlichen
5585 Datenbankupdate angezeigt. Während der Tag in englisch gehalten
5586 sein sollte, sollte die Beschreibung auf Deutsch
5592 <term><varname>depends</varname></term>
5595 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5596 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
5597 dass die in dieser Liste aufgeführten Scripte bereits
5598 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5600 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5601 Script "b" existiert, das von Änderungen in "a" abhängt, und
5602 eine neue Kontrolldatei für "c" erstellt wird, die von
5603 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5604 Tag "b" als Abhängigkeit zu definieren.</para>
5606 <para>Es ist nicht erlaubt, sich selbst referenzierende
5607 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5608 und "c" -> "a").</para>
5613 <term><varname>priority</varname></term>
5616 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5617 der Scripte ausgeführt werden, die die gleichen
5618 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5619 der Wert 1000 benutzt.</para>
5621 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5622 "depends" benutzt werden. kivitendo sortiert die auszuführenden
5623 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5624 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5625 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5626 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5627 Priorität alphabetisch nach dem "tag".</para>
5632 <term><varname>ignore</varname></term>
5635 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
5636 Skript bei der Anmeldung ignoriert und entsprechend nicht
5643 <sect2 id="db-upgrade-files.format-perl-files" xreflabel="Format von Perl-Upgradedateien">
5644 <title>Format von in Perl geschriebenen Datenbankupgradescripten</title>
5646 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so ausgeführt sondern müssen sich an gewisse Konventionen
5647 halten. Dafür bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
5649 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse dar, die vom Elternobjekt
5650 "<literal>SL::DBUpgrade2::Base</literal>" erben und eine Funktion namens "<literal>run</literal>" zur Verfügung stellen muss. Das
5651 Script wird ausgeführt, indem eine Instanz dieser Klasse erzeugt und darauf die erwähnte "<literal>run</literal>" aufgerufen
5654 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert für "<literal>@tag</literal>" ableitet. Dabei werden alle
5655 Zeichen, die in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche ersetzt. Insgesamt sieht der Paketname wie folgt
5656 aus: "<literal>SL::DBUpgrade2::tag</literal>".</para>
5658 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
5659 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
5661 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie folgt aus:</para>
5663 <programlisting># @tag: beispiel-upgrade-file42
5664 # @description: Ein schönes Beispielscript
5665 # @depends: release_3_0_0
5666 package SL::DBUpgrade2::beispiel_upgrade_file42;
5671 use parent qw(SL::DBUpgrade2::Base);
5676 # hier Aktionen ausführen
5685 <sect2 id="db-upgrade-files.dbupgrade-tool"
5686 xreflabel="Hilfsscript dbupgrade2_tool.pl">
5687 <title>Hilfsscript dbupgrade2_tool.pl</title>
5689 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
5690 existiert ein Hilfsscript namens
5691 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
5692 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
5693 liest alle Datenbankupgradescripte aus dem Verzeichnis
5694 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
5695 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
5696 von der Kommandozeile überprüft werden können.</para>
5698 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
5699 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
5700 sich aber auch Informationen auf verschiedene Art ausgeben
5705 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
5706 --list</command>"</para>
5708 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
5709 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
5710 würde. Es werden neben der Listenposition der Tag, die
5711 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
5715 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
5716 --tree</command>"</para>
5718 <para>Listet alle Tags in Baumform basierend auf den
5719 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
5720 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
5721 beim übergeordneten Script als Abhängigkeit eingetragen
5725 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
5726 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
5727 --rtree</command>"</para>
5729 <para>Listet alle Tags in Baumform basierend auf den
5730 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
5731 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
5732 die das übergeordnete Script als Abhängigkeit eingetragen
5737 <para>Baumform mit Postscriptausgabe:
5738 "<command>./scripts/dbupgrade2_tool.pl
5739 --graphviz</command>"</para>
5741 <para>Benötigt das Tool "<command>graphviz</command>", um mit
5742 seiner Hilfe die <link
5743 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
5744 Baumform</link> in eine Postscriptdatei namens
5745 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
5746 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
5747 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
5748 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
5753 <para>Scripte, von denen kein anderes Script abhängt:
5754 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
5756 <para>Listet die Tags aller Scripte auf, von denen keine anderen
5757 Scripte abhängen.</para>
5763 <sect1 id="translations-languages" xreflabel="Translations and languages">
5764 <title>Translations and languages</title>
5766 <sect2 id="translations-languages.introduction"
5767 xreflabel="Introduction to translations and languages">
5768 <title>Introduction</title>
5771 <para>Dieser Abschnitt ist in Englisch geschrieben, um
5772 internationalen Übersetzern die Arbeit zu erleichtern.</para>
5775 <para>This section describes how localization packages in kivitendo
5776 are built. Currently the only language fully supported is German, and
5777 since most of the internal messages are held in English the English
5778 version is usable too.</para>
5780 <para>A stub version of French is included but not functunal at this
5784 <sect2 id="translations-languages.file-structure"
5785 xreflabel="File structure">
5786 <title>File structure</title>
5788 <para>The structure of locales in kivitendo is:</para>
5790 <programlisting>kivitendo/locale/<langcode>/</programlisting>
5792 <para>where <langcode> stands for an abbreviation of the
5793 language package. The builtin packages use two letter <ulink
5794 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
5795 but the actual name is not relevant for the program and can easily be
5797 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
5798 tags</ulink> (i.e. "en_GB"). In fact the original language packages
5799 from SQL Ledger are named in this way.</para>
5801 <para>In such a language directory the following files are
5806 <term>LANGUAGE</term>
5809 <para>This file is mandatory.</para>
5811 <para>The <filename>LANGUAGE</filename> file contains the self
5812 descripted name of the language. It should contain a native
5813 representation first, and in parenthesis an english translation
5814 after that. Example:</para>
5816 <programlisting>Deutsch (German)</programlisting>
5821 <term>charset</term>
5824 <para>This file should be present.</para>
5826 <para>The <filename>charset</filename> file describes which
5827 charset a language package is written in and applies to all
5828 other language files in the package. It is possible to write
5829 some language packages without an explicit charset, but it is
5830 still strongly recommended. You'll never know in what
5831 environment your language package will be used, and neither
5832 UTF-8 nor Latin1 are guaranteed.</para>
5834 <para>The whole content of this file is a string that can be
5835 recognized as a valid charset encoding. Example:</para>
5837 <programlisting>UTF-8</programlisting>
5845 <para>This file is mandatory.</para>
5847 <para>The central translation file. It is essentially an inline
5848 Perl script autogenerated by <command>locales.pl</command>. To
5849 generate it, generate the directory and the two files mentioned
5850 above, and execute the following command:</para>
5852 <programlisting>scripts/locales.pl <langcode></programlisting>
5854 <para>Otherwise you can simply copy one of the other languages.
5855 You will be told how many are missing like this:</para>
5857 <programlisting>$ scripts/locales.pl en
5858 English - 0.6% - 2015/2028 missing</programlisting>
5860 <para>A file named "<filename>missing</filename>" will be
5861 generated and can be edited. You can also edit the
5862 "<filename>all</filename>" file directly. Edit everything you
5863 like to fit the target language and execute
5864 <command>locales.pl</command> again. See how the missing words
5870 <term>Num2text</term>
5873 <para>Legacy code from SQL Ledger. It provides a means for
5874 numbers to be converted into natural language, like
5875 <literal>1523 => one thousand five hundred twenty
5876 three</literal>. If you want to provide it, it must be inlinable
5877 Perl code which provides a <function>num2text</function> sub. If
5878 an <function>init</function> sub exists it will be executed
5881 <para>Only used in the check and receipt printing module.</para>
5886 <term>special_chars</term>
5889 <para>kivitendo comes with a lot of interfaces to different
5890 formats, some of which are rather picky with their accepted
5891 charset. The <filename>special_chars</filename> file contains a
5892 listing of chars not suited for different file format and
5893 provides substitutions. It is written in "Simple Ini" style,
5894 containing a block for every file format.</para>
5896 <para>First entry should be the order of substitution for
5897 entries as a whitespace separated list. All entries are
5898 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
5899 and <literal>\\</literal> all work.</para>
5901 <para>After that every entry is a special char that should be
5902 translated when writing text into such a file.</para>
5904 <para>Example:</para>
5906 <programlisting>[Template/XML]
5907 order=& < > \n
5911 \n=<br></programlisting>
5913 <para>Note the importance of the order in this example.
5914 Substituting < and > befor & would lead to $gt; become
5917 <para>For a list of valid formats, see the German
5918 <filename>special_chars</filename> entry. As of this writing the
5919 following are recognized:</para>
5921 <programlisting>HTML
5926 Template/OpenDocument
5927 filenames</programlisting>
5929 <para>The last of which is very machine dependant. Remember that
5930 a lot of characters are forbidden by some filesystems, for
5931 exmaple MS Windows doesn't like ':' in its files where Linux
5932 doesn't mind that. If you want the files created with your
5933 language pack to be portable, find all chars that could cause
5939 <term>missing</term>
5942 <para>This file is not a part of the language package
5945 <para>This is a file generated by
5946 <command>scripts/locales.pl</command> while processing your
5947 locales. It's only to have the missing entries singled out and
5948 does not belong to a language package.</para>
5956 <para>This file is not a part of the language package
5959 <para>Another file generated by
5960 <command>scripts/locales.pl</command>. If for any reason a
5961 translation does not appear anymore and can be deleted, it gets
5962 moved here. The last 50 or so entries deleted are saved here in
5963 case you made a typo, so that you don't have to translate
5964 everything again. If a tranlsation is missing, the lost file is
5965 checked first. If you maintain a language package, you might
5966 want to keep this safe somewhere.</para>
5973 <sect1 id="devel.testsuite">
5974 <title>Die kivitendo-Test-Suite</title>
5976 <sect2 id="devel.testsuite.intro">
5977 <title>Einführung</title>
5979 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul <literal>Test::More</literal>.</para>
5981 <para>Die grundlegenden Fakten sind:</para>
5984 <listitem><para>Alle Tests liegen im Unterverzeichnis <filename>t/</filename>.</para></listitem>
5986 <listitem><para>Ein Script (bzw. ein Test) in <filename>f/</filename> enthält einen oder mehrere Testfälle.</para></listitem>
5988 <listitem><para>Alle Dateinamen von Tests enden auf <literal>.t</literal>. Es sind selbstständig ausführbare Perl-Scripte.</para></listitem>
5990 <listitem><para>Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in <filename>f/</filename>, deren
5991 Dateiname auf <literal>.t</literal> endet.</para></listitem>
5995 <sect2 id="devel.testsuite.prerequisites">
5996 <title>Voraussetzungen</title>
5998 <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>
6001 <listitem><para><literal>Test::Deep</literal> (Debian-Paketname: <literal>libtest-deep-perl</literal>; Fedora Core:
6002 <literal>perl-Test-Deep</literal>; openSUSE: <literal>perl-Test-Deep</literal>)</para></listitem>
6003 <listitem><para><literal>Test::Exception</literal> (Debian-Paketname: <literal>libtest-exception-perl</literal>; Fedora Core:
6004 <literal>perl-Test-Exception</literal>; openSUSE: <literal>perl-Test-Exception</literal>)</para></listitem>
6005 <listitem><para><literal>Test::Output</literal> (Debian-Paketname: <literal>libtest-output-perl</literal>; Fedora Core:
6006 <literal>perl-Test-Output</literal>; openSUSE: <literal>perl-Test-Output</literal>)</para></listitem>
6007 <listitem><para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses Modul ist ab Perl 5.10.1 Bestandteil der
6008 Perl-Distribution und kann für frühere Versionen aus dem <ulink url="http://www.cpan.org">CPAN</ulink> bezogen
6009 werden.</para></listitem>
6013 <sect2 id="devel.testsuite.execution">
6015 Existierende Tests ausführen
6018 <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
6019 gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript <filename>t/test.sh</filename>.</para>
6021 <para>Will man die komplette Test-Suite ausführen, so muss man einfach nur <filename>t/test.sh</filename> ohne weitere Parameter aus
6022 dem kivitendo-Basisverzeichnis heraus ausführen.</para>
6024 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an <filename>t/test.sh</filename>. Beispielsweise:</para>
6026 <programlisting>t/test.sh t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
6030 <sect2 id="devel.testsuite.meaning_of_scripts">
6032 Bedeutung der verschiedenen Test-Scripte
6035 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch
6036 während der Entwicklung nützliche Tests sind:</para>
6039 <listitem><para><filename>t/001compile.t</filename> -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab</para></listitem>
6040 <listitem><para><filename>t/002goodperl.t</filename> -- überprüft alle Perl-Dateien auf Anwesenheit von '<literal>use strict</literal>'-Anweisungen</para></listitem>
6041 <listitem><para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von <function>system()</function> und <function>exec()</function> auf Gültigkeit</para></listitem>
6042 <listitem><para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien Tab-Zeichen enthalten</para></listitem>
6043 <listitem><para><filename>t/006spelling.t</filename> -- sucht nach häufigen Rechtschreibfehlern</para></listitem>
6044 <listitem><para><filename>t/011pod.t</filename> -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit</para></listitem>
6047 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module.</para>
6050 <sect2 id="devel.testsuite.create_new">
6052 Neue Test-Scripte erstellen
6055 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende
6056 Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden.</para>
6058 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
6060 Ideen für neue Test-Scripte, die keine konkreten Funktionen testen
6063 <para> Ideen, die abgesehen von Funktions noch nicht umgesetzt wurden:</para>
6066 <listitem><para>Überprüfung auf fehlende symbolische Links</para></listitem>
6067 <listitem><para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten)</para></listitem>
6068 <listitem><para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para></listitem>
6069 <listitem><para>Überprüfung auf Leerzeichen am Ende von Zeilen</para></listitem>
6070 <listitem><para>Test, ob alle zu übersetzenden Strings in <filename>locale/de/all</filename> vorhanden sind</para></listitem>
6071 <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>
6075 <sect3 id="devel.testsuite.directory_and_test_names">
6077 Konvention für Verzeichnis- und Dateinamen
6080 <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>
6083 <listitem><para>Die Dateiendung muss <filename>.t</filename> lauten.</para></listitem>
6085 <listitem><para>Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise
6086 <filename>bad_function_params.t</filename>).</para></listitem>
6088 <listitem><para>Unterverzeichnisse sollten grob nach dem Themenbereich benannt sind, mit dem sich die Scripte darin befassen
6089 (beispielsweise <filename>background_jobs</filename> für Tests rund um Hintergrund-Jobs).</para></listitem>
6091 <listitem><para>Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist
6092 (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben.</para></listitem>
6096 <sect3 id="devel.testsuite.minimal_example">
6098 Minimales Skelett für eigene Scripte
6101 <para>Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden:</para>
6103 <programlisting>use Test::More tests => 0;
6107 use Support::TestSetup;
6109 Support::TestSetup::login();</programlisting>
6111 <para>Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie
6112 <varname>$::auth</varname>, <varname>$::form</varname> oder <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
6113 <filename>config/kivitendo.conf</filename> im Abschnitt <literal>testing.login</literal> ein gültiger Login-Name eingetragen
6114 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
6116 <para>Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile <code>Support::TestSetup::login();</code>
6117 weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.</para>
6122 <sect1 id="devel.style-guide">
6123 <title>Stil-Richtlinien</title>
6125 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
6126 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
6127 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
6128 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
6130 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
6133 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
6134 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
6139 <para>Es werden keine echten Tabs sondern Leerzeichen
6144 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
6146 <programlisting>foreach my $row (@data) {
6148 # do something with $row
6152 $row->{modules} = MODULE->retrieve(
6153 id => $row->{id},
6154 date => $use_now ? localtime() : $row->{time},
6158 $report->add($row);
6163 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
6164 Zeile wie der letzte Befehl. Beispiele:</para>
6166 <programlisting>sub debug {
6172 <programlisting>if ($form->{item_rows} > 0) {
6178 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
6179 der Befehl / die öffnende schließende Klammer, die den Block
6180 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
6181 Beispiele wie bei 3. gelten.</para>
6185 <para>Die Wörter "<function>else</function>",
6186 "<function>elsif</function>", "<function>while</function>" befinden
6187 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
6190 <programlisting>if ($form->{sum} > 1000) {
6192 } elsif ($form->{sum} > 0) {
6200 } until ($a > 0);</programlisting>
6204 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
6205 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
6206 und grep-ähnliche Operatoren. Beispiel:</para>
6208 <programlisting>$main::lxdebug->message("Could not find file.");
6209 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
6213 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
6215 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
6216 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
6217 Blöcke schon. Beispiel:</para>
6219 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
6224 $form->{sum} += $form->{"row_$i"};
6225 $form->{ $form->{index} } += 1;
6227 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
6231 <para>Mehrzeilige Befehle</para>
6235 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
6236 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
6237 werden, in der die ersten Funktionsparameter in der ersten Zeile
6238 stehen. Beispiel:</para>
6240 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
6241 $form->{some_col_value});</programlisting>
6245 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
6246 besten in einer übersichtlichen Tabellenstruktur organisiert
6247 wird. Beispiel:</para>
6249 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
6250 : $form->{oldcount} ? $form->{oldcount} + 1
6251 : $form->{rowcount} - $form->{rowbase};</programlisting>
6257 <para>Kommentare</para>
6261 <para>Kommentare, die alleine in einer Zeile stehen, sollten
6262 soweit wie der Code eingerückt sein.</para>
6266 <para>Seitliche hängende Kommentare sollten einheitlich
6267 formatiert werden.</para>
6271 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
6272 auf Englisch zu verfassen. So wie ich keine Lust habe,
6273 französischen Quelltext zu lesen, sollte auch der kivitendo
6274 Quelltext für nicht-Deutschsprachige lesbar sein.
6277 <programlisting>my $found = 0;
6285 $i = 0 # initialize $i
6287 $i *= $const; # do something crazy
6288 $i = $n; # recover $i</programlisting>
6294 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
6295 Interpolation gewünscht ist. Beispiel:</para>
6297 <programlisting>$form->{sum} = 0;
6298 $form->{"row_$i"} = $form->{"row_$i"} - 5;
6299 $some_hash{42} = 54;</programlisting>
6303 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
6304 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
6305 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
6306 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
6308 <para>Als Beispiel sei die Funktion
6309 <function>print_options</function> aus
6310 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
6314 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
6315 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
6318 <para>Emacs und vim haben beide recht einfache Methoden zur
6319 Entfernung von trailing whitespace. Emacs kennt das Kommande
6320 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
6321 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
6322 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
6327 <para>Es wird kein <command>perltidy</command> verwendet.</para>
6329 <para>In der Vergangenheit wurde versucht,
6330 <command>perltidy</command> zu verwenden, um einen einheitlichen
6331 Stil zu erlangen. Es hat sich aber gezeigt, dass
6332 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
6333 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
6334 den Interessierten sind hier die
6335 <command>perltidy</command>-Optionen, die grob den beschriebenen
6336 Richtlinien entsprechen:</para>
6338 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
6339 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
6340 -lp -vt=1 -vtc=1</programlisting>
6344 <para><varname>STDERR</varname> ist tabu. Unkonditionale
6345 Debugmeldungen auch.</para>
6347 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
6348 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
6349 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
6351 <para>Die <classname>LXDebug</classname>-Methode
6352 "<function>message</function>" nimmt als ersten Paramter außerdem
6353 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
6354 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
6355 und werden in den meisten Fällen auch vom Repository
6356 zurückgewiesen.</para>
6360 <para>Alle neuen Module müssen use strict verwenden.</para>
6362 <para><varname>$form</varname>, <varname>$auth</varname>,
6363 <varname>$locale</varname>, <varname>$lxdebug</varname> und
6364 <varname>%myconfig</varname> werden derzeit aus dem main package
6365 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
6366 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
6371 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
6372 <title>Dokumentation erstellen</title>
6374 <sect2 id="devel.build-doc.introduction">
6375 <title>Einführung</title>
6377 <para>Diese Dokumentation ist in <productname>DocBook</productname>
6378 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
6379 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
6380 Editor nutzt, der spezielle Unterstützung für
6381 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
6382 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
6383 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
6387 <sect2 id="devel.build-doc.required-software">
6388 <title>Benötigte Software</title>
6390 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
6391 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
6392 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
6393 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
6394 <command>scripts/build_doc.sh</command>.</para>
6396 <para>Das Script benötigt zur Konvertierung verschiedene
6397 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
6403 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
6404 in einer halbwegs aktuellen Version</para>
6408 <para>Das Java-Build-System <ulink
6409 url="http://ant.apache.org/">Apache Ant</ulink></para>
6413 <para>Das Dokumentations-System Dobudish für
6414 <productname>DocBook</productname> 4.5, eine Zusammenstellung
6415 diverser Stylesheets und Grafiken zur Konvertierung von
6416 <productname>DocBook</productname> XML in andere Formate. Das
6417 Paket, das benötigt wird, ist zum Zeitpunkt der
6418 Dokumentationserstellung
6419 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
6420 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
6425 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
6426 sind auf allen gängigen Plattformen verfügbar. Beispiel für
6427 Debian/Ubuntu:</para>
6429 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
6431 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
6432 <filename>doc/build</filename> entpackt werden. Beispiel unter der
6433 Annahme, das <productname>Dobudish</productname> in
6434 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
6436 <programlisting>cd doc/build
6437 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
6440 <sect2 id="devel.build-doc.build">
6441 <title>PDFs und HTML-Seiten erstellen</title>
6443 <para>Die eigentliche Konvertierung erfolgt nach Installation der
6444 benötigten Software mit einem einfachen Aufruf direkt aus dem
6445 kivitendo-Installationsverzeichnis heraus:</para>
6447 <programlisting>./scripts/build_doc.sh</programlisting>
6450 <sect2 id="devel.build-doc.repository">
6451 <title>Einchecken in das Git-Repository</title>
6453 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
6454 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
6455 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
6456 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
6458 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
6459 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob