1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <book id="kivitendo-documentation" lang="de">
5 <title>kivitendo 3.0.0: Installation, Konfiguration, Entwicklung</title>
7 <chapter id="Aktuelle-Hinweise">
8 <title>Aktuelle Hinweise</title>
10 <para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>
14 <para>im kivitendo-Forum: <ulink
15 url="https://forum.kivitendo.org/">https://forum.kivitendo.org/</ulink></para>
21 <title>Installation und Grundkonfiguration</title>
23 <sect1 id="Installation-Übersicht">
24 <title>Übersicht</title>
27 Die Installation von kivitendo umfasst mehrere Schritte. Die folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
28 Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit minimalen Features möglichst schnell zum Laufen zu kriegen.
32 <listitem><para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo benötigt gewisse Ressourcen und benutzt weitere
33 Programme. Das Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert diese. Auch die Liste der benötigten Perl-Module
34 befindet sich hier.</para></listitem>
36 <listitem><para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst die "<xref
37 linkend="Manuelle-Installation-des-Programmpaketes"/>" sowie grundlegende Einstellungen, die der "<xref
38 linkend="config.config-file"/>" erläutert.</para></listitem>
40 <listitem><para><emphasis>Konfiguration externer Programme</emphasis>: hierzu gehören die Datenbank ("<xref
41 linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der Webserver ("<xref
42 linkend="Apache-Konfiguration"/>"). </para></listitem>
44 <listitem><para><emphasis>Benutzerinformationen speichern können</emphasis>: man benötigt mindestens eine Datenbank, in der
45 Informationen zur Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man das als Administrator macht, verrät "<xref
46 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para></listitem>
48 <listitem><para><emphasis>Benutzer, Gruppen und Datenbanken anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
49 linkend="Benutzer--und-Gruppenverwaltung"/>".</para></listitem>
51 <listitem><para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann kann es losgehen: "<xref
52 linkend="kivitendo-ERP-verwenden"/>"</para></listitem>
56 Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls wichtig und dienen sollten vor einer ernsthaften Inbetriebnahme gelesen
61 <sect1 id="Benötigte-Software-und-Pakete">
62 <title>Benötigte Software und Pakete</title>
64 <sect2 id="Betriebssystem">
65 <title>Betriebssystem</title>
67 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
68 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
69 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
70 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
71 ohne große Probleme auf den derzeit aktuellen verbreiteten
72 Distributionen läuft.</para>
74 <para>Mitte 2012 sind das folgende Systeme, von denen bekannt ist,
75 dass kivitendo auf ihnen läuft:</para>
83 <para>6.0 "Squeeze" (hier muss allerdings das Modul FCGI in der Version >= 0.72 compiled werden)</para>
86 <para>7.0 "Wheezy"</para>
92 <para>Ubuntu 10.04 LTS "Lucid Lynx", 12.04 LTS "Precise Pangolin" und 12.10 "Oneiric Ocelot"`</para>
96 <para>openSUSE 12.1 und 12.2</para>
100 <para>SuSE Linux Enterprice Server 11</para>
104 <para>Fedora 16 und 17</para>
109 <sect2 id="Pakete" xreflabel="Pakete">
110 <title>Benötigte Perl-Pakete installieren</title>
112 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
113 Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2)
116 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht Bestandteil einer Standard-Perl-Installation sind. Um zu
117 überprüfen, ob die erforderlichen Pakete installiert und aktuell genug sind, wird ein Script mitgeliefert, das wie folgt aufgerufen
120 <programlisting>./scripts/installation_check.pl</programlisting>
122 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
125 <listitem><para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para></listitem>
127 <listitem><para><literal>Archive::Zip</literal></para></listitem>
129 <listitem><para><literal>Config::Std</literal></para></listitem>
131 <listitem><para><literal>DateTime</literal></para></listitem>
133 <listitem><para><literal>DBI</literal></para></listitem>
135 <listitem><para><literal>DBD::Pg</literal></para></listitem>
137 <listitem><para><literal>Email::Address</literal></para></listitem>
139 <listitem><para><literal>Email::MIME</literal></para></listitem>
141 <listitem><para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71 inklusive; siehe <xref linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para></listitem>
143 <listitem><para><literal>File::Copy::Recursive</literal></para></listitem>
145 <listitem><para><literal>JSON</literal></para></listitem>
147 <listitem><para><literal>List::MoreUtils</literal></para></listitem>
149 <listitem><para><literal>Net::SMTP::SSL</literal> (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "<xref
150 linkend="config.sending-email.smtp"/>")</para></listitem>
152 <listitem><para><literal>Net::SSLGlue</literal> (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "<xref
153 linkend="config.sending-email.smtp"/>")</para></listitem>
155 <listitem><para><literal>Params::Validate</literal></para></listitem>
157 <listitem><para><literal>PDF::API2</literal></para></listitem>
159 <listitem><para><literal>Rose::Object</literal></para></listitem>
161 <listitem><para><literal>Rose::DB</literal></para></listitem>
163 <listitem><para><literal>Rose::DB::Object</literal></para></listitem>
165 <listitem><para><literal>Template</literal></para></listitem>
167 <listitem><para><literal>Text::CSV_XS</literal></para></listitem>
169 <listitem><para><literal>Text::Iconv</literal></para></listitem>
171 <listitem><para><literal>URI</literal></para></listitem>
173 <listitem><para><literal>XML::Writer</literal></para></listitem>
175 <listitem><para><literal>YAML</literal></para></listitem>
178 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen: <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
179 <literal>Net::SSLGlue</literal>.</para>
181 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
182 hinzugekommen, <literal>URI</literal> und
183 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
186 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
187 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
188 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
189 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
191 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
192 hinzugekommen.</para>
194 <para><literal>Email::Address</literal> und
195 <literal>List::MoreUtils</literal> sind schon länger feste
196 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
197 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
198 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
199 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
203 <title>Debian und Ubuntu</title>
205 <para>Alle benötigten Perl-Pakete stehen für Debian und Ubuntu als Debian-Pakete zur Verfügung. Sie können mit folgendem Befehl
206 installiert werden:</para>
208 <programlisting>apt-get install apache2 libarchive-zip-perl libclone-perl \
209 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
210 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
211 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
212 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
213 librose-db-perl librose-object-perl libsort-naturally-perl \
214 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
215 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
216 libfile-copy-recursive-perl postgresql</programlisting>
220 <title>Fedora Core</title>
222 <para>Für Fedora Core stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl installeirt werden:</para>
224 <programlisting>yum install httpd perl-Archive-Zip perl-Clone perl-DBD-Pg \
225 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
226 perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
227 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
228 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
229 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
230 perl-XML-Writer perl-YAML perl-parent postgresql-server</programlisting>
232 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
234 <programlisting>yum install perl-CPAN
235 cpan Config::Std</programlisting>
240 <title>openSUSE</title>
242 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
243 installiert werden:</para>
245 <programlisting>zypper install apache2 perl-Archive-Zip perl-Clone \
246 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
247 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
248 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
249 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
250 perl-URI perl-XML-Writer perl-YAML postgresql-server</programlisting>
252 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
254 <programlisting>yum install perl-CPAN
255 cpan Rose::Db::Object</programlisting>
261 <sect1 id="Manuelle-Installation-des-Programmpaketes"
262 xreflabel="Manuelle Installation des Programmpaketes">
263 <title>Manuelle Installation des Programmpaketes</title>
265 <para>Die kivitendo ERP Installationsdatei (<filename>kivitendo-erp-3.0.0.tgz</filename>) wird im Dokumentenverzeichnis des Webservers
266 (z.B. <filename>/var/www/html/</filename>, <filename>/srv/www/htdocs</filename> oder <filename>/var/www/</filename>) entpackt:</para>
268 <programlisting>cd /var/www
269 tar xvzf kivitendo-erp-3.0.0.tgz</programlisting>
271 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
273 <programlisting>cd kivitendo-erp</programlisting>
275 <para>Alternativ können Sie auch einen Alias in der
276 Webserverkonfiguration benutzen, um auf das tatsächliche
277 Installationsverzeichnis zu verweisen.</para>
279 <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
280 beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
281 Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
282 core <constant>apache</constant> oder bei OpenSUSE <constant>wwwrun</constant>).</para>
284 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
285 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
287 <programlisting>chown -R www-data users spool webdav</programlisting>
289 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
290 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>
292 <programlisting>chown www-data templates users</programlisting>
295 <sect1 id="config.config-file">
296 <title>kivitendo-Konfigurationsdatei</title>
298 <sect2 id="config.config-file.introduction"
299 xreflabel="Einführung in die Konfigurationsdatei">
300 <title>Einführung</title>
302 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei,
303 die benötigt wird: <filename>config/kivitendo.conf</filename> (kurz:
304 "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
305 von kivitendo bzw. der Migration von älteren Versionen angelegt
308 <para>Als Vorlage dient die Datei
309 <filename>config/kivitendo.conf.default</filename> (kurz: "die
310 Default-Datei"):</para>
312 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
314 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
315 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
316 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
317 Abschnitte und Werte enthalten, die von denen der Default-Datei
322 Vor der Umbenennung in kivitendo hieß diese Datei noch <filename>config/lx_office.conf</filename>. Aus Gründen der Kompatibilität
323 wird diese Datei eingelesen, sofern die Datei <filename>config/kivitendo.conf</filename> nicht existiert.
327 <para>Diese Hauptkonfigurationsdatei ist dann eine
328 installationsspezifische Datei, d.h. sie enthält bspw. lokale
329 Passwörter und wird auch nicht im Versionsmanagement (git)
332 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
333 Mandaten, bzw. Datenbanken gleich.</para>
336 <sect2 id="config.config-file.sections-parameters">
337 <title>Abschnitte und Parameter</title>
339 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
340 entsprechend kommentiert sind:</para>
343 <listitem><para><literal>authentication</literal> (siehe Abschnitt "<xref
344 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>" in diesem Kapitel)</para></listitem>
346 <listitem><para><literal>authentication/database</literal></para></listitem>
348 <listitem><para><literal>authentication/ldap</literal></para></listitem>
350 <listitem><para><literal>system</literal></para></listitem>
352 <listitem><para><literal>features</literal> (siehe Kapitel "<xref linkend="features"/>")</para></listitem>
354 <listitem><para><literal>paths</literal></para></listitem>
356 <listitem><para><literal>applications</literal></para></listitem>
358 <listitem><para><literal>environment</literal></para></listitem>
360 <listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>
362 <listitem><para><literal>print_templates</literal></para></listitem>
364 <listitem><para><literal>task_server</literal></para></listitem>
366 <listitem><para><literal>periodic_invoices</literal></para></listitem>
368 <listitem><para><literal>console</literal></para></listitem>
370 <listitem><para><literal>debug</literal></para></listitem>
373 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
374 einzustellen oder zu kontrollieren sind, sind:</para>
376 <programlisting>[authentication]
377 admin_password = geheim
379 [authentication/database]
384 password =</programlisting>
386 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
387 <varname>[periodic_invoices]</varname> den Login eines Benutzers
388 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
389 mit Informationen über die erstellten Rechnungen bekommt.</para>
391 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten Ausführung bestimmter Aufgaben mit, den <link
392 linkend="config.task-server">Taskserver</link>. Er wird u.a. für Features wie die <link
393 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link> benötigt, erledigt aber auch andere erforderliche Aufgaben
394 und muss daher in Betrieb genommen werden. Der Taskserver benötigt zwei Konfigurationseinstellungen, die unter
395 <varname>[task_server]</varname> anzugeben sind: ein Mandant (entweder der Mandantenname oder eine Datenbank-ID, Variable
396 <varname>client</varname>), aus dem die Datenbankkonfiguration entnommen wird, sowie ein Login (Variable <varname>login</varname>)
397 eines Benutzers, der für gewisse Dinge wie die Rechnungserstellung als Verkäufer eingetragen wird.</para>
399 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
400 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
403 <sect2 id="config.config-file.prior-versions">
404 <title>Versionen vor 2.6.3</title>
406 <para>In älteren kivitendo Versionen gab es im Verzeichnis
407 <filename>config</filename> die Dateien
408 <filename>authentication.pl</filename> und
409 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
410 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
411 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
412 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
414 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
415 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
416 manuell übertragen und die alten Konfigurationsdateien anschließend
417 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
418 entsprechende Fehlermeldung an.</para>
422 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
423 <title>Anpassung der PostgreSQL-Konfiguration</title>
425 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
427 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
428 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
430 <para>kivitendo setzt zwingend voraus, dass die Datenbank Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen Serverinstallationen
431 braucht man hier meist nicht einzugreifen.</para>
433 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so
434 braucht man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
436 <programlisting>su postgres
438 exit </programlisting>
440 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
441 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
442 Ubuntu kann dies z.B. für PostgreSQL 8.2 mit dem folgenden Befehl
445 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2 clustername</programlisting>
447 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
448 Versionsnummer angepasst werden.</para>
450 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
452 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
453 <literal>\l</literal> geprüft werden.</para>
456 <sect2 id="Änderungen-an-Konfigurationsdateien">
457 <title>Änderungen an Konfigurationsdateien</title>
459 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
460 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
461 <filename>/var/lib/pgsql/data/</filename> oder
462 <filename>/etc/postgresql/</filename>, muss sichergestellt werden,
463 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
464 Parameter <varname>listen_address</varname> gesteuert. Laufen
465 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
466 <literal>localhost</literal> verwendet werden. Andernfalls müssen
467 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
468 was mit dem Wert <literal>*</literal> geschieht.</para>
470 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
471 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
472 sein sollte, müssen die Berichtigungen für den Zugriff geändert
473 werden. Hier gibt es mehrere Möglichkeiten. sinnvoll ist es nur die
474 nögiten Verbindungen immer zuzulassen, für eine lokal laufenden
475 Datenbank zum Beispiel:</para>
477 <programlisting>local all kivitendo password
478 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
481 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
482 <title>Erweiterung für servergespeicherte Prozeduren</title>
484 <para>In der Datenbank <literal>template1</literal> muss die
485 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
486 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
487 <programlisting>su - postgres
488 psql template1</programlisting>
490 führen Sie die folgenden Kommandos aus:</para>
492 <programlisting>create language 'plpgsql';
496 <sect2 id="Datenbankbenutzer-anlegen">
497 <title>Datenbankbenutzer anlegen</title>
499 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
500 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
501 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
504 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit nein
505 beantworten, genauso ist die Berechtigung neue User (Roles) zu
506 generieren nicht nötig.</para>
507 <programlisting>su - postgres
508 createuser -d -P kivitendo
509 exit</programlisting>
511 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
512 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.
513 den hier gewählten Benutzernamen.</para>
517 <sect1 id="Apache-Konfiguration">
518 <title>Webserver-Konfiguration</title>
521 <title>Grundkonfiguration mittels CGI</title>
524 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
525 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
526 <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
529 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
530 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
531 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
532 anderen Datei hinzu, die beim Starten des Webservers eingelesen
535 <programlisting>AddHandler cgi-script .pl
536 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
538 <Directory /var/www/kivitendo-erp>
539 Options ExecCGI Includes FollowSymlinks
542 <Directory /var/www/kivitendo-erp/users>
545 </Directory></programlisting>
547 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
548 das kivitendo-Archiv entpacket haben.</para>
551 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
552 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
555 <para>Auf einigen Webservern werden manchmal die Grafiken und
556 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
557 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
559 <programlisting>EnableSendfile Off</programlisting>
562 <sect2 id="Apache-Konfiguration.FCGI"
563 xreflabel="Konfiguration für FastCGI/FCGI">
564 <title>Konfiguration für FastCGI/FCGI</title>
566 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
567 <title>Was ist FastCGI?</title>
569 <para>Direkt aus <ulink
570 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
573 <para><citation> FastCGI ist ein Standard für die Einbindung
574 externer Software zur Generierung dynamischer Webseiten in einem
575 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
576 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
577 umgehen. </citation></para>
580 <sect3 id="Apache-Konfiguration.FCGI.Warum">
581 <title>Warum FastCGI?</title>
583 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
584 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
585 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
586 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
587 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
588 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
589 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
590 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
591 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
592 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
593 deutlich länger dauert als früher, und dass davon 90% für das Laden
594 der Module verwendet wird.</para>
596 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
597 wird nur die eigentliche Programmlogik ausgeführt.</para>
600 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
601 <title>Getestete Kombinationen aus Webservern und Plugin</title>
603 <para>Folgende Kombinationen sind getestet:</para>
607 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
611 <para>Apache 2.2.11 (Ubuntu) und mod_fastcgi.</para>
615 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
616 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
617 mod_fastcgi nicht mehr explizit eingegangen.</para>
619 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
623 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern
624 bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrere Installation gibt, muss zwingend Version 0.68 oder
625 aber Version 0.72 und neuer eingesetzt werden.</para>
627 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie sich die Vorgängerversion wie folgt
630 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
634 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
635 <title>Konfiguration des Webservers</title>
637 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
638 laufen zu lassen, empfliehlt es sich die Installation ersteinmal
639 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
640 debuggen die beim ersten aufsetzen auftreten können. Sollte die
641 Installation schon funktionieren, lesen Sie weiter.</para>
643 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
644 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
646 <programlisting>a2enmod fcgid</programlisting>
648 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
649 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
650 und <function>Directory</function>-Direktiven. Dabei wird zwischen
651 dem Installationspfad von kivitendo im Dateisystem
652 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
653 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
654 ("<filename>/url/for/kivitendo-erp</filename>").</para>
656 <para>Folgender Konfigurationsschnipsel funktioniert mit
659 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
660 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
662 <Directory /path/to/kivitendo-erp>
664 Options ExecCGI Includes FollowSymlinks
669 <DirectoryMatch /path/to/kivitendo-erp/users>
672 </DirectoryMatch></programlisting>
674 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
675 die maximale Größe eines Requests. Diese sollte wie folgt
676 hochgesetzt werden:</para>
678 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
680 <para>Das ganze sollte dann so aussehen:</para>
682 <programlisting>AddHandler fcgid-script .fpl
683 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
684 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
685 FcgidMaxRequestLen 10485760
687 <Directory /path/to/kivitendo-erp>
689 Options ExecCGI Includes FollowSymlinks
694 <DirectoryMatch /path/to/kivitendo-erp/users>
697 </DirectoryMatch></programlisting>
699 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
700 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
701 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
702 gibt es hier kleine Performance-Einbußen.</para>
704 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
705 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
706 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
708 <programlisting># Zugriff über CGI
709 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
711 # Zugriff mit mod_fcgid:
712 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
713 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
715 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
716 die normale Version erreichbar, und unter
717 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
718 FastCGI-Version.</para>
723 <sect1 id="config.task-server">
724 <title>Der Task-Server</title>
726 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und
727 diese zu festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess wird u.a. für die Erzeugung der wiederkehrenden
728 Rechnungen und weitere essenzielle Aufgaben benutzt.</para>
730 <sect2 id="Konfiguration-des-Task-Servers">
731 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
733 <para>Die Konfiguration erfolgt über den Abschnitt
734 <literal>[task_server]</literal> in der Datei
735 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
736 Optionen sind:</para>
740 <term><varname>client</varname></term>
743 <para>Name oder Datenbank-ID eines vorhandenen kivitendo-Mandanten, der benutzt wird, um die zu verwendende
744 Datenbankverbindung auszulesen. Der Mandant muss in der Administration angelegt werden. Diese Option muss angegeben
747 <para>Diese Option kam mit Release v3.x.0 hinzu und muss daher in Konfigurationen, die von älteren Versionen aktualisiert
748 wurden, ergänzt werden.</para>
753 <term><varname>login</varname></term>
756 <para>gültiger kivitendo-Benutzername, der z.B. als Verkäufer beim Erzeugen wiederkehrender Rechnungen benötigt wird. Der
757 Benutzer muss in der Administration angelegt werden. Diese Option muss angegeben werden.</para>
762 <term><varname>run_as</varname></term>
765 <para>Wird der Server vom Systembenutzer <literal>root</literal>
766 gestartet, so wechselt er auf den mit <literal>run_as</literal>
767 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
768 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
770 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
771 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
772 unter dem auch der Webserver läuft.</para>
777 <term><varname>debug</varname></term>
780 <para>Schaltet Debug-Informationen an und aus.</para>
786 <sect2 id="Einbinden-in-den-Boot-Prozess">
787 <title>Automatisches Starten des Task-Servers beim Booten</title>
789 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
790 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
791 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
793 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
794 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
795 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
796 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
797 anstelle eines symbolischen Links verwendet werden können.</para>
800 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, ältere Fedora Core)</title>
802 <para>Kopieren Sie die Datei
803 <filename>scripts/boot/system-v/kivitendo-server</filename>
804 nach <filename>/etc/init.d/kivitendo-server</filename>. Passen
805 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
806 <literal>DAEMON=....</literal>). Binden Sie das Script in den
807 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
811 <para>Debian-basierende Systeme:</para>
813 <programlisting>update-rc.d kivitendo-task-server defaults
814 # Nur bei Debian Squeeze und neuer:
815 insserv kivitendo-task-server</programlisting>
819 <para>Ältere OpenSUSE und ältere Fedora Core:</para>
821 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
825 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
828 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
832 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
834 <para>Kopieren Sie die Datei
835 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
836 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
837 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
838 <literal>exec ....</literal>).</para>
840 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
843 <programlisting>service kivitendo-task-server start</programlisting>
847 <title>systemd-basierende Systeme (z.B. neure OpenSUSE, neuere Fedora Core)</title>
849 <para>Verlinken Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
850 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
851 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>). Binden Sie das Script in den Boot-Prozess ein.
854 <para>Alle hierzu benötigten Befehle sehen so aus:</para>
856 <programlisting>cd /var/www/kivitendo-erp/scripts/boot/systemd
857 ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
859 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
862 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
866 <sect2 id="Prozesskontrolle">
867 <title>Wie der Task-Server gestartet und beendet wird</title>
869 <para>Der Task-Server wird wie folgt kontrolliert:</para>
871 <programlisting>./scripts/task_server.pl Befehl</programlisting>
873 <para><literal>Befehl</literal> ist dabei eine der folgenden
878 <para><literal>start</literal> startet eine neue Instanz des
879 Task-Servers. Die Prozess-ID wird innerhalb des
880 <filename>users</filename>-Verzeichnisses abgelegt.</para>
884 <para><literal>stop</literal> beendet einen laufenden
889 <para><literal>restart</literal> beendet und startet ihn
894 <para><literal>status</literal> berichtet, ob der Task-Server
899 <para>Der Task-Server wechselt beim Starten automatisch in das
900 kivitendo-Installationsverzeichnis.</para>
902 <para>Dieselben Optionen können auch für die SystemV-basierenden
903 Runlevel-Scripte benutzt werden (siehe oben).</para>
905 <sect2 id="Prozesskontrolle2">
906 <title>Task-Server mit mehreren Mandanten</title>
908 <para>Beim Task-Server werden der zu verwendende Mandant und Login-Name des Benutzers, unter dem der Task-Server laufen soll, in die
909 Konfigurationsdatei geschrieben. Hat man mehrere Mandanten, muss man auch mehrere Konfigurationsdateien anlegen.</para>
911 <para>Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf, wo in der Kategorie <varname>[task_server]</varname> die
912 gewünschten Werte für <varname>client</varname> und <varname>login</varname> eingetragen werden.</para>
914 <para>Der alternative Task-Server wird dann mit folgendem Befehl
917 <programlisting>./scripts/task_server.pl -c config/DATEINAME.conf</programlisting>
921 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
922 <title>Benutzerauthentifizierung und Administratorpasswort</title>
924 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
925 über die Verwaltung von Gruppen und weitere Einstellungen</para>
927 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
928 <title>Grundlagen zur Benutzerauthentifizierung</title>
930 <para>kivitendo verwaltet die Benutzerinformationen in einer
931 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
932 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
933 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
934 können, müssen aber nicht unterschiedlich sein.</para>
936 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
937 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
938 abgelegt werden.</para>
940 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
941 entweder gegen die Authentifizierungsdatenbank oder gegen einen
942 LDAP-Server überprüft werden.</para>
944 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
945 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
946 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
947 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
948 einer Version vor v2.6.0 angelegt werden. Eine
949 Beispielkonfigurationsdatei
950 <filename>config/kivitendo.conf.default</filename> existiert, die als
951 Vorlage benutzt werden kann.</para>
954 <sect2 id="Administratorpasswort">
955 <title>Administratorpasswort</title>
957 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
958 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
959 nur dort und nicht mehr im Administrationsinterface selber geändert
960 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
961 Abschnitt <varname>[authentication]</varname>.</para>
964 <sect2 id="Authentifizierungsdatenbank">
965 <title>Authentifizierungsdatenbank</title>
967 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
968 Parametern in <varname>[authentication/database]</varname>
969 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
973 <term><literal>host</literal></term>
976 <para>Der Rechnername oder die IP-Adresse des
977 Datenbankservers</para>
982 <term><literal>port</literal></term>
985 <para>Die Portnummer des Datenbankservers, meist 5432</para>
990 <term><literal>db</literal></term>
993 <para>Der Name der Authentifizierungsdatenbank</para>
998 <term><literal>user</literal></term>
1001 <para>Der Benutzername, mit dem sich kivitendo beim
1002 Datenbankserver anmeldet (z.B.
1003 "<literal>postgres</literal>")</para>
1008 <term><literal>password</literal></term>
1011 <para>Das Passwort für den Datenbankbenutzer</para>
1016 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1017 automatisch anlegen (mehr dazu siehe unten).</para>
1020 <sect2 id="Passwortüberprüfung">
1021 <title>Passwortüberprüfung</title>
1023 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1024 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1025 Active-Directory-Server. Welche davon benutzt wird, regelt der
1026 Parameter <varname>module</varname> im Abschnitt
1027 <varname>[authentication]</varname>.</para>
1029 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1030 gespeichert werden, so muss der Parameter <varname>module</varname>
1031 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1032 der Administrator als auch die Benutzer selber ihre Psaswörter in
1033 kivitendo ändern.</para>
1035 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1036 benutzt werden, so muss der Parameter <varname>module</varname> auf
1037 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1038 zusätzliche Informationen über den LDAP-Server im Abschnitt
1039 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1043 <term><literal>host</literal></term>
1046 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1047 Active-Directory-Servers. Diese Angabe ist zwingend
1048 erforderlich.</para>
1053 <term><literal>port</literal></term>
1056 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1061 <term><literal>tls</literal></term>
1064 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1065 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1066 ‘<literal>0</literal>’ belassen</para>
1071 <term><literal>attribute</literal></term>
1074 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1075 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1076 meist ‘<literal>sAMAccountName</literal>’, für andere
1077 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1078 zwingend erforderlich.</para>
1083 <term><literal>base_dn</literal></term>
1086 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1087 Diese Angabe ist zwingend erforderlich.</para>
1092 <term><literal>filter</literal></term>
1095 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1096 <literal><%login%></literal>, so wird dieses durch den vom
1097 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1098 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1099 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1104 <term><literal>bind_dn</literal> und
1105 <literal>bind_password</literal></term>
1108 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1109 durchsucht werden kann (z.B. ist dies bei
1110 Active-Directory-Servern der Fall), so kann diese hier angegeben
1111 werden. Für Active-Directory-Server kann als
1112 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1113 z.B. ‘<literal>cn=Martin
1114 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1115 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1116 also ‘<literal>Martin Mustermann</literal>’.</para>
1122 <sect2 id="Name-des-Session-Cookies">
1123 <title>Name des Session-Cookies</title>
1125 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1126 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1127 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1128 Parameter <varname>cookie_name</varname> im Abschnitt
1129 <varname>[authentication]</varname>gesetzt.</para>
1131 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1132 Server existiert.</para>
1135 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1136 <title>Anlegen der Authentifizierungsdatenbank</title>
1138 <para>Nachdem alle Einstellungen in
1139 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1140 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1141 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1142 der folgenden URL erreichbar sein sollte:</para>
1145 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1149 <sect1 id="Benutzer--und-Gruppenverwaltung">
1150 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1152 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und Datenbanken angelegt werden. Dieses geschieht im
1153 Administrationsmenü, das Sie unter folgender URL finden:</para>
1156 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1158 <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
1159 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1161 <sect2 id="Zusammenhänge">
1162 <title>Zusammenhänge</title>
1164 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung in einer oder zwei Datenbanken gespeichert werden.</para>
1166 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat
1167 Zugriff auf welche Mandanten, und welche Gruppe verfügt über welche Rechte. Diese Informationen werden in der
1168 Authentifizierungsdatenbank gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter in der Konfigurationsdatei
1169 <filename>config/kivitendo.conf</filename> gespeichert werden.</para>
1171 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines Mandanten: Stammdaten (Kunden, Lieferanten, Waren), Belege
1172 (Angebote, Liferscheine, Rechnungen), Einstellungen. Diese werden in einer Mandantendatenbank gespeichert. Die
1173 Verbindungsinformationen einer solchen Mandantendatenbank werden im Administrationsbereich konfiguriert, indem man einen Mandanten
1174 anlegt und dort die Parameter einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1176 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich, die Authentifizierungsdatenbank und eine der
1177 Mandantendatenbanken in ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit mehr als einem Mandanten, wird
1178 empfohlen, für die Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die nicht gleichzeitig für einen Mandanten
1179 verwendet wird.</para>
1181 <para>kivitendo verwendet eine Datenbank zum Speichern all seiner
1182 Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um
1183 mit kivitendo arbeiten zu können, muss eine Person einen
1184 Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine
1185 Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist
1186 möglich und normal, dass mehreren Benutzern die selbe Datenbank
1187 zugewiesen wird, sodass sie alle mit den selben Daten arbeiten
1191 <sect2 id="Mandanten-Benutzer-Gruppen">
1192 <title>Mandanten, Benutzer und Gruppen</title>
1194 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen, die sich frei zueinander zuordnen lassen.</para>
1196 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1197 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1198 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank. Diese sollte über die <link
1199 linkend="Datenbanken-anlegen">Datenbankverwaltung</link> geschehen.</para>
1201 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten soll. Sie erhält einen Loginnamen sowie ein
1202 Passwort. Weiterhin legt der Administrator fest, an welchen Mandanten sich ein Benutzer anmelden kann, was beim Login verifiziert
1205 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür
1206 vom Administrator gewisse Rechte zugeordnet. Weiterhin legt der Administrator fest, für welche Mandanten eine Gruppe gilt, und
1207 welche Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer dann an einem Mandanten an, so erhält er alle Rechte von
1208 allen denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in denen der Benutzer zum Anderen Mitglied ist, </para>
1210 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und Benutzer angelegt werden, kann im Prinzip beliebig gewählt
1211 werden. Die folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1213 <orderedlist numeration="arabic">
1215 <para>Datenbank anlegen</para>
1219 <para>Gruppen anlegen</para>
1223 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1227 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1232 <sect2 id="Datenbanken-anlegen">
1233 <title>Datenbanken anlegen</title>
1235 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1236 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1237 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1240 <sect2 id="Gruppen-anlegen">
1241 <title>Gruppen anlegen</title>
1243 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1244 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1245 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1246 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1248 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank gespeichert, gelten aber nicht automatisch für alle
1249 Mandanten. Der Administrator legt vielmehr fest, für welche Mandanten eine Gruppe gültig ist. Dies kann entweder beim Bearbeiten der
1250 Gruppe geschehen ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn man einen Mandanten bearbeitet ("für diesen
1251 Mandanten sind die Gruppen A, B und C gültig").</para>
1253 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder dieser Gruppe festgelegt werden ("in dieser Gruppe sind die
1254 Benutzer X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten eines Benutzers geschehen ("dieser Benutzer ist
1255 Mitglied in den Gruppen A, B und C").</para>
1258 <sect2 id="Benutzer-anlegen">
1259 <title>Benutzer anlegen</title>
1261 <para>Beim Anlegen von Benutzern werden für viele Parameter Standardeinstellungen vorgenommen, die den Gepflogenheiten des deutschen
1262 Raumes entsprechen.</para>
1264 <para>Zwingend anzugeben ist der Loginname. Wenn die Passwortauthentifizierung über die Datenbank eingestellt ist, so kann hier auch
1265 das Benutzerpasswort gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1268 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier auch konfiguriert werden, auf welche Mandanten der Benutzer
1269 Zugriff hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können sowohl beim Benutzer vorgenommen werden ("dieser
1270 Benutzer hat Zugriff auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen X, Y und Z") als auch beim Mandanten ("auf
1271 diesen Mandanten haben Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe sind Benutzer A, B und C
1272 Mitglieder").</para>
1275 <sect2 id="Mandanten-anlegen">
1276 <title>Mandanten anlegen</title>
1278 <para>Ein Mandant besteht aus Administrationssicht primär aus einem eindeutigen Namen. Weiterhin wird hier hinterlegt, welche
1279 Datenbank als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten einer der eben angelegten Datenbanken eingetragen
1282 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch konfiguriert werden, welche Benutzer Zugriff auf den
1283 Mandanten haben bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen können sowohl beim Mandanten vorgenommen werden
1284 ("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
1285 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
1290 <sect1 id="config.sending-email" xreflabel="E-Mail-Versand aus kivitendo heraus">
1291 <title>E-Mail-Versand aus kivitendo heraus</title>
1293 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden, z.B. um ein Angebot direkt an einen Kunden zu
1294 verschicken. Damit dies funktioniert, muss eingestellt werden, über welchen Server die E-Mails verschickt werden sollen. kivitendo
1295 unterstützt dabei zwei Mechanismen: Versand über einen lokalen E-Mail-Server (z.B. mit <productname>Postfix</productname> oder
1296 <productname>Exim</productname>, was auch die standardmäßig aktive Methode ist) sowie Versand über einen SMTP-Server (z.B. der des
1297 eigenen Internet-Providers).</para>
1299 <para>Welche Methode und welcher Server verwendet werden, wird über die Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1300 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1302 <sect2 id="config.sending-email.sendmail" xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1303 <title>Versand über lokalen E-Mail-Server</title>
1305 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie
1306 z.B. <productname>Postfix</productname>, <productname>Exim</productname> oder <productname>Sendmail</productname> läuft.</para>
1308 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1309 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1311 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet wird, dient der Parameter '<literal>sendmail =
1312 ...</literal>'. Der Standardwert verweist auf das Programm <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1313 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1315 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen dieses sprengen. Hierfür sei auf die Dokumentation des
1316 E-Mail-Servers verwiesen.</para>
1319 <sect2 id="config.sending-email.smtp" xreflabel="E-Mail-Versand über einen SMTP-Server">
1320 <title>Versand über einen SMTP-Server</title>
1322 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server vorhanden oder zwar einer vorhanden, dieser aber nicht
1323 konfiguriert ist.</para>
1325 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1326 Parameter dienen dabei der weiteren Konfiguration:</para>
1330 <term><varname>hostname</varname></term>
1332 <listitem><para>Name oder IP-Adresse des SMTP-Servers. Standardwert: '<literal>localhost</literal>'</para></listitem>
1336 <term><varname>port</varname></term>
1338 <listitem><para>Portnummer. Der Standardwert hängt von der verwendeten Verschlüsselungsmethode ab. Gilt '<literal>security =
1339 none</literal>' oder '<literal>security = tls</literal>', so ist 25 die Standardportnummer. Für '<literal>security =
1340 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht geändert werden.</para></listitem>
1344 <term><varname>security</varname></term>
1346 <listitem><para>Wahl der zu verwendenden Verschlüsselung der Verbindung mit dem Server. Standardwert ist
1347 '<literal>none</literal>', wodurch keine Verschlüsselung verwendet wird. Mit '<literal>tls</literal>' wird TLS-Verschlüsselung
1348 eingeschaltet, und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL eingeschaltet. Achtung: Für
1349 '<literal>tls</literal>' und '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt (siehe unten).</para></listitem>
1353 <term><varname>login</varname> und <varname>password</varname></term>
1355 <listitem><para>Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername
1356 und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von
1357 Verschlüsselung aktiviert werden.</para></listitem>
1361 <para>Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind:</para>
1364 <listitem><para>TLS-Verschlüsselung: Modul <literal>Net::SSLGlue</literal> (Debian-Paketname
1365 <literal>libnet-sslglue-perl</literal>, Fedora Core: <literal>perl-Net-SSLGlue</literal>, openSUSE:
1366 <literal>perl-Net-SSLGlue</literal></para></listitem>
1368 <listitem><para>SSL-Verschlüsselung: Modul <literal>Net::SMTP::SSL</literal> (Debian-Paketname
1369 <literal>libnet-smtp-ssl-perl</literal>, Fedora Core: <literal>perl-Net-SMTP-SSL</literal>, openSUSE:
1370 <literal>perl-Net-SMTP-SSL</literal></para></listitem>
1375 <sect1 id="Drucken-mit-kivitendo">
1376 <title>Drucken mit kivitendo</title>
1378 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. Um drucken zu können, braucht der Server ein geeignetes
1379 LaTeX System. Am einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter Debianoiden Betriebssystemen installiert man
1380 die Pakete mit:</para>
1382 <para><programlisting>aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1383 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1385 <para>TODO: RPM-Pakete.</para>
1387 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1389 <listitem><para>Standard</para></listitem>
1390 <listitem><para>f-tex</para></listitem>
1391 <listitem><para>RB</para></listitem>
1394 <sect2 id="Vorlagenverzeichnis-anlegen" xreflabel="Vorlagenverzeichnis anlegen">
1395 <title>Vorlagenverzeichnis anlegen</title>
1396 <para>Im Administrationsbereich lässt sich bei einem Benutzer/Mandanten einer dieser Vorlagensätze als Basis für die zu
1397 druckenden Dokumente auswählen. Rufen Sie dazu die <guimenu>Benutzerverwaltung</guimenu> auf.</para>
1399 <para>Wählen Sie dort einen Benutzer aus oder legen Sie einen neuen an. In der Benutzerbearbeiten-Maske müssen Sie zwei Dinge
1403 <listitem><para><option>Name</option>: Der Verzeichnisname für den neuen Vorlagensatz. Dieser kann im Rahmen der üblichen
1404 Bedingungen für Verzeichnisnamen frei gewählt werden.</para></listitem>
1405 <listitem><para><option>Vorlagen auswählen</option>: Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll
1406 (<filename>Standard</filename>, <filename>f-tex</filename> oder <filename>RB</filename>.)</para></listitem>
1409 <para>Der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Benutzern verwendet werden.</para>
1411 <para>Die Abhängigkeiten kann man prüfen mit:</para>
1413 <programlisting>/scripts/installation_check.pl -l</programlisting>
1416 <sect2 id="Vorlagen-Standard">
1417 <title>Standard</title>
1419 <para>Der Standard-Vorlagensatz von Kivitendo. Wie unter <ulink url="http://demo.kivitendo.org">http://demo.kivitendo.org</ulink> zu
1425 <title>f-tex</title>
1427 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt.</para>
1429 <sect3 id="f-tex-Feature-Übersicht">
1430 <title>Feature-Übersicht</title>
1432 <listitem><para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage für alle briefartigen Dokumente verwendet. Also
1433 Angebot, Rechnung, Performarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc..</para></listitem>
1435 <listitem><para>Leichte Anpassung an das Firmen-Layout durch verwendung eines Hintergrund-PDF. Dieses kann leicht mit dem
1436 eigenen Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp, Adobe*)</para></listitem>
1438 <listitem><para>Hintergrund-PDF umschaltbar auf "nur erste Seite" (Standard) oder "alle Seiten" (Option
1439 "<option>bgPdfFirstPageOnly</option>" in Datei <filename>letter.lco</filename>)</para></listitem>
1441 <listitem><para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1442 versendeten Dokumenten eingebunden (Option "<option>bgPdfEmailOnly</option>" in Datei
1443 <filename>letter.lco</filename>).</para></listitem>
1445 <listitem><para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch, Wiederholung von Kopfzeilen, Zwischensummen
1446 etc. (danke an Kai-Martin Knaak für die Vorarbeit)</para></listitem>
1448 <listitem><para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom Land des eigenen Unternehmens abweicht (also die
1449 Rechnung das Land verlässt).</para></listitem>
1451 <listitem><para>Multisprachfähig leicht um weitere Sprachen zu erweitern, alle Übersetzungen in der Datei
1452 <filename>translatinos.tex</filename>.</para></listitem>
1454 <listitem><para>Auflistung von Bruttopreisen für Endverbraucher.</para></listitem>
1458 <sect3 id="f-tex-Installation">
1459 <title>Die Installation</title>
1461 <listitem><para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref linkend="Vorlagenverzeichnis-anlegen"/>. Das
1462 Vorlagensystem funktioniert jetzt schon, hat allerdings noch einen Beispiel-Briefkopf.</para></listitem>
1464 <listitem><para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach <filename>./letter_head.pdf</filename>.</para></listitem>
1465 <listitem><para>Editiere den Bereich "<option>settings</option>" in der datei <filename>letter.lco</filename>.</para></listitem>
1468 <para>oder etwas Detaillierter:</para>
1471 Es wird eine Datei <filename>sample.lco</filename> erstellt und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
1472 ist dies die Datei die für die Firmenspezifischen Anpassungen gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig
1473 ist, wird in dieser Datei auf ein Hintergrundpdf verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen
1474 vorzunehmen und <filename>sample.lco</filename> unverändert zu lassen. Die die Anpassung über eine
1475 <filename>*.lco</filename>-Datei die letztlich auf <filename>letter.lco</filename> verlinkt ist ist aber auch möglich.
1479 Es wird eine Datei <filename>sample_head.pdf</filename> mit ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
1480 verlinkt. Damit gibt es schon mal eine Funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei
1481 <filename>sample_haed.pdf</filename> an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
1482 Template Verzeichniss ablegen und statt <filename>sample_head.pdf</filename> nach <filename>letter_head.pdf</filename>
1487 letzlich muss <filename>letter_head.pdf</filename> auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
1488 enthält. Bei Updates oder nach erneutem
1492 Es wird eine Datei <filename>mydata.tex.example</filename> ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
1493 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das Land verwendet. Die Datei muss also nicht angefasst
1494 werden. Die Anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig).
1497 Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc. sollten über die Hintergrund-PDF-Datei oder die
1498 <filename>*.lco</filename>-Datei erfolgen.
1502 <sect3 id="f-tex-Funktionsübersicht">
1503 <title>f-tex Funktionsübersicht</title>
1505 Das Konzept von kivitendo sieht vor, für jedes Dokument (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine LaTeX-Vorlage
1506 vorzuhalten, dies ist sehr Wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
1507 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
1508 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche LaTeX-Vorlage verwendet, welche über Codeweichen die
1509 Besonderheiten der jeweiligen Dokumente Berücksichtigt.
1513 <listitem><para>Tabellen mit oder ohne Preis</para></listitem>
1514 <listitem><para>Sprache der Tabellenüberschriften etc.</para></listitem>
1515 <listitem><para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus Angebotsnummer)</para></listitem>
1516 <listitem><para>Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus Gewerblicher
1517 Kunde)</para></listitem>
1520 <para>Nachteil:</para>
1523 LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
1524 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann natürlich
1525 auch innerhalb der Tabellendarstellung gut persönliche Anpassungen vornehmen. Aber man kann sich hier bei Veränderungen sehr
1526 schnell häftig in den Fuss schiessen.
1529 <para>Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund PDF auf Basis der
1530 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen, und sich an der Form der dargestellten Tabellen wie sie
1531 ausgeliefert werden, erfreuen.
1534 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine kontinuierliche Schritte gehen.</para>
1538 <sect3 id="f-tex-Bruttopreise">
1539 <title>Bruttopreise für Endverbraucher</title>
1541 <para>Der auszuweisende Bruttopreis wird innerhalb der LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen "alle
1542 Preise Brutto" auszuwählen, aber:</para>
1545 <para>hierfür müssen die Preise auch in Brutto in der Datenbank stehen (ja - das lässt sich über die Preisgruppen und die
1546 Zuordung einer Default-Preisgruppe handhaben)</para>
1549 <para>man darf beim Anlegen des Vorgangs nicht vergessen Dieses Häkchen zu setzen. (das ist in der Praxis wenn man sowohl
1550 Endverbraucher- wie Gewerbekunden beliefert der eigentliche Knackpunkt)</para>
1555 Es gibt mit f-tex eine weitere Alternative. Die Information ob Brutto oder Nettorechnung wird mit den Zahlarten
1556 verknüpft. Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben werden sollen, enden mit "_E" (für
1557 Endverbraucher). Falls identische Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt man diese einfach doppelt
1558 an (einmal mit der Namensendung "_E"). Gewinn:</para>
1561 <listitem><para>Die Entscheidung, ob Netopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste Verbunden.</para></listitem>
1562 <listitem><para>Die Default-Zahlart kann im Kundendatensatz hinterlegt werden, und man muss nicht mehr daran denken, "alle Preise
1563 Netto" auszuwählen.</para></listitem>
1564 <listitem><para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken reviediert werden,
1565 ohne dass sich der Auftragswert ändert.</para></listitem>
1569 <sect3 id="f-tex-lieferadressen">
1570 <title>Lieferadressen</title>
1572 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen im Adressfeld zum Einsatz. Wenn die
1573 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende Adressvariable eingesetzt. Wenn also die Lieferadresse in
1574 Straße, Hausnummer und Ort abweicht, müssen auch nur diese Felder in der Lieferadresse ausgefüllt werden. Für den Firmenname wird
1575 der Wert der Hauptadresse angezeigt.
1580 <sect2 id="Vorlagen-RB">
1583 <para>Vollständiger Dokumentensatz mit alternativem Design</para>
1587 <sect2 id="allgemeine-hinweise-zu-latex">
1588 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
1589 <para>In den allermeisten Installationen sollte drucken jetzt schon
1590 funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
1591 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
1592 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1597 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1598 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1599 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1603 <para>! Package inputenc Error: Unicode char \u8:... set up for
1604 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1605 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1606 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1607 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1608 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1612 <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
1613 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1614 Prüfen Sie den Namen in der Konfiguration (Standard:
1615 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1616 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1619 <para>Wenn sich das Problem nicht auf Grund der ausgabe im Webbrowser verifizieren lässt:</para>
1622 <para> editiere [kivitendo-home]/config/kivitendo.conf und ändere "keep_tmp_files" auf 1</para>
1623 <para><programlisting>keep_temp_files = 1;</programlisting></para>
1626 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
1629 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
1632 <para>wechsele in das users Verzeichnis von kivitendo</para>
1633 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
1636 <para>LaTeX Suchpfad anpassen:</para>
1637 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
1640 <para>Finde herraus welche Datei kivitendo beim letzten Durchlauf erstellt hat</para>
1641 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
1642 <para>Es sollte die letzte Datei ganz unten sein</para>
1645 <para>für besseren Hinweis auf Fehler texdatei nochmals übersetzen</para>
1646 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
1647 <para>in der *.tex datei nach dem Fehler suchen.</para>
1653 <sect1 id="OpenDocument-Vorlagen">
1654 <title>OpenDocument-Vorlagen</title>
1656 <para>kivitendo unterstützt die Verwendung von Vorlagen im
1657 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1658 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1659 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1660 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1661 <filename>config/kivitendo.conf</filename> die Variable
1662 <literal>opendocument</literal> im Abschnitt
1663 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1664 Dieses ist die Standardeinstellung.</para>
1666 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1667 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1668 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1669 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1670 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1671 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1673 <para>Nach der Installation müssen in der Datei
1674 <filename>config/kivitendo.conf</filename> zwei weitere Variablen
1675 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1676 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1677 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1678 enthalten. Beide stehen im Abschnitt
1679 <literal>applications</literal>.</para>
1681 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
1682 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1683 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1684 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1685 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1686 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1687 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1688 werden muss. Der Nachteil ist, dass diese Methode Python und die
1689 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1694 Für die Verbindung zu OpenOffice wird normalerweise der Python-Interpreter <filename>/usr/bin/python</filename> benutzt. Sollte
1695 dies nicht der richtige sein, so kann man mit zwei Konfigurationsvariablen entscheiden, welcher Python-Interpreter genutzt
1696 wird. Mit der Option <literal>python_uno</literal> aus dem Abschnitt <literal>applications</literal> wird der Interpreter selber
1697 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert <literal>/usr/bin/python</literal>.
1701 Zusätzlich ist es möglich, Pfade anzugeben, in denen Python neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
1702 z.B. falls sich diese in einem gesonderten OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
1703 <literal>python_uno_path</literal> und befindet sich im Abschnitt <literal>environment</literal>. Sie ist standardmäßig
1704 leer. Werden hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte voneinander getrennt werden. Der Inhalt wird an den
1705 Python-Interpreter über die Umgebungsvariable <literal>PYTHONPATH</literal> übergeben.
1709 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1710 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1711 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1712 Dokumentenvorlage enthalten sein und
1713 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1714 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1715 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1716 ebenfalls enthalten sein muss.</para>
1718 <para>Als letztes muss herausgefunden werden, welchen Namen
1719 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1720 gibt. Unter Debian ist dies momentan
1721 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1722 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1723 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1724 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1725 folgender Befehl auszuführen:</para>
1727 <para><literal>mv users/.openoffice.org2
1728 users/.openoffice</literal></para>
1730 <para>Dieses Verzeichnis, wie auch das komplette
1731 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1732 sein. Dieses wurde bereits erledigt (siehe <xref
1733 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1734 erneut überprüft werden, wenn die Konvertierung nach PDF
1738 <sect1 id="config.eur">
1739 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1742 <sect2 id="config.eur.introduction"
1743 xreflabel="Einführung in die Konfiguration zur EUR">
1744 <title>Einführung</title>
1746 <para>kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1747 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals noch <filename>config/lx_office.conf</filename>)
1748 befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden.</para>
1750 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1751 die Mandantendatenbank verschoben und dabei auch gleich in drei
1752 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1753 steuern lässt.</para>
1756 <sect2 id="config.eur.parameters"
1757 xreflabel="Konfigurationsparameter für EUR">
1758 <title>Konfigurationsparameter</title>
1760 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1761 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1765 <term><varname>profit_determination</varname></term>
1768 <para>Dieser Parameter legt die Berechnungsmethode für die
1769 Gewinnermittlung fest. Er enthält entweder
1770 <literal>balance</literal> für
1771 Betriebsvermögensvergleich/Bilanzierung oder
1772 <literal>income</literal> für die
1773 Einnahmen-Überschuss-Rechnung.</para>
1778 <term><varname>accounting_method</varname></term>
1781 <para>Dieser Parameter steuert die Buchungs- und
1782 Berechnungsmethoden für die Versteuerungsart. Er enthält
1783 entweder <literal>accrual</literal> für die Soll-Versteuerung
1784 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1789 <term><varname>inventory_system</varname></term>
1792 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1793 enthält entweder <literal>perpetual</literal> für die
1794 Bestandsmethode oder <literal>periodic</literal> für die
1795 Aufwandsmethode.</para>
1800 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1801 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1802 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1803 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1804 Bestandsmethode.</para>
1806 <para>Die Konfiguration "<varname>eur</varname>" unter
1807 <varname>[system]</varname> in der <link
1808 linkend="config.config-file">Konfigurationsdatei</link>
1809 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
1810 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1813 <sect2 id="config.eur.setting-parameters">
1814 <title>Festlegen der Parameter</title>
1816 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1817 der Admininstration können diese Optionen nun unabhängig voneinander
1818 eingestellt werden.</para>
1820 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1821 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1824 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1825 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
1826 angezeigt. Unter <guimenu>System</guimenu>
1827 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> können
1828 die Einstellungen auch geändert werden. Dabei ist zu beachten,
1829 dass eine Änderung vorhandene Daten so belässt und damit
1830 evtl. die Ergebnisse verfälscht. Dies gilt vor Allem für die
1831 Warenbuchungsmethode (siehe auch
1832 <link linkend="config.eur.inventory-system-perpetual">
1833 Bemerkungen zu Bestandsmethode</link>).</para>
1836 <sect2 id="config.eur.inventory-system-perpetual">
1837 <title>Bemerkungen zu Bestandsmethode</title>
1839 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1840 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
1841 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1842 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1843 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1844 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1845 Einkaufsrechnungen berechnet wird.</para>
1847 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1848 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1849 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1853 <sect2 id="config.eur.knonw-issues">
1854 <title>Bekannte Probleme</title>
1856 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1857 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1858 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1859 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1860 die Konfigurationsvariable
1861 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1864 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1865 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1869 <sect1 id="config.skr04-update-3804">
1870 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1872 <sect2 id="config.skr04-update-3804.introduction">
1873 <title>Einführung</title>
1875 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1876 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1877 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1878 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1879 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1880 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1881 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1882 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1883 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1884 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1885 Screenshots dargestellt.</para>
1887 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1888 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1889 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1890 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1893 <sect2 id="config.skr04-update-3804.create-chart">
1894 <title>Konto 3804 manuell anlegen</title>
1896 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
1897 anzulegen und zu konfigurieren. Zuerst wird in
1898 <guimenu>System</guimenu> ->
1899 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
1900 erfassen</guimenuitem> das Konto angelegt.</para>
1903 <screeninfo>Konto 3804 erfassen</screeninfo>
1907 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
1913 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
1914 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
1915 wie im folgenden Screenshot angezeigt anpassen.
1919 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
1923 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
1929 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
1930 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
1934 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
1938 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
1944 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
1945 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
1946 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
1947 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
1951 <screeninfo>Konto 4315 anpassen</screeninfo>
1955 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
1961 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
1962 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
1966 <screeninfo>Steuerliste vergleichen</screeninfo>
1970 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
1977 <sect1 id="config.client">
1978 <title>Einstellungen pro Mandant</title>
1980 <para>Einige Einstellungen können von einem Benutzer mit dem
1981 <link linkend="Zusammenhänge">Recht</link> "Administration
1982 (Für die Verwaltung der aktuellen Instanz aus einem Userlogin heraus)"
1983 gemacht werden. Diese Einstellungen sind dann für die aktuellen
1984 Mandanten-Datenbank gültig. Die Einstellungen sind
1985 unter <guimenu>System</guimenu>
1986 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
1988 <para>Bitte beachten Sie die Hinweise zu den einzelnen
1989 Einstellungen. Einige Einstellungen sollten nicht ohne Weiteres
1990 im laufenden Betrieb geändert werden (siehe
1991 auch <link linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
1992 Bestandsmethode</link>).</para>
1994 <para>Die Einstellungen <literal>show_bestbefore</literal>
1995 und <literal>payments_changeable</literal> aus dem
1996 Abschnitt <literal>features</literal> und die Einstellungen im
1997 Abschnitt <literal>datev_check</literal> (sofern schon vorhanden)
1998 der <link linkend="config.config-file">kivitendo-Konfigurationsdatei</link>
1999 werden bei einem Datenbankupdate einer älteren Version automatisch
2000 übernommen. Diese Einträge können danach aus der Konfigurationsdatei
2001 entfernt werden.</para>
2004 <sect1 id="kivitendo-ERP-verwenden">
2005 <title>kivitendo ERP verwenden</title>
2007 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
2008 folgender URL erreichbar:</para>
2011 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
2013 <para>Die Administrationsseite erreichen Sie unter:</para>
2016 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
2020 <chapter id="features" xreflabel="Features und Funktionen">
2021 <title>Features und Funktionen</title>
2023 <sect1 id="features.periodic-invoices"
2024 xreflabel="Wiedekehrende Rechnungen">
2025 <title>Wiederkehrende Rechnungen</title>
2027 <sect2 id="features.periodic-invoices.introduction"
2028 xreflabel="Einführung in wiederkehrende Rechnungen">
2029 <title>Einführung</title>
2031 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
2032 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
2033 Die konfigurierten Aufträge werden später automatisch in Rechnungen
2034 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
2035 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
2036 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
2037 wiederzufinden sind.</para>
2040 <sect2 id="features.periodic-invoices.configuration"
2041 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
2042 <title>Konfiguration</title>
2044 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
2045 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
2046 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
2047 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
2048 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
2051 <para>Folgende Parameter kann man konfigurieren:</para>
2058 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
2059 erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
2060 neuen Monats).</para>
2062 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
2063 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
2064 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
2065 nächsten Periodenwechsel für alle Perioden, seit der letzten
2066 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
2067 verhindern, muss man vorher das Startdatum neu setzen.</para>
2069 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
2070 erstellt. Man kann sich diese Aufträge aber gesondert in den
2071 Berichten anzeigen lassen.</para>
2076 <term>Periodizität</term>
2079 <para>Ob monatlich, quartalsweise oder jährlich auf neue
2080 Rechnungen überprüft werden soll. Für jede Periode seit dem
2081 Startdatum wird überprüft, ob für die Periode (beginnend immer
2082 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
2083 wurde. Unter Umständen können bei einem Startdatum in der
2084 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
2089 <term>Buchen auf</term>
2092 <para>Das Forderungskonto, in der Regel "Forderungen aus
2093 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
2094 Buchungsgruppen der betreffenden Waren.</para>
2099 <term>Startdatum</term>
2102 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
2108 <term>Enddatum</term>
2111 <para>ab wann keine Rechnungen mehr erstellt werden
2117 <term>Automatische Verlängerung um x Monate</term>
2120 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
2121 eingetragenen Enddatums weiterhin erstellt werden, so kann man
2122 hier die Anzahl der Monate eingeben, um die das Enddatum
2123 automatisch nach hinten geschoben wird.</para>
2128 <term>Drucken</term>
2131 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
2132 Rechnungen auch gleich ausdrucken lassen.</para>
2137 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
2138 Informationen zu den erstellten Rechnungen verschickt werden.
2139 Konfiguriert wird dies in der <link
2140 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
2141 <filename>config/kivitendo.conf</filename> im Abschnitt
2142 <varname>[periodic_invoices]</varname>.</para>
2145 <sect2 id="features.periodic-invoices.variables">
2146 <title>Spezielle Variablen</title>
2149 Um die erzeugten Rechnungen individualisieren zu können, werden beim Umwandeln des Auftrags in eine Rechnung einige speziell
2150 formatierte Variablen durch für die jeweils aktuelle Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B. den
2151 Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei die Syntax <literal><%variablenname%></literal>.
2155 Diese Variablen werden in den folgenden Elementen des Auftrags ersetzt:
2159 <listitem><para>Bemerkungen</para></listitem>
2160 <listitem><para>Interne Bemerkungen</para></listitem>
2161 <listitem><para>Vorgangsbezeichnung</para></listitem>
2162 <listitem><para>In den Beschreibungs- und Langtextfeldern aller Positionen</para></listitem>
2165 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
2169 <term><varname><%current_quarter%></varname>, <varname><%previous_quarter%></varname>, <varname><%next_quarter%></varname></term>
2173 Aktuelles, vorheriges und nächstes Quartal als Zahl zwischen <literal>1</literal> und <literal>4</literal>.
2179 <term><varname><%current_month%></varname>, <varname><%previous_month%></varname>, <varname><%next_month%></varname></term>
2183 Aktueller, vorheriger und nächster Monat als Zahl zwischen <literal>1</literal> und <literal>12</literal>.
2189 <term><varname><%current_month_long%></varname>, <varname><%previous_month_long%></varname>, <varname><%next_month_long%></varname></term>
2193 Aktueller, vorheriger und nächster Monat als Name (<literal>Januar</literal>, <literal>Februar</literal> etc.).
2199 <term><varname><%current_year%></varname>, <varname><%previous_year%></varname>, <varname><%next_year%></varname></term>
2203 Aktuelles, vorheriges und nächstes Jahr als vierstellige Jahreszahl (<literal>2013</literal> etc.).
2209 <term><varname><%period_start_date%></varname>, <varname><%period_end_date%></varname></term>
2213 Formatiertes Datum des ersten und letzten Tages im Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im ersten
2214 Quartal von 2013 wären dies der <literal>01.01.2013</literal> und <literal>31.03.2013</literal>).
2221 <sect2 id="features.periodic-invoices.reports">
2222 <title>Auflisten</title>
2224 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
2225 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
2226 Rechnungen inaktiv", mit denen man sich einen Überglick über die
2227 wiederkehrenden Rechnungen verschaffen kann.</para>
2230 <sect2 id="features.periodic-invoices.task-server">
2231 <title>Erzeugung der eigentlichen Rechnungen</title>
2233 <para>Die zeitliche und periodische Überprüfung, ob eine
2234 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
2235 durch den <link linkend="config.task-server">Taskserver</link>, einen
2236 externen Dienst, der automatisch beim Start des Servers gestartet
2237 werden sollte.</para>
2240 <sect2 id="features.periodic-invoices.create-for-current-month">
2241 <title>Erste Rechnung für aktuellen Monat erstellen</title>
2243 <para>Will man im laufenden Monat eine monatlich wiederkehrende
2244 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
2245 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
2246 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
2247 generiert hat. Alternativ setzt man das Startdatum auf den
2248 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
2249 manuell über den Workflow.</para>
2253 <sect1 id="dokumentenvorlagen-und-variablen">
2254 <title>Dokumentenvorlagen und verfügbare Variablen</title>
2256 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
2257 <title>Einführung</title>
2259 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
2260 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
2261 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
2262 <function><%variablenname%></function> verwendet wird. Für
2263 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
2265 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
2267 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
2268 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
2269 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
2270 alle Vorlagenarten.</para>
2272 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
2273 verfügbar als hier aufgelistet werden. Die meisten davon können
2274 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
2275 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
2276 diese wie folgt erhalten werden:</para>
2280 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
2281 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
2285 <para>In <filename>Form.pm</filename> die Funktion
2286 <function>parse_template</function> suchen und hier die Zeile
2287 <command>print(STDERR Dumper($self));</command> einfügen.</para>
2291 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
2292 ein PDF für eine Rechnung erzeugen.</para>
2296 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
2297 der Variablen <varname>$self</varname> in der Form <varname>'key'
2298 => 'value',</varname>. Alle <varname>key</varname>s sind
2304 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
2305 <title>Variablen ausgeben</title>
2307 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
2308 Tags geschrieben werden, also z.B.
2309 <varname><%variablenname%></varname>.</para>
2311 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
2312 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
2313 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
2314 werden die folgenden Flags unterstützt:</para>
2318 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
2319 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
2320 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
2321 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
2325 <para><option>NOESCAPE</option> unterdrückt das Escapen von
2326 Sonderzeichen für die Vorlagensprache. Wenn also in einer
2327 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
2328 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
2329 ist dieses Flag sinnvoll.</para>
2333 <para>Beispiel:</para>
2335 <programlisting><%quototal NOFORMAT%></programlisting>
2338 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
2339 <title>Verwendung in Druckbefehlen</title>
2341 <para>In der Admininstration können Drucker definiert werden. Auch im
2342 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
2343 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
2344 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
2345 <function>`...`</function> nicht zu unerwünschtem Verhalten
2348 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
2349 für das die Telefonnummer eines Ansprechpartners als Teil der
2350 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
2351 z.B. wie folgt aussehen:</para>
2353 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
2356 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
2357 xreflabel="Anfang und Ende der Tags verändern">
2358 <title>Anfang und Ende der Tags verändern</title>
2360 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
2361 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
2362 Prozentzeichen und dem Größerzeichen endet, beispielsweise
2363 <function><%customer%></function>. Da diese Form aber z.B. in
2364 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
2365 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
2366 Stil umgestellt werden.</para>
2368 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
2369 Format gültigen Kommentarzeichen anfangen, dann
2370 <function>config:</function> enthalten, die entsprechende Option
2371 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
2372 enden. Beispiel für LaTeX:</para>
2374 <programlisting>% config: tag-style=($ $)</programlisting>
2376 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
2377 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
2378 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
2380 <programlisting><!-- config: tag-style=($ $) --></programlisting>
2383 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
2384 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
2386 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
2387 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
2388 "<filename>.ext</filename>" geeignet zu ersetzen:
2389 "<filename>.tex</filename>" für LaTeX-Vorlagen und
2390 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
2394 <term><filename>bin_list.ext</filename></term>
2397 <para>Lagerliste</para>
2402 <term><filename>check.ext</filename></term>
2410 <term><filename>invoice.ext</filename></term>
2413 <para>Rechnung</para>
2418 <term><filename>packing_list.ext</filename></term>
2421 <para>Packliste</para>
2426 <term><filename>pick_list.ext</filename></term>
2429 <para>Sammelliste</para>
2434 <term><filename>purchase_delivery_order.ext</filename></term>
2437 <para>Lieferschein (Einkauf)</para>
2442 <term><filename>purcharse_order.ext</filename></term>
2445 <para>Bestellung an Lieferanten</para>
2450 <term><filename>request_quotation.ext</filename></term>
2453 <para>Anfrage an Lieferanten</para>
2458 <term><filename>sales_delivery_order.ext</filename></term>
2461 <para>Lieferschein (Verkauf)</para>
2466 <term><filename>sales_order.ext</filename></term>
2469 <para>Bestellung</para>
2474 <term><filename>sales_quotation.ext</filename></term>
2477 <para>Angebot an Kunden</para>
2482 <term><filename>zahlungserinnerung.ext</filename></term>
2485 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2490 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2493 <para>Rechnung über Mahngebühren (Dateiname im Programm
2494 konfigurierbar)</para>
2500 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2501 <title>Sprache, Drucker und E-Mail</title>
2503 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2504 eingearbeitet. So wird aus der Vorlage
2505 <filename>sales_order.ext</filename> bei Sprache
2506 <function>de</function> und Druckerkürzel <function>lpr2</function>
2507 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2508 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2509 bekommen dann noch das Kürzel <filename>_email</filename>, der
2510 vollständige Vorlagenname wäre dann
2511 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2512 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2513 werden. Diese wird verwendet, wenn keine der anderen Varianten
2514 gefunden wird.</para>
2516 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2517 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2518 verschickt wird, ist:</para>
2522 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2526 <para><filename>sales_order_de_lpr2.tex</filename></para>
2530 <para><filename>sales_order.tex</filename></para>
2534 <para><filename>default.tex</filename></para>
2538 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2539 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2541 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2544 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2545 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2548 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2549 xreflabel="Metainformationen zur angeforderten Vorlage">
2550 <title>Metainformationen zur angeforderten Vorlage</title>
2552 <para>Diese Variablen liefern Informationen darüber welche Variante
2553 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2554 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2555 Formulare einbinden möchten.</para>
2559 <term><varname>template_meta.formname</varname></term>
2562 <para>Basisname der Vorlage. Identisch mit der <link
2563 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2564 zu den Dateinamen</link> ohne die Erweiterung. Ein
2565 Verkaufsauftrag enthält hier
2566 <constant>sales_order</constant>.</para>
2571 <term><varname>template_meta.language.description</varname></term>
2574 <para>Beschreibung der verwendeten Sprache</para>
2579 <term><varname>template_meta.language.template_code</varname></term>
2582 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2583 Kürzel das im Dateinamen verwendetet wird.</para>
2588 <term><varname>template_meta.language.output_numberformat</varname></term>
2591 <para>Zahlenformat der verwendeten Sprache in der Form
2592 "<constant>1.000,00</constant>". Experimentell! Nur
2593 interessant für Vorlagen die mit unformatierten Werten
2599 <term><varname>template_meta.language.output_dateformat</varname></term>
2602 <para>Datumsformat der verwendeten Sprache in der Form
2603 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2604 interessant für Vorlagen die mit unformatierten Werten
2610 <term><varname>template_meta.format</varname></term>
2613 <para>Das angeforderte Format. Kann im Moment die Werte
2614 <constant>pdf</constant>, <constant>postscript</constant>,
2615 <constant>html</constant>, <constant>opendocument</constant>,
2616 <constant>opendocument_pdf</constant> und
2617 <constant>excel</constant> enthalten.</para>
2622 <term><varname>template_meta.extension</varname></term>
2625 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2626 <constant>format</constant> entschieden.</para>
2631 <term><varname>template_meta.media</varname></term>
2634 <para>Ausgabemedium. Kann zur Zeit die Werte
2635 <constant>screen</constant> für Bildschirm,
2636 <constant>email</constant> für E-Mmail (triggert das
2637 <constant>_email</constant> Kürzel im Dateinamen),
2638 <constant>printer</constant> für Drucker, und
2639 <constant>queue</constant> für Warteschlange enthalten.</para>
2644 <term><varname>template_meta.printer.description</varname></term>
2647 <para>Beschreibung des ausgewählten Druckers</para>
2652 <term><varname>template_meta.printer.template_code</varname></term>
2655 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2656 dem Kürzel das im Dateinamen verwendetet wird.</para>
2661 <term><varname>template_meta.tmpfile</varname></term>
2664 <para>Datei-Prefix für temporäre Dateien.</para>
2670 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2671 <title>Stammdaten von Kunden und Lieferanten</title>
2675 <term><varname>account_number</varname></term>
2678 <para>Kontonummer</para>
2683 <term><varname>bank</varname></term>
2686 <para>Name der Bank</para>
2691 <term><varname>bank_code</varname></term>
2694 <para>Bankleitzahl</para>
2699 <term><varname>bic</varname></term>
2702 <para>Bank-Identifikations-Code (Bank Identifier Code,
2708 <term><varname>business</varname></term>
2711 <para>Kunden-/Lieferantentyp</para>
2716 <term><varname>city</varname></term>
2724 <term><varname>contact</varname></term>
2727 <para>Kontakt</para>
2732 <term><varname>country</varname></term>
2740 <term><varname>c_vendor_id</varname></term>
2743 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
2748 <term><varname>v_customer_id</varname></term>
2751 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
2756 <term><varname>cp_email</varname></term>
2759 <para>Email des Ansprechpartners</para>
2764 <term><varname>cp_givenname</varname></term>
2767 <para>Vorname des Ansprechpartners</para>
2772 <term><varname>cp_greeting</varname></term>
2775 <para>Anrede des Ansprechpartners</para>
2780 <term><varname>cp_name</varname></term>
2783 <para>Name des Ansprechpartners</para>
2788 <term><varname>cp_phone1</varname></term>
2791 <para>Telefonnummer 1 des Ansprechpartners</para>
2796 <term><varname>cp_phone2</varname></term>
2799 <para>Telefonnummer 2 des Ansprechpartners</para>
2804 <term><varname>cp_title</varname></term>
2807 <para>Titel des Ansprechpartners</para>
2812 <term><varname>creditlimit</varname></term>
2815 <para>Kreditlimit</para>
2820 <term><varname>customeremail</varname></term>
2823 <para>Email des Kunden; nur für Kunden</para>
2828 <term><varname>customerfax</varname></term>
2831 <para>Faxnummer des Kunden; nur für Kunden</para>
2836 <term><varname>customernotes</varname></term>
2839 <para>Bemerkungen beim Kunden; nur für Kunden</para>
2844 <term><varname>customernumber</varname></term>
2847 <para>Kundennummer; nur für Kunden</para>
2852 <term><varname>customerphone</varname></term>
2855 <para>Telefonnummer des Kunden; nur für Kunden</para>
2860 <term><varname>discount</varname></term>
2868 <term><varname>email</varname></term>
2871 <para>Emailadresse</para>
2876 <term><varname>fax</varname></term>
2879 <para>Faxnummer</para>
2884 <term><varname>homepage</varname></term>
2887 <para>Homepage</para>
2892 <term><varname>iban</varname></term>
2895 <para>Internationale Kontonummer (International Bank Account
2896 Number, IBAN)</para>
2901 <term><varname>language</varname></term>
2904 <para>Sprache</para>
2909 <term><varname>name</varname></term>
2912 <para>Firmenname</para>
2917 <term><varname>payment_description</varname></term>
2920 <para>Name der Zahlart</para>
2925 <term><varname>payment_terms</varname></term>
2928 <para>Zahlungskonditionen</para>
2933 <term><varname>phone</varname></term>
2936 <para>Telefonnummer</para>
2941 <term><varname>shiptocity</varname></term>
2944 <para>Stadt (Lieferadresse) <link
2945 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2950 <term><varname>shiptocontact</varname></term>
2953 <para>Kontakt (Lieferadresse) <link
2954 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2959 <term><varname>shiptocountry</varname></term>
2962 <para>Land (Lieferadresse) <link
2963 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2968 <term><varname>shiptodepartment1</varname></term>
2971 <para>Abteilung 1 (Lieferadresse) <link
2972 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2977 <term><varname>shiptodepartment2</varname></term>
2980 <para>Abteilung 2 (Lieferadresse) <link
2981 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2986 <term><varname>shiptoemail</varname></term>
2989 <para>Email (Lieferadresse) <link
2990 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2995 <term><varname>shiptofax</varname></term>
2998 <para>Fax (Lieferadresse) <link
2999 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3004 <term><varname>shiptoname</varname></term>
3007 <para>Firmenname (Lieferadresse) <link
3008 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3013 <term><varname>shiptophone</varname></term>
3016 <para>Telefonnummer (Lieferadresse) <link
3017 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3022 <term><varname>shiptostreet</varname></term>
3025 <para>Straße und Hausnummer (Lieferadresse) <link
3026 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3031 <term><varname>shiptozipcode</varname></term>
3034 <para>Postleitzahl (Lieferadresse) <link
3035 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3040 <term><varname>street</varname></term>
3043 <para>Straße und Hausnummer</para>
3048 <term><varname>taxnumber</varname></term>
3051 <para>Steuernummer</para>
3056 <term><varname>ustid</varname></term>
3059 <para>Umsatzsteuer-Identifikationsnummer</para>
3064 <term><varname>vendoremail</varname></term>
3067 <para>Email des Lieferanten; nur für Lieferanten</para>
3072 <term><varname>vendorfax</varname></term>
3075 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
3080 <term><varname>vendornotes</varname></term>
3083 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
3088 <term><varname>vendornumber</varname></term>
3091 <para>Lieferantennummer; nur für Lieferanten</para>
3096 <term><varname>vendorphone</varname></term>
3099 <para>Telefonnummer des Lieferanten; nur für
3105 <term><varname>zipcode</varname></term>
3108 <para>Postleitzahl</para>
3113 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
3114 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
3115 Stammdaten nicht eingetragen, so haben die Variablen
3116 <varname>shipto*</varname> den gleichen Wert wie die die
3117 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
3118 einige <varname>shipto*</varname>-Variablen so nicht in den
3119 Stammdaten wiederfinden sondern schlicht Kopien der
3120 Lieferdatenvariablen sind (z.B.
3121 <varname>shiptocontact</varname>).</para>
3125 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
3126 <title>Informationen über den Bearbeiter</title>
3130 <term><varname>employee_address</varname></term>
3133 <para>Adressfeld</para>
3138 <term><varname>employee_businessnumber</varname></term>
3141 <para>Firmennummer</para>
3146 <term><varname>employee_company</varname></term>
3149 <para>Firmenname</para>
3154 <term><varname>employee_co_ustid</varname></term>
3157 <para>Usatzsteuer-Identifikationsnummer</para>
3162 <term><varname>employee_duns</varname></term>
3165 <para>DUNS-Nummer</para>
3170 <term><varname>employee_email</varname></term>
3178 <term><varname>employee_fax</varname></term>
3186 <term><varname>employee_name</varname></term>
3189 <para>voller Name</para>
3194 <term><varname>employee_signature</varname></term>
3197 <para>Signatur</para>
3202 <term><varname>employee_taxnumber</varname></term>
3205 <para>Steuernummer</para>
3210 <term><varname>employee_tel</varname></term>
3213 <para>Telefonnummer</para>
3219 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
3220 <title>Informationen über den Bearbeiter</title>
3224 <term><varname>salesman_address</varname></term>
3227 <para>Adressfeld</para>
3232 <term><varname>salesman_businessnumber</varname></term>
3235 <para>Firmennummer</para>
3240 <term><varname>salesman_company</varname></term>
3243 <para>Firmenname</para>
3248 <term><varname>salesman_co_ustid</varname></term>
3251 <para>Usatzsteuer-Identifikationsnummer</para>
3256 <term><varname>salesman_duns</varname></term>
3259 <para>DUNS-Nummer</para>
3264 <term><varname>salesman_email</varname></term>
3272 <term><varname>salesman_fax</varname></term>
3280 <term><varname>salesman_name</varname></term>
3283 <para>voller Name</para>
3288 <term><varname>salesman_signature</varname></term>
3291 <para>Signatur</para>
3296 <term><varname>salesman_taxnumber</varname></term>
3299 <para>Steuernummer</para>
3304 <term><varname>salesman_tel</varname></term>
3307 <para>Telefonnummer</para>
3313 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
3314 <title>Variablen für die einzelnen Steuern</title>
3318 <term><varname>tax</varname></term>
3326 <term><varname>taxbase</varname></term>
3329 <para>zu versteuernder Betrag</para>
3334 <term><varname>taxdescription</varname></term>
3337 <para>Name der Steuer</para>
3342 <term><varname>taxrate</varname></term>
3345 <para>Steuersatz</para>
3352 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
3353 <title>Variablen in Rechnungen</title>
3355 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
3356 <title>Allgemeine Variablen</title>
3360 <term><varname>creditremaining</varname></term>
3363 <para>Verbleibender Kredit</para>
3368 <term><varname>currency</varname></term>
3371 <para>Währung</para>
3376 <term><varname>cusordnumber</varname></term>
3379 <para>Bestellnummer beim Kunden</para>
3384 <term><varname>deliverydate</varname></term>
3387 <para>Lieferdatum</para>
3392 <term><varname>duedate</varname></term>
3395 <para>Fälligkeitsdatum</para>
3400 <term><varname>globalprojectnumber</varname></term>
3403 <para>Projektnummer des ganzen Beleges</para>
3408 <term><varname>globalprojectdescription</varname></term>
3411 <para>Projekbeschreibung des ganzen Beleges</para>
3416 <term><varname>intnotes</varname></term>
3419 <para>Interne Bemerkungen</para>
3424 <term><varname>invdate</varname></term>
3427 <para>Rechnungsdatum</para>
3432 <term><varname>invnumber</varname></term>
3435 <para>Rechnungsnummer</para>
3440 <term><varname>invtotal</varname></term>
3443 <para>gesamter Rechnungsbetrag</para>
3448 <term><varname>notes</varname></term>
3451 <para>Bemerkungen der Rechnung</para>
3456 <term><varname>orddate</varname></term>
3459 <para>Auftragsdatum</para>
3464 <term><varname>ordnumber</varname></term>
3467 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3468 erstellt wurde</para>
3473 <term><varname>payment_description</varname></term>
3476 <para>Name der Zahlart</para>
3481 <term><varname>payment_terms</varname></term>
3484 <para>Zahlungskonditionen</para>
3489 <term><varname>quodate</varname></term>
3492 <para>Angebotsdatum</para>
3497 <term><varname>quonumber</varname></term>
3500 <para>Angebotsnummer</para>
3505 <term><varname>shippingpoint</varname></term>
3508 <para>Versandort</para>
3513 <term><varname>shipvia</varname></term>
3516 <para>Transportmittel</para>
3521 <term><varname>subtotal</varname></term>
3524 <para>Zwischensumme aller Posten ohne Steuern</para>
3529 <term><varname>total</varname></term>
3532 <para>Restsumme der Rechnung (Summe abzüglich bereits
3533 bezahlter Posten)</para>
3538 <term><varname>transaction_description</varname></term>
3541 <para>Vorgangsbezeichnung</para>
3546 <term><varname>transdate</varname></term>
3549 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3550 erstellt wurde</para>
3556 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3557 <title>Variablen für jeden Posten auf der Rechnung</title>
3561 <term><varname>bin</varname></term>
3564 <para>Stellage</para>
3569 <term><varname>description</varname></term>
3572 <para>Artikelbeschreibung</para>
3577 <term><varname>discount</varname></term>
3580 <para>Rabatt als Betrag</para>
3585 <term><varname>discount_sub</varname></term>
3588 <para>Zwischensumme mit Rabatt</para>
3593 <term><varname>drawing</varname></term>
3596 <para>Zeichnung</para>
3601 <term><varname>ean</varname></term>
3604 <para>EAN-Code</para>
3609 <term><varname>image</varname></term>
3617 <term><varname>linetotal</varname></term>
3620 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3625 <term><varname>longdescription</varname></term>
3628 <para>Langtext</para>
3633 <term><varname>microfiche</varname></term>
3636 <para>Mikrofilm</para>
3641 <term><varname>netprice</varname></term>
3644 <para>Nettopreis</para>
3649 <term><varname>nodiscount_linetotal</varname></term>
3652 <para>Zeilensumme ohne Rabatt</para>
3657 <term><varname>nodiscount_sub</varname></term>
3660 <para>Zwischensumme ohne Rabatt</para>
3665 <term><varname>number</varname></term>
3668 <para>Artikelnummer</para>
3673 <term><varname>ordnumber_oe</varname></term>
3676 <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
3677 aus einem Sammelauftrag erstellt wurde</para>
3682 <term><varname>p_discount</varname></term>
3685 <para>Rabatt in Prozent</para>
3690 <term><varname>partnotes</varname></term>
3693 <para>Die beim Artikel gespeicherten Bemerkungen</para>
3698 <term><varname>partsgroup</varname></term>
3701 <para>Warengruppe</para>
3706 <term><varname>price_factor</varname></term>
3709 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
3715 <term><varname>price_factor_name</varname></term>
3718 <para>Der Name des Preisfaktors, sofern einer eingestellt
3724 <term><varname>projectnumber</varname></term>
3727 <para>Projektnummer</para>
3732 <term><varname>projectdescription</varname></term>
3735 <para>Projektbeschreibung</para>
3740 <term><varname>qty</varname></term>
3748 <term><varname>reqdate</varname></term>
3751 <para>Lieferdatum</para>
3756 <term><varname>runningnumber</varname></term>
3759 <para>Position auf der Rechnung (1, 2, 3...)</para>
3764 <term><varname>sellprice</varname></term>
3767 <para>Verkaufspreis</para>
3772 <term><varname>serialnumber</varname></term>
3775 <para>Seriennummer</para>
3780 <term><varname>tax_rate</varname></term>
3783 <para>Steuersatz</para>
3788 <term><varname>transdate_oe</varname></term>
3791 <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
3792 aus einem Sammelauftrag erstellt wurde</para>
3797 <term><varname>unit</varname></term>
3800 <para>Einheit</para>
3805 <term><varname>weight</varname></term>
3808 <para>Gewicht</para>
3813 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
3814 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
3815 einer <function>foreach</function>-Schleife ausgegeben werden, da
3816 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
3817 können. Die Variablen dafür lauten:</para>
3821 <term><varname>make</varname></term>
3824 <para>Lieferant</para>
3829 <term><varname>model</varname></term>
3832 <para>Lieferantenartikelnummer</para>
3838 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
3839 <title>Variablen für die einzelnen Zahlungseingänge</title>
3843 <term><varname>payment</varname></term>
3851 <term><varname>paymentaccount</varname></term>
3859 <term><varname>paymentdate</varname></term>
3867 <term><varname>paymentmemo</varname></term>
3875 <term><varname>paymentsource</varname></term>
3884 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
3885 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
3887 <para>Die vom Benutzer definierten Variablen für Kunden und
3888 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
3889 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
3890 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
3891 Variablennamen zusammen.</para>
3893 <para>Beispiel: Der Benutzer hat eine Variable namens
3894 <varname>number_of_employees</varname> definiert, die die Anzahl der
3895 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
3896 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
3901 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
3902 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
3904 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
3905 <title>Namen der Vorlagen</title>
3907 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
3908 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
3909 Erstellung einer Rechnung über die Mahngebühren und Zinsen
3910 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
3911 Vorlagenname für diese Mahnstufe mit dem Zusatz
3912 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
3913 für die ausgewählte Sprache und den ausgewählten Drucker
3917 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
3918 <title>Allgemeine Variablen in Mahnungen</title>
3920 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3921 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3922 Kunden stehen als Variablen <varname>name</varname>,
3923 <varname>street</varname>, <varname>zipcode</varname>,
3924 <varname>city</varname>, <varname>country</varname>,
3925 <varname>department_1</varname>, <varname>department_2</varname>,
3926 und <varname>email</varname> zur Verfügung.</para>
3928 <para>Weitere Variablen beinhalten:</para>
3932 <term><varname>dunning_date</varname></term>
3935 <para>Datum der Mahnung</para>
3940 <term><varname>dunning_duedate</varname></term>
3943 <para>Fälligkeitsdatum für diese Mahhnung</para>
3948 <term><varname>dunning_id</varname></term>
3951 <para>Mahnungsnummer</para>
3956 <term><varname>fee</varname></term>
3959 <para>Kummulative Mahngebühren</para>
3964 <term><varname>interest_rate</varname></term>
3967 <para>Zinssatz per anno in Prozent</para>
3972 <term><varname>total_amount</varname></term>
3975 <para>Gesamter noch zu zahlender Betrag als
3976 <function>fee</function> + <function>total_interest</function>
3977 + <function>total_open_amount</function></para>
3982 <term><varname>total_interest</varname></term>
3985 <para>Zinsen per anno über alle Rechnungen</para>
3990 <term><varname>total_open_amount</varname></term>
3993 <para>Summe über alle offene Beträge der Rechnungen</para>
3999 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
4000 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
4004 <term><varname>dn_amount</varname></term>
4007 <para>Rechnungssumme (brutto)</para>
4012 <term><varname>dn_duedate</varname></term>
4015 <para>Originales Fälligkeitsdatum der Rechnung</para>
4020 <term><varname>dn_dunning_date</varname></term>
4023 <para>Datum der Mahnung</para>
4028 <term><varname>dn_dunning_duedate</varname></term>
4031 <para>Fälligkeitsdatum der Mahnung</para>
4036 <term><varname>dn_fee</varname></term>
4039 <para>Kummulative Mahngebühr</para>
4044 <term><varname>dn_interest</varname></term>
4047 <para>Zinsen per anno für diese Rechnung</para>
4052 <term><varname>dn_invnumber</varname></term>
4055 <para>Rechnungsnummer</para>
4060 <term><varname>dn_linetotal</varname></term>
4063 <para>Noch zu zahlender Betrag (ergibt sich aus
4064 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
4065 + <varname>dn_interest</varname>)</para>
4070 <term><varname>dn_netamount</varname></term>
4073 <para>Rechnungssumme (netto)</para>
4078 <term><varname>dn_open_amount</varname></term>
4081 <para>Offener Rechnungsbetrag</para>
4086 <term><varname>dn_ordnumber</varname></term>
4089 <para>Bestellnummer</para>
4094 <term><varname>dn_transdate</varname></term>
4097 <para>Rechnungsdatum</para>
4102 <term><varname>dn_curr</varname></term>
4105 <para>Währung, in der die Rechnung erstellt wurde. (Die
4106 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
4112 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
4113 <title>Variablen in automatisch erzeugten Rechnungen über
4114 Mahngebühren</title>
4116 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4117 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4118 Kunden stehen als Variablen <varname>name</varname>,
4119 <varname>street</varname>, <varname>zipcode</varname>,
4120 <varname>city</varname>, <varname>country</varname>,
4121 <varname>department_1</varname>, <varname>department_2</varname>,
4122 und <varname>email</varname> zur Verfügung.</para>
4124 <para>Weitere Variablen beinhalten:</para>
4128 <term><varname>duedate</varname></term>
4131 <para>Fälligkeitsdatum der Rechnung</para>
4136 <term><varname>dunning_id</varname></term>
4139 <para>Mahnungsnummer</para>
4144 <term><varname>fee</varname></term>
4147 <para>Mahngebühren</para>
4152 <term><varname>interest</varname></term>
4160 <term><varname>invamount</varname></term>
4163 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
4164 <varname>interest</varname>)</para>
4169 <term><varname>invdate</varname></term>
4172 <para>Rechnungsdatum</para>
4177 <term><varname>invnumber</varname></term>
4180 <para>Rechnungsnummer</para>
4187 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
4188 <title>Variablen in anderen Vorlagen</title>
4191 <title>Einführung</title>
4193 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
4194 Rechnung. Allerdings heißen die Variablen, die mit
4195 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
4196 fangen sie mit <varname>quo</varname> für "quotation" an:
4197 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
4198 wiederum fangen sie mit <varname>ord</varname> für "order" an:
4199 <varname>ordnumber</varname> für Bestellnummer etc.</para>
4201 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
4202 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
4203 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
4204 Vorlage keine Bedeutung haben oder noch nicht belegt sein
4207 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
4208 in Rechnungen aufgeführt.</para>
4211 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
4212 <title>Angebote und Preisanfragen</title>
4216 <term><varname>quonumber</varname></term>
4219 <para>Angebots- bzw. Anfragenummer</para>
4224 <term><varname>reqdate</varname></term>
4227 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
4228 Preisanfragen)</para>
4233 <term><varname>transdate</varname></term>
4236 <para>Angebots- bzw. Anfragedatum</para>
4242 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
4243 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
4247 <term><varname>ordnumber</varname></term>
4250 <para>Auftragsnummer</para>
4255 <term><varname>reqdate</varname></term>
4258 <para>Lieferdatum</para>
4263 <term><varname>transdate</varname></term>
4266 <para>Auftragsdatum</para>
4272 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
4273 <title>Lieferscheine (Verkauf und Einkauf)</title>
4277 <term><varname>cusordnumber</varname></term>
4280 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
4281 des Lieferanten (im Einkauf)</para>
4286 <term><varname>donumber</varname></term>
4289 <para>Lieferscheinnummer</para>
4294 <term><varname>transdate</varname></term>
4297 <para>Lieferscheindatum</para>
4302 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
4303 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
4304 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
4305 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
4306 <function>foreach</function>-Schleife ausgegeben werden. Diese
4307 Variablen sind:</para>
4311 <term><varname>si_bin</varname></term>
4314 <para>Lagerplatz</para>
4319 <term><varname>si_chargenumber</varname></term>
4322 <para>Chargennummer</para>
4327 <term><varname>si_bestbefore</varname></term>
4330 <para>Mindesthaltbarkeit</para>
4335 <term><varname>si_number</varname></term>
4338 <para>Artikelnummer</para>
4343 <term><varname>si_qty</varname></term>
4346 <para>Anzahl bzw. Menge</para>
4351 <term><varname>si_runningnumber</varname></term>
4354 <para>Positionsnummer (1, 2, 3 etc)</para>
4359 <term><varname>si_unit</varname></term>
4362 <para>Einheit</para>
4367 <term><varname>si_warehouse</varname></term>
4376 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
4377 <title>Variablen für Sammelrechnung</title>
4381 <term><varname>c0total</varname></term>
4384 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
4390 <term><varname>c30total</varname></term>
4393 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
4394 und < 60 Tage</para>
4399 <term><varname>c60total</varname></term>
4402 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
4403 und < 90 Tage</para>
4408 <term><varname>c90total</varname></term>
4411 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
4417 <term><varname>total</varname></term>
4420 <para>Gesamtbetrag aller Rechnungen</para>
4425 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
4429 <term><varname>invnumber</varname></term>
4432 <para>Rechnungsnummer</para>
4437 <term><varname>invdate</varname></term>
4440 <para>Rechnungsdatum</para>
4445 <term><varname>duedate</varname></term>
4448 <para>Fälligkeitsdatum</para>
4453 <term><varname>amount</varname></term>
4456 <para>Summe der Rechnung</para>
4461 <term><varname>open</varname></term>
4464 <para>Noch offener Betrag der Rechnung</para>
4469 <term><varname>c0</varname></term>
4472 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4478 <term><varname>c30</varname></term>
4481 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4487 <term><varname>c60</varname></term>
4490 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4496 <term><varname>c90</varname></term>
4499 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4507 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4508 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4510 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4511 <title>Einfürhung</title>
4513 <para>Der Parser kennt neben den Variablen einige weitere
4514 Konstrukte, die gesondert behandelt werden. Diese sind wie
4515 Variablennamen in spezieller Weise markiert:
4516 <command><%anweisung%> ... <%end%></command></para>
4518 <para>Anmerkung zum <command><%end%></command>: Der besseren
4519 Verständlichkeit halber kann man nach dem <command>end</command>
4520 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4521 Anweisung (z.B. <command>if</command> oder
4522 <command>foreach</command>) damit abgeschlossen wird.</para>
4524 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4525 <command><%if type == "sales_quotation"%></command>, so könnte
4526 er mit <command><%end%></command> genauso abgeschlossen werden
4527 wie mit <command><%end if%></command> oder auch
4528 <command><%end type == "sales_quotation"%></command>.</para>
4531 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4532 <title>Der if-Block</title>
4534 <programlisting><%if variablenname%>
4536 <%end%></programlisting>
4538 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4539 und dem "end" werden nur ausgegeben, wenn die Variable
4540 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4542 <para>Handelt es sich bei der benannten Variable um ein Array, also um einen Variablennamen, über den man mit
4543 <command><%foreach variablenname%></command> iteriert, so wird mit diesem Konstrukt darauf getestet, ob das Array Elemente
4544 enthält. Somit würde im folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt ihrer Überschrift "Zahlungseingänge"
4545 ausgegeben, wenn tatsächlich welche getätigt wurden:</para>
4547 <programlisting><%if payment%>
4549 <%foreach payment%>
4550 Am <%paymentdate%>: <%payment%> €
4551 <%end foreach%>
4552 <%end if%></programlisting>
4554 <para>Die Bedingung kann auch negiert werden, indem das Wort
4555 <function>not</function> nach dem <filename>if</filename> verwendet
4556 wird. Beispiel:</para>
4558 <programlisting><%if not cp_greeting%>
4560 <%end%></programlisting>
4562 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4563 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4564 einer Variablen mit einer festen Zeichenkette oder einer anderen
4565 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4566 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4567 die rechte Seite des Vergleichsoperators in Anführungszeichen
4568 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4569 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4572 <programlisting><%if var1 == "Wert"%></programlisting>
4574 <para>Testet die Variable <varname>var1</varname> auf
4575 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4576 Mittels <function>!=</function> anstelle von <function>==</function>
4577 würde auf Ungleichheit getestet.</para>
4579 <programlisting><%if var1 == var2%></programlisting>
4581 <para>Testet die Variable <varname>var1</varname> auf
4582 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4583 <function>!=</function> anstelle von <function>==</function> würde
4584 auf Ungleichheit getestet.</para>
4586 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4587 auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
4588 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4589 dieselbe Syntax wie oben nur mit <function>=~</function> und
4590 <function>!~</function> als Vergleichsoperatoren.</para>
4592 <para>Beispiel für einen Test, ob die Variable
4593 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4594 <constant>schwierig</constant> enthält:</para>
4596 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4599 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4600 <title>Der foreach-Block</title>
4602 <programlisting><%foreach variablenname%>
4604 <%end%></programlisting>
4606 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4607 wie das Perl-Array der Variablen <varname>variablenname</varname>
4608 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4609 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4610 benutzt. In jedem Durchlauf werden die <link
4611 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4612 Variablen</link> jeweils auf den Wert für die aktuelle Position
4615 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
4617 <programlisting><%foreach number%>
4618 Position: <%runningnumber%>
4619 Anzahl: <%qty%>
4620 Artikelnummer: <%number%>
4621 Beschreibung: <%description%>
4623 <%end%></programlisting>
4625 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
4626 <function><%foreach%></function>-Block innerhalb einer
4627 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
4628 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
4629 Inhalt zwischen <function><%foreach%></function> und
4630 <function><%end%></function> wiederholt, nicht aber die
4631 komplette Zeile, in der er steht.</para>
4635 <sect2 id="dokumentenvorlagen-und-variablen.markup">
4636 <title>Markup-Code zur Textformatierung innerhalb von
4639 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
4640 anders formatiert haben möchte, so ist dies begrenzt möglich.
4641 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
4642 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
4643 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
4644 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
4645 (HTML oder PDF über LaTeX) umgesetzt.</para>
4647 <para>Die unterstützen Formatierungen sind:</para>
4651 <term><b>Text</b></term>
4654 <para>Text wird in Fettdruck gesetzt.</para>
4659 <term><i>Text</i></term>
4662 <para>Text wird kursiv gesetzt.</para>
4667 <term><u>Text</u></term>
4670 <para>Text wird unterstrichen.</para>
4675 <term><s>Text</s></term>
4678 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
4679 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
4684 <term><bullet></term>
4687 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
4693 <para>Der Befehl <command><bullet></command> funktioniert
4694 momentan auch nur in Latex-Vorlagen.</para>
4698 <sect1 id="excel-templates">
4699 <title>Excel-Vorlagen</title>
4701 <sect2 id="excel-templates.summary">
4702 <title>Zusammenfassung</title>
4704 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
4705 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
4709 <sect2 id="excel-templates.usage">
4710 <title>Bedienung</title>
4712 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
4713 werden. Die Konfigurationsoption heißt <varname>excel_templates =
4714 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
4716 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
4717 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
4718 werden. In den normalen Verkaufsmasken taucht nun
4719 <constant>Excel</constant> als auswählbares Format auf und kann von da
4720 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
4722 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
4723 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
4724 <filename>sales_quotation.xls</filename> gespeichert.</para>
4727 <sect2 id="excel-templates.syntax">
4728 <title>Variablensyntax</title>
4730 <para>Einfache Syntax:
4731 <command><<varname>></command></para>
4733 <para>Dabei sind <constant><<</constant> und
4734 <constant>>></constant> die Delimiter. Da Excel auf festen
4735 Breiten besteht, kann der Tag künstlich verlängert werden, indem
4736 weitere <constant><</constant> oder <constant>></constant>
4737 eingefügt werden. Der Tag muss nicht symmetrisch sein.
4740 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4742 <para>Um die Limitierung der festen Breite zu reduzieren, können
4743 weitere Variablen in einem Block interpoliert werden. Whitespace wird
4744 dazwishen dann erhalten. Beispiel:</para>
4746 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4748 <para>Die Variablen werden interpoliert, und linksbündig mit
4749 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
4750 lang, werden überzählige Zeichen abgeschnitten.</para>
4752 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
4753 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
4755 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4757 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
4758 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
4762 <sect2 id="excel-templates.limitations">
4763 <title>Einschränkungen</title>
4765 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
4766 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
4767 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
4768 Text zu ersetzen.</para>
4770 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
4771 <command><%if%></command> und
4772 <command><%foreach%></command> nicht vorhanden. Der Delimiter
4773 <constant><% %></constant> kommt in den Headerinformationen
4774 evtl. vor. Deshalb wurde auf den sichereren Delimiter
4775 <constant><<</constant> und <constant>>></constant>
4782 <title>Entwicklerdokumentation</title>
4784 <sect1 id="devel.globals" xreflabel="Globale Variablen">
4785 <title>Globale Variablen</title>
4788 <title>Wie sehen globale Variablen in Perl aus?</title>
4790 <para>Globale Variablen liegen in einem speziellen namespace namens
4791 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
4792 globs global und die meisten speziellen Variablen sind...
4795 <para>Daraus ergeben sich folgende Formen:</para>
4799 <term><literal>$main::form</literal></term>
4802 <para>expliziter Namespace "main"</para>
4807 <term><literal>$::form</literal></term>
4810 <para>impliziter Namespace "main"</para>
4815 <term><literal>open FILE, "file.txt"</literal></term>
4818 <para><varname>FILE</varname> ist global</para>
4823 <term><literal>$_</literal></term>
4826 <para>speziell</para>
4831 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
4832 Schlüsselwort wie "<function>global</function>", mit dem man
4833 importieren kann. <function>my</function>, <function>our</function>
4834 und <function>local</function> machen was anderes.</para>
4838 <term><literal>my $form</literal></term>
4841 <para>lexikalische Variable, gültig bis zum Ende des
4847 <term><literal>our $form</literal></term>
4850 <para><varname>$form</varname> referenziert ab hier
4851 <varname>$PACKAGE::form</varname>.</para>
4856 <term><literal>local $form</literal></term>
4859 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
4860 des scopes zurückgesetzt</para>
4867 <title>Warum sind globale Variablen ein Problem?</title>
4869 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
4871 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
4872 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
4873 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
4874 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
4875 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
4876 Datenbankverbindungen, weil die sehr lange zum Initialisieren
4879 <para>Das zweite Problem ist <function>strict</function>. Unter
4880 <function>strict</function> werden alle Variablen die nicht explizit
4881 mit <function>Package</function>, <function>my</function> oder
4882 <function>our</function> angegeben werden als Tippfehler angemarkert,
4883 dies hat, seit der Einführung, u.a. schon so manche langwierige
4884 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
4885 angegeben werden, werden die nicht geprüft, und somit kann sich
4886 schnell ein Tippfehler einschleichen.</para>
4890 <title>Kanonische globale Variablen</title>
4892 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
4893 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
4894 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
4895 umhergereicht werden.</para>
4897 <para>Diese Variablen sind im Moment die folgenden neun:</para>
4901 <para><varname>$::form</varname></para>
4905 <para><varname>%::myconfig</varname></para>
4909 <para><varname>$::locale</varname></para>
4913 <para><varname>$::lxdebug</varname></para>
4917 <para><varname>$::auth</varname></para>
4921 <para><varname>$::lx_office_conf</varname></para>
4925 <para><varname>$::instance_conf</varname></para>
4929 <para><varname>$::dispatcher</varname></para>
4933 <para><varname>$::request</varname></para>
4937 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
4938 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
4939 Eigenschaften (Konventionen):</para>
4942 <title>$::form</title>
4946 <para>Ist ein Objekt der Klasse
4947 "<classname>Form</classname>"</para>
4951 <para>Wird nach jedem Request gelöscht</para>
4955 <para>Muss auch in Tests und Konsolenscripts vorhanden
4960 <para>Enthält am Anfang eines Requests die Requestparameter vom
4965 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
4966 cachen, das wird aber momentan absichtlich zerstört</para>
4970 <para><varname>$::form</varname> wurde unter <productname>SQL
4971 Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
4972 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
4973 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
4974 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
4975 <function>IS->retrieve_customer()</function> in Sicherheit
4978 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
4979 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
4980 3552, Stand version 2.7beta), um dies hinterher wieder auf den
4981 richtigen Wert zu setzen:</para>
4983 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
4984 $::myconfig{numberformat} = $numberformat;
4985 # (...) div Berechnungen
4986 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
4988 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
4989 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
4990 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
4991 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
4992 Es geht ziemlich sicher etwas kaputt.</para>
4994 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
4995 in den <productname>Template::Toolkit</productname> Templates
4996 außerhalb der Controller: der Ausdruck <function>[% var
4997 %]</function> greift auf <varname>$::form->{var}</varname> zu.
4998 Unter Controllern ist der Standard Scope anders, da lautet der
4999 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
5000 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
5001 <function><%var%></function> zeigt auf
5002 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
5003 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
5006 <programlisting>[%- IF business %]
5007 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
5008 [%- END %]</programlisting>
5010 <para>Entweder wird hier dann $::form->{business} ausgewertet
5011 oder aber der Funktion
5012 <function>$form->parse_html_template</function> wird explizit
5013 noch ein zusätzlicher Hash übergeben, der dann auch in den
5014 (Web-)Templates zu Verfügung steht, bspw. so:</para>
5016 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
5018 <para>Innerhalb von Schleifen wird
5019 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
5020 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
5021 welches über alle Positionen eines Lieferscheins in Schleife
5024 <programlisting>for $i (1 .. $form->{rowcount}) {
5026 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
5027 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
5028 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
5034 <title>%::myconfig</title>
5038 <para>Das einzige Hash unter den globalen Variablen</para>
5042 <para>Wird spätestens benötigt wenn auf die Datenbank
5043 zugegriffen wird</para>
5047 <para>Wird bei jedem Request neu erstellt.</para>
5051 <para>Enthält die Userdaten des aktuellen Logins</para>
5055 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
5056 extern serialisiert werden, weil da auch der Datenbankzugriff
5057 für diesen user drinsteht.</para>
5061 <para>Enthält unter anderem Listenbegrenzung vclimit,
5062 Datumsformat dateformat und Nummernformat numberformat</para>
5066 <para>Enthält Datenbankzugriffinformationen</para>
5070 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
5071 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
5072 aktuellen Users entscheiden müssen, befragen
5073 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
5074 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
5075 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
5076 Informationen über den Benutzer die über die
5077 Administrator-Schnittstelle eingegeben wurden.</para>
5081 <title>$::locale</title>
5085 <para>Objekt der Klasse "Locale"</para>
5089 <para>Wird pro Request erstellt</para>
5093 <para>Muss auch für Tests und Scripte immer verfügbar
5098 <para>Cached intern über Requestgrenzen hinweg benutzte
5103 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
5104 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
5108 <title>$::lxdebug</title>
5112 <para>Objekt der Klasse "LXDebug"</para>
5116 <para>Wird global gecached</para>
5120 <para>Muss immer verfügbar sein, in nahezu allen
5125 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
5126 bereit, wie "<function>enter_sub</function>" und
5127 "<function>leave_sub</function>", mit denen in den alten Modulen ein
5128 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
5129 der man die Wallclockzeit seit Requeststart loggen kann, sowie
5130 "<function>message</function>" und "<function>dump</function>" mit
5131 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
5134 <para>Beispielsweise so:</para>
5136 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
5137 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
5141 <title>$::auth</title>
5145 <para>Objekt der Klasse "SL::Auth"</para>
5149 <para>Wird global gecached</para>
5153 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
5157 <para>Wird nach jedem Request resettet.</para>
5161 <para><varname>$::auth</varname> stellt Funktionen bereit um die
5162 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
5163 vom aktuellen User abhängen wird das Objekt aus
5164 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
5165 Request kurz resettet.</para>
5167 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten. Dessen Einstellungen können über
5168 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert ist ein Hash mit den Werten aus der Tabelle
5169 <literal>auth.clients</literal>.</para>
5173 <title>$::lx_office_conf</title>
5177 <para>Objekt der Klasse
5178 "<classname>SL::LxOfficeConf</classname>"</para>
5182 <para>Global gecached</para>
5186 <para>Repräsentation der
5187 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
5191 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
5192 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
5193 das Programm die Konfiguration ändern kann oder sollte.</para>
5195 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
5196 Debug- und Trace-Log-Datei wie folgt konfiguriert und
5199 <programlisting>[debug]
5200 file = /tmp/kivitendo-debug.log</programlisting>
5202 <para>ist der Key <varname>file</varname> im Programm als
5203 <varname>$::lx_office_conf->{debug}{file}</varname>
5207 <para>Zugriff auf die Konfiguration erfolgt im Moment über
5208 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
5213 <title>$::instance_conf</title>
5217 <para>Objekt der Klasse
5218 "<classname>SL::InstanceConfiguration</classname>"</para>
5222 <para>wird pro Request neu erstellt</para>
5226 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
5227 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
5228 ist hier eine Mandantendatenbank. Beispielsweise überprüft
5229 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
5230 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
5234 <title>$::dispatcher</title>
5238 <para>Objekt der Klasse
5239 "<varname>SL::Dispatcher</varname>"</para>
5243 <para>wird pro Serverprozess erstellt.</para>
5247 <para>enthält Informationen über die technische Verbindung zum
5252 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
5253 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
5254 Objekt untergebracht.</para>
5258 <title>$::request</title>
5262 <para>Hashref (evtl später Objekt)</para>
5266 <para>Wird pro Request neu initialisiert.</para>
5270 <para>Keine Unterstruktur garantiert.</para>
5274 <para><varname>$::request</varname> ist ein generischer Platz um
5275 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
5276 at a distance benutzt werden, sondern um lokales memoizing zu
5277 ermöglichen, das garantiert am Ende des Requests zerstört
5280 <para>Vieles von dem, was im moment in <varname>$::form</varname>
5281 liegt, sollte eigentlich hier liegen. Die groben
5282 Differentialkriterien sind:</para>
5286 <para>Kommt es vom User, und soll unverändert wieder an den
5287 User? Dann <varname>$::form</varname>, steht da eh schon</para>
5291 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
5292 Requests gebraucht werden? Dann
5293 <varname>$::request</varname></para>
5297 <para>Muss ich von anderen Teilen des Programms lesend drauf
5298 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
5299 Wrappermethode</para>
5306 <title>Ehemalige globale Variablen</title>
5308 <para>Die folgenden Variablen waren einmal im Programm, und wurden
5312 <title>$::cgi</title>
5316 <para>war nötig, weil cookie Methoden nicht als
5317 Klassenfunktionen funktionieren</para>
5321 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
5322 Klassennamespace gehalten wird und über Requestgrenzen
5327 <para>liegt jetzt unter
5328 <varname>$::request->{cgi}</varname></para>
5334 <title>$::all_units</title>
5338 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
5339 ein paar hundert mal pro Request eine Liste der Einheiten
5340 brauchen, und de als Parameter durch einen Riesenstack von
5341 Funktionen geschleift werden müssten.</para>
5345 <para>Liegt jetzt unter
5346 <varname>$::request->{cache}{all_units}</varname></para>
5351 <function>AM->retrieve_all_units()</function> gesetzt oder
5358 <title>%::called_subs</title>
5362 <para>wurde benutzt um callsub deep recursions
5367 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
5368 möglichen Rekursioenen darstellt, und da nie welche
5373 <para>komplette recursion protection wurde entfernt.</para>
5380 <sect1 id="devel.fcgi">
5381 <title>Entwicklung unter FastCGI</title>
5383 <sect2 id="devel.fcgi.general">
5384 <title>Allgemeines</title>
5386 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
5387 werden, muss der Webserver neu gestartet werden.</para>
5389 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
5390 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
5391 müssen folgende Aspekte beachtet werden.</para>
5394 <sect2 id="devel.fcgi.exiting">
5395 <title>Programmende und Ausnahmen</title>
5397 <para>Betrifft die Funktionen <function>warn</function>,
5398 <function>die</function>, <function>exit</function>,
5399 <function>carp</function> und <function>confess</function>.</para>
5401 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
5402 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
5403 am Laufen zu halten. Man kann mit <function>die</function>,
5404 <function>confess</function> oder <function>carp</function> Fehler
5405 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
5406 eigene <function>$::form-</function>error()> tut im Prinzip das
5407 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
5408 <function>exit</function> hingegen werden nicht abgefangen.
5409 <function>warn</function> wird direkt nach STDERR, also in Server Log
5410 eine Nachricht schreiben (sofern in der Konfiguration nicht die
5411 Warnungen in das kivitendo Log umgeleitet wurden), und
5412 <function>exit</function> wird die Ausführung beenden.</para>
5414 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
5415 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
5416 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
5417 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
5420 <sect2 id="devel.fcgi.globals">
5421 <title>Globale Variablen</title>
5423 <para>Um zu vermeiden, dass Informationen von einem Request in einen
5424 anderen gelangen, müssen alle globalen Variablen vor einem Request
5425 sauber initialisiert werden. Das ist besonders wichtig im
5426 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
5427 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
5430 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
5431 abgetrennten Block, der alle kanonischen globalen Variablen listet und
5432 erklärt. Bitte keine anderen einführen ohne das sauber zu
5433 dokumentieren.</para>
5435 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
5436 man sicher geht, dass man die richtige erwischt.</para>
5439 <sect2 id="devel.fcgi.performance">
5440 <title>Performance und Statistiken</title>
5442 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
5443 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
5444 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
5445 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
5446 sind es je nach Menge der definierten Variablen 1-2s. Ab der
5447 Moose/Rose::DB Version sind es 5-6s.</para>
5449 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
5450 den kritischen Pfaden, unter 0,15 sonst.</para>
5454 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
5455 <title>SQL-Upgradedateien</title>
5457 <sect2 id="db-upgrade-files.introduction"
5458 xreflabel="Einführung in die Datenbank-Upgradedateien">
5459 <title>Einführung</title>
5461 <para>Der alte Mechanismus für SQL-Upgradescripte, der auf einer
5462 Versionsnummer beruht und dann in sql/Pg-upgrade nach einem Script für
5463 diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele
5464 Entwicklung im stable- und unstable-Baum betrifft.</para>
5466 <para>Dieser Mechanismus wurde für kivitendo 2.4.1 deutlich erweitert.
5467 Es werden weiterhin alle Scripte aus sql/Pg-upgrade ausgeführt.
5468 Zusätzlich gibt es aber ein zweites Verzeichnis, sql/Pg-upgrade2. In
5469 diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren,
5470 die neben den eigentlich auszuführenden SQL- oder Perl-Befehlen einige
5471 Kontrollinformationen enthält.</para>
5473 <para>Neu sind die Kontrollinformationen, die Abhängigkeiten und
5474 Prioritäten definieren können werden, sodass Datenbankscripte zwar in
5475 einer sicheren Reihenfolge ausgeführt werden (z.B. darf ein "ALTER
5476 TABLE" erst ausgeführt werden, wenn die Tabelle mit "CREATE TABLE"
5477 angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man
5478 keine Versionsnummern mehr braucht.</para>
5480 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
5481 sql/Pg-upgrade2 bereits durchgeführt wurde und führt diese nicht
5482 erneut aus. Dazu dient die Tabelle "schema_info", die bei der
5483 Anmeldung automatisch angelegt wird.</para>
5486 <sect2 id="db-upgrade-files.format"
5487 xreflabel="Format der Upgradedateien">
5488 <title>Format der Kontrollinformationen</title>
5490 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5491 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5492 hat dabei das folgende Format:</para>
5494 <para>Für SQL-Upgradedateien:</para>
5496 <programlisting>-- @key: value</programlisting>
5498 <para>Für Perl-Upgradedateien:</para>
5500 <programlisting># @key: value</programlisting>
5502 <para>Leerzeichen vor "<varname>value</varname>" werden
5505 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5509 <term><varname>tag</varname></term>
5512 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5513 Dieser "tag" kann von anderen Kontrolldateien in ihren
5514 Abhängigkeiten verwendet werden (Schlüsselwort
5515 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5516 in der Datenbank eingetragen wird.</para>
5518 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5519 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5521 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5522 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5523 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5529 <term><varname>charset</varname></term>
5532 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5533 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
5534 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte hingegen müssen immer in UTF-8 encodiert sein und sollten
5535 demnach auch ein "<literal>use utf8;</literal>" enthalten.</para>
5540 <term><varname>description</varname></term>
5543 <para>Benötigt. Eine Beschreibung, was in diesem Update
5544 passiert. Diese wird dem Benutzer beim eigentlichen
5545 Datenbankupdate angezeigt. Während der Tag in englisch gehalten
5546 sein sollte, sollte die Beschreibung auf Deutsch
5552 <term><varname>depends</varname></term>
5555 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5556 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
5557 dass die in dieser Liste aufgeführten Scripte bereits
5558 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5560 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5561 Script "b" existiert, das von Änderungen in "a" abhängt, und
5562 eine neue Kontrolldatei für "c" erstellt wird, die von
5563 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5564 Tag "b" als Abhängigkeit zu definieren.</para>
5566 <para>Es ist nicht erlaubt, sich selbst referenzierende
5567 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5568 und "c" -> "a").</para>
5573 <term><varname>priority</varname></term>
5576 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5577 der Scripte ausgeführt werden, die die gleichen
5578 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5579 der Wert 1000 benutzt.</para>
5581 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5582 "depends" benutzt werden. kivitendo sortiert die auszuführenden
5583 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5584 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5585 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5586 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5587 Priorität alphabetisch nach dem "tag".</para>
5592 <term><varname>ignore</varname></term>
5595 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
5596 Skript bei der Anmeldung ignoriert und entsprechend nicht
5603 <sect2 id="db-upgrade-files.format-perl-files" xreflabel="Format von Perl-Upgradedateien">
5604 <title>Format von in Perl geschriebenen Datenbankupgradescripten</title>
5606 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so ausgeführt sondern müssen sich an gewisse Konventionen
5607 halten. Dafür bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
5609 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse dar, die vom Elternobjekt
5610 "<literal>SL::DBUpgrade2::Base</literal>" erben und eine Funktion namens "<literal>run</literal>" zur Verfügung stellen muss. Das
5611 Script wird ausgeführt, indem eine Instanz dieser Klasse erzeugt und darauf die erwähnte "<literal>run</literal>" aufgerufen
5614 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert für "<literal>@tag</literal>" ableitet. Dabei werden alle
5615 Zeichen, die in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche ersetzt. Insgesamt sieht der Paketname wie folgt
5616 aus: "<literal>SL::DBUpgrade2::tag</literal>".</para>
5618 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
5619 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
5621 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie folgt aus:</para>
5623 <programlisting># @tag: beispiel-upgrade-file42
5624 # @description: Ein schönes Beispielscript
5625 # @depends: release_3_0_0
5626 package SL::DBUpgrade2::beispiel_upgrade_file42;
5631 use parent qw(SL::DBUpgrade2::Base);
5636 # hier Aktionen ausführen
5645 <sect2 id="db-upgrade-files.dbupgrade-tool"
5646 xreflabel="Hilfsscript dbupgrade2_tool.pl">
5647 <title>Hilfsscript dbupgrade2_tool.pl</title>
5649 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
5650 existiert ein Hilfsscript namens
5651 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
5652 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
5653 liest alle Datenbankupgradescripte aus dem Verzeichnis
5654 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
5655 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
5656 von der Kommandozeile überprüft werden können.</para>
5658 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
5659 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
5660 sich aber auch Informationen auf verschiedene Art ausgeben
5665 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
5666 --list</command>"</para>
5668 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
5669 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
5670 würde. Es werden neben der Listenposition der Tag, die
5671 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
5675 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
5676 --tree</command>"</para>
5678 <para>Listet alle Tags in Baumform basierend auf den
5679 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
5680 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
5681 beim übergeordneten Script als Abhängigkeit eingetragen
5685 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
5686 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
5687 --rtree</command>"</para>
5689 <para>Listet alle Tags in Baumform basierend auf den
5690 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
5691 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
5692 die das übergeordnete Script als Abhängigkeit eingetragen
5697 <para>Baumform mit Postscriptausgabe:
5698 "<command>./scripts/dbupgrade2_tool.pl
5699 --graphviz</command>"</para>
5701 <para>Benötigt das Tool "<command>graphviz</command>", um mit
5702 seiner Hilfe die <link
5703 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
5704 Baumform</link> in eine Postscriptdatei namens
5705 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
5706 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
5707 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
5708 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
5713 <para>Scripte, von denen kein anderes Script abhängt:
5714 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
5716 <para>Listet die Tags aller Scripte auf, von denen keine anderen
5717 Scripte abhängen.</para>
5723 <sect1 id="translations-languages" xreflabel="Translations and languages">
5724 <title>Translations and languages</title>
5726 <sect2 id="translations-languages.introduction"
5727 xreflabel="Introduction to translations and languages">
5728 <title>Introduction</title>
5731 <para>Dieser Abschnitt ist in Englisch geschrieben, um
5732 internationalen Übersetzern die Arbeit zu erleichtern.</para>
5735 <para>This section describes how localization packages in kivitendo
5736 are built. Currently the only language fully supported is German, and
5737 since most of the internal messages are held in English the English
5738 version is usable too.</para>
5740 <para>A stub version of French is included but not functunal at this
5744 <sect2 id="translations-languages.character-set"
5745 xreflabel="Character set">
5746 <title>Character set</title>
5748 <para>All files included in a language pack must use UTF-8 as their encoding.</para>
5751 <sect2 id="translations-languages.file-structure"
5752 xreflabel="File structure">
5753 <title>File structure</title>
5755 <para>The structure of locales in kivitendo is:</para>
5757 <programlisting>kivitendo/locale/<langcode>/</programlisting>
5759 <para>where <langcode> stands for an abbreviation of the
5760 language package. The builtin packages use two letter <ulink
5761 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
5762 but the actual name is not relevant for the program and can easily be
5764 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
5765 tags</ulink> (i.e. "en_GB"). In fact the original language packages
5766 from SQL Ledger are named in this way.</para>
5768 <para>In such a language directory the following files are
5773 <term>LANGUAGE</term>
5776 <para>This file is mandatory.</para>
5778 <para>The <filename>LANGUAGE</filename> file contains the self
5779 descripted name of the language. It should contain a native
5780 representation first, and in parenthesis an english translation
5781 after that. Example:</para>
5783 <programlisting>Deutsch (German)</programlisting>
5791 <para>This file is mandatory.</para>
5793 <para>The central translation file. It is essentially an inline
5794 Perl script autogenerated by <command>locales.pl</command>. To
5795 generate it, generate the directory and the two files mentioned
5796 above, and execute the following command:</para>
5798 <programlisting>scripts/locales.pl <langcode></programlisting>
5800 <para>Otherwise you can simply copy one of the other languages.
5801 You will be told how many are missing like this:</para>
5803 <programlisting>$ scripts/locales.pl en
5804 English - 0.6% - 2015/2028 missing</programlisting>
5806 <para>A file named "<filename>missing</filename>" will be
5807 generated and can be edited. You can also edit the
5808 "<filename>all</filename>" file directly. Edit everything you
5809 like to fit the target language and execute
5810 <command>locales.pl</command> again. See how the missing words
5816 <term>Num2text</term>
5819 <para>Legacy code from SQL Ledger. It provides a means for
5820 numbers to be converted into natural language, like
5821 <literal>1523 => one thousand five hundred twenty
5822 three</literal>. If you want to provide it, it must be inlinable
5823 Perl code which provides a <function>num2text</function> sub. If
5824 an <function>init</function> sub exists it will be executed
5827 <para>Only used in the check and receipt printing module.</para>
5832 <term>special_chars</term>
5835 <para>kivitendo comes with a lot of interfaces to different
5836 formats, some of which are rather picky with their accepted
5837 charset. The <filename>special_chars</filename> file contains a
5838 listing of chars not suited for different file format and
5839 provides substitutions. It is written in "Simple Ini" style,
5840 containing a block for every file format.</para>
5842 <para>First entry should be the order of substitution for
5843 entries as a whitespace separated list. All entries are
5844 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
5845 and <literal>\\</literal> all work.</para>
5847 <para>After that every entry is a special char that should be
5848 translated when writing text into such a file.</para>
5850 <para>Example:</para>
5852 <programlisting>[Template/XML]
5853 order=& < > \n
5857 \n=<br></programlisting>
5859 <para>Note the importance of the order in this example.
5860 Substituting < and > befor & would lead to $gt; become
5863 <para>For a list of valid formats, see the German
5864 <filename>special_chars</filename> entry. As of this writing the
5865 following are recognized:</para>
5867 <programlisting>HTML
5872 Template/OpenDocument
5873 filenames</programlisting>
5875 <para>The last of which is very machine dependant. Remember that
5876 a lot of characters are forbidden by some filesystems, for
5877 exmaple MS Windows doesn't like ':' in its files where Linux
5878 doesn't mind that. If you want the files created with your
5879 language pack to be portable, find all chars that could cause
5885 <term>missing</term>
5888 <para>This file is not a part of the language package
5891 <para>This is a file generated by
5892 <command>scripts/locales.pl</command> while processing your
5893 locales. It's only to have the missing entries singled out and
5894 does not belong to a language package.</para>
5902 <para>This file is not a part of the language package
5905 <para>Another file generated by
5906 <command>scripts/locales.pl</command>. If for any reason a
5907 translation does not appear anymore and can be deleted, it gets
5908 moved here. The last 50 or so entries deleted are saved here in
5909 case you made a typo, so that you don't have to translate
5910 everything again. If a tranlsation is missing, the lost file is
5911 checked first. If you maintain a language package, you might
5912 want to keep this safe somewhere.</para>
5919 <sect1 id="devel.testsuite">
5920 <title>Die kivitendo-Test-Suite</title>
5922 <sect2 id="devel.testsuite.intro">
5923 <title>Einführung</title>
5925 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul <literal>Test::More</literal>.</para>
5927 <para>Die grundlegenden Fakten sind:</para>
5930 <listitem><para>Alle Tests liegen im Unterverzeichnis <filename>t/</filename>.</para></listitem>
5932 <listitem><para>Ein Script (bzw. ein Test) in <filename>f/</filename> enthält einen oder mehrere Testfälle.</para></listitem>
5934 <listitem><para>Alle Dateinamen von Tests enden auf <literal>.t</literal>. Es sind selbstständig ausführbare Perl-Scripte.</para></listitem>
5936 <listitem><para>Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in <filename>f/</filename>, deren
5937 Dateiname auf <literal>.t</literal> endet.</para></listitem>
5941 <sect2 id="devel.testsuite.prerequisites">
5942 <title>Voraussetzungen</title>
5944 <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>
5947 <listitem><para><literal>Test::Deep</literal> (Debian-Paketname: <literal>libtest-deep-perl</literal>; Fedora Core:
5948 <literal>perl-Test-Deep</literal>; openSUSE: <literal>perl-Test-Deep</literal>)</para></listitem>
5949 <listitem><para><literal>Test::Exception</literal> (Debian-Paketname: <literal>libtest-exception-perl</literal>; Fedora Core:
5950 <literal>perl-Test-Exception</literal>; openSUSE: <literal>perl-Test-Exception</literal>)</para></listitem>
5951 <listitem><para><literal>Test::Output</literal> (Debian-Paketname: <literal>libtest-output-perl</literal>; Fedora Core:
5952 <literal>perl-Test-Output</literal>; openSUSE: <literal>perl-Test-Output</literal>)</para></listitem>
5953 <listitem><para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses Modul ist ab Perl 5.10.1 Bestandteil der
5954 Perl-Distribution und kann für frühere Versionen aus dem <ulink url="http://www.cpan.org">CPAN</ulink> bezogen
5955 werden.</para></listitem>
5959 <sect2 id="devel.testsuite.execution">
5961 Existierende Tests ausführen
5964 <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
5965 gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript <filename>t/test.sh</filename>.</para>
5967 <para>Will man die komplette Test-Suite ausführen, so muss man einfach nur <filename>t/test.sh</filename> ohne weitere Parameter aus
5968 dem kivitendo-Basisverzeichnis heraus ausführen.</para>
5970 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an <filename>t/test.sh</filename>. Beispielsweise:</para>
5972 <programlisting>t/test.sh t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
5976 <sect2 id="devel.testsuite.meaning_of_scripts">
5978 Bedeutung der verschiedenen Test-Scripte
5981 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch
5982 während der Entwicklung nützliche Tests sind:</para>
5985 <listitem><para><filename>t/001compile.t</filename> -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab</para></listitem>
5986 <listitem><para><filename>t/002goodperl.t</filename> -- überprüft alle Perl-Dateien auf Anwesenheit von '<literal>use strict</literal>'-Anweisungen</para></listitem>
5987 <listitem><para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von <function>system()</function> und <function>exec()</function> auf Gültigkeit</para></listitem>
5988 <listitem><para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien Tab-Zeichen enthalten</para></listitem>
5989 <listitem><para><filename>t/006spelling.t</filename> -- sucht nach häufigen Rechtschreibfehlern</para></listitem>
5990 <listitem><para><filename>t/011pod.t</filename> -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit</para></listitem>
5993 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module.</para>
5996 <sect2 id="devel.testsuite.create_new">
5998 Neue Test-Scripte erstellen
6001 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende
6002 Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden.</para>
6004 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
6006 Ideen für neue Test-Scripte, die keine konkreten Funktionen testen
6009 <para> Ideen, die abgesehen von Funktions noch nicht umgesetzt wurden:</para>
6012 <listitem><para>Überprüfung auf fehlende symbolische Links</para></listitem>
6013 <listitem><para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten)</para></listitem>
6014 <listitem><para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para></listitem>
6015 <listitem><para>Überprüfung auf Leerzeichen am Ende von Zeilen</para></listitem>
6016 <listitem><para>Test, ob alle zu übersetzenden Strings in <filename>locale/de/all</filename> vorhanden sind</para></listitem>
6017 <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>
6021 <sect3 id="devel.testsuite.directory_and_test_names">
6023 Konvention für Verzeichnis- und Dateinamen
6026 <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>
6029 <listitem><para>Die Dateiendung muss <filename>.t</filename> lauten.</para></listitem>
6031 <listitem><para>Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise
6032 <filename>bad_function_params.t</filename>).</para></listitem>
6034 <listitem><para>Unterverzeichnisse sollten grob nach dem Themenbereich benannt sind, mit dem sich die Scripte darin befassen
6035 (beispielsweise <filename>background_jobs</filename> für Tests rund um Hintergrund-Jobs).</para></listitem>
6037 <listitem><para>Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist
6038 (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben.</para></listitem>
6042 <sect3 id="devel.testsuite.minimal_example">
6044 Minimales Skelett für eigene Scripte
6047 <para>Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden:</para>
6049 <programlisting>use Test::More tests => 0;
6053 use Support::TestSetup;
6055 Support::TestSetup::login();</programlisting>
6057 <para>Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie
6058 <varname>$::auth</varname>, <varname>$::form</varname> oder <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
6059 <filename>config/kivitendo.conf</filename> im Abschnitt <literal>testing.login</literal> ein gültiger Login-Name eingetragen
6060 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
6062 <para>Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile <code>Support::TestSetup::login();</code>
6063 weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.</para>
6068 <sect1 id="devel.style-guide">
6069 <title>Stil-Richtlinien</title>
6071 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
6072 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
6073 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
6074 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
6076 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
6079 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
6080 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
6085 <para>Es werden keine echten Tabs sondern Leerzeichen
6090 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
6092 <programlisting>foreach my $row (@data) {
6094 # do something with $row
6098 $row->{modules} = MODULE->retrieve(
6099 id => $row->{id},
6100 date => $use_now ? localtime() : $row->{time},
6104 $report->add($row);
6109 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
6110 Zeile wie der letzte Befehl. Beispiele:</para>
6112 <programlisting>sub debug {
6118 <programlisting>if ($form->{item_rows} > 0) {
6124 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
6125 der Befehl / die öffnende schließende Klammer, die den Block
6126 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
6127 Beispiele wie bei 3. gelten.</para>
6131 <para>Die Wörter "<function>else</function>",
6132 "<function>elsif</function>", "<function>while</function>" befinden
6133 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
6136 <programlisting>if ($form->{sum} > 1000) {
6138 } elsif ($form->{sum} > 0) {
6146 } until ($a > 0);</programlisting>
6150 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
6151 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
6152 und grep-ähnliche Operatoren. Beispiel:</para>
6154 <programlisting>$main::lxdebug->message("Could not find file.");
6155 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
6159 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
6161 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
6162 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
6163 Blöcke schon. Beispiel:</para>
6165 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
6170 $form->{sum} += $form->{"row_$i"};
6171 $form->{ $form->{index} } += 1;
6173 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
6177 <para>Mehrzeilige Befehle</para>
6181 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
6182 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
6183 werden, in der die ersten Funktionsparameter in der ersten Zeile
6184 stehen. Beispiel:</para>
6186 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
6187 $form->{some_col_value});</programlisting>
6191 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
6192 besten in einer übersichtlichen Tabellenstruktur organisiert
6193 wird. Beispiel:</para>
6195 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
6196 : $form->{oldcount} ? $form->{oldcount} + 1
6197 : $form->{rowcount} - $form->{rowbase};</programlisting>
6203 <para>Kommentare</para>
6207 <para>Kommentare, die alleine in einer Zeile stehen, sollten
6208 soweit wie der Code eingerückt sein.</para>
6212 <para>Seitliche hängende Kommentare sollten einheitlich
6213 formatiert werden.</para>
6217 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
6218 auf Englisch zu verfassen. So wie ich keine Lust habe,
6219 französischen Quelltext zu lesen, sollte auch der kivitendo
6220 Quelltext für nicht-Deutschsprachige lesbar sein.
6223 <programlisting>my $found = 0;
6231 $i = 0 # initialize $i
6233 $i *= $const; # do something crazy
6234 $i = $n; # recover $i</programlisting>
6240 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
6241 Interpolation gewünscht ist. Beispiel:</para>
6243 <programlisting>$form->{sum} = 0;
6244 $form->{"row_$i"} = $form->{"row_$i"} - 5;
6245 $some_hash{42} = 54;</programlisting>
6249 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
6250 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
6251 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
6252 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
6254 <para>Als Beispiel sei die Funktion
6255 <function>print_options</function> aus
6256 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
6260 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
6261 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
6264 <para>Emacs und vim haben beide recht einfache Methoden zur
6265 Entfernung von trailing whitespace. Emacs kennt das Kommande
6266 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
6267 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
6268 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
6273 <para>Es wird kein <command>perltidy</command> verwendet.</para>
6275 <para>In der Vergangenheit wurde versucht,
6276 <command>perltidy</command> zu verwenden, um einen einheitlichen
6277 Stil zu erlangen. Es hat sich aber gezeigt, dass
6278 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
6279 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
6280 den Interessierten sind hier die
6281 <command>perltidy</command>-Optionen, die grob den beschriebenen
6282 Richtlinien entsprechen:</para>
6284 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
6285 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
6286 -lp -vt=1 -vtc=1</programlisting>
6290 <para><varname>STDERR</varname> ist tabu. Unkonditionale
6291 Debugmeldungen auch.</para>
6293 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
6294 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
6295 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
6297 <para>Die <classname>LXDebug</classname>-Methode
6298 "<function>message</function>" nimmt als ersten Paramter außerdem
6299 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
6300 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
6301 und werden in den meisten Fällen auch vom Repository
6302 zurückgewiesen.</para>
6306 <para>Alle neuen Module müssen use strict verwenden.</para>
6308 <para><varname>$form</varname>, <varname>$auth</varname>,
6309 <varname>$locale</varname>, <varname>$lxdebug</varname> und
6310 <varname>%myconfig</varname> werden derzeit aus dem main package
6311 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
6312 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
6317 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
6318 <title>Dokumentation erstellen</title>
6320 <sect2 id="devel.build-doc.introduction">
6321 <title>Einführung</title>
6323 <para>Diese Dokumentation ist in <productname>DocBook</productname>
6324 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
6325 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
6326 Editor nutzt, der spezielle Unterstützung für
6327 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
6328 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
6329 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
6333 <sect2 id="devel.build-doc.required-software">
6334 <title>Benötigte Software</title>
6336 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
6337 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
6338 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
6339 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
6340 <command>scripts/build_doc.sh</command>.</para>
6342 <para>Das Script benötigt zur Konvertierung verschiedene
6343 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
6349 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
6350 in einer halbwegs aktuellen Version</para>
6354 <para>Das Java-Build-System <ulink
6355 url="http://ant.apache.org/">Apache Ant</ulink></para>
6359 <para>Das Dokumentations-System Dobudish für
6360 <productname>DocBook</productname> 4.5, eine Zusammenstellung
6361 diverser Stylesheets und Grafiken zur Konvertierung von
6362 <productname>DocBook</productname> XML in andere Formate. Das
6363 Paket, das benötigt wird, ist zum Zeitpunkt der
6364 Dokumentationserstellung
6365 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
6366 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
6371 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
6372 sind auf allen gängigen Plattformen verfügbar. Beispiel für
6373 Debian/Ubuntu:</para>
6375 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
6377 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
6378 <filename>doc/build</filename> entpackt werden. Beispiel unter der
6379 Annahme, das <productname>Dobudish</productname> in
6380 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
6382 <programlisting>cd doc/build
6383 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
6386 <sect2 id="devel.build-doc.build">
6387 <title>PDFs und HTML-Seiten erstellen</title>
6389 <para>Die eigentliche Konvertierung erfolgt nach Installation der
6390 benötigten Software mit einem einfachen Aufruf direkt aus dem
6391 kivitendo-Installationsverzeichnis heraus:</para>
6393 <programlisting>./scripts/build_doc.sh</programlisting>
6396 <sect2 id="devel.build-doc.repository">
6397 <title>Einchecken in das Git-Repository</title>
6399 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
6400 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
6401 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
6402 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
6404 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
6405 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob