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>
18 <para>in der doc/UPGRADE Datei im doc-Verzeichnis der Installation</para>
21 <para>Im Schulungs- und Dienstleistungsangebot der entsprechenden kivitendo-Partner: <ulink
22 url="http://www.kivitendo.de/partner.html">http://www.kivitendo.de/partner.html</ulink></para>
28 <title>Installation und Grundkonfiguration</title>
30 <sect1 id="Installation-Übersicht">
31 <title>Übersicht</title>
34 Die Installation von kivitendo umfasst mehrere Schritte. Die folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
35 Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit minimalen Features möglichst schnell zum Laufen zu kriegen.
39 <listitem><para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo benötigt gewisse Ressourcen und benutzt weitere
40 Programme. Das Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert diese. Auch die Liste der benötigten Perl-Module
41 befindet sich hier.</para></listitem>
43 <listitem><para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst die "<xref
44 linkend="Manuelle-Installation-des-Programmpaketes"/>" sowie grundlegende Einstellungen, die der "<xref
45 linkend="config.config-file"/>" erläutert.</para></listitem>
47 <listitem><para><emphasis>Konfiguration externer Programme</emphasis>: hierzu gehören die Datenbank ("<xref
48 linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der Webserver ("<xref
49 linkend="Apache-Konfiguration"/>"). </para></listitem>
51 <listitem><para><emphasis>Benutzerinformationen speichern können</emphasis>: man benötigt mindestens eine Datenbank, in der
52 Informationen zur Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man das als Administrator macht, verrät "<xref
53 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para></listitem>
55 <listitem><para><emphasis>Benutzer, Gruppen und Datenbanken anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
56 linkend="Benutzer--und-Gruppenverwaltung"/>".</para></listitem>
58 <listitem><para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann kann es losgehen: "<xref
59 linkend="kivitendo-ERP-verwenden"/>"</para></listitem>
63 Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls wichtig und dienen sollten vor einer ernsthaften Inbetriebnahme gelesen
68 <sect1 id="Benötigte-Software-und-Pakete">
69 <title>Benötigte Software und Pakete</title>
71 <sect2 id="Betriebssystem">
72 <title>Betriebssystem</title>
74 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
75 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
76 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
77 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
78 ohne große Probleme auf den derzeit aktuellen verbreiteten
79 Distributionen läuft.</para>
81 <para>Anfang 2014 sind das folgende Systeme, von denen bekannt ist,
82 dass kivitendo auf ihnen läuft:</para>
90 <para>6.0 "Squeeze" (hier muss allerdings das Modul FCGI in der Version >= 0.72 compiled werden, und <literal>Rose::DB::Object</literal> ist zu alt)</para>
93 <para>7.0 "Wheezy"</para>
99 <para>Ubuntu 12.04 LTS "Precise Pangolin", 12.10 "Quantal Quetzal" und 13.04 "Precise Pangolin"</para>
103 <para>openSUSE 12.2 und 12.3</para>
107 <para>SuSE Linux Enterprice Server 11</para>
111 <para>Fedora 16 bis 19</para>
116 <sect2 id="Pakete" xreflabel="Pakete">
117 <title>Benötigte Perl-Pakete installieren</title>
119 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
120 Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.4)
123 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht Bestandteil einer Standard-Perl-Installation sind. Um zu
124 überprüfen, ob die erforderlichen Pakete installiert und aktuell genug sind, wird ein Script mitgeliefert, das wie folgt aufgerufen
127 <programlisting>./scripts/installation_check.pl</programlisting>
129 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
132 <listitem><para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para></listitem>
134 <listitem><para><literal>Archive::Zip</literal></para></listitem>
136 <listitem><para><literal>Config::Std</literal></para></listitem>
138 <listitem><para><literal>DateTime</literal></para></listitem>
140 <listitem><para><literal>DBI</literal></para></listitem>
142 <listitem><para><literal>DBD::Pg</literal></para></listitem>
144 <listitem><para><literal>Email::Address</literal></para></listitem>
146 <listitem><para><literal>Email::MIME</literal></para></listitem>
148 <listitem><para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71 inklusive; siehe <xref linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para></listitem>
150 <listitem><para><literal>File::Copy::Recursive</literal></para></listitem>
152 <listitem><para><literal>JSON</literal></para></listitem>
154 <listitem><para><literal>List::MoreUtils</literal></para></listitem>
156 <listitem><para><literal>Net::SMTP::SSL</literal> (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "<xref
157 linkend="config.sending-email.smtp"/>")</para></listitem>
159 <listitem><para><literal>Net::SSLGlue</literal> (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "<xref
160 linkend="config.sending-email.smtp"/>")</para></listitem>
162 <listitem><para><literal>Params::Validate</literal></para></listitem>
164 <listitem><para><literal>PDF::API2</literal></para></listitem>
166 <listitem><para><literal>Rose::Object</literal></para></listitem>
168 <listitem><para><literal>Rose::DB</literal></para></listitem>
170 <listitem><para><literal>Rose::DB::Object</literal> Version 0.788 oder neuer</para></listitem>
172 <listitem><para><literal>Template</literal></para></listitem>
174 <listitem><para><literal>Text::CSV_XS</literal></para></listitem>
176 <listitem><para><literal>Text::Iconv</literal></para></listitem>
178 <listitem><para><literal>URI</literal></para></listitem>
180 <listitem><para><literal>XML::Writer</literal></para></listitem>
182 <listitem><para><literal>YAML</literal></para></listitem>
185 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen: <literal>File::Copy::Recursive</literal>.</para>
187 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen: <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
188 <literal>Net::SSLGlue</literal>.</para>
190 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
191 hinzugekommen, <literal>URI</literal> und
192 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
195 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
196 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
197 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
198 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
200 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
201 hinzugekommen.</para>
203 <para><literal>Email::Address</literal> und
204 <literal>List::MoreUtils</literal> sind schon länger feste
205 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
206 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
207 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
208 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
212 <title>Debian und Ubuntu</title>
214 <para>Alle benötigten Perl-Pakete stehen für Debian und Ubuntu als Debian-Pakete zur Verfügung. Sie können mit folgendem Befehl
215 installiert werden:</para>
217 <programlisting>apt-get install apache2 libarchive-zip-perl libclone-perl \
218 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
219 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
220 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
221 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
222 librose-db-perl librose-object-perl libsort-naturally-perl \
223 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
224 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
225 libfile-copy-recursive-perl postgresql</programlisting>
229 <title>Fedora Core</title>
231 <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>
233 <programlisting>yum install httpd perl-Archive-Zip perl-Clone perl-DBD-Pg \
234 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
235 perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
236 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
237 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
238 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
239 perl-XML-Writer perl-YAML perl-parent postgresql-server</programlisting>
241 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
243 <programlisting>yum install perl-CPAN
244 cpan Config::Std</programlisting>
249 <title>openSUSE</title>
251 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
252 installiert werden:</para>
254 <programlisting>zypper install apache2 perl-Archive-Zip perl-Clone \
255 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
256 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
257 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
258 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
259 perl-URI perl-XML-Writer perl-YAML postgresql-server</programlisting>
261 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
263 <programlisting>yum install perl-CPAN
264 cpan Rose::Db::Object</programlisting>
270 <sect1 id="Manuelle-Installation-des-Programmpaketes"
271 xreflabel="Manuelle Installation des Programmpaketes">
272 <title>Manuelle Installation des Programmpaketes</title>
274 <para>Die kivitendo ERP Installationsdatei (<filename>kivitendo-erp-3.0.0.tgz</filename>) wird im Dokumentenverzeichnis des Webservers
275 (z.B. <filename>/var/www/html/</filename>, <filename>/srv/www/htdocs</filename> oder <filename>/var/www/</filename>) entpackt:</para>
277 <programlisting>cd /var/www
278 tar xvzf kivitendo-erp-3.0.0.tgz</programlisting>
280 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
282 <programlisting>cd kivitendo-erp</programlisting>
284 <para>Alternativ können Sie auch einen Alias in der
285 Webserverkonfiguration benutzen, um auf das tatsächliche
286 Installationsverzeichnis zu verweisen.</para>
288 <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
289 beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
290 Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
291 core <constant>apache</constant> oder bei OpenSUSE <constant>wwwrun</constant>).</para>
293 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
294 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
296 <programlisting>chown -R www-data users spool webdav</programlisting>
298 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
299 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>
301 <programlisting>chown www-data templates users</programlisting>
304 <sect1 id="config.config-file">
305 <title>kivitendo-Konfigurationsdatei</title>
307 <sect2 id="config.config-file.introduction"
308 xreflabel="Einführung in die Konfigurationsdatei">
309 <title>Einführung</title>
311 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei,
312 die benötigt wird: <filename>config/kivitendo.conf</filename> (kurz:
313 "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
314 von kivitendo bzw. der Migration von älteren Versionen angelegt
317 <para>Als Vorlage dient die Datei
318 <filename>config/kivitendo.conf.default</filename> (kurz: "die
319 Default-Datei"):</para>
321 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
323 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
324 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
325 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
326 Abschnitte und Werte enthalten, die von denen der Default-Datei
331 Vor der Umbenennung in kivitendo hieß diese Datei noch <filename>config/lx_office.conf</filename>. Aus Gründen der Kompatibilität
332 wird diese Datei eingelesen, sofern die Datei <filename>config/kivitendo.conf</filename> nicht existiert.
336 <para>Diese Hauptkonfigurationsdatei ist dann eine
337 installationsspezifische Datei, d.h. sie enthält bspw. lokale
338 Passwörter und wird auch nicht im Versionsmanagement (git)
341 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
342 Mandaten, bzw. Datenbanken gleich.</para>
345 <sect2 id="config.config-file.sections-parameters">
346 <title>Abschnitte und Parameter</title>
348 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
349 entsprechend kommentiert sind:</para>
352 <listitem><para><literal>authentication</literal> (siehe Abschnitt "<xref
353 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>" in diesem Kapitel)</para></listitem>
355 <listitem><para><literal>authentication/database</literal></para></listitem>
357 <listitem><para><literal>authentication/ldap</literal></para></listitem>
359 <listitem><para><literal>system</literal></para></listitem>
361 <listitem><para><literal>paths</literal></para></listitem>
363 <listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>
365 <listitem><para><literal>applications</literal></para></listitem>
367 <listitem><para><literal>environment</literal></para></listitem>
370 <listitem><para><literal>print_templates</literal></para></listitem>
372 <listitem><para><literal>task_server</literal></para></listitem>
374 <listitem><para><literal>periodic_invoices</literal></para></listitem>
376 <listitem><para><literal>self_tests</literal></para></listitem>
378 <listitem><para><literal>console</literal></para></listitem>
380 <listitem><para><literal>testing</literal></para></listitem>
382 <listitem><para><literal>testing/database</literal></para></listitem>
384 <listitem><para><literal>debug</literal></para></listitem>
387 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
388 einzustellen oder zu kontrollieren sind, sind:</para>
390 <programlisting>[authentication]
391 admin_password = geheim
393 [authentication/database]
398 password =</programlisting>
400 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
401 <varname>[periodic_invoices]</varname> den Login eines Benutzers
402 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
403 mit Informationen über die erstellten Rechnungen bekommt.</para>
405 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten Ausführung bestimmter Aufgaben mit, den <link
406 linkend="config.task-server">Taskserver</link>. Er wird u.a. für Features wie die <link
407 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link> benötigt, erledigt aber auch andere erforderliche Aufgaben
408 und muss daher in Betrieb genommen werden. Der Taskserver benötigt zwei Konfigurationseinstellungen, die unter
409 <varname>[task_server]</varname> anzugeben sind: ein Mandant (entweder der Mandantenname oder eine Datenbank-ID, Variable
410 <varname>client</varname>), aus dem die Datenbankkonfiguration entnommen wird, sowie ein Login (Variable <varname>login</varname>)
411 eines Benutzers, der für gewisse Dinge wie die Rechnungserstellung als Verkäufer eingetragen wird.</para>
413 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
414 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
417 <sect2 id="config.config-file.prior-versions">
418 <title>Versionen vor 2.6.3</title>
420 <para>In älteren kivitendo Versionen gab es im Verzeichnis
421 <filename>config</filename> die Dateien
422 <filename>authentication.pl</filename> und
423 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
424 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
425 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
426 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
428 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
429 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
430 manuell übertragen und die alten Konfigurationsdateien anschließend
431 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
432 entsprechende Fehlermeldung an.</para>
436 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
437 <title>Anpassung der PostgreSQL-Konfiguration</title>
439 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
441 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
442 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
444 <para>kivitendo setzt zwingend voraus, dass die Datenbank Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen Serverinstallationen
445 braucht man hier meist nicht einzugreifen.</para>
447 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so
448 braucht man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
450 <programlisting>su postgres
452 exit </programlisting>
454 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
455 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
456 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
459 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
461 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
462 Versionsnummer angepasst werden.</para>
464 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
466 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
467 <literal>\l</literal> geprüft werden.</para>
470 <sect2 id="Änderungen-an-Konfigurationsdateien">
471 <title>Änderungen an Konfigurationsdateien</title>
473 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
474 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
475 <filename>/var/lib/pgsql/data/</filename> oder
476 <filename>/etc/postgresql/</filename>, muss sichergestellt werden,
477 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
478 Parameter <varname>listen_address</varname> gesteuert. Laufen
479 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
480 <literal>localhost</literal> verwendet werden. Andernfalls müssen
481 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
482 was mit dem Wert <literal>*</literal> geschieht.</para>
484 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
485 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
486 sein sollte, müssen die Berichtigungen für den Zugriff geändert
487 werden. Hier gibt es mehrere Möglichkeiten. sinnvoll ist es nur die
488 nögiten Verbindungen immer zuzulassen, für eine lokal laufenden
489 Datenbank zum Beispiel:</para>
491 <programlisting>local all kivitendo password
492 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
495 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
496 <title>Erweiterung für servergespeicherte Prozeduren</title>
498 <para>In der Datenbank <literal>template1</literal> muss die
499 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
500 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
501 <programlisting>su - postgres
502 psql template1</programlisting>
504 führen Sie die folgenden Kommandos aus:</para>
506 <programlisting>create language 'plpgsql';
510 <sect2 id="Datenbankbenutzer-anlegen">
511 <title>Datenbankbenutzer anlegen</title>
513 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
514 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
515 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
518 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit nein
519 beantworten, genauso ist die Berechtigung neue User (Roles) zu
520 generieren nicht nötig.</para>
521 <programlisting>su - postgres
522 createuser -d -P kivitendo
523 exit</programlisting>
525 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
526 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.
527 den hier gewählten Benutzernamen.</para>
531 <sect1 id="Apache-Konfiguration">
532 <title>Webserver-Konfiguration</title>
535 <title>Grundkonfiguration mittels CGI</title>
538 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
539 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
540 <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
543 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
544 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
545 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
546 anderen Datei hinzu, die beim Starten des Webservers eingelesen
549 <programlisting>AddHandler cgi-script .pl
550 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
552 <Directory /var/www/kivitendo-erp>
553 Options ExecCGI Includes FollowSymlinks
556 <Directory /var/www/kivitendo-erp/users>
559 </Directory></programlisting>
561 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
562 das kivitendo-Archiv entpacket haben.</para>
565 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
566 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
569 <para>Auf einigen Webservern werden manchmal die Grafiken und
570 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
571 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
573 <programlisting>EnableSendfile Off</programlisting>
576 <sect2 id="Apache-Konfiguration.FCGI"
577 xreflabel="Konfiguration für FastCGI/FCGI">
578 <title>Konfiguration für FastCGI/FCGI</title>
580 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
581 <title>Was ist FastCGI?</title>
583 <para>Direkt aus <ulink
584 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
587 <para><citation> FastCGI ist ein Standard für die Einbindung
588 externer Software zur Generierung dynamischer Webseiten in einem
589 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
590 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
591 umgehen. </citation></para>
594 <sect3 id="Apache-Konfiguration.FCGI.Warum">
595 <title>Warum FastCGI?</title>
597 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
598 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
599 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
600 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
601 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
602 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
603 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
604 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
605 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
606 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
607 deutlich länger dauert als früher, und dass davon 90% für das Laden
608 der Module verwendet wird.</para>
610 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
611 wird nur die eigentliche Programmlogik ausgeführt.</para>
614 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
615 <title>Getestete Kombinationen aus Webservern und Plugin</title>
617 <para>Folgende Kombinationen sind getestet:</para>
621 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
625 <para>Apache 2.2.11 (Ubuntu) und mod_fastcgi.</para>
629 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
630 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
631 mod_fastcgi nicht mehr explizit eingegangen.</para>
633 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
637 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern
638 bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrere Installation gibt, muss zwingend Version 0.68 oder
639 aber Version 0.72 und neuer eingesetzt werden.</para>
641 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie sich die Vorgängerversion wie folgt
644 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
648 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
649 <title>Konfiguration des Webservers</title>
651 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
652 laufen zu lassen, empfliehlt es sich die Installation ersteinmal
653 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
654 debuggen die beim ersten aufsetzen auftreten können. Sollte die
655 Installation schon funktionieren, lesen Sie weiter.</para>
657 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
658 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
660 <programlisting>a2enmod fcgid</programlisting>
662 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
663 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
664 und <function>Directory</function>-Direktiven. Dabei wird zwischen
665 dem Installationspfad von kivitendo im Dateisystem
666 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
667 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
668 ("<filename>/url/for/kivitendo-erp</filename>").</para>
670 <para>Folgender Konfigurationsschnipsel funktioniert mit
673 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
674 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
676 <Directory /path/to/kivitendo-erp>
678 Options ExecCGI Includes FollowSymlinks
683 <DirectoryMatch /path/to/kivitendo-erp/users>
686 </DirectoryMatch></programlisting>
688 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
689 die maximale Größe eines Requests. Diese sollte wie folgt
690 hochgesetzt werden:</para>
692 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
694 <para>Das ganze sollte dann so aussehen:</para>
696 <programlisting>AddHandler fcgid-script .fpl
697 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
698 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
699 FcgidMaxRequestLen 10485760
701 <Directory /path/to/kivitendo-erp>
703 Options ExecCGI Includes FollowSymlinks
708 <DirectoryMatch /path/to/kivitendo-erp/users>
711 </DirectoryMatch></programlisting>
713 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
714 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
715 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
716 gibt es hier kleine Performance-Einbußen.</para>
718 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
719 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
720 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
722 <programlisting># Zugriff über CGI
723 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
725 # Zugriff mit mod_fcgid:
726 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
727 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
729 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
730 die normale Version erreichbar, und unter
731 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
732 FastCGI-Version.</para>
737 <sect1 id="config.task-server">
738 <title>Der Task-Server</title>
740 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und
741 diese zu festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess wird u.a. für die Erzeugung der wiederkehrenden
742 Rechnungen und weitere essenzielle Aufgaben benutzt.</para>
744 <sect2 id="Konfiguration-des-Task-Servers">
745 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
747 <para>Die Konfiguration erfolgt über den Abschnitt
748 <literal>[task_server]</literal> in der Datei
749 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
750 Optionen sind:</para>
754 <term><varname>client</varname></term>
757 <para>Name oder Datenbank-ID eines vorhandenen kivitendo-Mandanten, der benutzt wird, um die zu verwendende
758 Datenbankverbindung auszulesen. Der Mandant muss in der Administration angelegt werden. Diese Option muss angegeben
761 <para>Diese Option kam mit Release v3.x.0 hinzu und muss daher in Konfigurationen, die von älteren Versionen aktualisiert
762 wurden, ergänzt werden.</para>
767 <term><varname>login</varname></term>
770 <para>gültiger kivitendo-Benutzername, der z.B. als Verkäufer beim Erzeugen wiederkehrender Rechnungen benötigt wird. Der
771 Benutzer muss in der Administration angelegt werden. Diese Option muss angegeben werden.</para>
776 <term><varname>run_as</varname></term>
779 <para>Wird der Server vom Systembenutzer <literal>root</literal>
780 gestartet, so wechselt er auf den mit <literal>run_as</literal>
781 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
782 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
784 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
785 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
786 unter dem auch der Webserver läuft.</para>
791 <term><varname>debug</varname></term>
794 <para>Schaltet Debug-Informationen an und aus.</para>
800 <sect2 id="Einbinden-in-den-Boot-Prozess">
801 <title>Automatisches Starten des Task-Servers beim Booten</title>
803 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
804 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
805 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
807 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
808 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
809 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
810 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
811 anstelle eines symbolischen Links verwendet werden können.</para>
814 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, ältere Fedora Core)</title>
816 <para>Kopieren Sie die Datei
817 <filename>scripts/boot/system-v/kivitendo-server</filename>
818 nach <filename>/etc/init.d/kivitendo-server</filename>. Passen
819 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
820 <literal>DAEMON=....</literal>). Binden Sie das Script in den
821 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
825 <para>Debian-basierende Systeme:</para>
827 <programlisting>update-rc.d kivitendo-task-server defaults
828 # Nur bei Debian Squeeze und neuer:
829 insserv kivitendo-task-server</programlisting>
833 <para>Ältere OpenSUSE und ältere Fedora Core:</para>
835 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
839 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
842 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
846 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
848 <para>Kopieren Sie die Datei
849 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
850 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
851 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
852 <literal>exec ....</literal>).</para>
854 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
857 <programlisting>service kivitendo-task-server start</programlisting>
861 <title>systemd-basierende Systeme (z.B. neure OpenSUSE, neuere Fedora Core)</title>
863 <para>Verlinken Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
864 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
865 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>). Binden Sie das Script in den Boot-Prozess ein.
868 <para>Alle hierzu benötigten Befehle sehen so aus:</para>
870 <programlisting>cd /var/www/kivitendo-erp/scripts/boot/systemd
871 ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
873 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
876 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
880 <sect2 id="Prozesskontrolle">
881 <title>Wie der Task-Server gestartet und beendet wird</title>
883 <para>Der Task-Server wird wie folgt kontrolliert:</para>
885 <programlisting>./scripts/task_server.pl Befehl</programlisting>
887 <para><literal>Befehl</literal> ist dabei eine der folgenden
892 <para><literal>start</literal> startet eine neue Instanz des
893 Task-Servers. Die Prozess-ID wird innerhalb des
894 <filename>users</filename>-Verzeichnisses abgelegt.</para>
898 <para><literal>stop</literal> beendet einen laufenden
903 <para><literal>restart</literal> beendet und startet ihn
908 <para><literal>status</literal> berichtet, ob der Task-Server
913 <para>Der Task-Server wechselt beim Starten automatisch in das
914 kivitendo-Installationsverzeichnis.</para>
916 <para>Dieselben Optionen können auch für die SystemV-basierenden
917 Runlevel-Scripte benutzt werden (siehe oben).</para>
919 <sect2 id="Prozesskontrolle2">
920 <title>Task-Server mit mehreren Mandanten</title>
922 <para>Beim Task-Server werden der zu verwendende Mandant und Login-Name des Benutzers, unter dem der Task-Server laufen soll, in die
923 Konfigurationsdatei geschrieben. Hat man mehrere Mandanten, muss man auch mehrere Konfigurationsdateien anlegen.</para>
925 <para>Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf, wo in der Kategorie <varname>[task_server]</varname> die
926 gewünschten Werte für <varname>client</varname> und <varname>login</varname> eingetragen werden.</para>
928 <para>Der alternative Task-Server wird dann mit folgendem Befehl
931 <programlisting>./scripts/task_server.pl -c config/DATEINAME.conf</programlisting>
935 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
936 <title>Benutzerauthentifizierung und Administratorpasswort</title>
938 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
939 über die Verwaltung von Gruppen und weitere Einstellungen</para>
941 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
942 <title>Grundlagen zur Benutzerauthentifizierung</title>
944 <para>kivitendo verwaltet die Benutzerinformationen in einer
945 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
946 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
947 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
948 können, müssen aber nicht unterschiedlich sein.</para>
950 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
951 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
952 abgelegt werden.</para>
954 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
955 entweder gegen die Authentifizierungsdatenbank oder gegen einen
956 LDAP-Server überprüft werden.</para>
958 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
959 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
960 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
961 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
962 einer Version vor v2.6.0 angelegt werden. Eine
963 Beispielkonfigurationsdatei
964 <filename>config/kivitendo.conf.default</filename> existiert, die als
965 Vorlage benutzt werden kann.</para>
968 <sect2 id="Administratorpasswort">
969 <title>Administratorpasswort</title>
971 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
972 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
973 nur dort und nicht mehr im Administrationsinterface selber geändert
974 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
975 Abschnitt <varname>[authentication]</varname>.</para>
978 <sect2 id="Authentifizierungsdatenbank">
979 <title>Authentifizierungsdatenbank</title>
981 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
982 Parametern in <varname>[authentication/database]</varname>
983 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
987 <term><literal>host</literal></term>
990 <para>Der Rechnername oder die IP-Adresse des
991 Datenbankservers</para>
996 <term><literal>port</literal></term>
999 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1004 <term><literal>db</literal></term>
1007 <para>Der Name der Authentifizierungsdatenbank</para>
1012 <term><literal>user</literal></term>
1015 <para>Der Benutzername, mit dem sich kivitendo beim
1016 Datenbankserver anmeldet (z.B.
1017 "<literal>postgres</literal>")</para>
1022 <term><literal>password</literal></term>
1025 <para>Das Passwort für den Datenbankbenutzer</para>
1030 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1031 automatisch anlegen (mehr dazu siehe unten).</para>
1034 <sect2 id="Passwortüberprüfung">
1035 <title>Passwortüberprüfung</title>
1037 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1038 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1039 Active-Directory-Server. Welche davon benutzt wird, regelt der
1040 Parameter <varname>module</varname> im Abschnitt
1041 <varname>[authentication]</varname>.</para>
1043 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1044 gespeichert werden, so muss der Parameter <varname>module</varname>
1045 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1046 der Administrator als auch die Benutzer selber ihre Psaswörter in
1047 kivitendo ändern.</para>
1049 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1050 benutzt werden, so muss der Parameter <varname>module</varname> auf
1051 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1052 zusätzliche Informationen über den LDAP-Server im Abschnitt
1053 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1057 <term><literal>host</literal></term>
1060 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1061 Active-Directory-Servers. Diese Angabe ist zwingend
1062 erforderlich.</para>
1067 <term><literal>port</literal></term>
1070 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1075 <term><literal>tls</literal></term>
1078 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1079 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1080 ‘<literal>0</literal>’ belassen</para>
1085 <term><literal>attribute</literal></term>
1088 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1089 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1090 meist ‘<literal>sAMAccountName</literal>’, für andere
1091 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1092 zwingend erforderlich.</para>
1097 <term><literal>base_dn</literal></term>
1100 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1101 Diese Angabe ist zwingend erforderlich.</para>
1106 <term><literal>filter</literal></term>
1109 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1110 <literal><%login%></literal>, so wird dieses durch den vom
1111 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1112 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1113 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1118 <term><literal>bind_dn</literal> und
1119 <literal>bind_password</literal></term>
1122 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1123 durchsucht werden kann (z.B. ist dies bei
1124 Active-Directory-Servern der Fall), so kann diese hier angegeben
1125 werden. Für Active-Directory-Server kann als
1126 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1127 z.B. ‘<literal>cn=Martin
1128 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1129 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1130 also ‘<literal>Martin Mustermann</literal>’.</para>
1136 <sect2 id="Name-des-Session-Cookies">
1137 <title>Name des Session-Cookies</title>
1139 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1140 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1141 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1142 Parameter <varname>cookie_name</varname> im Abschnitt
1143 <varname>[authentication]</varname>gesetzt.</para>
1145 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1146 Server existiert.</para>
1149 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1150 <title>Anlegen der Authentifizierungsdatenbank</title>
1152 <para>Nachdem alle Einstellungen in
1153 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1154 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1155 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1156 der folgenden URL erreichbar sein sollte:</para>
1159 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1163 <sect1 id="Benutzer--und-Gruppenverwaltung">
1164 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1166 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und Datenbanken angelegt werden. Dieses geschieht im
1167 Administrationsmenü, das Sie unter folgender URL finden:</para>
1170 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1172 <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
1173 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1175 <sect2 id="Zusammenhänge">
1176 <title>Zusammenhänge</title>
1178 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung in einer oder zwei Datenbanken gespeichert werden.</para>
1180 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat
1181 Zugriff auf welche Mandanten, und welche Gruppe verfügt über welche Rechte. Diese Informationen werden in der
1182 Authentifizierungsdatenbank gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter in der Konfigurationsdatei
1183 <filename>config/kivitendo.conf</filename> gespeichert werden.</para>
1185 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten, Waren) und Belege
1186 (Angebote, Lieferscheine, Rechnungen). Diese werden in einer Mandantendatenbank gespeichert. Die
1187 Verbindungsinformationen einer solchen Mandantendatenbank werden im Administrationsbereich konfiguriert, indem man einen Mandanten
1188 anlegt und dort die Parameter einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1190 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich, die Authentifizierungsdatenbank und eine der
1191 Mandantendatenbanken in ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit mehr als einem Mandanten, wird
1192 empfohlen, für die Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die nicht gleichzeitig für einen Mandanten
1193 verwendet wird.</para>
1196 <sect2 id="Mandanten-Benutzer-Gruppen">
1197 <title>Mandanten, Benutzer und Gruppen</title>
1199 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen, die sich frei zueinander zuordnen lassen.</para>
1201 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1202 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1203 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank. Diese sollte über die <link
1204 linkend="Datenbanken-anlegen">Datenbankverwaltung</link> geschehen.</para>
1206 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten soll. Sie erhält einen Loginnamen sowie ein
1207 Passwort. Weiterhin legt der Administrator fest, an welchen Mandanten sich ein Benutzer anmelden kann, was beim Login verifiziert
1210 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür
1211 vom Administrator gewisse Rechte zugeordnet. Weiterhin legt der Administrator fest, für welche Mandanten eine Gruppe gilt, und
1212 welche Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer dann an einem Mandanten an, so erhält er alle Rechte von
1213 allen denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in denen der Benutzer zum Anderen Mitglied ist, </para>
1215 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und Benutzer angelegt werden, kann im Prinzip beliebig gewählt
1216 werden. Die folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1218 <orderedlist numeration="arabic">
1220 <para>Datenbank anlegen</para>
1224 <para>Gruppen anlegen</para>
1228 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1232 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1237 <sect2 id="Datenbanken-anlegen">
1238 <title>Datenbanken anlegen</title>
1240 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1241 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1242 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1245 <sect2 id="Gruppen-anlegen">
1246 <title>Gruppen anlegen</title>
1248 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1249 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1250 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1251 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1253 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank gespeichert, gelten aber nicht automatisch für alle
1254 Mandanten. Der Administrator legt vielmehr fest, für welche Mandanten eine Gruppe gültig ist. Dies kann entweder beim Bearbeiten der
1255 Gruppe geschehen ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn man einen Mandanten bearbeitet ("für diesen
1256 Mandanten sind die Gruppen A, B und C gültig").</para>
1258 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder dieser Gruppe festgelegt werden ("in dieser Gruppe sind die
1259 Benutzer X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten eines Benutzers geschehen ("dieser Benutzer ist
1260 Mitglied in den Gruppen A, B und C").</para>
1263 <sect2 id="Benutzer-anlegen">
1264 <title>Benutzer anlegen</title>
1266 <para>Beim Anlegen von Benutzern werden für viele Parameter Standardeinstellungen vorgenommen, die den Gepflogenheiten des deutschen
1267 Raumes entsprechen.</para>
1269 <para>Zwingend anzugeben ist der Loginname. Wenn die Passwortauthentifizierung über die Datenbank eingestellt ist, so kann hier auch
1270 das Benutzerpasswort gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1273 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier auch konfiguriert werden, auf welche Mandanten der Benutzer
1274 Zugriff hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können sowohl beim Benutzer vorgenommen werden ("dieser
1275 Benutzer hat Zugriff auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen X, Y und Z") als auch beim Mandanten ("auf
1276 diesen Mandanten haben Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe sind Benutzer A, B und C
1277 Mitglieder").</para>
1280 <sect2 id="Mandanten-anlegen">
1281 <title>Mandanten anlegen</title>
1283 <para>Ein Mandant besteht aus Administrationssicht primär aus einem eindeutigen Namen. Weiterhin wird hier hinterlegt, welche
1284 Datenbank als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten einer der eben angelegten Datenbanken eingetragen
1287 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch konfiguriert werden, welche Benutzer Zugriff auf den
1288 Mandanten haben bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen können sowohl beim Mandanten vorgenommen werden
1289 ("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
1290 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
1295 <sect1 id="config.sending-email" xreflabel="E-Mail-Versand aus kivitendo heraus">
1296 <title>E-Mail-Versand aus kivitendo heraus</title>
1298 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden, z.B. um ein Angebot direkt an einen Kunden zu
1299 verschicken. Damit dies funktioniert, muss eingestellt werden, über welchen Server die E-Mails verschickt werden sollen. kivitendo
1300 unterstützt dabei zwei Mechanismen: Versand über einen lokalen E-Mail-Server (z.B. mit <productname>Postfix</productname> oder
1301 <productname>Exim</productname>, was auch die standardmäßig aktive Methode ist) sowie Versand über einen SMTP-Server (z.B. der des
1302 eigenen Internet-Providers).</para>
1304 <para>Welche Methode und welcher Server verwendet werden, wird über die Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1305 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1307 <sect2 id="config.sending-email.sendmail" xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1308 <title>Versand über lokalen E-Mail-Server</title>
1310 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie
1311 z.B. <productname>Postfix</productname>, <productname>Exim</productname> oder <productname>Sendmail</productname> läuft.</para>
1313 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1314 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1316 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet wird, dient der Parameter '<literal>sendmail =
1317 ...</literal>'. Der Standardwert verweist auf das Programm <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1318 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1320 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen dieses sprengen. Hierfür sei auf die Dokumentation des
1321 E-Mail-Servers verwiesen.</para>
1324 <sect2 id="config.sending-email.smtp" xreflabel="E-Mail-Versand über einen SMTP-Server">
1325 <title>Versand über einen SMTP-Server</title>
1327 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server vorhanden oder zwar einer vorhanden, dieser aber nicht
1328 konfiguriert ist.</para>
1330 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1331 Parameter dienen dabei der weiteren Konfiguration:</para>
1335 <term><varname>hostname</varname></term>
1337 <listitem><para>Name oder IP-Adresse des SMTP-Servers. Standardwert: '<literal>localhost</literal>'</para></listitem>
1341 <term><varname>port</varname></term>
1343 <listitem><para>Portnummer. Der Standardwert hängt von der verwendeten Verschlüsselungsmethode ab. Gilt '<literal>security =
1344 none</literal>' oder '<literal>security = tls</literal>', so ist 25 die Standardportnummer. Für '<literal>security =
1345 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht geändert werden.</para></listitem>
1349 <term><varname>security</varname></term>
1351 <listitem><para>Wahl der zu verwendenden Verschlüsselung der Verbindung mit dem Server. Standardwert ist
1352 '<literal>none</literal>', wodurch keine Verschlüsselung verwendet wird. Mit '<literal>tls</literal>' wird TLS-Verschlüsselung
1353 eingeschaltet, und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL eingeschaltet. Achtung: Für
1354 '<literal>tls</literal>' und '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt (siehe unten).</para></listitem>
1358 <term><varname>login</varname> und <varname>password</varname></term>
1360 <listitem><para>Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername
1361 und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von
1362 Verschlüsselung aktiviert werden.</para></listitem>
1366 <para>Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind:</para>
1369 <listitem><para>TLS-Verschlüsselung: Modul <literal>Net::SSLGlue</literal> (Debian-Paketname
1370 <literal>libnet-sslglue-perl</literal>, Fedora Core: <literal>perl-Net-SSLGlue</literal>, openSUSE:
1371 <literal>perl-Net-SSLGlue</literal></para></listitem>
1373 <listitem><para>SSL-Verschlüsselung: Modul <literal>Net::SMTP::SSL</literal> (Debian-Paketname
1374 <literal>libnet-smtp-ssl-perl</literal>, Fedora Core: <literal>perl-Net-SMTP-SSL</literal>, openSUSE:
1375 <literal>perl-Net-SMTP-SSL</literal></para></listitem>
1380 <sect1 id="Drucken-mit-kivitendo">
1381 <title>Drucken mit kivitendo</title>
1383 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. Um drucken zu können, braucht der Server ein geeignetes
1384 LaTeX System. Am einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter Debianoiden Betriebssystemen installiert man
1385 die Pakete mit:</para>
1387 <para><programlisting>aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1388 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1390 <para>TODO: RPM-Pakete.</para>
1392 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1394 <listitem><para>Standard</para></listitem>
1395 <listitem><para>f-tex</para></listitem>
1396 <listitem><para>RB</para></listitem>
1399 <sect2 id="Vorlagenverzeichnis-anlegen" xreflabel="Vorlagenverzeichnis anlegen">
1400 <title>Vorlagenverzeichnis anlegen</title>
1401 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1403 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1405 <para>Der Angemmeldete Benutzer muss in einer Gruppe sein, die über das
1406 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch <xref linkend="Gruppen-anlegen"/>.
1408 <para>Im Userbereich lässt sich unter:
1409 "<guimenu>System</guimenu> ->
1410 <guisubmenu>Mandantenverwaltung</guisubmenu> -> <guimenuitem>Verschiedenes</guimenuitem>" die Option
1411 "Neue Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1414 <listitem><para><option>Vorlagen auswählen</option>: Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll
1415 (<filename>Standard</filename>, <filename>f-tex</filename> oder <filename>RB</filename>.)</para></listitem>
1416 <listitem><para><option>Neuer Name</option>: Der Verzeichnisname für den neuen Vorlagensatz. Dieser kann im Rahmen der üblichen
1417 Bedingungen für Verzeichnisnamen frei gewählt werden.</para></listitem>
1420 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist für den aktuellen Mandanten ausgewählt.
1421 Der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1422 Eventuell muessen Anpassungen (Logo, Erscheinungsbild, etc) noch vorgenommen werden. Den Ordner findet man im Dateisistem unter
1423 <filename>./templates/[Neuer Name]</filename></para>
1427 <sect2 id="Vorlagen-Standard">
1428 <title>Standard</title>
1430 <para>Der Standard-Vorlagensatz von Kivitendo. Wie unter <ulink url="http://demo.kivitendo.org">http://demo.kivitendo.org</ulink> zu
1436 <title>f-tex</title>
1438 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt.</para>
1440 <sect3 id="f-tex-Feature-Übersicht">
1441 <title>Feature-Übersicht</title>
1443 <listitem><para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage für alle briefartigen Dokumente verwendet. Also
1444 Angebot, Rechnung, Performarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc..</para></listitem>
1446 <listitem><para>Leichte Anpassung an das Firmen-Layout durch verwendung eines Hintergrund-PDF. Dieses kann leicht mit dem
1447 eigenen Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp, Adobe*)</para></listitem>
1449 <listitem><para>Hintergrund-PDF umschaltbar auf "nur erste Seite" (Standard) oder "alle Seiten" (Option
1450 "<option>bgPdfFirstPageOnly</option>" in Datei <filename>letter.lco</filename>)</para></listitem>
1452 <listitem><para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1453 versendeten Dokumenten eingebunden (Option "<option>bgPdfEmailOnly</option>" in Datei
1454 <filename>letter.lco</filename>).</para></listitem>
1456 <listitem><para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch, Wiederholung von Kopfzeilen, Zwischensummen
1457 etc. (danke an Kai-Martin Knaak für die Vorarbeit)</para></listitem>
1459 <listitem><para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom Land des eigenen Unternehmens abweicht (also die
1460 Rechnung das Land verlässt).</para></listitem>
1462 <listitem><para>Multisprachfähig leicht um weitere Sprachen zu erweitern, alle Übersetzungen in der Datei
1463 <filename>translatinos.tex</filename>.</para></listitem>
1465 <listitem><para>Auflistung von Bruttopreisen für Endverbraucher.</para></listitem>
1469 <sect3 id="f-tex-Installation">
1470 <title>Die Installation</title>
1472 <listitem><para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref linkend="Vorlagenverzeichnis-anlegen"/>. Das
1473 Vorlagensystem funktioniert jetzt schon, hat allerdings noch einen Beispiel-Briefkopf.</para></listitem>
1475 <listitem><para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach <filename>./letter_head.pdf</filename>.</para></listitem>
1476 <listitem><para>Editiere den Bereich "<option>settings</option>" in der datei <filename>letter.lco</filename>.</para></listitem>
1479 <para>oder etwas Detaillierter:</para>
1482 Es wird eine Datei <filename>sample.lco</filename> erstellt und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
1483 ist dies die Datei die für die Firmenspezifischen Anpassungen gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig
1484 ist, wird in dieser Datei auf ein Hintergrundpdf verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen
1485 vorzunehmen und <filename>sample.lco</filename> unverändert zu lassen. Die die Anpassung über eine
1486 <filename>*.lco</filename>-Datei die letztlich auf <filename>letter.lco</filename> verlinkt ist ist aber auch möglich.
1490 Es wird eine Datei <filename>sample_head.pdf</filename> mit ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
1491 verlinkt. Damit gibt es schon mal eine Funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei
1492 <filename>sample_haed.pdf</filename> an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
1493 Template Verzeichniss ablegen und statt <filename>sample_head.pdf</filename> nach <filename>letter_head.pdf</filename>
1498 letzlich muss <filename>letter_head.pdf</filename> auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
1499 enthält. Bei Updates oder nach erneutem
1503 Es wird eine Datei <filename>mydata.tex.example</filename> ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
1504 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das Land verwendet. Die Datei muss also nicht angefasst
1505 werden. Die Anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig).
1508 Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc. sollten über die Hintergrund-PDF-Datei oder die
1509 <filename>*.lco</filename>-Datei erfolgen.
1513 <sect3 id="f-tex-Funktionsübersicht">
1514 <title>f-tex Funktionsübersicht</title>
1516 Das Konzept von kivitendo sieht vor, für jedes Dokument (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine LaTeX-Vorlage
1517 vorzuhalten, dies ist sehr Wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
1518 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
1519 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche LaTeX-Vorlage verwendet, welche über Codeweichen die
1520 Besonderheiten der jeweiligen Dokumente Berücksichtigt.
1524 <listitem><para>Tabellen mit oder ohne Preis</para></listitem>
1525 <listitem><para>Sprache der Tabellenüberschriften etc.</para></listitem>
1526 <listitem><para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus Angebotsnummer)</para></listitem>
1527 <listitem><para>Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus Gewerblicher
1528 Kunde)</para></listitem>
1531 <para>Nachteil:</para>
1534 LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
1535 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann natürlich
1536 auch innerhalb der Tabellendarstellung gut persönliche Anpassungen vornehmen. Aber man kann sich hier bei Veränderungen sehr
1537 schnell häftig in den Fuss schiessen.
1540 <para>Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund PDF auf Basis der
1541 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen, und sich an der Form der dargestellten Tabellen wie sie
1542 ausgeliefert werden, erfreuen.
1545 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine kontinuierliche Schritte gehen.</para>
1549 <sect3 id="f-tex-Bruttopreise">
1550 <title>Bruttopreise für Endverbraucher</title>
1552 <para>Der auszuweisende Bruttopreis wird innerhalb der LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen "alle
1553 Preise Brutto" auszuwählen, aber:</para>
1556 <para>hierfür müssen die Preise auch in Brutto in der Datenbank stehen (ja - das lässt sich über die Preisgruppen und die
1557 Zuordung einer Default-Preisgruppe handhaben)</para>
1560 <para>man darf beim Anlegen des Vorgangs nicht vergessen Dieses Häkchen zu setzen. (das ist in der Praxis wenn man sowohl
1561 Endverbraucher- wie Gewerbekunden beliefert der eigentliche Knackpunkt)</para>
1566 Es gibt mit f-tex eine weitere Alternative. Die Information ob Brutto oder Nettorechnung wird mit den Zahlarten
1567 verknüpft. Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben werden sollen, enden mit "_E" (für
1568 Endverbraucher). Falls identische Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt man diese einfach doppelt
1569 an (einmal mit der Namensendung "_E"). Gewinn:</para>
1572 <listitem><para>Die Entscheidung, ob Netopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste Verbunden.</para></listitem>
1573 <listitem><para>Die Default-Zahlart kann im Kundendatensatz hinterlegt werden, und man muss nicht mehr daran denken, "alle Preise
1574 Netto" auszuwählen.</para></listitem>
1575 <listitem><para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken reviediert werden,
1576 ohne dass sich der Auftragswert ändert.</para></listitem>
1580 <sect3 id="f-tex-lieferadressen">
1581 <title>Lieferadressen</title>
1583 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen im Adressfeld zum Einsatz. Wenn die
1584 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende Adressvariable eingesetzt. Wenn also die Lieferadresse in
1585 Straße, Hausnummer und Ort abweicht, müssen auch nur diese Felder in der Lieferadresse ausgefüllt werden. Für den Firmenname wird
1586 der Wert der Hauptadresse angezeigt.
1591 <sect2 id="Vorlagen-RB">
1594 <para>Vollständiger Dokumentensatz mit alternativem Design</para>
1595 <para>Die konzeptionelle Idee wird <ulink
1596 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1597 auf Folie 5 bis 10 vorgestellt, Detaileinstellungen dann im Readme.tex im Vorlagenverzeichnis.</para>
1601 <sect2 id="allgemeine-hinweise-zu-latex">
1602 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
1603 <para>In den allermeisten Installationen sollte drucken jetzt schon
1604 funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
1605 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
1606 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1611 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1612 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1613 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1617 <para>! Package inputenc Error: Unicode char \u8:... set up for
1618 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1619 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1620 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1621 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1622 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1626 <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
1627 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1628 Prüfen Sie den Namen in der Konfiguration (Standard:
1629 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1630 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1633 <para>Wenn sich das Problem nicht auf Grund der ausgabe im Webbrowser verifizieren lässt:</para>
1636 <para> editiere [kivitendo-home]/config/kivitendo.conf und ändere "keep_temp_files" auf 1</para>
1637 <para><programlisting>keep_temp_files = 1;</programlisting></para>
1640 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
1643 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
1646 <para>wechsele in das users Verzeichnis von kivitendo</para>
1647 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
1650 <para>LaTeX Suchpfad anpassen:</para>
1651 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
1654 <para>Finde herraus welche Datei kivitendo beim letzten Durchlauf erstellt hat</para>
1655 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
1656 <para>Es sollte die letzte Datei ganz unten sein</para>
1659 <para>für besseren Hinweis auf Fehler texdatei nochmals übersetzen</para>
1660 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
1661 <para>in der *.tex datei nach dem Fehler suchen.</para>
1667 <sect1 id="OpenDocument-Vorlagen">
1668 <title>OpenDocument-Vorlagen</title>
1670 <para>kivitendo unterstützt die Verwendung von Vorlagen im
1671 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1672 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1673 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1674 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1675 <filename>config/kivitendo.conf</filename> die Variable
1676 <literal>opendocument</literal> im Abschnitt
1677 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1678 Dieses ist die Standardeinstellung.</para>
1680 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1681 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1682 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1683 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1684 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1685 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1687 <para>Nach der Installation müssen in der Datei
1688 <filename>config/kivitendo.conf</filename> zwei weitere Variablen
1689 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1690 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1691 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1692 enthalten. Beide stehen im Abschnitt
1693 <literal>applications</literal>.</para>
1695 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
1696 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1697 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1698 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1699 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1700 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1701 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1702 werden muss. Der Nachteil ist, dass diese Methode Python und die
1703 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1708 Für die Verbindung zu OpenOffice wird normalerweise der Python-Interpreter <filename>/usr/bin/python</filename> benutzt. Sollte
1709 dies nicht der richtige sein, so kann man mit zwei Konfigurationsvariablen entscheiden, welcher Python-Interpreter genutzt
1710 wird. Mit der Option <literal>python_uno</literal> aus dem Abschnitt <literal>applications</literal> wird der Interpreter selber
1711 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert <literal>/usr/bin/python</literal>.
1715 Zusätzlich ist es möglich, Pfade anzugeben, in denen Python neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
1716 z.B. falls sich diese in einem gesonderten OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
1717 <literal>python_uno_path</literal> und befindet sich im Abschnitt <literal>environment</literal>. Sie ist standardmäßig
1718 leer. Werden hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte voneinander getrennt werden. Der Inhalt wird an den
1719 Python-Interpreter über die Umgebungsvariable <literal>PYTHONPATH</literal> übergeben.
1723 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1724 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1725 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1726 Dokumentenvorlage enthalten sein und
1727 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1728 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1729 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1730 ebenfalls enthalten sein muss.</para>
1732 <para>Als letztes muss herausgefunden werden, welchen Namen
1733 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1734 gibt. Unter Debian ist dies momentan
1735 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1736 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1737 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1738 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1739 folgender Befehl auszuführen:</para>
1741 <para><literal>mv users/.openoffice.org2
1742 users/.openoffice</literal></para>
1744 <para>Dieses Verzeichnis, wie auch das komplette
1745 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1746 sein. Dieses wurde bereits erledigt (siehe <xref
1747 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1748 erneut überprüft werden, wenn die Konvertierung nach PDF
1752 <sect1 id="config.eur">
1753 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1756 <sect2 id="config.eur.introduction"
1757 xreflabel="Einführung in die Konfiguration zur EUR">
1758 <title>Einführung</title>
1760 <para>kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1761 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals noch <filename>config/lx_office.conf</filename>)
1762 befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden.</para>
1764 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1765 die Mandantendatenbank verschoben und dabei auch gleich in drei
1766 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1767 steuern lässt.</para>
1770 <sect2 id="config.eur.parameters"
1771 xreflabel="Konfigurationsparameter für EUR">
1772 <title>Konfigurationsparameter</title>
1774 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1775 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1779 <term><varname>profit_determination</varname></term>
1782 <para>Dieser Parameter legt die Berechnungsmethode für die
1783 Gewinnermittlung fest. Er enthält entweder
1784 <literal>balance</literal> für
1785 Betriebsvermögensvergleich/Bilanzierung oder
1786 <literal>income</literal> für die
1787 Einnahmen-Überschuss-Rechnung.</para>
1792 <term><varname>accounting_method</varname></term>
1795 <para>Dieser Parameter steuert die Buchungs- und
1796 Berechnungsmethoden für die Versteuerungsart. Er enthält
1797 entweder <literal>accrual</literal> für die Soll-Versteuerung
1798 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1803 <term><varname>inventory_system</varname></term>
1806 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1807 enthält entweder <literal>perpetual</literal> für die
1808 Bestandsmethode oder <literal>periodic</literal> für die
1809 Aufwandsmethode.</para>
1814 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1815 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1816 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1817 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1818 Bestandsmethode.</para>
1820 <para>Die Konfiguration "<varname>eur</varname>" unter
1821 <varname>[system]</varname> in der <link
1822 linkend="config.config-file">Konfigurationsdatei</link>
1823 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
1824 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1827 <sect2 id="config.eur.setting-parameters">
1828 <title>Festlegen der Parameter</title>
1830 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1831 der Admininstration können diese Optionen nun unabhängig voneinander
1832 eingestellt werden.</para>
1834 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1835 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1838 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1839 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
1840 angezeigt. Unter <guimenu>System</guimenu>
1841 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> können
1842 die Einstellungen auch geändert werden. Dabei ist zu beachten,
1843 dass eine Änderung vorhandene Daten so belässt und damit
1844 evtl. die Ergebnisse verfälscht. Dies gilt vor Allem für die
1845 Warenbuchungsmethode (siehe auch
1846 <link linkend="config.eur.inventory-system-perpetual">
1847 Bemerkungen zu Bestandsmethode</link>).</para>
1850 <sect2 id="config.eur.inventory-system-perpetual">
1851 <title>Bemerkungen zu Bestandsmethode</title>
1853 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1854 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
1855 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1856 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1857 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1858 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1859 Einkaufsrechnungen berechnet wird.</para>
1861 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1862 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1863 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1867 <sect2 id="config.eur.knonw-issues">
1868 <title>Bekannte Probleme</title>
1870 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1871 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1872 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1873 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1874 die Konfigurationsvariable
1875 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1878 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1879 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1883 <sect1 id="config.skr04-update-3804">
1884 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1886 <sect2 id="config.skr04-update-3804.introduction">
1887 <title>Einführung</title>
1889 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1890 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1891 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1892 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1893 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1894 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1895 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1896 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1897 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1898 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1899 Screenshots dargestellt.</para>
1901 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1902 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1903 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1904 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1907 <sect2 id="config.skr04-update-3804.create-chart">
1908 <title>Konto 3804 manuell anlegen</title>
1910 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
1911 anzulegen und zu konfigurieren. Zuerst wird in
1912 <guimenu>System</guimenu> ->
1913 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
1914 erfassen</guimenuitem> das Konto angelegt.</para>
1917 <screeninfo>Konto 3804 erfassen</screeninfo>
1921 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
1927 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
1928 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
1929 wie im folgenden Screenshot angezeigt anpassen.
1933 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
1937 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
1943 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
1944 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
1948 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
1952 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
1958 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
1959 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
1960 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
1961 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
1965 <screeninfo>Konto 4315 anpassen</screeninfo>
1969 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
1975 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
1976 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
1980 <screeninfo>Steuerliste vergleichen</screeninfo>
1984 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
1991 <sect1 id="config.client">
1992 <title>Einstellungen pro Mandant</title>
1994 <para>Einige Einstellungen können von einem Benutzer mit dem
1995 <link linkend="Zusammenhänge">Recht</link> "Administration
1996 (Für die Verwaltung der aktuellen Instanz aus einem Userlogin heraus)"
1997 gemacht werden. Diese Einstellungen sind dann für die aktuellen
1998 Mandanten-Datenbank gültig. Die Einstellungen sind
1999 unter <guimenu>System</guimenu>
2000 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
2002 <para>Bitte beachten Sie die Hinweise zu den einzelnen
2003 Einstellungen. Einige Einstellungen sollten nicht ohne Weiteres
2004 im laufenden Betrieb geändert werden (siehe
2005 auch <link linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
2006 Bestandsmethode</link>).</para>
2008 <para>Die Einstellungen <literal>show_bestbefore</literal>
2009 und <literal>payments_changeable</literal> aus dem
2010 Abschnitt <literal>features</literal> und die Einstellungen im
2011 Abschnitt <literal>datev_check</literal> (sofern schon vorhanden)
2012 der <link linkend="config.config-file">kivitendo-Konfigurationsdatei</link>
2013 werden bei einem Datenbankupdate einer älteren Version automatisch
2014 übernommen. Diese Einträge können danach aus der Konfigurationsdatei
2015 entfernt werden.</para>
2018 <sect1 id="kivitendo-ERP-verwenden">
2019 <title>kivitendo ERP verwenden</title>
2021 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
2022 folgender URL erreichbar:</para>
2025 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
2027 <para>Die Administrationsseite erreichen Sie unter:</para>
2030 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
2034 <chapter id="features" xreflabel="Features und Funktionen">
2035 <title>Features und Funktionen</title>
2037 <sect1 id="features.periodic-invoices"
2038 xreflabel="Wiedekehrende Rechnungen">
2039 <title>Wiederkehrende Rechnungen</title>
2041 <sect2 id="features.periodic-invoices.introduction"
2042 xreflabel="Einführung in wiederkehrende Rechnungen">
2043 <title>Einführung</title>
2045 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
2046 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
2047 Die konfigurierten Aufträge werden später automatisch in Rechnungen
2048 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
2049 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
2050 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
2051 wiederzufinden sind.</para>
2054 <sect2 id="features.periodic-invoices.configuration"
2055 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
2056 <title>Konfiguration</title>
2058 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
2059 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
2060 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
2061 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
2062 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
2065 <para>Folgende Parameter kann man konfigurieren:</para>
2072 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
2073 erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
2074 neuen Monats).</para>
2076 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
2077 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
2078 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
2079 nächsten Periodenwechsel für alle Perioden, seit der letzten
2080 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
2081 verhindern, muss man vorher das Startdatum neu setzen.</para>
2083 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
2084 erstellt. Man kann sich diese Aufträge aber gesondert in den
2085 Berichten anzeigen lassen.</para>
2090 <term>Periodizität</term>
2093 <para>Ob monatlich, quartalsweise oder jährlich auf neue
2094 Rechnungen überprüft werden soll. Für jede Periode seit dem
2095 Startdatum wird überprüft, ob für die Periode (beginnend immer
2096 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
2097 wurde. Unter Umständen können bei einem Startdatum in der
2098 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
2103 <term>Buchen auf</term>
2106 <para>Das Forderungskonto, in der Regel "Forderungen aus
2107 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
2108 Buchungsgruppen der betreffenden Waren.</para>
2113 <term>Startdatum</term>
2116 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
2122 <term>Enddatum</term>
2125 <para>ab wann keine Rechnungen mehr erstellt werden
2131 <term>Automatische Verlängerung um x Monate</term>
2134 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
2135 eingetragenen Enddatums weiterhin erstellt werden, so kann man
2136 hier die Anzahl der Monate eingeben, um die das Enddatum
2137 automatisch nach hinten geschoben wird.</para>
2142 <term>Drucken</term>
2145 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
2146 Rechnungen auch gleich ausdrucken lassen.</para>
2151 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
2152 Informationen zu den erstellten Rechnungen verschickt werden.
2153 Konfiguriert wird dies in der <link
2154 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
2155 <filename>config/kivitendo.conf</filename> im Abschnitt
2156 <varname>[periodic_invoices]</varname>.</para>
2159 <sect2 id="features.periodic-invoices.variables">
2160 <title>Spezielle Variablen</title>
2163 Um die erzeugten Rechnungen individualisieren zu können, werden beim Umwandeln des Auftrags in eine Rechnung einige speziell
2164 formatierte Variablen durch für die jeweils aktuelle Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B. den
2165 Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei die Syntax <literal><%variablenname%></literal>.
2169 Diese Variablen werden in den folgenden Elementen des Auftrags ersetzt:
2173 <listitem><para>Bemerkungen</para></listitem>
2174 <listitem><para>Interne Bemerkungen</para></listitem>
2175 <listitem><para>Vorgangsbezeichnung</para></listitem>
2176 <listitem><para>In den Beschreibungs- und Langtextfeldern aller Positionen</para></listitem>
2179 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
2183 <term><varname><%current_quarter%></varname>, <varname><%previous_quarter%></varname>, <varname><%next_quarter%></varname></term>
2187 Aktuelles, vorheriges und nächstes Quartal als Zahl zwischen <literal>1</literal> und <literal>4</literal>.
2193 <term><varname><%current_month%></varname>, <varname><%previous_month%></varname>, <varname><%next_month%></varname></term>
2197 Aktueller, vorheriger und nächster Monat als Zahl zwischen <literal>1</literal> und <literal>12</literal>.
2203 <term><varname><%current_month_long%></varname>, <varname><%previous_month_long%></varname>, <varname><%next_month_long%></varname></term>
2207 Aktueller, vorheriger und nächster Monat als Name (<literal>Januar</literal>, <literal>Februar</literal> etc.).
2213 <term><varname><%current_year%></varname>, <varname><%previous_year%></varname>, <varname><%next_year%></varname></term>
2217 Aktuelles, vorheriges und nächstes Jahr als vierstellige Jahreszahl (<literal>2013</literal> etc.).
2223 <term><varname><%period_start_date%></varname>, <varname><%period_end_date%></varname></term>
2227 Formatiertes Datum des ersten und letzten Tages im Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im ersten
2228 Quartal von 2013 wären dies der <literal>01.01.2013</literal> und <literal>31.03.2013</literal>).
2235 <sect2 id="features.periodic-invoices.reports">
2236 <title>Auflisten</title>
2238 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
2239 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
2240 Rechnungen inaktiv", mit denen man sich einen Überglick über die
2241 wiederkehrenden Rechnungen verschaffen kann.</para>
2244 <sect2 id="features.periodic-invoices.task-server">
2245 <title>Erzeugung der eigentlichen Rechnungen</title>
2247 <para>Die zeitliche und periodische Überprüfung, ob eine
2248 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
2249 durch den <link linkend="config.task-server">Taskserver</link>, einen
2250 externen Dienst, der automatisch beim Start des Servers gestartet
2251 werden sollte.</para>
2254 <sect2 id="features.periodic-invoices.create-for-current-month">
2255 <title>Erste Rechnung für aktuellen Monat erstellen</title>
2257 <para>Will man im laufenden Monat eine monatlich wiederkehrende
2258 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
2259 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
2260 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
2261 generiert hat. Alternativ setzt man das Startdatum auf den
2262 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
2263 manuell über den Workflow.</para>
2266 <sect1 id="dokumentenvorlagen-und-variablen">
2267 <title>Dokumentenvorlagen und verfügbare Variablen</title>
2269 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
2270 <title>Einführung</title>
2272 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
2273 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
2274 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
2275 <function><%variablenname%></function> verwendet wird. Für
2276 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
2278 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
2280 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
2281 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
2282 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
2283 alle Vorlagenarten.</para>
2285 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
2286 verfügbar als hier aufgelistet werden. Die meisten davon können
2287 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
2288 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
2289 diese wie folgt erhalten werden:</para>
2293 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
2294 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
2298 <para>In <filename>Form.pm</filename> die Funktion
2299 <function>parse_template</function> suchen und hier die Zeile
2300 <command>print(STDERR Dumper($self));</command> einfügen.</para>
2304 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
2305 ein PDF für eine Rechnung erzeugen.</para>
2309 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
2310 der Variablen <varname>$self</varname> in der Form <varname>'key'
2311 => 'value',</varname>. Alle <varname>key</varname>s sind
2317 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
2318 <title>Variablen ausgeben</title>
2320 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
2321 Tags geschrieben werden, also z.B.
2322 <varname><%variablenname%></varname>.</para>
2324 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
2325 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
2326 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
2327 werden die folgenden Flags unterstützt:</para>
2331 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
2332 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
2333 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
2334 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
2338 <para><option>NOESCAPE</option> unterdrückt das Escapen von
2339 Sonderzeichen für die Vorlagensprache. Wenn also in einer
2340 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
2341 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
2342 ist dieses Flag sinnvoll.</para>
2346 <para>Beispiel:</para>
2348 <programlisting><%quototal NOFORMAT%></programlisting>
2351 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
2352 <title>Verwendung in Druckbefehlen</title>
2354 <para>In der Admininstration können Drucker definiert werden. Auch im
2355 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
2356 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
2357 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
2358 <function>`...`</function> nicht zu unerwünschtem Verhalten
2361 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
2362 für das die Telefonnummer eines Ansprechpartners als Teil der
2363 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
2364 z.B. wie folgt aussehen:</para>
2366 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
2369 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
2370 xreflabel="Anfang und Ende der Tags verändern">
2371 <title>Anfang und Ende der Tags verändern</title>
2373 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
2374 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
2375 Prozentzeichen und dem Größerzeichen endet, beispielsweise
2376 <function><%customer%></function>. Da diese Form aber z.B. in
2377 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
2378 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
2379 Stil umgestellt werden.</para>
2381 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
2382 Format gültigen Kommentarzeichen anfangen, dann
2383 <function>config:</function> enthalten, die entsprechende Option
2384 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
2385 enden. Beispiel für LaTeX:</para>
2387 <programlisting>% config: tag-style=($ $)</programlisting>
2389 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
2390 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
2391 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
2393 <programlisting><!-- config: tag-style=($ $) --></programlisting>
2396 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
2397 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
2399 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
2400 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
2401 "<filename>.ext</filename>" geeignet zu ersetzen:
2402 "<filename>.tex</filename>" für LaTeX-Vorlagen und
2403 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
2407 <term><filename>bin_list.ext</filename></term>
2410 <para>Lagerliste</para>
2415 <term><filename>check.ext</filename></term>
2423 <term><filename>invoice.ext</filename></term>
2426 <para>Rechnung</para>
2431 <term><filename>packing_list.ext</filename></term>
2434 <para>Packliste</para>
2439 <term><filename>pick_list.ext</filename></term>
2442 <para>Sammelliste</para>
2447 <term><filename>purchase_delivery_order.ext</filename></term>
2450 <para>Lieferschein (Einkauf)</para>
2455 <term><filename>purcharse_order.ext</filename></term>
2458 <para>Bestellung an Lieferanten</para>
2463 <term><filename>request_quotation.ext</filename></term>
2466 <para>Anfrage an Lieferanten</para>
2471 <term><filename>sales_delivery_order.ext</filename></term>
2474 <para>Lieferschein (Verkauf)</para>
2479 <term><filename>sales_order.ext</filename></term>
2482 <para>Bestellung</para>
2487 <term><filename>sales_quotation.ext</filename></term>
2490 <para>Angebot an Kunden</para>
2495 <term><filename>zahlungserinnerung.ext</filename></term>
2498 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2503 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2506 <para>Rechnung über Mahngebühren (Dateiname im Programm
2507 konfigurierbar)</para>
2513 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2514 <title>Sprache, Drucker und E-Mail</title>
2516 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2517 eingearbeitet. So wird aus der Vorlage
2518 <filename>sales_order.ext</filename> bei Sprache
2519 <function>de</function> und Druckerkürzel <function>lpr2</function>
2520 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2521 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2522 bekommen dann noch das Kürzel <filename>_email</filename>, der
2523 vollständige Vorlagenname wäre dann
2524 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2525 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2526 werden. Diese wird verwendet, wenn keine der anderen Varianten
2527 gefunden wird.</para>
2529 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2530 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2531 verschickt wird, ist:</para>
2535 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2539 <para><filename>sales_order_de_lpr2.tex</filename></para>
2543 <para><filename>sales_order.tex</filename></para>
2547 <para><filename>default.tex</filename></para>
2551 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2552 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2554 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2557 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2558 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2561 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2562 xreflabel="Metainformationen zur angeforderten Vorlage">
2563 <title>Metainformationen zur angeforderten Vorlage</title>
2565 <para>Diese Variablen liefern Informationen darüber welche Variante
2566 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2567 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2568 Formulare einbinden möchten.</para>
2572 <term><varname>template_meta.formname</varname></term>
2575 <para>Basisname der Vorlage. Identisch mit der <link
2576 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2577 zu den Dateinamen</link> ohne die Erweiterung. Ein
2578 Verkaufsauftrag enthält hier
2579 <constant>sales_order</constant>.</para>
2584 <term><varname>template_meta.language.description</varname></term>
2587 <para>Beschreibung der verwendeten Sprache</para>
2592 <term><varname>template_meta.language.template_code</varname></term>
2595 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2596 Kürzel das im Dateinamen verwendetet wird.</para>
2601 <term><varname>template_meta.language.output_numberformat</varname></term>
2604 <para>Zahlenformat der verwendeten Sprache in der Form
2605 "<constant>1.000,00</constant>". Experimentell! Nur
2606 interessant für Vorlagen die mit unformatierten Werten
2612 <term><varname>template_meta.language.output_dateformat</varname></term>
2615 <para>Datumsformat der verwendeten Sprache in der Form
2616 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2617 interessant für Vorlagen die mit unformatierten Werten
2623 <term><varname>template_meta.format</varname></term>
2626 <para>Das angeforderte Format. Kann im Moment die Werte
2627 <constant>pdf</constant>, <constant>postscript</constant>,
2628 <constant>html</constant>, <constant>opendocument</constant>,
2629 <constant>opendocument_pdf</constant> und
2630 <constant>excel</constant> enthalten.</para>
2635 <term><varname>template_meta.extension</varname></term>
2638 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2639 <constant>format</constant> entschieden.</para>
2644 <term><varname>template_meta.media</varname></term>
2647 <para>Ausgabemedium. Kann zur Zeit die Werte
2648 <constant>screen</constant> für Bildschirm,
2649 <constant>email</constant> für E-Mmail (triggert das
2650 <constant>_email</constant> Kürzel im Dateinamen),
2651 <constant>printer</constant> für Drucker, und
2652 <constant>queue</constant> für Warteschlange enthalten.</para>
2657 <term><varname>template_meta.printer.description</varname></term>
2660 <para>Beschreibung des ausgewählten Druckers</para>
2665 <term><varname>template_meta.printer.template_code</varname></term>
2668 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2669 dem Kürzel das im Dateinamen verwendetet wird.</para>
2674 <term><varname>template_meta.tmpfile</varname></term>
2677 <para>Datei-Prefix für temporäre Dateien.</para>
2683 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2684 <title>Stammdaten von Kunden und Lieferanten</title>
2688 <term><varname>account_number</varname></term>
2691 <para>Kontonummer</para>
2696 <term><varname>bank</varname></term>
2699 <para>Name der Bank</para>
2704 <term><varname>bank_code</varname></term>
2707 <para>Bankleitzahl</para>
2712 <term><varname>bic</varname></term>
2715 <para>Bank-Identifikations-Code (Bank Identifier Code,
2721 <term><varname>business</varname></term>
2724 <para>Kunden-/Lieferantentyp</para>
2729 <term><varname>city</varname></term>
2737 <term><varname>contact</varname></term>
2740 <para>Kontakt</para>
2745 <term><varname>country</varname></term>
2753 <term><varname>c_vendor_id</varname></term>
2756 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
2761 <term><varname>v_customer_id</varname></term>
2764 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
2769 <term><varname>cp_email</varname></term>
2772 <para>Email des Ansprechpartners</para>
2777 <term><varname>cp_givenname</varname></term>
2780 <para>Vorname des Ansprechpartners</para>
2785 <term><varname>cp_greeting</varname></term>
2788 <para>Anrede des Ansprechpartners</para>
2793 <term><varname>cp_name</varname></term>
2796 <para>Name des Ansprechpartners</para>
2801 <term><varname>cp_phone1</varname></term>
2804 <para>Telefonnummer 1 des Ansprechpartners</para>
2809 <term><varname>cp_phone2</varname></term>
2812 <para>Telefonnummer 2 des Ansprechpartners</para>
2817 <term><varname>cp_title</varname></term>
2820 <para>Titel des Ansprechpartners</para>
2825 <term><varname>creditlimit</varname></term>
2828 <para>Kreditlimit</para>
2833 <term><varname>customeremail</varname></term>
2836 <para>Email des Kunden; nur für Kunden</para>
2841 <term><varname>customerfax</varname></term>
2844 <para>Faxnummer des Kunden; nur für Kunden</para>
2849 <term><varname>customernotes</varname></term>
2852 <para>Bemerkungen beim Kunden; nur für Kunden</para>
2857 <term><varname>customernumber</varname></term>
2860 <para>Kundennummer; nur für Kunden</para>
2865 <term><varname>customerphone</varname></term>
2868 <para>Telefonnummer des Kunden; nur für Kunden</para>
2873 <term><varname>discount</varname></term>
2881 <term><varname>email</varname></term>
2884 <para>Emailadresse</para>
2889 <term><varname>fax</varname></term>
2892 <para>Faxnummer</para>
2897 <term><varname>homepage</varname></term>
2900 <para>Homepage</para>
2905 <term><varname>iban</varname></term>
2908 <para>Internationale Kontonummer (International Bank Account
2909 Number, IBAN)</para>
2914 <term><varname>language</varname></term>
2917 <para>Sprache</para>
2922 <term><varname>name</varname></term>
2925 <para>Firmenname</para>
2930 <term><varname>payment_description</varname></term>
2933 <para>Name der Zahlart</para>
2938 <term><varname>payment_terms</varname></term>
2941 <para>Zahlungskonditionen</para>
2946 <term><varname>phone</varname></term>
2949 <para>Telefonnummer</para>
2954 <term><varname>shiptocity</varname></term>
2957 <para>Stadt (Lieferadresse) <link
2958 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2963 <term><varname>shiptocontact</varname></term>
2966 <para>Kontakt (Lieferadresse) <link
2967 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2972 <term><varname>shiptocountry</varname></term>
2975 <para>Land (Lieferadresse) <link
2976 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2981 <term><varname>shiptodepartment1</varname></term>
2984 <para>Abteilung 1 (Lieferadresse) <link
2985 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2990 <term><varname>shiptodepartment2</varname></term>
2993 <para>Abteilung 2 (Lieferadresse) <link
2994 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2999 <term><varname>shiptoemail</varname></term>
3002 <para>Email (Lieferadresse) <link
3003 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3008 <term><varname>shiptofax</varname></term>
3011 <para>Fax (Lieferadresse) <link
3012 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3017 <term><varname>shiptoname</varname></term>
3020 <para>Firmenname (Lieferadresse) <link
3021 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3026 <term><varname>shiptophone</varname></term>
3029 <para>Telefonnummer (Lieferadresse) <link
3030 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3035 <term><varname>shiptostreet</varname></term>
3038 <para>Straße und Hausnummer (Lieferadresse) <link
3039 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3044 <term><varname>shiptozipcode</varname></term>
3047 <para>Postleitzahl (Lieferadresse) <link
3048 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3053 <term><varname>street</varname></term>
3056 <para>Straße und Hausnummer</para>
3061 <term><varname>taxnumber</varname></term>
3064 <para>Steuernummer</para>
3069 <term><varname>ustid</varname></term>
3072 <para>Umsatzsteuer-Identifikationsnummer</para>
3077 <term><varname>vendoremail</varname></term>
3080 <para>Email des Lieferanten; nur für Lieferanten</para>
3085 <term><varname>vendorfax</varname></term>
3088 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
3093 <term><varname>vendornotes</varname></term>
3096 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
3101 <term><varname>vendornumber</varname></term>
3104 <para>Lieferantennummer; nur für Lieferanten</para>
3109 <term><varname>vendorphone</varname></term>
3112 <para>Telefonnummer des Lieferanten; nur für
3118 <term><varname>zipcode</varname></term>
3121 <para>Postleitzahl</para>
3126 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
3127 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
3128 Stammdaten nicht eingetragen, so haben die Variablen
3129 <varname>shipto*</varname> den gleichen Wert wie die die
3130 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
3131 einige <varname>shipto*</varname>-Variablen so nicht in den
3132 Stammdaten wiederfinden sondern schlicht Kopien der
3133 Lieferdatenvariablen sind (z.B.
3134 <varname>shiptocontact</varname>).</para>
3138 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
3139 <title>Informationen über den Bearbeiter</title>
3143 <term><varname>employee_address</varname></term>
3146 <para>Adressfeld</para>
3151 <term><varname>employee_businessnumber</varname></term>
3154 <para>Firmennummer</para>
3159 <term><varname>employee_company</varname></term>
3162 <para>Firmenname</para>
3167 <term><varname>employee_co_ustid</varname></term>
3170 <para>Usatzsteuer-Identifikationsnummer</para>
3175 <term><varname>employee_duns</varname></term>
3178 <para>DUNS-Nummer</para>
3183 <term><varname>employee_email</varname></term>
3191 <term><varname>employee_fax</varname></term>
3199 <term><varname>employee_name</varname></term>
3202 <para>voller Name</para>
3207 <term><varname>employee_signature</varname></term>
3210 <para>Signatur</para>
3215 <term><varname>employee_taxnumber</varname></term>
3218 <para>Steuernummer</para>
3223 <term><varname>employee_tel</varname></term>
3226 <para>Telefonnummer</para>
3232 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
3233 <title>Informationen über den Verkäufer</title>
3237 <term><varname>salesman_address</varname></term>
3240 <para>Adressfeld</para>
3245 <term><varname>salesman_businessnumber</varname></term>
3248 <para>Firmennummer</para>
3253 <term><varname>salesman_company</varname></term>
3256 <para>Firmenname</para>
3261 <term><varname>salesman_co_ustid</varname></term>
3264 <para>Usatzsteuer-Identifikationsnummer</para>
3269 <term><varname>salesman_duns</varname></term>
3272 <para>DUNS-Nummer</para>
3277 <term><varname>salesman_email</varname></term>
3285 <term><varname>salesman_fax</varname></term>
3293 <term><varname>salesman_name</varname></term>
3296 <para>voller Name</para>
3301 <term><varname>salesman_signature</varname></term>
3304 <para>Signatur</para>
3309 <term><varname>salesman_taxnumber</varname></term>
3312 <para>Steuernummer</para>
3317 <term><varname>salesman_tel</varname></term>
3320 <para>Telefonnummer</para>
3326 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
3327 <title>Variablen für die einzelnen Steuern</title>
3331 <term><varname>tax</varname></term>
3339 <term><varname>taxbase</varname></term>
3342 <para>zu versteuernder Betrag</para>
3347 <term><varname>taxdescription</varname></term>
3350 <para>Name der Steuer</para>
3355 <term><varname>taxrate</varname></term>
3358 <para>Steuersatz</para>
3364 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
3365 <title>Variablen für Lieferbedingungen</title>
3369 <term><varname>delivery_term</varname></term>
3370 <listitem><para>Datenbank-Objekt der Lieferbedingung</para></listitem>
3373 <term><varname>delivery_term.description</varname></term>
3374 <listitem><para>Beschreibung der Lieferbedingung</para></listitem>
3377 <term><varname>delivery_term.long_description</varname></term>
3378 <listitem><para>Langtext bzw. übersetzter Langtext der Lieferbedingung</para></listitem>
3384 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
3385 <title>Variablen in Rechnungen</title>
3387 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
3388 <title>Allgemeine Variablen</title>
3392 <term><varname>creditremaining</varname></term>
3395 <para>Verbleibender Kredit</para>
3400 <term><varname>currency</varname></term>
3403 <para>Währung</para>
3408 <term><varname>cusordnumber</varname></term>
3411 <para>Bestellnummer beim Kunden</para>
3416 <term><varname>deliverydate</varname></term>
3419 <para>Lieferdatum</para>
3424 <term><varname>duedate</varname></term>
3427 <para>Fälligkeitsdatum</para>
3432 <term><varname>globalprojectnumber</varname></term>
3435 <para>Projektnummer des ganzen Beleges</para>
3440 <term><varname>globalprojectdescription</varname></term>
3443 <para>Projekbeschreibung des ganzen Beleges</para>
3448 <term><varname>intnotes</varname></term>
3451 <para>Interne Bemerkungen</para>
3456 <term><varname>invdate</varname></term>
3459 <para>Rechnungsdatum</para>
3464 <term><varname>invnumber</varname></term>
3467 <para>Rechnungsnummer</para>
3472 <term><varname>invtotal</varname></term>
3475 <para>gesamter Rechnungsbetrag</para>
3480 <term><varname>notes</varname></term>
3483 <para>Bemerkungen der Rechnung</para>
3488 <term><varname>orddate</varname></term>
3491 <para>Auftragsdatum</para>
3496 <term><varname>ordnumber</varname></term>
3499 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3500 erstellt wurde</para>
3505 <term><varname>payment_description</varname></term>
3508 <para>Name der Zahlart</para>
3513 <term><varname>payment_terms</varname></term>
3516 <para>Zahlungskonditionen</para>
3521 <term><varname>quodate</varname></term>
3524 <para>Angebotsdatum</para>
3529 <term><varname>quonumber</varname></term>
3532 <para>Angebotsnummer</para>
3537 <term><varname>shippingpoint</varname></term>
3540 <para>Versandort</para>
3545 <term><varname>shipvia</varname></term>
3548 <para>Transportmittel</para>
3553 <term><varname>subtotal</varname></term>
3556 <para>Zwischensumme aller Posten ohne Steuern</para>
3561 <term><varname>total</varname></term>
3564 <para>Restsumme der Rechnung (Summe abzüglich bereits
3565 bezahlter Posten)</para>
3570 <term><varname>transaction_description</varname></term>
3573 <para>Vorgangsbezeichnung</para>
3578 <term><varname>transdate</varname></term>
3581 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3582 erstellt wurde</para>
3588 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3589 <title>Variablen für jeden Posten auf der Rechnung</title>
3593 <term><varname>bin</varname></term>
3596 <para>Stellage</para>
3601 <term><varname>description</varname></term>
3604 <para>Artikelbeschreibung</para>
3609 <term><varname>discount</varname></term>
3612 <para>Rabatt als Betrag</para>
3617 <term><varname>discount_sub</varname></term>
3620 <para>Zwischensumme mit Rabatt</para>
3625 <term><varname>drawing</varname></term>
3628 <para>Zeichnung</para>
3633 <term><varname>ean</varname></term>
3636 <para>EAN-Code</para>
3641 <term><varname>image</varname></term>
3649 <term><varname>linetotal</varname></term>
3652 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3657 <term><varname>longdescription</varname></term>
3660 <para>Langtext</para>
3665 <term><varname>microfiche</varname></term>
3668 <para>Mikrofilm</para>
3673 <term><varname>netprice</varname></term>
3676 <para>Nettopreis</para>
3681 <term><varname>nodiscount_linetotal</varname></term>
3684 <para>Zeilensumme ohne Rabatt</para>
3689 <term><varname>nodiscount_sub</varname></term>
3692 <para>Zwischensumme ohne Rabatt</para>
3697 <term><varname>number</varname></term>
3700 <para>Artikelnummer</para>
3705 <term><varname>ordnumber_oe</varname></term>
3708 <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
3709 aus einem Sammelauftrag erstellt wurde</para>
3714 <term><varname>p_discount</varname></term>
3717 <para>Rabatt in Prozent</para>
3722 <term><varname>partnotes</varname></term>
3725 <para>Die beim Artikel gespeicherten Bemerkungen</para>
3730 <term><varname>partsgroup</varname></term>
3733 <para>Warengruppe</para>
3738 <term><varname>price_factor</varname></term>
3741 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
3747 <term><varname>price_factor_name</varname></term>
3750 <para>Der Name des Preisfaktors, sofern einer eingestellt
3756 <term><varname>projectnumber</varname></term>
3759 <para>Projektnummer</para>
3764 <term><varname>projectdescription</varname></term>
3767 <para>Projektbeschreibung</para>
3772 <term><varname>qty</varname></term>
3780 <term><varname>reqdate</varname></term>
3783 <para>Lieferdatum</para>
3788 <term><varname>runningnumber</varname></term>
3791 <para>Position auf der Rechnung (1, 2, 3...)</para>
3796 <term><varname>sellprice</varname></term>
3799 <para>Verkaufspreis</para>
3804 <term><varname>serialnumber</varname></term>
3807 <para>Seriennummer</para>
3812 <term><varname>tax_rate</varname></term>
3815 <para>Steuersatz</para>
3820 <term><varname>transdate_oe</varname></term>
3823 <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
3824 aus einem Sammelauftrag erstellt wurde</para>
3829 <term><varname>unit</varname></term>
3832 <para>Einheit</para>
3837 <term><varname>weight</varname></term>
3840 <para>Gewicht</para>
3845 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
3846 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
3847 einer <function>foreach</function>-Schleife ausgegeben werden, da
3848 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
3849 können. Die Variablen dafür lauten:</para>
3853 <term><varname>make</varname></term>
3856 <para>Lieferant</para>
3861 <term><varname>model</varname></term>
3864 <para>Lieferantenartikelnummer</para>
3870 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
3871 <title>Variablen für die einzelnen Zahlungseingänge</title>
3875 <term><varname>payment</varname></term>
3883 <term><varname>paymentaccount</varname></term>
3891 <term><varname>paymentdate</varname></term>
3899 <term><varname>paymentmemo</varname></term>
3907 <term><varname>paymentsource</varname></term>
3916 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
3917 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
3919 <para>Die vom Benutzer definierten Variablen für Kunden und
3920 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
3921 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
3922 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
3923 Variablennamen zusammen.</para>
3925 <para>Beispiel: Der Benutzer hat eine Variable namens
3926 <varname>number_of_employees</varname> definiert, die die Anzahl der
3927 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
3928 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
3933 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
3934 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
3936 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
3937 <title>Namen der Vorlagen</title>
3939 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
3940 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
3941 Erstellung einer Rechnung über die Mahngebühren und Zinsen
3942 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
3943 Vorlagenname für diese Mahnstufe mit dem Zusatz
3944 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
3945 für die ausgewählte Sprache und den ausgewählten Drucker
3949 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
3950 <title>Allgemeine Variablen in Mahnungen</title>
3952 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3953 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3954 Kunden stehen als Variablen <varname>name</varname>,
3955 <varname>street</varname>, <varname>zipcode</varname>,
3956 <varname>city</varname>, <varname>country</varname>,
3957 <varname>department_1</varname>, <varname>department_2</varname>,
3958 und <varname>email</varname> zur Verfügung.</para>
3960 <para>Weitere Variablen beinhalten:</para>
3964 <term><varname>dunning_date</varname></term>
3967 <para>Datum der Mahnung</para>
3972 <term><varname>dunning_duedate</varname></term>
3975 <para>Fälligkeitsdatum für diese Mahhnung</para>
3980 <term><varname>dunning_id</varname></term>
3983 <para>Mahnungsnummer</para>
3988 <term><varname>fee</varname></term>
3991 <para>Kummulative Mahngebühren</para>
3996 <term><varname>interest_rate</varname></term>
3999 <para>Zinssatz per anno in Prozent</para>
4004 <term><varname>total_amount</varname></term>
4007 <para>Gesamter noch zu zahlender Betrag als
4008 <function>fee</function> + <function>total_interest</function>
4009 + <function>total_open_amount</function></para>
4014 <term><varname>total_interest</varname></term>
4017 <para>Zinsen per anno über alle Rechnungen</para>
4022 <term><varname>total_open_amount</varname></term>
4025 <para>Summe über alle offene Beträge der Rechnungen</para>
4031 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
4032 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
4036 <term><varname>dn_amount</varname></term>
4039 <para>Rechnungssumme (brutto)</para>
4044 <term><varname>dn_duedate</varname></term>
4047 <para>Originales Fälligkeitsdatum der Rechnung</para>
4052 <term><varname>dn_dunning_date</varname></term>
4055 <para>Datum der Mahnung</para>
4060 <term><varname>dn_dunning_duedate</varname></term>
4063 <para>Fälligkeitsdatum der Mahnung</para>
4068 <term><varname>dn_fee</varname></term>
4071 <para>Kummulative Mahngebühr</para>
4076 <term><varname>dn_interest</varname></term>
4079 <para>Zinsen per anno für diese Rechnung</para>
4084 <term><varname>dn_invnumber</varname></term>
4087 <para>Rechnungsnummer</para>
4092 <term><varname>dn_linetotal</varname></term>
4095 <para>Noch zu zahlender Betrag (ergibt sich aus
4096 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
4097 + <varname>dn_interest</varname>)</para>
4102 <term><varname>dn_netamount</varname></term>
4105 <para>Rechnungssumme (netto)</para>
4110 <term><varname>dn_open_amount</varname></term>
4113 <para>Offener Rechnungsbetrag</para>
4118 <term><varname>dn_ordnumber</varname></term>
4121 <para>Bestellnummer</para>
4126 <term><varname>dn_transdate</varname></term>
4129 <para>Rechnungsdatum</para>
4134 <term><varname>dn_curr</varname></term>
4137 <para>Währung, in der die Rechnung erstellt wurde. (Die
4138 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
4144 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
4145 <title>Variablen in automatisch erzeugten Rechnungen über
4146 Mahngebühren</title>
4148 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4149 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4150 Kunden stehen als Variablen <varname>name</varname>,
4151 <varname>street</varname>, <varname>zipcode</varname>,
4152 <varname>city</varname>, <varname>country</varname>,
4153 <varname>department_1</varname>, <varname>department_2</varname>,
4154 und <varname>email</varname> zur Verfügung.</para>
4156 <para>Weitere Variablen beinhalten:</para>
4160 <term><varname>duedate</varname></term>
4163 <para>Fälligkeitsdatum der Rechnung</para>
4168 <term><varname>dunning_id</varname></term>
4171 <para>Mahnungsnummer</para>
4176 <term><varname>fee</varname></term>
4179 <para>Mahngebühren</para>
4184 <term><varname>interest</varname></term>
4192 <term><varname>invamount</varname></term>
4195 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
4196 <varname>interest</varname>)</para>
4201 <term><varname>invdate</varname></term>
4204 <para>Rechnungsdatum</para>
4209 <term><varname>invnumber</varname></term>
4212 <para>Rechnungsnummer</para>
4219 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
4220 <title>Variablen in anderen Vorlagen</title>
4223 <title>Einführung</title>
4225 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
4226 Rechnung. Allerdings heißen die Variablen, die mit
4227 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
4228 fangen sie mit <varname>quo</varname> für "quotation" an:
4229 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
4230 wiederum fangen sie mit <varname>ord</varname> für "order" an:
4231 <varname>ordnumber</varname> für Bestellnummer etc.</para>
4233 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
4234 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
4235 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
4236 Vorlage keine Bedeutung haben oder noch nicht belegt sein
4239 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
4240 in Rechnungen aufgeführt.</para>
4243 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
4244 <title>Angebote und Preisanfragen</title>
4248 <term><varname>quonumber</varname></term>
4251 <para>Angebots- bzw. Anfragenummer</para>
4256 <term><varname>reqdate</varname></term>
4259 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
4260 Preisanfragen)</para>
4265 <term><varname>transdate</varname></term>
4268 <para>Angebots- bzw. Anfragedatum</para>
4274 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
4275 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
4279 <term><varname>ordnumber</varname></term>
4282 <para>Auftragsnummer</para>
4287 <term><varname>reqdate</varname></term>
4290 <para>Lieferdatum</para>
4295 <term><varname>transdate</varname></term>
4298 <para>Auftragsdatum</para>
4304 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
4305 <title>Lieferscheine (Verkauf und Einkauf)</title>
4309 <term><varname>cusordnumber</varname></term>
4312 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
4313 des Lieferanten (im Einkauf)</para>
4318 <term><varname>donumber</varname></term>
4321 <para>Lieferscheinnummer</para>
4326 <term><varname>transdate</varname></term>
4329 <para>Lieferscheindatum</para>
4334 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
4335 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
4336 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
4337 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
4338 <function>foreach</function>-Schleife ausgegeben werden. Diese
4339 Variablen sind:</para>
4343 <term><varname>si_bin</varname></term>
4346 <para>Lagerplatz</para>
4351 <term><varname>si_chargenumber</varname></term>
4354 <para>Chargennummer</para>
4359 <term><varname>si_bestbefore</varname></term>
4362 <para>Mindesthaltbarkeit</para>
4367 <term><varname>si_number</varname></term>
4370 <para>Artikelnummer</para>
4375 <term><varname>si_qty</varname></term>
4378 <para>Anzahl bzw. Menge</para>
4383 <term><varname>si_runningnumber</varname></term>
4386 <para>Positionsnummer (1, 2, 3 etc)</para>
4391 <term><varname>si_unit</varname></term>
4394 <para>Einheit</para>
4399 <term><varname>si_warehouse</varname></term>
4408 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
4409 <title>Variablen für Sammelrechnung</title>
4413 <term><varname>c0total</varname></term>
4416 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
4422 <term><varname>c30total</varname></term>
4425 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
4426 und < 60 Tage</para>
4431 <term><varname>c60total</varname></term>
4434 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
4435 und < 90 Tage</para>
4440 <term><varname>c90total</varname></term>
4443 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
4449 <term><varname>total</varname></term>
4452 <para>Gesamtbetrag aller Rechnungen</para>
4457 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
4461 <term><varname>invnumber</varname></term>
4464 <para>Rechnungsnummer</para>
4469 <term><varname>invdate</varname></term>
4472 <para>Rechnungsdatum</para>
4477 <term><varname>duedate</varname></term>
4480 <para>Fälligkeitsdatum</para>
4485 <term><varname>amount</varname></term>
4488 <para>Summe der Rechnung</para>
4493 <term><varname>open</varname></term>
4496 <para>Noch offener Betrag der Rechnung</para>
4501 <term><varname>c0</varname></term>
4504 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4510 <term><varname>c30</varname></term>
4513 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4519 <term><varname>c60</varname></term>
4522 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4528 <term><varname>c90</varname></term>
4531 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4539 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4540 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4542 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4543 <title>Einfürhung</title>
4545 <para>Der Parser kennt neben den Variablen einige weitere
4546 Konstrukte, die gesondert behandelt werden. Diese sind wie
4547 Variablennamen in spezieller Weise markiert:
4548 <command><%anweisung%> ... <%end%></command></para>
4550 <para>Anmerkung zum <command><%end%></command>: Der besseren
4551 Verständlichkeit halber kann man nach dem <command>end</command>
4552 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4553 Anweisung (z.B. <command>if</command> oder
4554 <command>foreach</command>) damit abgeschlossen wird.</para>
4556 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4557 <command><%if type == "sales_quotation"%></command>, so könnte
4558 er mit <command><%end%></command> genauso abgeschlossen werden
4559 wie mit <command><%end if%></command> oder auch
4560 <command><%end type == "sales_quotation"%></command>.</para>
4563 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4564 <title>Der if-Block</title>
4566 <programlisting><%if variablenname%>
4568 <%end%></programlisting>
4570 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4571 und dem "end" werden nur ausgegeben, wenn die Variable
4572 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4574 <para>Handelt es sich bei der benannten Variable um ein Array, also um einen Variablennamen, über den man mit
4575 <command><%foreach variablenname%></command> iteriert, so wird mit diesem Konstrukt darauf getestet, ob das Array Elemente
4576 enthält. Somit würde im folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt ihrer Überschrift "Zahlungseingänge"
4577 ausgegeben, wenn tatsächlich welche getätigt wurden:</para>
4579 <programlisting><%if payment%>
4581 <%foreach payment%>
4582 Am <%paymentdate%>: <%payment%> €
4583 <%end foreach%>
4584 <%end if%></programlisting>
4586 <para>Die Bedingung kann auch negiert werden, indem das Wort
4587 <function>not</function> nach dem <filename>if</filename> verwendet
4588 wird. Beispiel:</para>
4590 <programlisting><%if not cp_greeting%>
4592 <%end%></programlisting>
4594 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4595 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4596 einer Variablen mit einer festen Zeichenkette oder einer anderen
4597 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4598 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4599 die rechte Seite des Vergleichsoperators in Anführungszeichen
4600 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4601 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4604 <programlisting><%if var1 == "Wert"%></programlisting>
4606 <para>Testet die Variable <varname>var1</varname> auf
4607 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4608 Mittels <function>!=</function> anstelle von <function>==</function>
4609 würde auf Ungleichheit getestet.</para>
4611 <programlisting><%if var1 == var2%></programlisting>
4613 <para>Testet die Variable <varname>var1</varname> auf
4614 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4615 <function>!=</function> anstelle von <function>==</function> würde
4616 auf Ungleichheit getestet.</para>
4618 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4619 auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
4620 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4621 dieselbe Syntax wie oben nur mit <function>=~</function> und
4622 <function>!~</function> als Vergleichsoperatoren.</para>
4624 <para>Beispiel für einen Test, ob die Variable
4625 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4626 <constant>schwierig</constant> enthält:</para>
4628 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4631 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4632 <title>Der foreach-Block</title>
4634 <programlisting><%foreach variablenname%>
4636 <%end%></programlisting>
4638 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4639 wie das Perl-Array der Variablen <varname>variablenname</varname>
4640 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4641 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4642 benutzt. In jedem Durchlauf werden die <link
4643 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4644 Variablen</link> jeweils auf den Wert für die aktuelle Position
4647 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
4649 <programlisting><%foreach number%>
4650 Position: <%runningnumber%>
4651 Anzahl: <%qty%>
4652 Artikelnummer: <%number%>
4653 Beschreibung: <%description%>
4655 <%end%></programlisting>
4657 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
4658 <function><%foreach%></function>-Block innerhalb einer
4659 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
4660 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
4661 Inhalt zwischen <function><%foreach%></function> und
4662 <function><%end%></function> wiederholt, nicht aber die
4663 komplette Zeile, in der er steht.</para>
4667 <sect2 id="dokumentenvorlagen-und-variablen.markup">
4668 <title>Markup-Code zur Textformatierung innerhalb von
4671 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
4672 anders formatiert haben möchte, so ist dies begrenzt möglich.
4673 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
4674 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
4675 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
4676 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
4677 (HTML oder PDF über LaTeX) umgesetzt.</para>
4679 <para>Die unterstützen Formatierungen sind:</para>
4683 <term><b>Text</b></term>
4686 <para>Text wird in Fettdruck gesetzt.</para>
4691 <term><i>Text</i></term>
4694 <para>Text wird kursiv gesetzt.</para>
4699 <term><u>Text</u></term>
4702 <para>Text wird unterstrichen.</para>
4707 <term><s>Text</s></term>
4710 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
4711 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
4716 <term><bullet></term>
4719 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
4725 <para>Der Befehl <command><bullet></command> funktioniert
4726 momentan auch nur in Latex-Vorlagen.</para>
4730 <sect1 id="excel-templates">
4731 <title>Excel-Vorlagen</title>
4733 <sect2 id="excel-templates.summary">
4734 <title>Zusammenfassung</title>
4736 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
4737 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
4741 <sect2 id="excel-templates.usage">
4742 <title>Bedienung</title>
4744 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
4745 werden. Die Konfigurationsoption heißt <varname>excel_templates =
4746 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
4748 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
4749 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
4750 werden. In den normalen Verkaufsmasken taucht nun
4751 <constant>Excel</constant> als auswählbares Format auf und kann von da
4752 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
4754 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
4755 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
4756 <filename>sales_quotation.xls</filename> gespeichert.</para>
4759 <sect2 id="excel-templates.syntax">
4760 <title>Variablensyntax</title>
4762 <para>Einfache Syntax:
4763 <command><<varname>></command></para>
4765 <para>Dabei sind <constant><<</constant> und
4766 <constant>>></constant> die Delimiter. Da Excel auf festen
4767 Breiten besteht, kann der Tag künstlich verlängert werden, indem
4768 weitere <constant><</constant> oder <constant>></constant>
4769 eingefügt werden. Der Tag muss nicht symmetrisch sein.
4772 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4774 <para>Um die Limitierung der festen Breite zu reduzieren, können
4775 weitere Variablen in einem Block interpoliert werden. Whitespace wird
4776 dazwishen dann erhalten. Beispiel:</para>
4778 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4780 <para>Die Variablen werden interpoliert, und linksbündig mit
4781 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
4782 lang, werden überzählige Zeichen abgeschnitten.</para>
4784 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
4785 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
4787 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4789 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
4790 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
4794 <sect2 id="excel-templates.limitations">
4795 <title>Einschränkungen</title>
4797 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
4798 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
4799 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
4800 Text zu ersetzen.</para>
4802 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
4803 <command><%if%></command> und
4804 <command><%foreach%></command> nicht vorhanden. Der Delimiter
4805 <constant><% %></constant> kommt in den Headerinformationen
4806 evtl. vor. Deshalb wurde auf den sichereren Delimiter
4807 <constant><<</constant> und <constant>>></constant>
4811 <sect1 id="features.warehouse">
4812 <title>Mandantenkonfiguration Lager</title>
4813 Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt:
4814 Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die Möglichkeit hier über den
4815 Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. Ferner kann
4816 jede Position eines Lieferscheins ein-, bzw. ausgelagert werden (Einkauf-, bzw. Verkauf).
4817 Es können beliebig viele Lager mit beliebig vielen Lagerplätzen abgebildet werden.
4818 Die Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder Einzelposition und
4819 das Auswählen dieser Position zu einem Lager mit Lagerplatz.
4820 Dieses Verfahren lässt sich schrittweise vereinfachen, je nachdem wie die Einstellungen in
4821 der Mandatenkonfiguration gesetzt werden.
4824 <para><option>Auslagern über Standardlagerplatz</option> Hier wird ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz)
4825 in dem Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über den Standardlagerplatz (konfigurierbar pro Ware) durchführt.
4829 <para><option>Auslagern ohne Bestandsprüfung</option>Das obige Auslagern schlägt fehl, wenn die entsprechende Menge für
4830 die Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit dieser Option
4831 erlauben. Hierfür muss ein entsprechender Lagerplatz (Fehlbestand, o.ä.) konfiguriert sein.</para>
4834 Zusätzliche Funktionshinweise:
4836 <listitem><para><option>Standard-Lagerplatz</option>Ist dieser konfiguriert, wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
4837 Stammdaten-> Waren / Dienstleistung / Erzeugnis verwendet.
4840 <listitem><para><option>Standard-Lagerplatz verwenden, falls keiner in Stammdaten definiert</option>Wird beim 'Auslagern über Standardlagerplatz'
4841 keine Standardlagerplatz zu der Ware gefunden, so wird mit dieser Option einfach der Standardlagerplatz verwendet.
4849 <title>Entwicklerdokumentation</title>
4851 <sect1 id="devel.globals" xreflabel="Globale Variablen">
4852 <title>Globale Variablen</title>
4855 <title>Wie sehen globale Variablen in Perl aus?</title>
4857 <para>Globale Variablen liegen in einem speziellen namespace namens
4858 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
4859 globs global und die meisten speziellen Variablen sind...
4862 <para>Daraus ergeben sich folgende Formen:</para>
4866 <term><literal>$main::form</literal></term>
4869 <para>expliziter Namespace "main"</para>
4874 <term><literal>$::form</literal></term>
4877 <para>impliziter Namespace "main"</para>
4882 <term><literal>open FILE, "file.txt"</literal></term>
4885 <para><varname>FILE</varname> ist global</para>
4890 <term><literal>$_</literal></term>
4893 <para>speziell</para>
4898 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
4899 Schlüsselwort wie "<function>global</function>", mit dem man
4900 importieren kann. <function>my</function>, <function>our</function>
4901 und <function>local</function> machen was anderes.</para>
4905 <term><literal>my $form</literal></term>
4908 <para>lexikalische Variable, gültig bis zum Ende des
4914 <term><literal>our $form</literal></term>
4917 <para><varname>$form</varname> referenziert ab hier
4918 <varname>$PACKAGE::form</varname>.</para>
4923 <term><literal>local $form</literal></term>
4926 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
4927 des scopes zurückgesetzt</para>
4934 <title>Warum sind globale Variablen ein Problem?</title>
4936 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
4938 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
4939 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
4940 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
4941 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
4942 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
4943 Datenbankverbindungen, weil die sehr lange zum Initialisieren
4946 <para>Das zweite Problem ist <function>strict</function>. Unter
4947 <function>strict</function> werden alle Variablen die nicht explizit
4948 mit <function>Package</function>, <function>my</function> oder
4949 <function>our</function> angegeben werden als Tippfehler angemarkert,
4950 dies hat, seit der Einführung, u.a. schon so manche langwierige
4951 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
4952 angegeben werden, werden die nicht geprüft, und somit kann sich
4953 schnell ein Tippfehler einschleichen.</para>
4957 <title>Kanonische globale Variablen</title>
4959 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
4960 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
4961 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
4962 umhergereicht werden.</para>
4964 <para>Diese Variablen sind im Moment die folgenden neun:</para>
4968 <para><varname>$::form</varname></para>
4972 <para><varname>%::myconfig</varname></para>
4976 <para><varname>$::locale</varname></para>
4980 <para><varname>$::lxdebug</varname></para>
4984 <para><varname>$::auth</varname></para>
4988 <para><varname>$::lx_office_conf</varname></para>
4992 <para><varname>$::instance_conf</varname></para>
4996 <para><varname>$::dispatcher</varname></para>
5000 <para><varname>$::request</varname></para>
5004 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
5005 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
5006 Eigenschaften (Konventionen):</para>
5009 <title>$::form</title>
5013 <para>Ist ein Objekt der Klasse
5014 "<classname>Form</classname>"</para>
5018 <para>Wird nach jedem Request gelöscht</para>
5022 <para>Muss auch in Tests und Konsolenscripts vorhanden
5027 <para>Enthält am Anfang eines Requests die Requestparameter vom
5032 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
5033 cachen, das wird aber momentan absichtlich zerstört</para>
5037 <para><varname>$::form</varname> wurde unter <productname>SQL
5038 Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
5039 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
5040 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
5041 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
5042 <function>IS->retrieve_customer()</function> in Sicherheit
5045 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
5046 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
5047 3552, Stand version 2.7beta), um dies hinterher wieder auf den
5048 richtigen Wert zu setzen:</para>
5050 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
5051 $::myconfig{numberformat} = $numberformat;
5052 # (...) div Berechnungen
5053 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
5055 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
5056 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
5057 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
5058 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
5059 Es geht ziemlich sicher etwas kaputt.</para>
5061 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
5062 in den <productname>Template::Toolkit</productname> Templates
5063 außerhalb der Controller: der Ausdruck <function>[% var
5064 %]</function> greift auf <varname>$::form->{var}</varname> zu.
5065 Unter Controllern ist der Standard Scope anders, da lautet der
5066 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
5067 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
5068 <function><%var%></function> zeigt auf
5069 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
5070 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
5073 <programlisting>[%- IF business %]
5074 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
5075 [%- END %]</programlisting>
5077 <para>Entweder wird hier dann $::form->{business} ausgewertet
5078 oder aber der Funktion
5079 <function>$form->parse_html_template</function> wird explizit
5080 noch ein zusätzlicher Hash übergeben, der dann auch in den
5081 (Web-)Templates zu Verfügung steht, bspw. so:</para>
5083 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
5085 <para>Innerhalb von Schleifen wird
5086 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
5087 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
5088 welches über alle Positionen eines Lieferscheins in Schleife
5091 <programlisting>for $i (1 .. $form->{rowcount}) {
5093 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
5094 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
5095 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
5101 <title>%::myconfig</title>
5105 <para>Das einzige Hash unter den globalen Variablen</para>
5109 <para>Wird spätestens benötigt wenn auf die Datenbank
5110 zugegriffen wird</para>
5114 <para>Wird bei jedem Request neu erstellt.</para>
5118 <para>Enthält die Userdaten des aktuellen Logins</para>
5122 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
5123 extern serialisiert werden, weil da auch der Datenbankzugriff
5124 für diesen user drinsteht.</para>
5128 <para>Enthält unter anderem Listenbegrenzung vclimit,
5129 Datumsformat dateformat und Nummernformat numberformat</para>
5133 <para>Enthält Datenbankzugriffinformationen</para>
5137 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
5138 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
5139 aktuellen Users entscheiden müssen, befragen
5140 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
5141 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
5142 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
5143 Informationen über den Benutzer die über die
5144 Administrator-Schnittstelle eingegeben wurden.</para>
5148 <title>$::locale</title>
5152 <para>Objekt der Klasse "Locale"</para>
5156 <para>Wird pro Request erstellt</para>
5160 <para>Muss auch für Tests und Scripte immer verfügbar
5165 <para>Cached intern über Requestgrenzen hinweg benutzte
5170 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
5171 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
5175 <title>$::lxdebug</title>
5179 <para>Objekt der Klasse "LXDebug"</para>
5183 <para>Wird global gecached</para>
5187 <para>Muss immer verfügbar sein, in nahezu allen
5192 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
5193 bereit, wie "<function>enter_sub</function>" und
5194 "<function>leave_sub</function>", mit denen in den alten Modulen ein
5195 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
5196 der man die Wallclockzeit seit Requeststart loggen kann, sowie
5197 "<function>message</function>" und "<function>dump</function>" mit
5198 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
5201 <para>Beispielsweise so:</para>
5203 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
5204 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
5208 <title>$::auth</title>
5212 <para>Objekt der Klasse "SL::Auth"</para>
5216 <para>Wird global gecached</para>
5220 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
5224 <para>Wird nach jedem Request resettet.</para>
5228 <para><varname>$::auth</varname> stellt Funktionen bereit um die
5229 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
5230 vom aktuellen User abhängen wird das Objekt aus
5231 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
5232 Request kurz resettet.</para>
5234 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten. Dessen Einstellungen können über
5235 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert ist ein Hash mit den Werten aus der Tabelle
5236 <literal>auth.clients</literal>.</para>
5240 <title>$::lx_office_conf</title>
5244 <para>Objekt der Klasse
5245 "<classname>SL::LxOfficeConf</classname>"</para>
5249 <para>Global gecached</para>
5253 <para>Repräsentation der
5254 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
5258 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
5259 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
5260 das Programm die Konfiguration ändern kann oder sollte.</para>
5262 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
5263 Debug- und Trace-Log-Datei wie folgt konfiguriert und
5266 <programlisting>[debug]
5267 file = /tmp/kivitendo-debug.log</programlisting>
5269 <para>ist der Key <varname>file</varname> im Programm als
5270 <varname>$::lx_office_conf->{debug}{file}</varname>
5274 <para>Zugriff auf die Konfiguration erfolgt im Moment über
5275 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
5280 <title>$::instance_conf</title>
5284 <para>Objekt der Klasse
5285 "<classname>SL::InstanceConfiguration</classname>"</para>
5289 <para>wird pro Request neu erstellt</para>
5293 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
5294 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
5295 ist hier eine Mandantendatenbank. Beispielsweise überprüft
5296 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
5297 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
5301 <title>$::dispatcher</title>
5305 <para>Objekt der Klasse
5306 "<varname>SL::Dispatcher</varname>"</para>
5310 <para>wird pro Serverprozess erstellt.</para>
5314 <para>enthält Informationen über die technische Verbindung zum
5319 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
5320 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
5321 Objekt untergebracht.</para>
5325 <title>$::request</title>
5329 <para>Hashref (evtl später Objekt)</para>
5333 <para>Wird pro Request neu initialisiert.</para>
5337 <para>Keine Unterstruktur garantiert.</para>
5341 <para><varname>$::request</varname> ist ein generischer Platz um
5342 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
5343 at a distance benutzt werden, sondern um lokales memoizing zu
5344 ermöglichen, das garantiert am Ende des Requests zerstört
5347 <para>Vieles von dem, was im moment in <varname>$::form</varname>
5348 liegt, sollte eigentlich hier liegen. Die groben
5349 Differentialkriterien sind:</para>
5353 <para>Kommt es vom User, und soll unverändert wieder an den
5354 User? Dann <varname>$::form</varname>, steht da eh schon</para>
5358 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
5359 Requests gebraucht werden? Dann
5360 <varname>$::request</varname></para>
5364 <para>Muss ich von anderen Teilen des Programms lesend drauf
5365 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
5366 Wrappermethode</para>
5373 <title>Ehemalige globale Variablen</title>
5375 <para>Die folgenden Variablen waren einmal im Programm, und wurden
5379 <title>$::cgi</title>
5383 <para>war nötig, weil cookie Methoden nicht als
5384 Klassenfunktionen funktionieren</para>
5388 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
5389 Klassennamespace gehalten wird und über Requestgrenzen
5394 <para>liegt jetzt unter
5395 <varname>$::request->{cgi}</varname></para>
5401 <title>$::all_units</title>
5405 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
5406 ein paar hundert mal pro Request eine Liste der Einheiten
5407 brauchen, und de als Parameter durch einen Riesenstack von
5408 Funktionen geschleift werden müssten.</para>
5412 <para>Liegt jetzt unter
5413 <varname>$::request->{cache}{all_units}</varname></para>
5418 <function>AM->retrieve_all_units()</function> gesetzt oder
5425 <title>%::called_subs</title>
5429 <para>wurde benutzt um callsub deep recursions
5434 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
5435 möglichen Rekursioenen darstellt, und da nie welche
5440 <para>komplette recursion protection wurde entfernt.</para>
5447 <sect1 id="devel.fcgi">
5448 <title>Entwicklung unter FastCGI</title>
5450 <sect2 id="devel.fcgi.general">
5451 <title>Allgemeines</title>
5453 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
5454 werden, muss der Webserver neu gestartet werden.</para>
5456 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
5457 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
5458 müssen folgende Aspekte beachtet werden.</para>
5461 <sect2 id="devel.fcgi.exiting">
5462 <title>Programmende und Ausnahmen</title>
5464 <para>Betrifft die Funktionen <function>warn</function>,
5465 <function>die</function>, <function>exit</function>,
5466 <function>carp</function> und <function>confess</function>.</para>
5468 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
5469 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
5470 am Laufen zu halten. Man kann mit <function>die</function>,
5471 <function>confess</function> oder <function>carp</function> Fehler
5472 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
5473 eigene <function>$::form-</function>error()> tut im Prinzip das
5474 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
5475 <function>exit</function> hingegen werden nicht abgefangen.
5476 <function>warn</function> wird direkt nach STDERR, also in Server Log
5477 eine Nachricht schreiben (sofern in der Konfiguration nicht die
5478 Warnungen in das kivitendo Log umgeleitet wurden), und
5479 <function>exit</function> wird die Ausführung beenden.</para>
5481 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
5482 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
5483 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
5484 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
5487 <sect2 id="devel.fcgi.globals">
5488 <title>Globale Variablen</title>
5490 <para>Um zu vermeiden, dass Informationen von einem Request in einen
5491 anderen gelangen, müssen alle globalen Variablen vor einem Request
5492 sauber initialisiert werden. Das ist besonders wichtig im
5493 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
5494 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
5497 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
5498 abgetrennten Block, der alle kanonischen globalen Variablen listet und
5499 erklärt. Bitte keine anderen einführen ohne das sauber zu
5500 dokumentieren.</para>
5502 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
5503 man sicher geht, dass man die richtige erwischt.</para>
5506 <sect2 id="devel.fcgi.performance">
5507 <title>Performance und Statistiken</title>
5509 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
5510 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
5511 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
5512 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
5513 sind es je nach Menge der definierten Variablen 1-2s. Ab der
5514 Moose/Rose::DB Version sind es 5-6s.</para>
5516 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
5517 den kritischen Pfaden, unter 0,15 sonst.</para>
5521 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
5522 <title>SQL-Upgradedateien</title>
5524 <sect2 id="db-upgrade-files.introduction"
5525 xreflabel="Einführung in die Datenbank-Upgradedateien">
5526 <title>Einführung</title>
5528 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte gesteuert, die sich im Verzeichnis <filename>sql/Pg-upgrade2</filename>
5529 befinden. In diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren, die neben den eigentlich auszuführenden SQL- oder
5530 Perl-Befehlen einige Kontrollinformationen enthält.</para>
5532 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten, sodass Datenbankscripte zwar in einer sicheren Reihenfolge
5533 ausgeführt werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt werden, wenn die Tabelle mit <literal>CREATE
5534 TABLE</literal> angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man keine Versionsnummern braucht.</para>
5536 <para>kivitendo merkt sich dabei, welches der Upgradescripte in <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
5537 führt diese nicht erneut aus. Dazu dient die Tabelle "<literal>schema_info</literal>", die bei der Anmeldung automatisch angelegt
5541 <sect2 id="db-upgrade-files.format"
5542 xreflabel="Format der Upgradedateien">
5543 <title>Format der Kontrollinformationen</title>
5545 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5546 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5547 hat dabei das folgende Format:</para>
5549 <para>Für SQL-Upgradedateien:</para>
5551 <programlisting>-- @key: value</programlisting>
5553 <para>Für Perl-Upgradedateien:</para>
5555 <programlisting># @key: value</programlisting>
5557 <para>Leerzeichen vor "<varname>value</varname>" werden
5560 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5564 <term><varname>tag</varname></term>
5567 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5568 Dieser "tag" kann von anderen Kontrolldateien in ihren
5569 Abhängigkeiten verwendet werden (Schlüsselwort
5570 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5571 in der Datenbank eingetragen wird.</para>
5573 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5574 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5576 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5577 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5578 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5584 <term><varname>charset</varname></term>
5587 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5588 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
5589 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte hingegen müssen immer in UTF-8 encodiert sein und sollten
5590 demnach auch ein "<literal>use utf8;</literal>" enthalten.</para>
5595 <term><varname>description</varname></term>
5598 <para>Benötigt. Eine Beschreibung, was in diesem Update
5599 passiert. Diese wird dem Benutzer beim eigentlichen
5600 Datenbankupdate angezeigt. Während der Tag in englisch gehalten
5601 sein sollte, sollte die Beschreibung auf Deutsch
5607 <term><varname>depends</varname></term>
5610 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5611 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
5612 dass die in dieser Liste aufgeführten Scripte bereits
5613 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5615 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5616 Script "b" existiert, das von Änderungen in "a" abhängt, und
5617 eine neue Kontrolldatei für "c" erstellt wird, die von
5618 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5619 Tag "b" als Abhängigkeit zu definieren.</para>
5621 <para>Es ist nicht erlaubt, sich selbst referenzierende
5622 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5623 und "c" -> "a").</para>
5628 <term><varname>priority</varname></term>
5631 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5632 der Scripte ausgeführt werden, die die gleichen
5633 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5634 der Wert 1000 benutzt.</para>
5636 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5637 "depends" benutzt werden. kivitendo sortiert die auszuführenden
5638 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5639 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5640 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5641 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5642 Priorität alphabetisch nach dem "tag".</para>
5647 <term><varname>ignore</varname></term>
5650 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
5651 Skript bei der Anmeldung ignoriert und entsprechend nicht
5658 <sect2 id="db-upgrade-files.format-perl-files" xreflabel="Format von Perl-Upgradedateien">
5659 <title>Format von in Perl geschriebenen Datenbankupgradescripten</title>
5661 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so ausgeführt sondern müssen sich an gewisse Konventionen
5662 halten. Dafür bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
5664 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse dar, die vom Elternobjekt
5665 "<literal>SL::DBUpgrade2::Base</literal>" erben und eine Funktion namens "<literal>run</literal>" zur Verfügung stellen muss. Das
5666 Script wird ausgeführt, indem eine Instanz dieser Klasse erzeugt und darauf die erwähnte "<literal>run</literal>" aufgerufen
5669 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert für "<literal>@tag</literal>" ableitet. Dabei werden alle
5670 Zeichen, die in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche ersetzt. Insgesamt sieht der Paketname wie folgt
5671 aus: "<literal>SL::DBUpgrade2::tag</literal>".</para>
5673 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
5674 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
5676 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie folgt aus:</para>
5678 <programlisting># @tag: beispiel-upgrade-file42
5679 # @description: Ein schönes Beispielscript
5680 # @depends: release_3_0_0
5681 package SL::DBUpgrade2::beispiel_upgrade_file42;
5686 use parent qw(SL::DBUpgrade2::Base);
5691 # hier Aktionen ausführen
5700 <sect2 id="db-upgrade-files.dbupgrade-tool"
5701 xreflabel="Hilfsscript dbupgrade2_tool.pl">
5702 <title>Hilfsscript dbupgrade2_tool.pl</title>
5704 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
5705 existiert ein Hilfsscript namens
5706 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
5707 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
5708 liest alle Datenbankupgradescripte aus dem Verzeichnis
5709 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
5710 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
5711 von der Kommandozeile überprüft werden können.</para>
5713 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
5714 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
5715 sich aber auch Informationen auf verschiedene Art ausgeben
5720 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
5721 --list</command>"</para>
5723 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
5724 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
5725 würde. Es werden neben der Listenposition der Tag, die
5726 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
5730 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
5731 --tree</command>"</para>
5733 <para>Listet alle Tags in Baumform basierend auf den
5734 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
5735 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
5736 beim übergeordneten Script als Abhängigkeit eingetragen
5740 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
5741 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
5742 --rtree</command>"</para>
5744 <para>Listet alle Tags in Baumform basierend auf den
5745 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
5746 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
5747 die das übergeordnete Script als Abhängigkeit eingetragen
5752 <para>Baumform mit Postscriptausgabe:
5753 "<command>./scripts/dbupgrade2_tool.pl
5754 --graphviz</command>"</para>
5756 <para>Benötigt das Tool "<command>graphviz</command>", um mit
5757 seiner Hilfe die <link
5758 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
5759 Baumform</link> in eine Postscriptdatei namens
5760 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
5761 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
5762 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
5763 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
5768 <para>Scripte, von denen kein anderes Script abhängt:
5769 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
5771 <para>Listet die Tags aller Scripte auf, von denen keine anderen
5772 Scripte abhängen.</para>
5778 <sect1 id="translations-languages" xreflabel="Translations and languages">
5779 <title>Translations and languages</title>
5781 <sect2 id="translations-languages.introduction"
5782 xreflabel="Introduction to translations and languages">
5783 <title>Introduction</title>
5786 <para>Dieser Abschnitt ist in Englisch geschrieben, um
5787 internationalen Übersetzern die Arbeit zu erleichtern.</para>
5790 <para>This section describes how localization packages in kivitendo
5791 are built. Currently the only language fully supported is German, and
5792 since most of the internal messages are held in English the English
5793 version is usable too.</para>
5795 <para>A stub version of French is included but not functunal at this
5799 <sect2 id="translations-languages.character-set"
5800 xreflabel="Character set">
5801 <title>Character set</title>
5803 <para>All files included in a language pack must use UTF-8 as their encoding.</para>
5806 <sect2 id="translations-languages.file-structure"
5807 xreflabel="File structure">
5808 <title>File structure</title>
5810 <para>The structure of locales in kivitendo is:</para>
5812 <programlisting>kivitendo/locale/<langcode>/</programlisting>
5814 <para>where <langcode> stands for an abbreviation of the
5815 language package. The builtin packages use two letter <ulink
5816 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
5817 but the actual name is not relevant for the program and can easily be
5819 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
5820 tags</ulink> (i.e. "en_GB"). In fact the original language packages
5821 from SQL Ledger are named in this way.</para>
5823 <para>In such a language directory the following files are
5828 <term>LANGUAGE</term>
5831 <para>This file is mandatory.</para>
5833 <para>The <filename>LANGUAGE</filename> file contains the self
5834 descripted name of the language. It should contain a native
5835 representation first, and in parenthesis an english translation
5836 after that. Example:</para>
5838 <programlisting>Deutsch (German)</programlisting>
5846 <para>This file is mandatory.</para>
5848 <para>The central translation file. It is essentially an inline
5849 Perl script autogenerated by <command>locales.pl</command>. To
5850 generate it, generate the directory and the two files mentioned
5851 above, and execute the following command:</para>
5853 <programlisting>scripts/locales.pl <langcode></programlisting>
5855 <para>Otherwise you can simply copy one of the other languages.
5856 You will be told how many are missing like this:</para>
5858 <programlisting>$ scripts/locales.pl en
5859 English - 0.6% - 2015/2028 missing</programlisting>
5861 <para>A file named "<filename>missing</filename>" will be
5862 generated and can be edited. You can also edit the
5863 "<filename>all</filename>" file directly. Edit everything you
5864 like to fit the target language and execute
5865 <command>locales.pl</command> again. See how the missing words
5871 <term>Num2text</term>
5874 <para>Legacy code from SQL Ledger. It provides a means for
5875 numbers to be converted into natural language, like
5876 <literal>1523 => one thousand five hundred twenty
5877 three</literal>. If you want to provide it, it must be inlinable
5878 Perl code which provides a <function>num2text</function> sub. If
5879 an <function>init</function> sub exists it will be executed
5882 <para>Only used in the check and receipt printing module.</para>
5887 <term>special_chars</term>
5890 <para>kivitendo comes with a lot of interfaces to different
5891 formats, some of which are rather picky with their accepted
5892 charset. The <filename>special_chars</filename> file contains a
5893 listing of chars not suited for different file format and
5894 provides substitutions. It is written in "Simple Ini" style,
5895 containing a block for every file format.</para>
5897 <para>First entry should be the order of substitution for
5898 entries as a whitespace separated list. All entries are
5899 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
5900 and <literal>\\</literal> all work.</para>
5902 <para>After that every entry is a special char that should be
5903 translated when writing text into such a file.</para>
5905 <para>Example:</para>
5907 <programlisting>[Template/XML]
5908 order=& < > \n
5912 \n=<br></programlisting>
5914 <para>Note the importance of the order in this example.
5915 Substituting < and > befor & would lead to $gt; become
5918 <para>For a list of valid formats, see the German
5919 <filename>special_chars</filename> entry. As of this writing the
5920 following are recognized:</para>
5922 <programlisting>HTML
5927 Template/OpenDocument
5928 filenames</programlisting>
5930 <para>The last of which is very machine dependant. Remember that
5931 a lot of characters are forbidden by some filesystems, for
5932 exmaple MS Windows doesn't like ':' in its files where Linux
5933 doesn't mind that. If you want the files created with your
5934 language pack to be portable, find all chars that could cause
5940 <term>missing</term>
5943 <para>This file is not a part of the language package
5946 <para>This is a file generated by
5947 <command>scripts/locales.pl</command> while processing your
5948 locales. It's only to have the missing entries singled out and
5949 does not belong to a language package.</para>
5957 <para>This file is not a part of the language package
5960 <para>Another file generated by
5961 <command>scripts/locales.pl</command>. If for any reason a
5962 translation does not appear anymore and can be deleted, it gets
5963 moved here. The last 50 or so entries deleted are saved here in
5964 case you made a typo, so that you don't have to translate
5965 everything again. If a tranlsation is missing, the lost file is
5966 checked first. If you maintain a language package, you might
5967 want to keep this safe somewhere.</para>
5974 <sect1 id="devel.testsuite">
5975 <title>Die kivitendo-Test-Suite</title>
5977 <sect2 id="devel.testsuite.intro">
5978 <title>Einführung</title>
5980 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul <literal>Test::More</literal>.</para>
5982 <para>Die grundlegenden Fakten sind:</para>
5985 <listitem><para>Alle Tests liegen im Unterverzeichnis <filename>t/</filename>.</para></listitem>
5987 <listitem><para>Ein Script (bzw. ein Test) in <filename>t/</filename> enthält einen oder mehrere Testfälle.</para></listitem>
5989 <listitem><para>Alle Dateinamen von Tests enden auf <literal>.t</literal>. Es sind selbstständig ausführbare Perl-Scripte.</para></listitem>
5991 <listitem><para>Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in <filename>t/</filename>, deren
5992 Dateiname auf <literal>.t</literal> endet.</para></listitem>
5996 <sect2 id="devel.testsuite.prerequisites">
5997 <title>Voraussetzungen</title>
5999 <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>
6002 <listitem><para><literal>Test::Deep</literal> (Debian-Paketname: <literal>libtest-deep-perl</literal>; Fedora Core:
6003 <literal>perl-Test-Deep</literal>; openSUSE: <literal>perl-Test-Deep</literal>)</para></listitem>
6004 <listitem><para><literal>Test::Exception</literal> (Debian-Paketname: <literal>libtest-exception-perl</literal>; Fedora Core:
6005 <literal>perl-Test-Exception</literal>; openSUSE: <literal>perl-Test-Exception</literal>)</para></listitem>
6006 <listitem><para><literal>Test::Output</literal> (Debian-Paketname: <literal>libtest-output-perl</literal>; Fedora Core:
6007 <literal>perl-Test-Output</literal>; openSUSE: <literal>perl-Test-Output</literal>)</para></listitem>
6008 <listitem><para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses Modul ist ab Perl 5.10.1 Bestandteil der
6009 Perl-Distribution und kann für frühere Versionen aus dem <ulink url="http://www.cpan.org">CPAN</ulink> bezogen
6010 werden.</para></listitem>
6011 <listitem><para><literal>LWP::Simple</literal> aus dem Paket <literal>libwww-perl</literal> (Debian-Panetname:
6012 <literal>libwww-perl</literal>; Fedora Core: <literal>perl-libwww-perl</literal>; openSUSE:
6013 <literal>perl-libwww-perl</literal>)</para></listitem>
6014 <listitem><para><literal>URI::Find</literal> (Debian-Panetname: <literal>liburi-find-perl</literal>; Fedora Core:
6015 <literal>perl-URI-Find</literal>; openSUSE: <literal>perl-URI-Find</literal>)</para></listitem>
6018 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
6019 müssen in der Konfigurationsdatei im Abschnit <literal>testing/database</literal> Datenbankverbindungsparameter angegeben
6020 werden. Der hier angegebene Benutzer muss weiterhin das Recht haben, Datenbanken anzulegen und zu löschen.</para>
6023 <sect2 id="devel.testsuite.execution">
6025 Existierende Tests ausführen
6028 <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
6029 gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript <filename>t/test.pl</filename>.</para>
6031 <para>Will man die komplette Test-Suite ausführen, so muss man einfach nur <filename>t/test.pl</filename> ohne weitere Parameter aus
6032 dem kivitendo-Basisverzeichnis heraus ausführen.</para>
6034 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an <filename>t/test.pl</filename>. Beispielsweise:</para>
6036 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
6040 <sect2 id="devel.testsuite.meaning_of_scripts">
6042 Bedeutung der verschiedenen Test-Scripte
6045 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch
6046 während der Entwicklung nützliche Tests sind:</para>
6049 <listitem><para><filename>t/001compile.t</filename> -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab</para></listitem>
6050 <listitem><para><filename>t/002goodperl.t</filename> -- überprüft alle Perl-Dateien auf Anwesenheit von '<literal>use strict</literal>'-Anweisungen</para></listitem>
6051 <listitem><para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von <function>system()</function> und <function>exec()</function> auf Gültigkeit</para></listitem>
6052 <listitem><para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien Tab-Zeichen enthalten</para></listitem>
6053 <listitem><para><filename>t/006spelling.t</filename> -- sucht nach häufigen Rechtschreibfehlern</para></listitem>
6054 <listitem><para><filename>t/011pod.t</filename> -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit</para></listitem>
6057 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module.</para>
6060 <sect2 id="devel.testsuite.create_new">
6062 Neue Test-Scripte erstellen
6065 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende
6066 Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden.</para>
6068 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
6070 Ideen für neue Test-Scripte, die keine konkreten Funktionen testen
6073 <para> Ideen, die abgesehen von Funktionen noch nicht umgesetzt wurden:</para>
6076 <listitem><para>Überprüfung auf fehlende symbolische Links</para></listitem>
6077 <listitem><para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten)</para></listitem>
6078 <listitem><para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para></listitem>
6079 <listitem><para>Überprüfung auf Leerzeichen am Ende von Zeilen</para></listitem>
6080 <listitem><para>Test, ob alle zu übersetzenden Strings in <filename>locale/de/all</filename> vorhanden sind</para></listitem>
6081 <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>
6085 <sect3 id="devel.testsuite.directory_and_test_names">
6087 Konvention für Verzeichnis- und Dateinamen
6090 <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>
6093 <listitem><para>Die Dateiendung muss <filename>.t</filename> lauten.</para></listitem>
6095 <listitem><para>Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise
6096 <filename>bad_function_params.t</filename>).</para></listitem>
6098 <listitem><para>Unterverzeichnisse sollten grob nach dem Themenbereich benannt sein, mit dem sich die Scripte darin befassen
6099 (beispielsweise <filename>background_jobs</filename> für Tests rund um Hintergrund-Jobs).</para></listitem>
6101 <listitem><para>Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist
6102 (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben.</para></listitem>
6106 <sect3 id="devel.testsuite.minimal_example">
6108 Minimales Skelett für eigene Scripte
6111 <para>Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden:</para>
6113 <programlisting>use Test::More tests => 0;
6117 use Support::TestSetup;
6119 Support::TestSetup::login();</programlisting>
6121 <para>Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie
6122 <varname>$::auth</varname>, <varname>$::form</varname> oder <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
6123 <filename>config/kivitendo.conf</filename> im Abschnitt <literal>testing.login</literal> ein gültiger Login-Name eingetragen
6124 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
6126 <para>Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile <code>Support::TestSetup::login();</code>
6127 weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.</para>
6132 <sect1 id="devel.style-guide">
6133 <title>Stil-Richtlinien</title>
6135 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
6136 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
6137 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
6138 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
6140 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
6143 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
6144 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
6149 <para>Es werden keine echten Tabs sondern Leerzeichen
6154 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
6156 <programlisting>foreach my $row (@data) {
6158 # do something with $row
6162 $row->{modules} = MODULE->retrieve(
6163 id => $row->{id},
6164 date => $use_now ? localtime() : $row->{time},
6168 $report->add($row);
6173 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
6174 Zeile wie der letzte Befehl. Beispiele:</para>
6176 <programlisting>sub debug {
6182 <programlisting>if ($form->{item_rows} > 0) {
6188 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
6189 der Befehl / die öffnende schließende Klammer, die den Block
6190 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
6191 Beispiele wie bei 3. gelten.</para>
6195 <para>Die Wörter "<function>else</function>",
6196 "<function>elsif</function>", "<function>while</function>" befinden
6197 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
6200 <programlisting>if ($form->{sum} > 1000) {
6202 } elsif ($form->{sum} > 0) {
6210 } until ($a > 0);</programlisting>
6214 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
6215 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
6216 und grep-ähnliche Operatoren. Beispiel:</para>
6218 <programlisting>$main::lxdebug->message("Could not find file.");
6219 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
6223 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
6225 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
6226 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
6227 Blöcke schon. Beispiel:</para>
6229 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
6234 $form->{sum} += $form->{"row_$i"};
6235 $form->{ $form->{index} } += 1;
6237 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
6241 <para>Mehrzeilige Befehle</para>
6245 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
6246 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
6247 werden, in der die ersten Funktionsparameter in der ersten Zeile
6248 stehen. Beispiel:</para>
6250 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
6251 $form->{some_col_value});</programlisting>
6255 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
6256 besten in einer übersichtlichen Tabellenstruktur organisiert
6257 wird. Beispiel:</para>
6259 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
6260 : $form->{oldcount} ? $form->{oldcount} + 1
6261 : $form->{rowcount} - $form->{rowbase};</programlisting>
6267 <para>Kommentare</para>
6271 <para>Kommentare, die alleine in einer Zeile stehen, sollten
6272 soweit wie der Code eingerückt sein.</para>
6276 <para>Seitliche hängende Kommentare sollten einheitlich
6277 formatiert werden.</para>
6281 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
6282 auf Englisch zu verfassen. So wie ich keine Lust habe,
6283 französischen Quelltext zu lesen, sollte auch der kivitendo
6284 Quelltext für nicht-Deutschsprachige lesbar sein.
6287 <programlisting>my $found = 0;
6295 $i = 0 # initialize $i
6297 $i *= $const; # do something crazy
6298 $i = $n; # recover $i</programlisting>
6304 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
6305 Interpolation gewünscht ist. Beispiel:</para>
6307 <programlisting>$form->{sum} = 0;
6308 $form->{"row_$i"} = $form->{"row_$i"} - 5;
6309 $some_hash{42} = 54;</programlisting>
6313 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
6314 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
6315 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
6316 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
6318 <para>Als Beispiel sei die Funktion
6319 <function>print_options</function> aus
6320 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
6324 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
6325 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
6328 <para>Emacs und vim haben beide recht einfache Methoden zur
6329 Entfernung von trailing whitespace. Emacs kennt das Kommande
6330 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
6331 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
6332 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
6337 <para>Es wird kein <command>perltidy</command> verwendet.</para>
6339 <para>In der Vergangenheit wurde versucht,
6340 <command>perltidy</command> zu verwenden, um einen einheitlichen
6341 Stil zu erlangen. Es hat sich aber gezeigt, dass
6342 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
6343 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
6344 den Interessierten sind hier die
6345 <command>perltidy</command>-Optionen, die grob den beschriebenen
6346 Richtlinien entsprechen:</para>
6348 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
6349 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
6350 -lp -vt=1 -vtc=1</programlisting>
6354 <para><varname>STDERR</varname> ist tabu. Unkonditionale
6355 Debugmeldungen auch.</para>
6357 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
6358 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
6359 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
6361 <para>Die <classname>LXDebug</classname>-Methode
6362 "<function>message</function>" nimmt als ersten Paramter außerdem
6363 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
6364 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
6365 und werden in den meisten Fällen auch vom Repository
6366 zurückgewiesen.</para>
6370 <para>Alle neuen Module müssen use strict verwenden.</para>
6372 <para><varname>$form</varname>, <varname>$auth</varname>,
6373 <varname>$locale</varname>, <varname>$lxdebug</varname> und
6374 <varname>%myconfig</varname> werden derzeit aus dem main package
6375 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
6376 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
6381 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
6382 <title>Dokumentation erstellen</title>
6384 <sect2 id="devel.build-doc.introduction">
6385 <title>Einführung</title>
6387 <para>Diese Dokumentation ist in <productname>DocBook</productname>
6388 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
6389 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
6390 Editor nutzt, der spezielle Unterstützung für
6391 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
6392 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
6393 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
6397 <sect2 id="devel.build-doc.required-software">
6398 <title>Benötigte Software</title>
6400 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
6401 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
6402 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
6403 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
6404 <command>scripts/build_doc.sh</command>.</para>
6406 <para>Das Script benötigt zur Konvertierung verschiedene
6407 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
6413 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
6414 in einer halbwegs aktuellen Version</para>
6418 <para>Das Java-Build-System <ulink
6419 url="http://ant.apache.org/">Apache Ant</ulink></para>
6423 <para>Das Dokumentations-System Dobudish für
6424 <productname>DocBook</productname> 4.5, eine Zusammenstellung
6425 diverser Stylesheets und Grafiken zur Konvertierung von
6426 <productname>DocBook</productname> XML in andere Formate. Das
6427 Paket, das benötigt wird, ist zum Zeitpunkt der
6428 Dokumentationserstellung
6429 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
6430 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
6435 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
6436 sind auf allen gängigen Plattformen verfügbar. Beispiel für
6437 Debian/Ubuntu:</para>
6439 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
6441 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
6442 <filename>doc/build</filename> entpackt werden. Beispiel unter der
6443 Annahme, das <productname>Dobudish</productname> in
6444 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
6446 <programlisting>cd doc/build
6447 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
6450 <sect2 id="devel.build-doc.build">
6451 <title>PDFs und HTML-Seiten erstellen</title>
6453 <para>Die eigentliche Konvertierung erfolgt nach Installation der
6454 benötigten Software mit einem einfachen Aufruf direkt aus dem
6455 kivitendo-Installationsverzeichnis heraus:</para>
6457 <programlisting>./scripts/build_doc.sh</programlisting>
6460 <sect2 id="devel.build-doc.repository">
6461 <title>Einchecken in das Git-Repository</title>
6463 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
6464 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
6465 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
6466 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
6468 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
6469 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob