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>Anfang 2014 sind das folgende Systeme, von denen bekannt ist,
75 dass kivitendo auf ihnen läuft:</para>
83 <para>6.0 "Squeeze" (hier muss allerdings das Modul FCGI in der Version >= 0.72 compiled werden, und <literal>Rose::DB::Object</literal> ist zu alt)</para>
86 <para>7.0 "Wheezy"</para>
92 <para>Ubuntu 12.04 LTS "Precise Pangolin", 12.10 "Quantal Quetzal" und 13.04 "Precise Pangolin"</para>
96 <para>openSUSE 12.2 und 12.3</para>
100 <para>SuSE Linux Enterprice Server 11</para>
104 <para>Fedora 16 bis 19</para>
109 <sect2 id="Pakete" xreflabel="Pakete">
110 <title>Benötigte Perl-Pakete installieren</title>
112 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
113 Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.4)
116 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht Bestandteil einer Standard-Perl-Installation sind. Um zu
117 überprüfen, ob die erforderlichen Pakete installiert und aktuell genug sind, wird ein Script mitgeliefert, das wie folgt aufgerufen
120 <programlisting>./scripts/installation_check.pl</programlisting>
122 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
125 <listitem><para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para></listitem>
127 <listitem><para><literal>Archive::Zip</literal></para></listitem>
129 <listitem><para><literal>Config::Std</literal></para></listitem>
131 <listitem><para><literal>DateTime</literal></para></listitem>
133 <listitem><para><literal>DBI</literal></para></listitem>
135 <listitem><para><literal>DBD::Pg</literal></para></listitem>
137 <listitem><para><literal>Email::Address</literal></para></listitem>
139 <listitem><para><literal>Email::MIME</literal></para></listitem>
141 <listitem><para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71 inklusive; siehe <xref linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para></listitem>
143 <listitem><para><literal>File::Copy::Recursive</literal></para></listitem>
145 <listitem><para><literal>JSON</literal></para></listitem>
147 <listitem><para><literal>List::MoreUtils</literal></para></listitem>
149 <listitem><para><literal>Net::SMTP::SSL</literal> (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "<xref
150 linkend="config.sending-email.smtp"/>")</para></listitem>
152 <listitem><para><literal>Net::SSLGlue</literal> (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "<xref
153 linkend="config.sending-email.smtp"/>")</para></listitem>
155 <listitem><para><literal>Params::Validate</literal></para></listitem>
157 <listitem><para><literal>PDF::API2</literal></para></listitem>
159 <listitem><para><literal>Rose::Object</literal></para></listitem>
161 <listitem><para><literal>Rose::DB</literal></para></listitem>
163 <listitem><para><literal>Rose::DB::Object</literal> Version 0.788 oder neuer</para></listitem>
165 <listitem><para><literal>Template</literal></para></listitem>
167 <listitem><para><literal>Text::CSV_XS</literal></para></listitem>
169 <listitem><para><literal>Text::Iconv</literal></para></listitem>
171 <listitem><para><literal>URI</literal></para></listitem>
173 <listitem><para><literal>XML::Writer</literal></para></listitem>
175 <listitem><para><literal>YAML</literal></para></listitem>
178 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen: <literal>File::Copy::Recursive</literal>.</para>
180 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen: <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
181 <literal>Net::SSLGlue</literal>.</para>
183 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
184 hinzugekommen, <literal>URI</literal> und
185 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
188 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
189 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
190 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
191 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
193 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
194 hinzugekommen.</para>
196 <para><literal>Email::Address</literal> und
197 <literal>List::MoreUtils</literal> sind schon länger feste
198 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
199 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
200 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
201 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
205 <title>Debian und Ubuntu</title>
207 <para>Alle benötigten Perl-Pakete stehen für Debian und Ubuntu als Debian-Pakete zur Verfügung. Sie können mit folgendem Befehl
208 installiert werden:</para>
210 <programlisting>apt-get install apache2 libarchive-zip-perl libclone-perl \
211 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
212 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
213 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
214 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
215 librose-db-perl librose-object-perl libsort-naturally-perl \
216 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
217 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
218 libfile-copy-recursive-perl postgresql</programlisting>
222 <title>Fedora Core</title>
224 <para>Für Fedora Core stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl installeirt werden:</para>
226 <programlisting>yum install httpd perl-Archive-Zip perl-Clone perl-DBD-Pg \
227 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
228 perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
229 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
230 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
231 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
232 perl-XML-Writer perl-YAML perl-parent postgresql-server</programlisting>
234 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
236 <programlisting>yum install perl-CPAN
237 cpan Config::Std</programlisting>
242 <title>openSUSE</title>
244 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
245 installiert werden:</para>
247 <programlisting>zypper install apache2 perl-Archive-Zip perl-Clone \
248 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
249 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
250 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
251 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
252 perl-URI perl-XML-Writer perl-YAML postgresql-server</programlisting>
254 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
256 <programlisting>yum install perl-CPAN
257 cpan Rose::Db::Object</programlisting>
263 <sect1 id="Manuelle-Installation-des-Programmpaketes"
264 xreflabel="Manuelle Installation des Programmpaketes">
265 <title>Manuelle Installation des Programmpaketes</title>
267 <para>Die kivitendo ERP Installationsdatei (<filename>kivitendo-erp-3.0.0.tgz</filename>) wird im Dokumentenverzeichnis des Webservers
268 (z.B. <filename>/var/www/html/</filename>, <filename>/srv/www/htdocs</filename> oder <filename>/var/www/</filename>) entpackt:</para>
270 <programlisting>cd /var/www
271 tar xvzf kivitendo-erp-3.0.0.tgz</programlisting>
273 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
275 <programlisting>cd kivitendo-erp</programlisting>
277 <para>Alternativ können Sie auch einen Alias in der
278 Webserverkonfiguration benutzen, um auf das tatsächliche
279 Installationsverzeichnis zu verweisen.</para>
281 <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
282 beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
283 Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
284 core <constant>apache</constant> oder bei OpenSUSE <constant>wwwrun</constant>).</para>
286 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
287 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
289 <programlisting>chown -R www-data users spool webdav</programlisting>
291 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
292 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>
294 <programlisting>chown www-data templates users</programlisting>
297 <sect1 id="config.config-file">
298 <title>kivitendo-Konfigurationsdatei</title>
300 <sect2 id="config.config-file.introduction"
301 xreflabel="Einführung in die Konfigurationsdatei">
302 <title>Einführung</title>
304 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei,
305 die benötigt wird: <filename>config/kivitendo.conf</filename> (kurz:
306 "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
307 von kivitendo bzw. der Migration von älteren Versionen angelegt
310 <para>Als Vorlage dient die Datei
311 <filename>config/kivitendo.conf.default</filename> (kurz: "die
312 Default-Datei"):</para>
314 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
316 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
317 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
318 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
319 Abschnitte und Werte enthalten, die von denen der Default-Datei
324 Vor der Umbenennung in kivitendo hieß diese Datei noch <filename>config/lx_office.conf</filename>. Aus Gründen der Kompatibilität
325 wird diese Datei eingelesen, sofern die Datei <filename>config/kivitendo.conf</filename> nicht existiert.
329 <para>Diese Hauptkonfigurationsdatei ist dann eine
330 installationsspezifische Datei, d.h. sie enthält bspw. lokale
331 Passwörter und wird auch nicht im Versionsmanagement (git)
334 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
335 Mandaten, bzw. Datenbanken gleich.</para>
338 <sect2 id="config.config-file.sections-parameters">
339 <title>Abschnitte und Parameter</title>
341 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
342 entsprechend kommentiert sind:</para>
345 <listitem><para><literal>authentication</literal> (siehe Abschnitt "<xref
346 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>" in diesem Kapitel)</para></listitem>
348 <listitem><para><literal>authentication/database</literal></para></listitem>
350 <listitem><para><literal>authentication/ldap</literal></para></listitem>
352 <listitem><para><literal>system</literal></para></listitem>
354 <listitem><para><literal>paths</literal></para></listitem>
356 <listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>
358 <listitem><para><literal>applications</literal></para></listitem>
360 <listitem><para><literal>environment</literal></para></listitem>
363 <listitem><para><literal>print_templates</literal></para></listitem>
365 <listitem><para><literal>task_server</literal></para></listitem>
367 <listitem><para><literal>periodic_invoices</literal></para></listitem>
369 <listitem><para><literal>self_tests</literal></para></listitem>
371 <listitem><para><literal>console</literal></para></listitem>
373 <listitem><para><literal>testing</literal></para></listitem>
375 <listitem><para><literal>testing/database</literal></para></listitem>
377 <listitem><para><literal>debug</literal></para></listitem>
380 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
381 einzustellen oder zu kontrollieren sind, sind:</para>
383 <programlisting>[authentication]
384 admin_password = geheim
386 [authentication/database]
391 password =</programlisting>
393 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
394 <varname>[periodic_invoices]</varname> den Login eines Benutzers
395 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
396 mit Informationen über die erstellten Rechnungen bekommt.</para>
398 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten Ausführung bestimmter Aufgaben mit, den <link
399 linkend="config.task-server">Taskserver</link>. Er wird u.a. für Features wie die <link
400 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link> benötigt, erledigt aber auch andere erforderliche Aufgaben
401 und muss daher in Betrieb genommen werden. Der Taskserver benötigt zwei Konfigurationseinstellungen, die unter
402 <varname>[task_server]</varname> anzugeben sind: ein Mandant (entweder der Mandantenname oder eine Datenbank-ID, Variable
403 <varname>client</varname>), aus dem die Datenbankkonfiguration entnommen wird, sowie ein Login (Variable <varname>login</varname>)
404 eines Benutzers, der für gewisse Dinge wie die Rechnungserstellung als Verkäufer eingetragen wird.</para>
406 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
407 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
410 <sect2 id="config.config-file.prior-versions">
411 <title>Versionen vor 2.6.3</title>
413 <para>In älteren kivitendo Versionen gab es im Verzeichnis
414 <filename>config</filename> die Dateien
415 <filename>authentication.pl</filename> und
416 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
417 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
418 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
419 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
421 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
422 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
423 manuell übertragen und die alten Konfigurationsdateien anschließend
424 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
425 entsprechende Fehlermeldung an.</para>
429 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
430 <title>Anpassung der PostgreSQL-Konfiguration</title>
432 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
434 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
435 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
437 <para>kivitendo setzt zwingend voraus, dass die Datenbank Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen Serverinstallationen
438 braucht man hier meist nicht einzugreifen.</para>
440 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so
441 braucht man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
443 <programlisting>su postgres
445 exit </programlisting>
447 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
448 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
449 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
452 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
454 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
455 Versionsnummer angepasst werden.</para>
457 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
459 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
460 <literal>\l</literal> geprüft werden.</para>
463 <sect2 id="Änderungen-an-Konfigurationsdateien">
464 <title>Änderungen an Konfigurationsdateien</title>
466 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
467 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
468 <filename>/var/lib/pgsql/data/</filename> oder
469 <filename>/etc/postgresql/</filename>, muss sichergestellt werden,
470 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
471 Parameter <varname>listen_address</varname> gesteuert. Laufen
472 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
473 <literal>localhost</literal> verwendet werden. Andernfalls müssen
474 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
475 was mit dem Wert <literal>*</literal> geschieht.</para>
477 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
478 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
479 sein sollte, müssen die Berichtigungen für den Zugriff geändert
480 werden. Hier gibt es mehrere Möglichkeiten. sinnvoll ist es nur die
481 nögiten Verbindungen immer zuzulassen, für eine lokal laufenden
482 Datenbank zum Beispiel:</para>
484 <programlisting>local all kivitendo password
485 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
488 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
489 <title>Erweiterung für servergespeicherte Prozeduren</title>
491 <para>In der Datenbank <literal>template1</literal> muss die
492 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
493 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
494 <programlisting>su - postgres
495 psql template1</programlisting>
497 führen Sie die folgenden Kommandos aus:</para>
499 <programlisting>create language 'plpgsql';
503 <sect2 id="Datenbankbenutzer-anlegen">
504 <title>Datenbankbenutzer anlegen</title>
506 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
507 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
508 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
511 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit nein
512 beantworten, genauso ist die Berechtigung neue User (Roles) zu
513 generieren nicht nötig.</para>
514 <programlisting>su - postgres
515 createuser -d -P kivitendo
516 exit</programlisting>
518 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
519 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.
520 den hier gewählten Benutzernamen.</para>
524 <sect1 id="Apache-Konfiguration">
525 <title>Webserver-Konfiguration</title>
528 <title>Grundkonfiguration mittels CGI</title>
531 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
532 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
533 <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
536 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
537 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
538 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
539 anderen Datei hinzu, die beim Starten des Webservers eingelesen
542 <programlisting>AddHandler cgi-script .pl
543 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
545 <Directory /var/www/kivitendo-erp>
546 Options ExecCGI Includes FollowSymlinks
549 <Directory /var/www/kivitendo-erp/users>
552 </Directory></programlisting>
554 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
555 das kivitendo-Archiv entpacket haben.</para>
558 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
559 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
562 <para>Auf einigen Webservern werden manchmal die Grafiken und
563 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
564 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
566 <programlisting>EnableSendfile Off</programlisting>
569 <sect2 id="Apache-Konfiguration.FCGI"
570 xreflabel="Konfiguration für FastCGI/FCGI">
571 <title>Konfiguration für FastCGI/FCGI</title>
573 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
574 <title>Was ist FastCGI?</title>
576 <para>Direkt aus <ulink
577 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
580 <para><citation> FastCGI ist ein Standard für die Einbindung
581 externer Software zur Generierung dynamischer Webseiten in einem
582 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
583 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
584 umgehen. </citation></para>
587 <sect3 id="Apache-Konfiguration.FCGI.Warum">
588 <title>Warum FastCGI?</title>
590 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
591 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
592 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
593 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
594 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
595 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
596 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
597 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
598 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
599 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
600 deutlich länger dauert als früher, und dass davon 90% für das Laden
601 der Module verwendet wird.</para>
603 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
604 wird nur die eigentliche Programmlogik ausgeführt.</para>
607 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
608 <title>Getestete Kombinationen aus Webservern und Plugin</title>
610 <para>Folgende Kombinationen sind getestet:</para>
614 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
618 <para>Apache 2.2.11 (Ubuntu) und mod_fastcgi.</para>
622 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
623 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
624 mod_fastcgi nicht mehr explizit eingegangen.</para>
626 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
630 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern
631 bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrere Installation gibt, muss zwingend Version 0.68 oder
632 aber Version 0.72 und neuer eingesetzt werden.</para>
634 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie sich die Vorgängerversion wie folgt
637 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
641 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
642 <title>Konfiguration des Webservers</title>
644 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
645 laufen zu lassen, empfliehlt es sich die Installation ersteinmal
646 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
647 debuggen die beim ersten aufsetzen auftreten können. Sollte die
648 Installation schon funktionieren, lesen Sie weiter.</para>
650 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
651 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
653 <programlisting>a2enmod fcgid</programlisting>
655 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
656 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
657 und <function>Directory</function>-Direktiven. Dabei wird zwischen
658 dem Installationspfad von kivitendo im Dateisystem
659 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
660 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
661 ("<filename>/url/for/kivitendo-erp</filename>").</para>
663 <para>Folgender Konfigurationsschnipsel funktioniert mit
666 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
667 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
669 <Directory /path/to/kivitendo-erp>
671 Options ExecCGI Includes FollowSymlinks
676 <DirectoryMatch /path/to/kivitendo-erp/users>
679 </DirectoryMatch></programlisting>
681 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
682 die maximale Größe eines Requests. Diese sollte wie folgt
683 hochgesetzt werden:</para>
685 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
687 <para>Das ganze sollte dann so aussehen:</para>
689 <programlisting>AddHandler fcgid-script .fpl
690 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
691 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
692 FcgidMaxRequestLen 10485760
694 <Directory /path/to/kivitendo-erp>
696 Options ExecCGI Includes FollowSymlinks
701 <DirectoryMatch /path/to/kivitendo-erp/users>
704 </DirectoryMatch></programlisting>
706 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
707 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
708 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
709 gibt es hier kleine Performance-Einbußen.</para>
711 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
712 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
713 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
715 <programlisting># Zugriff über CGI
716 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
718 # Zugriff mit mod_fcgid:
719 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
720 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
722 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
723 die normale Version erreichbar, und unter
724 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
725 FastCGI-Version.</para>
730 <sect1 id="config.task-server">
731 <title>Der Task-Server</title>
733 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und
734 diese zu festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess wird u.a. für die Erzeugung der wiederkehrenden
735 Rechnungen und weitere essenzielle Aufgaben benutzt.</para>
737 <sect2 id="Konfiguration-des-Task-Servers">
738 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
740 <para>Die Konfiguration erfolgt über den Abschnitt
741 <literal>[task_server]</literal> in der Datei
742 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
743 Optionen sind:</para>
747 <term><varname>client</varname></term>
750 <para>Name oder Datenbank-ID eines vorhandenen kivitendo-Mandanten, der benutzt wird, um die zu verwendende
751 Datenbankverbindung auszulesen. Der Mandant muss in der Administration angelegt werden. Diese Option muss angegeben
754 <para>Diese Option kam mit Release v3.x.0 hinzu und muss daher in Konfigurationen, die von älteren Versionen aktualisiert
755 wurden, ergänzt werden.</para>
760 <term><varname>login</varname></term>
763 <para>gültiger kivitendo-Benutzername, der z.B. als Verkäufer beim Erzeugen wiederkehrender Rechnungen benötigt wird. Der
764 Benutzer muss in der Administration angelegt werden. Diese Option muss angegeben werden.</para>
769 <term><varname>run_as</varname></term>
772 <para>Wird der Server vom Systembenutzer <literal>root</literal>
773 gestartet, so wechselt er auf den mit <literal>run_as</literal>
774 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
775 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
777 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
778 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
779 unter dem auch der Webserver läuft.</para>
784 <term><varname>debug</varname></term>
787 <para>Schaltet Debug-Informationen an und aus.</para>
793 <sect2 id="Einbinden-in-den-Boot-Prozess">
794 <title>Automatisches Starten des Task-Servers beim Booten</title>
796 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
797 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
798 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
800 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
801 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
802 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
803 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
804 anstelle eines symbolischen Links verwendet werden können.</para>
807 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, ältere Fedora Core)</title>
809 <para>Kopieren Sie die Datei
810 <filename>scripts/boot/system-v/kivitendo-server</filename>
811 nach <filename>/etc/init.d/kivitendo-server</filename>. Passen
812 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
813 <literal>DAEMON=....</literal>). Binden Sie das Script in den
814 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
818 <para>Debian-basierende Systeme:</para>
820 <programlisting>update-rc.d kivitendo-task-server defaults
821 # Nur bei Debian Squeeze und neuer:
822 insserv kivitendo-task-server</programlisting>
826 <para>Ältere OpenSUSE und ältere Fedora Core:</para>
828 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
832 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
835 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
839 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
841 <para>Kopieren Sie die Datei
842 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
843 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
844 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
845 <literal>exec ....</literal>).</para>
847 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
850 <programlisting>service kivitendo-task-server start</programlisting>
854 <title>systemd-basierende Systeme (z.B. neure OpenSUSE, neuere Fedora Core)</title>
856 <para>Verlinken Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
857 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
858 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>). Binden Sie das Script in den Boot-Prozess ein.
861 <para>Alle hierzu benötigten Befehle sehen so aus:</para>
863 <programlisting>cd /var/www/kivitendo-erp/scripts/boot/systemd
864 ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
866 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
869 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
873 <sect2 id="Prozesskontrolle">
874 <title>Wie der Task-Server gestartet und beendet wird</title>
876 <para>Der Task-Server wird wie folgt kontrolliert:</para>
878 <programlisting>./scripts/task_server.pl Befehl</programlisting>
880 <para><literal>Befehl</literal> ist dabei eine der folgenden
885 <para><literal>start</literal> startet eine neue Instanz des
886 Task-Servers. Die Prozess-ID wird innerhalb des
887 <filename>users</filename>-Verzeichnisses abgelegt.</para>
891 <para><literal>stop</literal> beendet einen laufenden
896 <para><literal>restart</literal> beendet und startet ihn
901 <para><literal>status</literal> berichtet, ob der Task-Server
906 <para>Der Task-Server wechselt beim Starten automatisch in das
907 kivitendo-Installationsverzeichnis.</para>
909 <para>Dieselben Optionen können auch für die SystemV-basierenden
910 Runlevel-Scripte benutzt werden (siehe oben).</para>
912 <sect2 id="Prozesskontrolle2">
913 <title>Task-Server mit mehreren Mandanten</title>
915 <para>Beim Task-Server werden der zu verwendende Mandant und Login-Name des Benutzers, unter dem der Task-Server laufen soll, in die
916 Konfigurationsdatei geschrieben. Hat man mehrere Mandanten, muss man auch mehrere Konfigurationsdateien anlegen.</para>
918 <para>Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf, wo in der Kategorie <varname>[task_server]</varname> die
919 gewünschten Werte für <varname>client</varname> und <varname>login</varname> eingetragen werden.</para>
921 <para>Der alternative Task-Server wird dann mit folgendem Befehl
924 <programlisting>./scripts/task_server.pl -c config/DATEINAME.conf</programlisting>
928 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
929 <title>Benutzerauthentifizierung und Administratorpasswort</title>
931 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
932 über die Verwaltung von Gruppen und weitere Einstellungen</para>
934 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
935 <title>Grundlagen zur Benutzerauthentifizierung</title>
937 <para>kivitendo verwaltet die Benutzerinformationen in einer
938 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
939 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
940 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
941 können, müssen aber nicht unterschiedlich sein.</para>
943 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
944 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
945 abgelegt werden.</para>
947 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
948 entweder gegen die Authentifizierungsdatenbank oder gegen einen
949 LDAP-Server überprüft werden.</para>
951 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
952 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
953 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
954 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
955 einer Version vor v2.6.0 angelegt werden. Eine
956 Beispielkonfigurationsdatei
957 <filename>config/kivitendo.conf.default</filename> existiert, die als
958 Vorlage benutzt werden kann.</para>
961 <sect2 id="Administratorpasswort">
962 <title>Administratorpasswort</title>
964 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
965 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
966 nur dort und nicht mehr im Administrationsinterface selber geändert
967 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
968 Abschnitt <varname>[authentication]</varname>.</para>
971 <sect2 id="Authentifizierungsdatenbank">
972 <title>Authentifizierungsdatenbank</title>
974 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
975 Parametern in <varname>[authentication/database]</varname>
976 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
980 <term><literal>host</literal></term>
983 <para>Der Rechnername oder die IP-Adresse des
984 Datenbankservers</para>
989 <term><literal>port</literal></term>
992 <para>Die Portnummer des Datenbankservers, meist 5432</para>
997 <term><literal>db</literal></term>
1000 <para>Der Name der Authentifizierungsdatenbank</para>
1005 <term><literal>user</literal></term>
1008 <para>Der Benutzername, mit dem sich kivitendo beim
1009 Datenbankserver anmeldet (z.B.
1010 "<literal>postgres</literal>")</para>
1015 <term><literal>password</literal></term>
1018 <para>Das Passwort für den Datenbankbenutzer</para>
1023 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1024 automatisch anlegen (mehr dazu siehe unten).</para>
1027 <sect2 id="Passwortüberprüfung">
1028 <title>Passwortüberprüfung</title>
1030 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1031 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1032 Active-Directory-Server. Welche davon benutzt wird, regelt der
1033 Parameter <varname>module</varname> im Abschnitt
1034 <varname>[authentication]</varname>.</para>
1036 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1037 gespeichert werden, so muss der Parameter <varname>module</varname>
1038 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1039 der Administrator als auch die Benutzer selber ihre Psaswörter in
1040 kivitendo ändern.</para>
1042 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1043 benutzt werden, so muss der Parameter <varname>module</varname> auf
1044 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1045 zusätzliche Informationen über den LDAP-Server im Abschnitt
1046 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1050 <term><literal>host</literal></term>
1053 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1054 Active-Directory-Servers. Diese Angabe ist zwingend
1055 erforderlich.</para>
1060 <term><literal>port</literal></term>
1063 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1068 <term><literal>tls</literal></term>
1071 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1072 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1073 ‘<literal>0</literal>’ belassen</para>
1078 <term><literal>attribute</literal></term>
1081 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1082 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1083 meist ‘<literal>sAMAccountName</literal>’, für andere
1084 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1085 zwingend erforderlich.</para>
1090 <term><literal>base_dn</literal></term>
1093 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1094 Diese Angabe ist zwingend erforderlich.</para>
1099 <term><literal>filter</literal></term>
1102 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1103 <literal><%login%></literal>, so wird dieses durch den vom
1104 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1105 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1106 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1111 <term><literal>bind_dn</literal> und
1112 <literal>bind_password</literal></term>
1115 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1116 durchsucht werden kann (z.B. ist dies bei
1117 Active-Directory-Servern der Fall), so kann diese hier angegeben
1118 werden. Für Active-Directory-Server kann als
1119 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1120 z.B. ‘<literal>cn=Martin
1121 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1122 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1123 also ‘<literal>Martin Mustermann</literal>’.</para>
1129 <sect2 id="Name-des-Session-Cookies">
1130 <title>Name des Session-Cookies</title>
1132 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1133 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1134 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1135 Parameter <varname>cookie_name</varname> im Abschnitt
1136 <varname>[authentication]</varname>gesetzt.</para>
1138 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1139 Server existiert.</para>
1142 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1143 <title>Anlegen der Authentifizierungsdatenbank</title>
1145 <para>Nachdem alle Einstellungen in
1146 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1147 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1148 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1149 der folgenden URL erreichbar sein sollte:</para>
1152 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1156 <sect1 id="Benutzer--und-Gruppenverwaltung">
1157 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1159 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und Datenbanken angelegt werden. Dieses geschieht im
1160 Administrationsmenü, das Sie unter folgender URL finden:</para>
1163 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1165 <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
1166 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1168 <sect2 id="Zusammenhänge">
1169 <title>Zusammenhänge</title>
1171 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung in einer oder zwei Datenbanken gespeichert werden.</para>
1173 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat
1174 Zugriff auf welche Mandanten, und welche Gruppe verfügt über welche Rechte. Diese Informationen werden in der
1175 Authentifizierungsdatenbank gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter in der Konfigurationsdatei
1176 <filename>config/kivitendo.conf</filename> gespeichert werden.</para>
1178 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten, Waren) und Belege
1179 (Angebote, Lieferscheine, Rechnungen). Diese werden in einer Mandantendatenbank gespeichert. Die
1180 Verbindungsinformationen einer solchen Mandantendatenbank werden im Administrationsbereich konfiguriert, indem man einen Mandanten
1181 anlegt und dort die Parameter einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1183 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich, die Authentifizierungsdatenbank und eine der
1184 Mandantendatenbanken in ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit mehr als einem Mandanten, wird
1185 empfohlen, für die Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die nicht gleichzeitig für einen Mandanten
1186 verwendet wird.</para>
1189 <sect2 id="Mandanten-Benutzer-Gruppen">
1190 <title>Mandanten, Benutzer und Gruppen</title>
1192 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen, die sich frei zueinander zuordnen lassen.</para>
1194 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1195 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1196 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank. Diese sollte über die <link
1197 linkend="Datenbanken-anlegen">Datenbankverwaltung</link> geschehen.</para>
1199 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten soll. Sie erhält einen Loginnamen sowie ein
1200 Passwort. Weiterhin legt der Administrator fest, an welchen Mandanten sich ein Benutzer anmelden kann, was beim Login verifiziert
1203 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür
1204 vom Administrator gewisse Rechte zugeordnet. Weiterhin legt der Administrator fest, für welche Mandanten eine Gruppe gilt, und
1205 welche Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer dann an einem Mandanten an, so erhält er alle Rechte von
1206 allen denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in denen der Benutzer zum Anderen Mitglied ist, </para>
1208 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und Benutzer angelegt werden, kann im Prinzip beliebig gewählt
1209 werden. Die folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1211 <orderedlist numeration="arabic">
1213 <para>Datenbank anlegen</para>
1217 <para>Gruppen anlegen</para>
1221 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1225 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1230 <sect2 id="Datenbanken-anlegen">
1231 <title>Datenbanken anlegen</title>
1233 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1234 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1235 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1238 <sect2 id="Gruppen-anlegen">
1239 <title>Gruppen anlegen</title>
1241 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1242 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1243 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1244 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1246 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank gespeichert, gelten aber nicht automatisch für alle
1247 Mandanten. Der Administrator legt vielmehr fest, für welche Mandanten eine Gruppe gültig ist. Dies kann entweder beim Bearbeiten der
1248 Gruppe geschehen ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn man einen Mandanten bearbeitet ("für diesen
1249 Mandanten sind die Gruppen A, B und C gültig").</para>
1251 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder dieser Gruppe festgelegt werden ("in dieser Gruppe sind die
1252 Benutzer X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten eines Benutzers geschehen ("dieser Benutzer ist
1253 Mitglied in den Gruppen A, B und C").</para>
1256 <sect2 id="Benutzer-anlegen">
1257 <title>Benutzer anlegen</title>
1259 <para>Beim Anlegen von Benutzern werden für viele Parameter Standardeinstellungen vorgenommen, die den Gepflogenheiten des deutschen
1260 Raumes entsprechen.</para>
1262 <para>Zwingend anzugeben ist der Loginname. Wenn die Passwortauthentifizierung über die Datenbank eingestellt ist, so kann hier auch
1263 das Benutzerpasswort gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1266 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier auch konfiguriert werden, auf welche Mandanten der Benutzer
1267 Zugriff hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können sowohl beim Benutzer vorgenommen werden ("dieser
1268 Benutzer hat Zugriff auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen X, Y und Z") als auch beim Mandanten ("auf
1269 diesen Mandanten haben Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe sind Benutzer A, B und C
1270 Mitglieder").</para>
1273 <sect2 id="Mandanten-anlegen">
1274 <title>Mandanten anlegen</title>
1276 <para>Ein Mandant besteht aus Administrationssicht primär aus einem eindeutigen Namen. Weiterhin wird hier hinterlegt, welche
1277 Datenbank als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten einer der eben angelegten Datenbanken eingetragen
1280 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch konfiguriert werden, welche Benutzer Zugriff auf den
1281 Mandanten haben bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen können sowohl beim Mandanten vorgenommen werden
1282 ("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
1283 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
1288 <sect1 id="config.sending-email" xreflabel="E-Mail-Versand aus kivitendo heraus">
1289 <title>E-Mail-Versand aus kivitendo heraus</title>
1291 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden, z.B. um ein Angebot direkt an einen Kunden zu
1292 verschicken. Damit dies funktioniert, muss eingestellt werden, über welchen Server die E-Mails verschickt werden sollen. kivitendo
1293 unterstützt dabei zwei Mechanismen: Versand über einen lokalen E-Mail-Server (z.B. mit <productname>Postfix</productname> oder
1294 <productname>Exim</productname>, was auch die standardmäßig aktive Methode ist) sowie Versand über einen SMTP-Server (z.B. der des
1295 eigenen Internet-Providers).</para>
1297 <para>Welche Methode und welcher Server verwendet werden, wird über die Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1298 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1300 <sect2 id="config.sending-email.sendmail" xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1301 <title>Versand über lokalen E-Mail-Server</title>
1303 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie
1304 z.B. <productname>Postfix</productname>, <productname>Exim</productname> oder <productname>Sendmail</productname> läuft.</para>
1306 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1307 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1309 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet wird, dient der Parameter '<literal>sendmail =
1310 ...</literal>'. Der Standardwert verweist auf das Programm <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1311 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1313 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen dieses sprengen. Hierfür sei auf die Dokumentation des
1314 E-Mail-Servers verwiesen.</para>
1317 <sect2 id="config.sending-email.smtp" xreflabel="E-Mail-Versand über einen SMTP-Server">
1318 <title>Versand über einen SMTP-Server</title>
1320 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server vorhanden oder zwar einer vorhanden, dieser aber nicht
1321 konfiguriert ist.</para>
1323 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1324 Parameter dienen dabei der weiteren Konfiguration:</para>
1328 <term><varname>hostname</varname></term>
1330 <listitem><para>Name oder IP-Adresse des SMTP-Servers. Standardwert: '<literal>localhost</literal>'</para></listitem>
1334 <term><varname>port</varname></term>
1336 <listitem><para>Portnummer. Der Standardwert hängt von der verwendeten Verschlüsselungsmethode ab. Gilt '<literal>security =
1337 none</literal>' oder '<literal>security = tls</literal>', so ist 25 die Standardportnummer. Für '<literal>security =
1338 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht geändert werden.</para></listitem>
1342 <term><varname>security</varname></term>
1344 <listitem><para>Wahl der zu verwendenden Verschlüsselung der Verbindung mit dem Server. Standardwert ist
1345 '<literal>none</literal>', wodurch keine Verschlüsselung verwendet wird. Mit '<literal>tls</literal>' wird TLS-Verschlüsselung
1346 eingeschaltet, und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL eingeschaltet. Achtung: Für
1347 '<literal>tls</literal>' und '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt (siehe unten).</para></listitem>
1351 <term><varname>login</varname> und <varname>password</varname></term>
1353 <listitem><para>Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername
1354 und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von
1355 Verschlüsselung aktiviert werden.</para></listitem>
1359 <para>Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind:</para>
1362 <listitem><para>TLS-Verschlüsselung: Modul <literal>Net::SSLGlue</literal> (Debian-Paketname
1363 <literal>libnet-sslglue-perl</literal>, Fedora Core: <literal>perl-Net-SSLGlue</literal>, openSUSE:
1364 <literal>perl-Net-SSLGlue</literal></para></listitem>
1366 <listitem><para>SSL-Verschlüsselung: Modul <literal>Net::SMTP::SSL</literal> (Debian-Paketname
1367 <literal>libnet-smtp-ssl-perl</literal>, Fedora Core: <literal>perl-Net-SMTP-SSL</literal>, openSUSE:
1368 <literal>perl-Net-SMTP-SSL</literal></para></listitem>
1373 <sect1 id="Drucken-mit-kivitendo">
1374 <title>Drucken mit kivitendo</title>
1376 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. Um drucken zu können, braucht der Server ein geeignetes
1377 LaTeX System. Am einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter Debianoiden Betriebssystemen installiert man
1378 die Pakete mit:</para>
1380 <para><programlisting>aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1381 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1383 <para>TODO: RPM-Pakete.</para>
1385 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1387 <listitem><para>Standard</para></listitem>
1388 <listitem><para>f-tex</para></listitem>
1389 <listitem><para>RB</para></listitem>
1392 <sect2 id="Vorlagenverzeichnis-anlegen" xreflabel="Vorlagenverzeichnis anlegen">
1393 <title>Vorlagenverzeichnis anlegen</title>
1394 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1396 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1398 <para>Der Angemmeldete Benutzer muss in einer Gruppe sein, die über das
1399 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch <xref linkend="Gruppen-anlegen"/>.
1401 <para>Im Userbereich lässt sich unter:
1402 "<guimenu>System</guimenu> ->
1403 <guisubmenu>Mandantenverwaltung</guisubmenu> -> <guimenuitem>Verschiedenes</guimenuitem>" die Option
1404 "Neue Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1407 <listitem><para><option>Vorlagen auswählen</option>: Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll
1408 (<filename>Standard</filename>, <filename>f-tex</filename> oder <filename>RB</filename>.)</para></listitem>
1409 <listitem><para><option>Neuer Name</option>: Der Verzeichnisname für den neuen Vorlagensatz. Dieser kann im Rahmen der üblichen
1410 Bedingungen für Verzeichnisnamen frei gewählt werden.</para></listitem>
1413 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist für den aktuellen Mandanten ausgewählt.
1414 Der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1415 Eventuell muessen Anpassungen (Logo, Erscheinungsbild, etc) noch vorgenommen werden. Den Ordner findet man im Dateisistem unter
1416 <filename>./templates/[Neuer Name]</filename></para>
1420 <sect2 id="Vorlagen-Standard">
1421 <title>Standard</title>
1423 <para>Der Standard-Vorlagensatz von Kivitendo. Wie unter <ulink url="http://demo.kivitendo.org">http://demo.kivitendo.org</ulink> zu
1429 <title>f-tex</title>
1431 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt.</para>
1433 <sect3 id="f-tex-Feature-Übersicht">
1434 <title>Feature-Übersicht</title>
1436 <listitem><para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage für alle briefartigen Dokumente verwendet. Also
1437 Angebot, Rechnung, Performarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc..</para></listitem>
1439 <listitem><para>Leichte Anpassung an das Firmen-Layout durch verwendung eines Hintergrund-PDF. Dieses kann leicht mit dem
1440 eigenen Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp, Adobe*)</para></listitem>
1442 <listitem><para>Hintergrund-PDF umschaltbar auf "nur erste Seite" (Standard) oder "alle Seiten" (Option
1443 "<option>bgPdfFirstPageOnly</option>" in Datei <filename>letter.lco</filename>)</para></listitem>
1445 <listitem><para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1446 versendeten Dokumenten eingebunden (Option "<option>bgPdfEmailOnly</option>" in Datei
1447 <filename>letter.lco</filename>).</para></listitem>
1449 <listitem><para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch, Wiederholung von Kopfzeilen, Zwischensummen
1450 etc. (danke an Kai-Martin Knaak für die Vorarbeit)</para></listitem>
1452 <listitem><para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom Land des eigenen Unternehmens abweicht (also die
1453 Rechnung das Land verlässt).</para></listitem>
1455 <listitem><para>Multisprachfähig leicht um weitere Sprachen zu erweitern, alle Übersetzungen in der Datei
1456 <filename>translatinos.tex</filename>.</para></listitem>
1458 <listitem><para>Auflistung von Bruttopreisen für Endverbraucher.</para></listitem>
1462 <sect3 id="f-tex-Installation">
1463 <title>Die Installation</title>
1465 <listitem><para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref linkend="Vorlagenverzeichnis-anlegen"/>. Das
1466 Vorlagensystem funktioniert jetzt schon, hat allerdings noch einen Beispiel-Briefkopf.</para></listitem>
1468 <listitem><para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach <filename>./letter_head.pdf</filename>.</para></listitem>
1469 <listitem><para>Editiere den Bereich "<option>settings</option>" in der datei <filename>letter.lco</filename>.</para></listitem>
1472 <para>oder etwas Detaillierter:</para>
1475 Es wird eine Datei <filename>sample.lco</filename> erstellt und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
1476 ist dies die Datei die für die Firmenspezifischen Anpassungen gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig
1477 ist, wird in dieser Datei auf ein Hintergrundpdf verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen
1478 vorzunehmen und <filename>sample.lco</filename> unverändert zu lassen. Die die Anpassung über eine
1479 <filename>*.lco</filename>-Datei die letztlich auf <filename>letter.lco</filename> verlinkt ist ist aber auch möglich.
1483 Es wird eine Datei <filename>sample_head.pdf</filename> mit ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
1484 verlinkt. Damit gibt es schon mal eine Funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei
1485 <filename>sample_haed.pdf</filename> an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
1486 Template Verzeichniss ablegen und statt <filename>sample_head.pdf</filename> nach <filename>letter_head.pdf</filename>
1491 letzlich muss <filename>letter_head.pdf</filename> auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
1492 enthält. Bei Updates oder nach erneutem
1496 Es wird eine Datei <filename>mydata.tex.example</filename> ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
1497 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das Land verwendet. Die Datei muss also nicht angefasst
1498 werden. Die Anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig).
1501 Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc. sollten über die Hintergrund-PDF-Datei oder die
1502 <filename>*.lco</filename>-Datei erfolgen.
1506 <sect3 id="f-tex-Funktionsübersicht">
1507 <title>f-tex Funktionsübersicht</title>
1509 Das Konzept von kivitendo sieht vor, für jedes Dokument (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine LaTeX-Vorlage
1510 vorzuhalten, dies ist sehr Wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
1511 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
1512 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche LaTeX-Vorlage verwendet, welche über Codeweichen die
1513 Besonderheiten der jeweiligen Dokumente Berücksichtigt.
1517 <listitem><para>Tabellen mit oder ohne Preis</para></listitem>
1518 <listitem><para>Sprache der Tabellenüberschriften etc.</para></listitem>
1519 <listitem><para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus Angebotsnummer)</para></listitem>
1520 <listitem><para>Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus Gewerblicher
1521 Kunde)</para></listitem>
1524 <para>Nachteil:</para>
1527 LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
1528 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann natürlich
1529 auch innerhalb der Tabellendarstellung gut persönliche Anpassungen vornehmen. Aber man kann sich hier bei Veränderungen sehr
1530 schnell häftig in den Fuss schiessen.
1533 <para>Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund PDF auf Basis der
1534 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen, und sich an der Form der dargestellten Tabellen wie sie
1535 ausgeliefert werden, erfreuen.
1538 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine kontinuierliche Schritte gehen.</para>
1542 <sect3 id="f-tex-Bruttopreise">
1543 <title>Bruttopreise für Endverbraucher</title>
1545 <para>Der auszuweisende Bruttopreis wird innerhalb der LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen "alle
1546 Preise Brutto" auszuwählen, aber:</para>
1549 <para>hierfür müssen die Preise auch in Brutto in der Datenbank stehen (ja - das lässt sich über die Preisgruppen und die
1550 Zuordung einer Default-Preisgruppe handhaben)</para>
1553 <para>man darf beim Anlegen des Vorgangs nicht vergessen Dieses Häkchen zu setzen. (das ist in der Praxis wenn man sowohl
1554 Endverbraucher- wie Gewerbekunden beliefert der eigentliche Knackpunkt)</para>
1559 Es gibt mit f-tex eine weitere Alternative. Die Information ob Brutto oder Nettorechnung wird mit den Zahlarten
1560 verknüpft. Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben werden sollen, enden mit "_E" (für
1561 Endverbraucher). Falls identische Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt man diese einfach doppelt
1562 an (einmal mit der Namensendung "_E"). Gewinn:</para>
1565 <listitem><para>Die Entscheidung, ob Netopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste Verbunden.</para></listitem>
1566 <listitem><para>Die Default-Zahlart kann im Kundendatensatz hinterlegt werden, und man muss nicht mehr daran denken, "alle Preise
1567 Netto" auszuwählen.</para></listitem>
1568 <listitem><para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken reviediert werden,
1569 ohne dass sich der Auftragswert ändert.</para></listitem>
1573 <sect3 id="f-tex-lieferadressen">
1574 <title>Lieferadressen</title>
1576 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen im Adressfeld zum Einsatz. Wenn die
1577 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende Adressvariable eingesetzt. Wenn also die Lieferadresse in
1578 Straße, Hausnummer und Ort abweicht, müssen auch nur diese Felder in der Lieferadresse ausgefüllt werden. Für den Firmenname wird
1579 der Wert der Hauptadresse angezeigt.
1584 <sect2 id="Vorlagen-RB">
1587 <para>Vollständiger Dokumentensatz mit alternativem Design</para>
1588 <para>Die konzeptionelle Idee wird <ulink
1589 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1590 auf Folie 5 bis 10 vorgestellt, Detaileinstellungen dann im Readme.tex im Vorlagenverzeichnis.</para>
1594 <sect2 id="allgemeine-hinweise-zu-latex">
1595 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
1596 <para>In den allermeisten Installationen sollte drucken jetzt schon
1597 funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
1598 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
1599 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1604 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1605 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1606 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1610 <para>! Package inputenc Error: Unicode char \u8:... set up for
1611 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1612 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1613 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1614 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1615 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1619 <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
1620 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1621 Prüfen Sie den Namen in der Konfiguration (Standard:
1622 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1623 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1626 <para>Wenn sich das Problem nicht auf Grund der ausgabe im Webbrowser verifizieren lässt:</para>
1629 <para> editiere [kivitendo-home]/config/kivitendo.conf und ändere "keep_temp_files" auf 1</para>
1630 <para><programlisting>keep_temp_files = 1;</programlisting></para>
1633 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
1636 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
1639 <para>wechsele in das users Verzeichnis von kivitendo</para>
1640 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
1643 <para>LaTeX Suchpfad anpassen:</para>
1644 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
1647 <para>Finde herraus welche Datei kivitendo beim letzten Durchlauf erstellt hat</para>
1648 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
1649 <para>Es sollte die letzte Datei ganz unten sein</para>
1652 <para>für besseren Hinweis auf Fehler texdatei nochmals übersetzen</para>
1653 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
1654 <para>in der *.tex datei nach dem Fehler suchen.</para>
1660 <sect1 id="OpenDocument-Vorlagen">
1661 <title>OpenDocument-Vorlagen</title>
1663 <para>kivitendo unterstützt die Verwendung von Vorlagen im
1664 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1665 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1666 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1667 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1668 <filename>config/kivitendo.conf</filename> die Variable
1669 <literal>opendocument</literal> im Abschnitt
1670 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1671 Dieses ist die Standardeinstellung.</para>
1673 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1674 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1675 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1676 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1677 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1678 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1680 <para>Nach der Installation müssen in der Datei
1681 <filename>config/kivitendo.conf</filename> zwei weitere Variablen
1682 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1683 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1684 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1685 enthalten. Beide stehen im Abschnitt
1686 <literal>applications</literal>.</para>
1688 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
1689 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1690 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1691 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1692 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1693 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1694 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1695 werden muss. Der Nachteil ist, dass diese Methode Python und die
1696 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1701 Für die Verbindung zu OpenOffice wird normalerweise der Python-Interpreter <filename>/usr/bin/python</filename> benutzt. Sollte
1702 dies nicht der richtige sein, so kann man mit zwei Konfigurationsvariablen entscheiden, welcher Python-Interpreter genutzt
1703 wird. Mit der Option <literal>python_uno</literal> aus dem Abschnitt <literal>applications</literal> wird der Interpreter selber
1704 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert <literal>/usr/bin/python</literal>.
1708 Zusätzlich ist es möglich, Pfade anzugeben, in denen Python neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
1709 z.B. falls sich diese in einem gesonderten OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
1710 <literal>python_uno_path</literal> und befindet sich im Abschnitt <literal>environment</literal>. Sie ist standardmäßig
1711 leer. Werden hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte voneinander getrennt werden. Der Inhalt wird an den
1712 Python-Interpreter über die Umgebungsvariable <literal>PYTHONPATH</literal> übergeben.
1716 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1717 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1718 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1719 Dokumentenvorlage enthalten sein und
1720 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1721 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1722 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1723 ebenfalls enthalten sein muss.</para>
1725 <para>Als letztes muss herausgefunden werden, welchen Namen
1726 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1727 gibt. Unter Debian ist dies momentan
1728 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1729 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1730 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1731 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1732 folgender Befehl auszuführen:</para>
1734 <para><literal>mv users/.openoffice.org2
1735 users/.openoffice</literal></para>
1737 <para>Dieses Verzeichnis, wie auch das komplette
1738 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1739 sein. Dieses wurde bereits erledigt (siehe <xref
1740 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1741 erneut überprüft werden, wenn die Konvertierung nach PDF
1745 <sect1 id="config.eur">
1746 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1749 <sect2 id="config.eur.introduction"
1750 xreflabel="Einführung in die Konfiguration zur EUR">
1751 <title>Einführung</title>
1753 <para>kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1754 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals noch <filename>config/lx_office.conf</filename>)
1755 befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden.</para>
1757 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1758 die Mandantendatenbank verschoben und dabei auch gleich in drei
1759 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1760 steuern lässt.</para>
1763 <sect2 id="config.eur.parameters"
1764 xreflabel="Konfigurationsparameter für EUR">
1765 <title>Konfigurationsparameter</title>
1767 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1768 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1772 <term><varname>profit_determination</varname></term>
1775 <para>Dieser Parameter legt die Berechnungsmethode für die
1776 Gewinnermittlung fest. Er enthält entweder
1777 <literal>balance</literal> für
1778 Betriebsvermögensvergleich/Bilanzierung oder
1779 <literal>income</literal> für die
1780 Einnahmen-Überschuss-Rechnung.</para>
1785 <term><varname>accounting_method</varname></term>
1788 <para>Dieser Parameter steuert die Buchungs- und
1789 Berechnungsmethoden für die Versteuerungsart. Er enthält
1790 entweder <literal>accrual</literal> für die Soll-Versteuerung
1791 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1796 <term><varname>inventory_system</varname></term>
1799 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1800 enthält entweder <literal>perpetual</literal> für die
1801 Bestandsmethode oder <literal>periodic</literal> für die
1802 Aufwandsmethode.</para>
1807 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1808 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1809 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1810 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1811 Bestandsmethode.</para>
1813 <para>Die Konfiguration "<varname>eur</varname>" unter
1814 <varname>[system]</varname> in der <link
1815 linkend="config.config-file">Konfigurationsdatei</link>
1816 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
1817 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1820 <sect2 id="config.eur.setting-parameters">
1821 <title>Festlegen der Parameter</title>
1823 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1824 der Admininstration können diese Optionen nun unabhängig voneinander
1825 eingestellt werden.</para>
1827 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1828 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1831 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1832 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
1833 angezeigt. Unter <guimenu>System</guimenu>
1834 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> können
1835 die Einstellungen auch geändert werden. Dabei ist zu beachten,
1836 dass eine Änderung vorhandene Daten so belässt und damit
1837 evtl. die Ergebnisse verfälscht. Dies gilt vor Allem für die
1838 Warenbuchungsmethode (siehe auch
1839 <link linkend="config.eur.inventory-system-perpetual">
1840 Bemerkungen zu Bestandsmethode</link>).</para>
1843 <sect2 id="config.eur.inventory-system-perpetual">
1844 <title>Bemerkungen zu Bestandsmethode</title>
1846 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1847 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
1848 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1849 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1850 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1851 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1852 Einkaufsrechnungen berechnet wird.</para>
1854 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1855 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1856 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1860 <sect2 id="config.eur.knonw-issues">
1861 <title>Bekannte Probleme</title>
1863 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1864 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1865 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1866 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1867 die Konfigurationsvariable
1868 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1871 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1872 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1876 <sect1 id="config.skr04-update-3804">
1877 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1879 <sect2 id="config.skr04-update-3804.introduction">
1880 <title>Einführung</title>
1882 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1883 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1884 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1885 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1886 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1887 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1888 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1889 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1890 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1891 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1892 Screenshots dargestellt.</para>
1894 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1895 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1896 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1897 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1900 <sect2 id="config.skr04-update-3804.create-chart">
1901 <title>Konto 3804 manuell anlegen</title>
1903 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
1904 anzulegen und zu konfigurieren. Zuerst wird in
1905 <guimenu>System</guimenu> ->
1906 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
1907 erfassen</guimenuitem> das Konto angelegt.</para>
1910 <screeninfo>Konto 3804 erfassen</screeninfo>
1914 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
1920 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
1921 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
1922 wie im folgenden Screenshot angezeigt anpassen.
1926 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
1930 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
1936 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
1937 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
1941 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
1945 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
1951 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
1952 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
1953 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
1954 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
1958 <screeninfo>Konto 4315 anpassen</screeninfo>
1962 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
1968 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
1969 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
1973 <screeninfo>Steuerliste vergleichen</screeninfo>
1977 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
1984 <sect1 id="config.client">
1985 <title>Einstellungen pro Mandant</title>
1987 <para>Einige Einstellungen können von einem Benutzer mit dem
1988 <link linkend="Zusammenhänge">Recht</link> "Administration
1989 (Für die Verwaltung der aktuellen Instanz aus einem Userlogin heraus)"
1990 gemacht werden. Diese Einstellungen sind dann für die aktuellen
1991 Mandanten-Datenbank gültig. Die Einstellungen sind
1992 unter <guimenu>System</guimenu>
1993 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
1995 <para>Bitte beachten Sie die Hinweise zu den einzelnen
1996 Einstellungen. Einige Einstellungen sollten nicht ohne Weiteres
1997 im laufenden Betrieb geändert werden (siehe
1998 auch <link linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
1999 Bestandsmethode</link>).</para>
2001 <para>Die Einstellungen <literal>show_bestbefore</literal>
2002 und <literal>payments_changeable</literal> aus dem
2003 Abschnitt <literal>features</literal> und die Einstellungen im
2004 Abschnitt <literal>datev_check</literal> (sofern schon vorhanden)
2005 der <link linkend="config.config-file">kivitendo-Konfigurationsdatei</link>
2006 werden bei einem Datenbankupdate einer älteren Version automatisch
2007 übernommen. Diese Einträge können danach aus der Konfigurationsdatei
2008 entfernt werden.</para>
2011 <sect1 id="kivitendo-ERP-verwenden">
2012 <title>kivitendo ERP verwenden</title>
2014 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
2015 folgender URL erreichbar:</para>
2018 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
2020 <para>Die Administrationsseite erreichen Sie unter:</para>
2023 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
2027 <chapter id="features" xreflabel="Features und Funktionen">
2028 <title>Features und Funktionen</title>
2030 <sect1 id="features.periodic-invoices"
2031 xreflabel="Wiedekehrende Rechnungen">
2032 <title>Wiederkehrende Rechnungen</title>
2034 <sect2 id="features.periodic-invoices.introduction"
2035 xreflabel="Einführung in wiederkehrende Rechnungen">
2036 <title>Einführung</title>
2038 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
2039 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
2040 Die konfigurierten Aufträge werden später automatisch in Rechnungen
2041 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
2042 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
2043 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
2044 wiederzufinden sind.</para>
2047 <sect2 id="features.periodic-invoices.configuration"
2048 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
2049 <title>Konfiguration</title>
2051 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
2052 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
2053 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
2054 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
2055 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
2058 <para>Folgende Parameter kann man konfigurieren:</para>
2065 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
2066 erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
2067 neuen Monats).</para>
2069 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
2070 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
2071 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
2072 nächsten Periodenwechsel für alle Perioden, seit der letzten
2073 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
2074 verhindern, muss man vorher das Startdatum neu setzen.</para>
2076 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
2077 erstellt. Man kann sich diese Aufträge aber gesondert in den
2078 Berichten anzeigen lassen.</para>
2083 <term>Periodizität</term>
2086 <para>Ob monatlich, quartalsweise oder jährlich auf neue
2087 Rechnungen überprüft werden soll. Für jede Periode seit dem
2088 Startdatum wird überprüft, ob für die Periode (beginnend immer
2089 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
2090 wurde. Unter Umständen können bei einem Startdatum in der
2091 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
2096 <term>Buchen auf</term>
2099 <para>Das Forderungskonto, in der Regel "Forderungen aus
2100 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
2101 Buchungsgruppen der betreffenden Waren.</para>
2106 <term>Startdatum</term>
2109 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
2115 <term>Enddatum</term>
2118 <para>ab wann keine Rechnungen mehr erstellt werden
2124 <term>Automatische Verlängerung um x Monate</term>
2127 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
2128 eingetragenen Enddatums weiterhin erstellt werden, so kann man
2129 hier die Anzahl der Monate eingeben, um die das Enddatum
2130 automatisch nach hinten geschoben wird.</para>
2135 <term>Drucken</term>
2138 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
2139 Rechnungen auch gleich ausdrucken lassen.</para>
2144 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
2145 Informationen zu den erstellten Rechnungen verschickt werden.
2146 Konfiguriert wird dies in der <link
2147 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
2148 <filename>config/kivitendo.conf</filename> im Abschnitt
2149 <varname>[periodic_invoices]</varname>.</para>
2152 <sect2 id="features.periodic-invoices.variables">
2153 <title>Spezielle Variablen</title>
2156 Um die erzeugten Rechnungen individualisieren zu können, werden beim Umwandeln des Auftrags in eine Rechnung einige speziell
2157 formatierte Variablen durch für die jeweils aktuelle Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B. den
2158 Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei die Syntax <literal><%variablenname%></literal>.
2162 Diese Variablen werden in den folgenden Elementen des Auftrags ersetzt:
2166 <listitem><para>Bemerkungen</para></listitem>
2167 <listitem><para>Interne Bemerkungen</para></listitem>
2168 <listitem><para>Vorgangsbezeichnung</para></listitem>
2169 <listitem><para>In den Beschreibungs- und Langtextfeldern aller Positionen</para></listitem>
2172 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
2176 <term><varname><%current_quarter%></varname>, <varname><%previous_quarter%></varname>, <varname><%next_quarter%></varname></term>
2180 Aktuelles, vorheriges und nächstes Quartal als Zahl zwischen <literal>1</literal> und <literal>4</literal>.
2186 <term><varname><%current_month%></varname>, <varname><%previous_month%></varname>, <varname><%next_month%></varname></term>
2190 Aktueller, vorheriger und nächster Monat als Zahl zwischen <literal>1</literal> und <literal>12</literal>.
2196 <term><varname><%current_month_long%></varname>, <varname><%previous_month_long%></varname>, <varname><%next_month_long%></varname></term>
2200 Aktueller, vorheriger und nächster Monat als Name (<literal>Januar</literal>, <literal>Februar</literal> etc.).
2206 <term><varname><%current_year%></varname>, <varname><%previous_year%></varname>, <varname><%next_year%></varname></term>
2210 Aktuelles, vorheriges und nächstes Jahr als vierstellige Jahreszahl (<literal>2013</literal> etc.).
2216 <term><varname><%period_start_date%></varname>, <varname><%period_end_date%></varname></term>
2220 Formatiertes Datum des ersten und letzten Tages im Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im ersten
2221 Quartal von 2013 wären dies der <literal>01.01.2013</literal> und <literal>31.03.2013</literal>).
2228 <sect2 id="features.periodic-invoices.reports">
2229 <title>Auflisten</title>
2231 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
2232 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
2233 Rechnungen inaktiv", mit denen man sich einen Überglick über die
2234 wiederkehrenden Rechnungen verschaffen kann.</para>
2237 <sect2 id="features.periodic-invoices.task-server">
2238 <title>Erzeugung der eigentlichen Rechnungen</title>
2240 <para>Die zeitliche und periodische Überprüfung, ob eine
2241 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
2242 durch den <link linkend="config.task-server">Taskserver</link>, einen
2243 externen Dienst, der automatisch beim Start des Servers gestartet
2244 werden sollte.</para>
2247 <sect2 id="features.periodic-invoices.create-for-current-month">
2248 <title>Erste Rechnung für aktuellen Monat erstellen</title>
2250 <para>Will man im laufenden Monat eine monatlich wiederkehrende
2251 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
2252 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
2253 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
2254 generiert hat. Alternativ setzt man das Startdatum auf den
2255 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
2256 manuell über den Workflow.</para>
2259 <sect1 id="dokumentenvorlagen-und-variablen">
2260 <title>Dokumentenvorlagen und verfügbare Variablen</title>
2262 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
2263 <title>Einführung</title>
2265 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
2266 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
2267 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
2268 <function><%variablenname%></function> verwendet wird. Für
2269 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
2271 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
2273 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
2274 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
2275 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
2276 alle Vorlagenarten.</para>
2278 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
2279 verfügbar als hier aufgelistet werden. Die meisten davon können
2280 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
2281 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
2282 diese wie folgt erhalten werden:</para>
2286 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
2287 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
2291 <para>In <filename>Form.pm</filename> die Funktion
2292 <function>parse_template</function> suchen und hier die Zeile
2293 <command>print(STDERR Dumper($self));</command> einfügen.</para>
2297 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
2298 ein PDF für eine Rechnung erzeugen.</para>
2302 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
2303 der Variablen <varname>$self</varname> in der Form <varname>'key'
2304 => 'value',</varname>. Alle <varname>key</varname>s sind
2310 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
2311 <title>Variablen ausgeben</title>
2313 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
2314 Tags geschrieben werden, also z.B.
2315 <varname><%variablenname%></varname>.</para>
2317 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
2318 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
2319 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
2320 werden die folgenden Flags unterstützt:</para>
2324 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
2325 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
2326 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
2327 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
2331 <para><option>NOESCAPE</option> unterdrückt das Escapen von
2332 Sonderzeichen für die Vorlagensprache. Wenn also in einer
2333 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
2334 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
2335 ist dieses Flag sinnvoll.</para>
2339 <para>Beispiel:</para>
2341 <programlisting><%quototal NOFORMAT%></programlisting>
2344 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
2345 <title>Verwendung in Druckbefehlen</title>
2347 <para>In der Admininstration können Drucker definiert werden. Auch im
2348 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
2349 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
2350 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
2351 <function>`...`</function> nicht zu unerwünschtem Verhalten
2354 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
2355 für das die Telefonnummer eines Ansprechpartners als Teil der
2356 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
2357 z.B. wie folgt aussehen:</para>
2359 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
2362 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
2363 xreflabel="Anfang und Ende der Tags verändern">
2364 <title>Anfang und Ende der Tags verändern</title>
2366 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
2367 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
2368 Prozentzeichen und dem Größerzeichen endet, beispielsweise
2369 <function><%customer%></function>. Da diese Form aber z.B. in
2370 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
2371 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
2372 Stil umgestellt werden.</para>
2374 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
2375 Format gültigen Kommentarzeichen anfangen, dann
2376 <function>config:</function> enthalten, die entsprechende Option
2377 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
2378 enden. Beispiel für LaTeX:</para>
2380 <programlisting>% config: tag-style=($ $)</programlisting>
2382 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
2383 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
2384 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
2386 <programlisting><!-- config: tag-style=($ $) --></programlisting>
2389 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
2390 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
2392 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
2393 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
2394 "<filename>.ext</filename>" geeignet zu ersetzen:
2395 "<filename>.tex</filename>" für LaTeX-Vorlagen und
2396 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
2400 <term><filename>bin_list.ext</filename></term>
2403 <para>Lagerliste</para>
2408 <term><filename>check.ext</filename></term>
2416 <term><filename>invoice.ext</filename></term>
2419 <para>Rechnung</para>
2424 <term><filename>packing_list.ext</filename></term>
2427 <para>Packliste</para>
2432 <term><filename>pick_list.ext</filename></term>
2435 <para>Sammelliste</para>
2440 <term><filename>purchase_delivery_order.ext</filename></term>
2443 <para>Lieferschein (Einkauf)</para>
2448 <term><filename>purcharse_order.ext</filename></term>
2451 <para>Bestellung an Lieferanten</para>
2456 <term><filename>request_quotation.ext</filename></term>
2459 <para>Anfrage an Lieferanten</para>
2464 <term><filename>sales_delivery_order.ext</filename></term>
2467 <para>Lieferschein (Verkauf)</para>
2472 <term><filename>sales_order.ext</filename></term>
2475 <para>Bestellung</para>
2480 <term><filename>sales_quotation.ext</filename></term>
2483 <para>Angebot an Kunden</para>
2488 <term><filename>zahlungserinnerung.ext</filename></term>
2491 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2496 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2499 <para>Rechnung über Mahngebühren (Dateiname im Programm
2500 konfigurierbar)</para>
2506 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2507 <title>Sprache, Drucker und E-Mail</title>
2509 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2510 eingearbeitet. So wird aus der Vorlage
2511 <filename>sales_order.ext</filename> bei Sprache
2512 <function>de</function> und Druckerkürzel <function>lpr2</function>
2513 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2514 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2515 bekommen dann noch das Kürzel <filename>_email</filename>, der
2516 vollständige Vorlagenname wäre dann
2517 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2518 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2519 werden. Diese wird verwendet, wenn keine der anderen Varianten
2520 gefunden wird.</para>
2522 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2523 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2524 verschickt wird, ist:</para>
2528 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2532 <para><filename>sales_order_de_lpr2.tex</filename></para>
2536 <para><filename>sales_order.tex</filename></para>
2540 <para><filename>default.tex</filename></para>
2544 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2545 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2547 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2550 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2551 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2554 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2555 xreflabel="Metainformationen zur angeforderten Vorlage">
2556 <title>Metainformationen zur angeforderten Vorlage</title>
2558 <para>Diese Variablen liefern Informationen darüber welche Variante
2559 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2560 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2561 Formulare einbinden möchten.</para>
2565 <term><varname>template_meta.formname</varname></term>
2568 <para>Basisname der Vorlage. Identisch mit der <link
2569 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2570 zu den Dateinamen</link> ohne die Erweiterung. Ein
2571 Verkaufsauftrag enthält hier
2572 <constant>sales_order</constant>.</para>
2577 <term><varname>template_meta.language.description</varname></term>
2580 <para>Beschreibung der verwendeten Sprache</para>
2585 <term><varname>template_meta.language.template_code</varname></term>
2588 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2589 Kürzel das im Dateinamen verwendetet wird.</para>
2594 <term><varname>template_meta.language.output_numberformat</varname></term>
2597 <para>Zahlenformat der verwendeten Sprache in der Form
2598 "<constant>1.000,00</constant>". Experimentell! Nur
2599 interessant für Vorlagen die mit unformatierten Werten
2605 <term><varname>template_meta.language.output_dateformat</varname></term>
2608 <para>Datumsformat der verwendeten Sprache in der Form
2609 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2610 interessant für Vorlagen die mit unformatierten Werten
2616 <term><varname>template_meta.format</varname></term>
2619 <para>Das angeforderte Format. Kann im Moment die Werte
2620 <constant>pdf</constant>, <constant>postscript</constant>,
2621 <constant>html</constant>, <constant>opendocument</constant>,
2622 <constant>opendocument_pdf</constant> und
2623 <constant>excel</constant> enthalten.</para>
2628 <term><varname>template_meta.extension</varname></term>
2631 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2632 <constant>format</constant> entschieden.</para>
2637 <term><varname>template_meta.media</varname></term>
2640 <para>Ausgabemedium. Kann zur Zeit die Werte
2641 <constant>screen</constant> für Bildschirm,
2642 <constant>email</constant> für E-Mmail (triggert das
2643 <constant>_email</constant> Kürzel im Dateinamen),
2644 <constant>printer</constant> für Drucker, und
2645 <constant>queue</constant> für Warteschlange enthalten.</para>
2650 <term><varname>template_meta.printer.description</varname></term>
2653 <para>Beschreibung des ausgewählten Druckers</para>
2658 <term><varname>template_meta.printer.template_code</varname></term>
2661 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2662 dem Kürzel das im Dateinamen verwendetet wird.</para>
2667 <term><varname>template_meta.tmpfile</varname></term>
2670 <para>Datei-Prefix für temporäre Dateien.</para>
2676 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2677 <title>Stammdaten von Kunden und Lieferanten</title>
2681 <term><varname>account_number</varname></term>
2684 <para>Kontonummer</para>
2689 <term><varname>bank</varname></term>
2692 <para>Name der Bank</para>
2697 <term><varname>bank_code</varname></term>
2700 <para>Bankleitzahl</para>
2705 <term><varname>bic</varname></term>
2708 <para>Bank-Identifikations-Code (Bank Identifier Code,
2714 <term><varname>business</varname></term>
2717 <para>Kunden-/Lieferantentyp</para>
2722 <term><varname>city</varname></term>
2730 <term><varname>contact</varname></term>
2733 <para>Kontakt</para>
2738 <term><varname>country</varname></term>
2746 <term><varname>c_vendor_id</varname></term>
2749 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
2754 <term><varname>v_customer_id</varname></term>
2757 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
2762 <term><varname>cp_email</varname></term>
2765 <para>Email des Ansprechpartners</para>
2770 <term><varname>cp_givenname</varname></term>
2773 <para>Vorname des Ansprechpartners</para>
2778 <term><varname>cp_greeting</varname></term>
2781 <para>Anrede des Ansprechpartners</para>
2786 <term><varname>cp_name</varname></term>
2789 <para>Name des Ansprechpartners</para>
2794 <term><varname>cp_phone1</varname></term>
2797 <para>Telefonnummer 1 des Ansprechpartners</para>
2802 <term><varname>cp_phone2</varname></term>
2805 <para>Telefonnummer 2 des Ansprechpartners</para>
2810 <term><varname>cp_title</varname></term>
2813 <para>Titel des Ansprechpartners</para>
2818 <term><varname>creditlimit</varname></term>
2821 <para>Kreditlimit</para>
2826 <term><varname>customeremail</varname></term>
2829 <para>Email des Kunden; nur für Kunden</para>
2834 <term><varname>customerfax</varname></term>
2837 <para>Faxnummer des Kunden; nur für Kunden</para>
2842 <term><varname>customernotes</varname></term>
2845 <para>Bemerkungen beim Kunden; nur für Kunden</para>
2850 <term><varname>customernumber</varname></term>
2853 <para>Kundennummer; nur für Kunden</para>
2858 <term><varname>customerphone</varname></term>
2861 <para>Telefonnummer des Kunden; nur für Kunden</para>
2866 <term><varname>discount</varname></term>
2874 <term><varname>email</varname></term>
2877 <para>Emailadresse</para>
2882 <term><varname>fax</varname></term>
2885 <para>Faxnummer</para>
2890 <term><varname>homepage</varname></term>
2893 <para>Homepage</para>
2898 <term><varname>iban</varname></term>
2901 <para>Internationale Kontonummer (International Bank Account
2902 Number, IBAN)</para>
2907 <term><varname>language</varname></term>
2910 <para>Sprache</para>
2915 <term><varname>name</varname></term>
2918 <para>Firmenname</para>
2923 <term><varname>payment_description</varname></term>
2926 <para>Name der Zahlart</para>
2931 <term><varname>payment_terms</varname></term>
2934 <para>Zahlungskonditionen</para>
2939 <term><varname>phone</varname></term>
2942 <para>Telefonnummer</para>
2947 <term><varname>shiptocity</varname></term>
2950 <para>Stadt (Lieferadresse) <link
2951 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2956 <term><varname>shiptocontact</varname></term>
2959 <para>Kontakt (Lieferadresse) <link
2960 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2965 <term><varname>shiptocountry</varname></term>
2968 <para>Land (Lieferadresse) <link
2969 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2974 <term><varname>shiptodepartment1</varname></term>
2977 <para>Abteilung 1 (Lieferadresse) <link
2978 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2983 <term><varname>shiptodepartment2</varname></term>
2986 <para>Abteilung 2 (Lieferadresse) <link
2987 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2992 <term><varname>shiptoemail</varname></term>
2995 <para>Email (Lieferadresse) <link
2996 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3001 <term><varname>shiptofax</varname></term>
3004 <para>Fax (Lieferadresse) <link
3005 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3010 <term><varname>shiptoname</varname></term>
3013 <para>Firmenname (Lieferadresse) <link
3014 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3019 <term><varname>shiptophone</varname></term>
3022 <para>Telefonnummer (Lieferadresse) <link
3023 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3028 <term><varname>shiptostreet</varname></term>
3031 <para>Straße und Hausnummer (Lieferadresse) <link
3032 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3037 <term><varname>shiptozipcode</varname></term>
3040 <para>Postleitzahl (Lieferadresse) <link
3041 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3046 <term><varname>street</varname></term>
3049 <para>Straße und Hausnummer</para>
3054 <term><varname>taxnumber</varname></term>
3057 <para>Steuernummer</para>
3062 <term><varname>ustid</varname></term>
3065 <para>Umsatzsteuer-Identifikationsnummer</para>
3070 <term><varname>vendoremail</varname></term>
3073 <para>Email des Lieferanten; nur für Lieferanten</para>
3078 <term><varname>vendorfax</varname></term>
3081 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
3086 <term><varname>vendornotes</varname></term>
3089 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
3094 <term><varname>vendornumber</varname></term>
3097 <para>Lieferantennummer; nur für Lieferanten</para>
3102 <term><varname>vendorphone</varname></term>
3105 <para>Telefonnummer des Lieferanten; nur für
3111 <term><varname>zipcode</varname></term>
3114 <para>Postleitzahl</para>
3119 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
3120 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
3121 Stammdaten nicht eingetragen, so haben die Variablen
3122 <varname>shipto*</varname> den gleichen Wert wie die die
3123 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
3124 einige <varname>shipto*</varname>-Variablen so nicht in den
3125 Stammdaten wiederfinden sondern schlicht Kopien der
3126 Lieferdatenvariablen sind (z.B.
3127 <varname>shiptocontact</varname>).</para>
3131 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
3132 <title>Informationen über den Bearbeiter</title>
3136 <term><varname>employee_address</varname></term>
3139 <para>Adressfeld</para>
3144 <term><varname>employee_businessnumber</varname></term>
3147 <para>Firmennummer</para>
3152 <term><varname>employee_company</varname></term>
3155 <para>Firmenname</para>
3160 <term><varname>employee_co_ustid</varname></term>
3163 <para>Usatzsteuer-Identifikationsnummer</para>
3168 <term><varname>employee_duns</varname></term>
3171 <para>DUNS-Nummer</para>
3176 <term><varname>employee_email</varname></term>
3184 <term><varname>employee_fax</varname></term>
3192 <term><varname>employee_name</varname></term>
3195 <para>voller Name</para>
3200 <term><varname>employee_signature</varname></term>
3203 <para>Signatur</para>
3208 <term><varname>employee_taxnumber</varname></term>
3211 <para>Steuernummer</para>
3216 <term><varname>employee_tel</varname></term>
3219 <para>Telefonnummer</para>
3225 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
3226 <title>Informationen über den Verkäufer</title>
3230 <term><varname>salesman_address</varname></term>
3233 <para>Adressfeld</para>
3238 <term><varname>salesman_businessnumber</varname></term>
3241 <para>Firmennummer</para>
3246 <term><varname>salesman_company</varname></term>
3249 <para>Firmenname</para>
3254 <term><varname>salesman_co_ustid</varname></term>
3257 <para>Usatzsteuer-Identifikationsnummer</para>
3262 <term><varname>salesman_duns</varname></term>
3265 <para>DUNS-Nummer</para>
3270 <term><varname>salesman_email</varname></term>
3278 <term><varname>salesman_fax</varname></term>
3286 <term><varname>salesman_name</varname></term>
3289 <para>voller Name</para>
3294 <term><varname>salesman_signature</varname></term>
3297 <para>Signatur</para>
3302 <term><varname>salesman_taxnumber</varname></term>
3305 <para>Steuernummer</para>
3310 <term><varname>salesman_tel</varname></term>
3313 <para>Telefonnummer</para>
3319 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
3320 <title>Variablen für die einzelnen Steuern</title>
3324 <term><varname>tax</varname></term>
3332 <term><varname>taxbase</varname></term>
3335 <para>zu versteuernder Betrag</para>
3340 <term><varname>taxdescription</varname></term>
3343 <para>Name der Steuer</para>
3348 <term><varname>taxrate</varname></term>
3351 <para>Steuersatz</para>
3357 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
3358 <title>Variablen für Lieferbedingungen</title>
3362 <term><varname>delivery_term</varname></term>
3363 <listitem><para>Datenbank-Objekt der Lieferbedingung</para></listitem>
3366 <term><varname>delivery_term.description</varname></term>
3367 <listitem><para>Beschreibung der Lieferbedingung</para></listitem>
3370 <term><varname>delivery_term.long_description</varname></term>
3371 <listitem><para>Langtext bzw. übersetzter Langtext der Lieferbedingung</para></listitem>
3377 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
3378 <title>Variablen in Rechnungen</title>
3380 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
3381 <title>Allgemeine Variablen</title>
3385 <term><varname>creditremaining</varname></term>
3388 <para>Verbleibender Kredit</para>
3393 <term><varname>currency</varname></term>
3396 <para>Währung</para>
3401 <term><varname>cusordnumber</varname></term>
3404 <para>Bestellnummer beim Kunden</para>
3409 <term><varname>deliverydate</varname></term>
3412 <para>Lieferdatum</para>
3417 <term><varname>duedate</varname></term>
3420 <para>Fälligkeitsdatum</para>
3425 <term><varname>globalprojectnumber</varname></term>
3428 <para>Projektnummer des ganzen Beleges</para>
3433 <term><varname>globalprojectdescription</varname></term>
3436 <para>Projekbeschreibung des ganzen Beleges</para>
3441 <term><varname>intnotes</varname></term>
3444 <para>Interne Bemerkungen</para>
3449 <term><varname>invdate</varname></term>
3452 <para>Rechnungsdatum</para>
3457 <term><varname>invnumber</varname></term>
3460 <para>Rechnungsnummer</para>
3465 <term><varname>invtotal</varname></term>
3468 <para>gesamter Rechnungsbetrag</para>
3473 <term><varname>notes</varname></term>
3476 <para>Bemerkungen der Rechnung</para>
3481 <term><varname>orddate</varname></term>
3484 <para>Auftragsdatum</para>
3489 <term><varname>ordnumber</varname></term>
3492 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3493 erstellt wurde</para>
3498 <term><varname>payment_description</varname></term>
3501 <para>Name der Zahlart</para>
3506 <term><varname>payment_terms</varname></term>
3509 <para>Zahlungskonditionen</para>
3514 <term><varname>quodate</varname></term>
3517 <para>Angebotsdatum</para>
3522 <term><varname>quonumber</varname></term>
3525 <para>Angebotsnummer</para>
3530 <term><varname>shippingpoint</varname></term>
3533 <para>Versandort</para>
3538 <term><varname>shipvia</varname></term>
3541 <para>Transportmittel</para>
3546 <term><varname>subtotal</varname></term>
3549 <para>Zwischensumme aller Posten ohne Steuern</para>
3554 <term><varname>total</varname></term>
3557 <para>Restsumme der Rechnung (Summe abzüglich bereits
3558 bezahlter Posten)</para>
3563 <term><varname>transaction_description</varname></term>
3566 <para>Vorgangsbezeichnung</para>
3571 <term><varname>transdate</varname></term>
3574 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3575 erstellt wurde</para>
3581 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3582 <title>Variablen für jeden Posten auf der Rechnung</title>
3586 <term><varname>bin</varname></term>
3589 <para>Stellage</para>
3594 <term><varname>description</varname></term>
3597 <para>Artikelbeschreibung</para>
3602 <term><varname>discount</varname></term>
3605 <para>Rabatt als Betrag</para>
3610 <term><varname>discount_sub</varname></term>
3613 <para>Zwischensumme mit Rabatt</para>
3618 <term><varname>drawing</varname></term>
3621 <para>Zeichnung</para>
3626 <term><varname>ean</varname></term>
3629 <para>EAN-Code</para>
3634 <term><varname>image</varname></term>
3642 <term><varname>linetotal</varname></term>
3645 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3650 <term><varname>longdescription</varname></term>
3653 <para>Langtext</para>
3658 <term><varname>microfiche</varname></term>
3661 <para>Mikrofilm</para>
3666 <term><varname>netprice</varname></term>
3669 <para>Nettopreis</para>
3674 <term><varname>nodiscount_linetotal</varname></term>
3677 <para>Zeilensumme ohne Rabatt</para>
3682 <term><varname>nodiscount_sub</varname></term>
3685 <para>Zwischensumme ohne Rabatt</para>
3690 <term><varname>number</varname></term>
3693 <para>Artikelnummer</para>
3698 <term><varname>ordnumber_oe</varname></term>
3701 <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
3702 aus einem Sammelauftrag erstellt wurde</para>
3707 <term><varname>p_discount</varname></term>
3710 <para>Rabatt in Prozent</para>
3715 <term><varname>partnotes</varname></term>
3718 <para>Die beim Artikel gespeicherten Bemerkungen</para>
3723 <term><varname>partsgroup</varname></term>
3726 <para>Warengruppe</para>
3731 <term><varname>price_factor</varname></term>
3734 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
3740 <term><varname>price_factor_name</varname></term>
3743 <para>Der Name des Preisfaktors, sofern einer eingestellt
3749 <term><varname>projectnumber</varname></term>
3752 <para>Projektnummer</para>
3757 <term><varname>projectdescription</varname></term>
3760 <para>Projektbeschreibung</para>
3765 <term><varname>qty</varname></term>
3773 <term><varname>reqdate</varname></term>
3776 <para>Lieferdatum</para>
3781 <term><varname>runningnumber</varname></term>
3784 <para>Position auf der Rechnung (1, 2, 3...)</para>
3789 <term><varname>sellprice</varname></term>
3792 <para>Verkaufspreis</para>
3797 <term><varname>serialnumber</varname></term>
3800 <para>Seriennummer</para>
3805 <term><varname>tax_rate</varname></term>
3808 <para>Steuersatz</para>
3813 <term><varname>transdate_oe</varname></term>
3816 <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
3817 aus einem Sammelauftrag erstellt wurde</para>
3822 <term><varname>unit</varname></term>
3825 <para>Einheit</para>
3830 <term><varname>weight</varname></term>
3833 <para>Gewicht</para>
3838 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
3839 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
3840 einer <function>foreach</function>-Schleife ausgegeben werden, da
3841 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
3842 können. Die Variablen dafür lauten:</para>
3846 <term><varname>make</varname></term>
3849 <para>Lieferant</para>
3854 <term><varname>model</varname></term>
3857 <para>Lieferantenartikelnummer</para>
3863 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
3864 <title>Variablen für die einzelnen Zahlungseingänge</title>
3868 <term><varname>payment</varname></term>
3876 <term><varname>paymentaccount</varname></term>
3884 <term><varname>paymentdate</varname></term>
3892 <term><varname>paymentmemo</varname></term>
3900 <term><varname>paymentsource</varname></term>
3909 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
3910 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
3912 <para>Die vom Benutzer definierten Variablen für Kunden und
3913 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
3914 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
3915 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
3916 Variablennamen zusammen.</para>
3918 <para>Beispiel: Der Benutzer hat eine Variable namens
3919 <varname>number_of_employees</varname> definiert, die die Anzahl der
3920 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
3921 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
3926 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
3927 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
3929 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
3930 <title>Namen der Vorlagen</title>
3932 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
3933 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
3934 Erstellung einer Rechnung über die Mahngebühren und Zinsen
3935 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
3936 Vorlagenname für diese Mahnstufe mit dem Zusatz
3937 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
3938 für die ausgewählte Sprache und den ausgewählten Drucker
3942 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
3943 <title>Allgemeine Variablen in Mahnungen</title>
3945 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3946 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3947 Kunden stehen als Variablen <varname>name</varname>,
3948 <varname>street</varname>, <varname>zipcode</varname>,
3949 <varname>city</varname>, <varname>country</varname>,
3950 <varname>department_1</varname>, <varname>department_2</varname>,
3951 und <varname>email</varname> zur Verfügung.</para>
3953 <para>Weitere Variablen beinhalten:</para>
3957 <term><varname>dunning_date</varname></term>
3960 <para>Datum der Mahnung</para>
3965 <term><varname>dunning_duedate</varname></term>
3968 <para>Fälligkeitsdatum für diese Mahhnung</para>
3973 <term><varname>dunning_id</varname></term>
3976 <para>Mahnungsnummer</para>
3981 <term><varname>fee</varname></term>
3984 <para>Kummulative Mahngebühren</para>
3989 <term><varname>interest_rate</varname></term>
3992 <para>Zinssatz per anno in Prozent</para>
3997 <term><varname>total_amount</varname></term>
4000 <para>Gesamter noch zu zahlender Betrag als
4001 <function>fee</function> + <function>total_interest</function>
4002 + <function>total_open_amount</function></para>
4007 <term><varname>total_interest</varname></term>
4010 <para>Zinsen per anno über alle Rechnungen</para>
4015 <term><varname>total_open_amount</varname></term>
4018 <para>Summe über alle offene Beträge der Rechnungen</para>
4024 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
4025 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
4029 <term><varname>dn_amount</varname></term>
4032 <para>Rechnungssumme (brutto)</para>
4037 <term><varname>dn_duedate</varname></term>
4040 <para>Originales Fälligkeitsdatum der Rechnung</para>
4045 <term><varname>dn_dunning_date</varname></term>
4048 <para>Datum der Mahnung</para>
4053 <term><varname>dn_dunning_duedate</varname></term>
4056 <para>Fälligkeitsdatum der Mahnung</para>
4061 <term><varname>dn_fee</varname></term>
4064 <para>Kummulative Mahngebühr</para>
4069 <term><varname>dn_interest</varname></term>
4072 <para>Zinsen per anno für diese Rechnung</para>
4077 <term><varname>dn_invnumber</varname></term>
4080 <para>Rechnungsnummer</para>
4085 <term><varname>dn_linetotal</varname></term>
4088 <para>Noch zu zahlender Betrag (ergibt sich aus
4089 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
4090 + <varname>dn_interest</varname>)</para>
4095 <term><varname>dn_netamount</varname></term>
4098 <para>Rechnungssumme (netto)</para>
4103 <term><varname>dn_open_amount</varname></term>
4106 <para>Offener Rechnungsbetrag</para>
4111 <term><varname>dn_ordnumber</varname></term>
4114 <para>Bestellnummer</para>
4119 <term><varname>dn_transdate</varname></term>
4122 <para>Rechnungsdatum</para>
4127 <term><varname>dn_curr</varname></term>
4130 <para>Währung, in der die Rechnung erstellt wurde. (Die
4131 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
4137 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
4138 <title>Variablen in automatisch erzeugten Rechnungen über
4139 Mahngebühren</title>
4141 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4142 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4143 Kunden stehen als Variablen <varname>name</varname>,
4144 <varname>street</varname>, <varname>zipcode</varname>,
4145 <varname>city</varname>, <varname>country</varname>,
4146 <varname>department_1</varname>, <varname>department_2</varname>,
4147 und <varname>email</varname> zur Verfügung.</para>
4149 <para>Weitere Variablen beinhalten:</para>
4153 <term><varname>duedate</varname></term>
4156 <para>Fälligkeitsdatum der Rechnung</para>
4161 <term><varname>dunning_id</varname></term>
4164 <para>Mahnungsnummer</para>
4169 <term><varname>fee</varname></term>
4172 <para>Mahngebühren</para>
4177 <term><varname>interest</varname></term>
4185 <term><varname>invamount</varname></term>
4188 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
4189 <varname>interest</varname>)</para>
4194 <term><varname>invdate</varname></term>
4197 <para>Rechnungsdatum</para>
4202 <term><varname>invnumber</varname></term>
4205 <para>Rechnungsnummer</para>
4212 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
4213 <title>Variablen in anderen Vorlagen</title>
4216 <title>Einführung</title>
4218 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
4219 Rechnung. Allerdings heißen die Variablen, die mit
4220 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
4221 fangen sie mit <varname>quo</varname> für "quotation" an:
4222 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
4223 wiederum fangen sie mit <varname>ord</varname> für "order" an:
4224 <varname>ordnumber</varname> für Bestellnummer etc.</para>
4226 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
4227 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
4228 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
4229 Vorlage keine Bedeutung haben oder noch nicht belegt sein
4232 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
4233 in Rechnungen aufgeführt.</para>
4236 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
4237 <title>Angebote und Preisanfragen</title>
4241 <term><varname>quonumber</varname></term>
4244 <para>Angebots- bzw. Anfragenummer</para>
4249 <term><varname>reqdate</varname></term>
4252 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
4253 Preisanfragen)</para>
4258 <term><varname>transdate</varname></term>
4261 <para>Angebots- bzw. Anfragedatum</para>
4267 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
4268 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
4272 <term><varname>ordnumber</varname></term>
4275 <para>Auftragsnummer</para>
4280 <term><varname>reqdate</varname></term>
4283 <para>Lieferdatum</para>
4288 <term><varname>transdate</varname></term>
4291 <para>Auftragsdatum</para>
4297 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
4298 <title>Lieferscheine (Verkauf und Einkauf)</title>
4302 <term><varname>cusordnumber</varname></term>
4305 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
4306 des Lieferanten (im Einkauf)</para>
4311 <term><varname>donumber</varname></term>
4314 <para>Lieferscheinnummer</para>
4319 <term><varname>transdate</varname></term>
4322 <para>Lieferscheindatum</para>
4327 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
4328 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
4329 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
4330 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
4331 <function>foreach</function>-Schleife ausgegeben werden. Diese
4332 Variablen sind:</para>
4336 <term><varname>si_bin</varname></term>
4339 <para>Lagerplatz</para>
4344 <term><varname>si_chargenumber</varname></term>
4347 <para>Chargennummer</para>
4352 <term><varname>si_bestbefore</varname></term>
4355 <para>Mindesthaltbarkeit</para>
4360 <term><varname>si_number</varname></term>
4363 <para>Artikelnummer</para>
4368 <term><varname>si_qty</varname></term>
4371 <para>Anzahl bzw. Menge</para>
4376 <term><varname>si_runningnumber</varname></term>
4379 <para>Positionsnummer (1, 2, 3 etc)</para>
4384 <term><varname>si_unit</varname></term>
4387 <para>Einheit</para>
4392 <term><varname>si_warehouse</varname></term>
4401 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
4402 <title>Variablen für Sammelrechnung</title>
4406 <term><varname>c0total</varname></term>
4409 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
4415 <term><varname>c30total</varname></term>
4418 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
4419 und < 60 Tage</para>
4424 <term><varname>c60total</varname></term>
4427 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
4428 und < 90 Tage</para>
4433 <term><varname>c90total</varname></term>
4436 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
4442 <term><varname>total</varname></term>
4445 <para>Gesamtbetrag aller Rechnungen</para>
4450 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
4454 <term><varname>invnumber</varname></term>
4457 <para>Rechnungsnummer</para>
4462 <term><varname>invdate</varname></term>
4465 <para>Rechnungsdatum</para>
4470 <term><varname>duedate</varname></term>
4473 <para>Fälligkeitsdatum</para>
4478 <term><varname>amount</varname></term>
4481 <para>Summe der Rechnung</para>
4486 <term><varname>open</varname></term>
4489 <para>Noch offener Betrag der Rechnung</para>
4494 <term><varname>c0</varname></term>
4497 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4503 <term><varname>c30</varname></term>
4506 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4512 <term><varname>c60</varname></term>
4515 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4521 <term><varname>c90</varname></term>
4524 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4532 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4533 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4535 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4536 <title>Einfürhung</title>
4538 <para>Der Parser kennt neben den Variablen einige weitere
4539 Konstrukte, die gesondert behandelt werden. Diese sind wie
4540 Variablennamen in spezieller Weise markiert:
4541 <command><%anweisung%> ... <%end%></command></para>
4543 <para>Anmerkung zum <command><%end%></command>: Der besseren
4544 Verständlichkeit halber kann man nach dem <command>end</command>
4545 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4546 Anweisung (z.B. <command>if</command> oder
4547 <command>foreach</command>) damit abgeschlossen wird.</para>
4549 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4550 <command><%if type == "sales_quotation"%></command>, so könnte
4551 er mit <command><%end%></command> genauso abgeschlossen werden
4552 wie mit <command><%end if%></command> oder auch
4553 <command><%end type == "sales_quotation"%></command>.</para>
4556 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4557 <title>Der if-Block</title>
4559 <programlisting><%if variablenname%>
4561 <%end%></programlisting>
4563 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4564 und dem "end" werden nur ausgegeben, wenn die Variable
4565 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4567 <para>Handelt es sich bei der benannten Variable um ein Array, also um einen Variablennamen, über den man mit
4568 <command><%foreach variablenname%></command> iteriert, so wird mit diesem Konstrukt darauf getestet, ob das Array Elemente
4569 enthält. Somit würde im folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt ihrer Überschrift "Zahlungseingänge"
4570 ausgegeben, wenn tatsächlich welche getätigt wurden:</para>
4572 <programlisting><%if payment%>
4574 <%foreach payment%>
4575 Am <%paymentdate%>: <%payment%> €
4576 <%end foreach%>
4577 <%end if%></programlisting>
4579 <para>Die Bedingung kann auch negiert werden, indem das Wort
4580 <function>not</function> nach dem <filename>if</filename> verwendet
4581 wird. Beispiel:</para>
4583 <programlisting><%if not cp_greeting%>
4585 <%end%></programlisting>
4587 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4588 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4589 einer Variablen mit einer festen Zeichenkette oder einer anderen
4590 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4591 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4592 die rechte Seite des Vergleichsoperators in Anführungszeichen
4593 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4594 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4597 <programlisting><%if var1 == "Wert"%></programlisting>
4599 <para>Testet die Variable <varname>var1</varname> auf
4600 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4601 Mittels <function>!=</function> anstelle von <function>==</function>
4602 würde auf Ungleichheit getestet.</para>
4604 <programlisting><%if var1 == var2%></programlisting>
4606 <para>Testet die Variable <varname>var1</varname> auf
4607 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4608 <function>!=</function> anstelle von <function>==</function> würde
4609 auf Ungleichheit getestet.</para>
4611 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4612 auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
4613 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4614 dieselbe Syntax wie oben nur mit <function>=~</function> und
4615 <function>!~</function> als Vergleichsoperatoren.</para>
4617 <para>Beispiel für einen Test, ob die Variable
4618 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4619 <constant>schwierig</constant> enthält:</para>
4621 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4624 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4625 <title>Der foreach-Block</title>
4627 <programlisting><%foreach variablenname%>
4629 <%end%></programlisting>
4631 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4632 wie das Perl-Array der Variablen <varname>variablenname</varname>
4633 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4634 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4635 benutzt. In jedem Durchlauf werden die <link
4636 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4637 Variablen</link> jeweils auf den Wert für die aktuelle Position
4640 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
4642 <programlisting><%foreach number%>
4643 Position: <%runningnumber%>
4644 Anzahl: <%qty%>
4645 Artikelnummer: <%number%>
4646 Beschreibung: <%description%>
4648 <%end%></programlisting>
4650 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
4651 <function><%foreach%></function>-Block innerhalb einer
4652 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
4653 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
4654 Inhalt zwischen <function><%foreach%></function> und
4655 <function><%end%></function> wiederholt, nicht aber die
4656 komplette Zeile, in der er steht.</para>
4660 <sect2 id="dokumentenvorlagen-und-variablen.markup">
4661 <title>Markup-Code zur Textformatierung innerhalb von
4664 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
4665 anders formatiert haben möchte, so ist dies begrenzt möglich.
4666 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
4667 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
4668 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
4669 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
4670 (HTML oder PDF über LaTeX) umgesetzt.</para>
4672 <para>Die unterstützen Formatierungen sind:</para>
4676 <term><b>Text</b></term>
4679 <para>Text wird in Fettdruck gesetzt.</para>
4684 <term><i>Text</i></term>
4687 <para>Text wird kursiv gesetzt.</para>
4692 <term><u>Text</u></term>
4695 <para>Text wird unterstrichen.</para>
4700 <term><s>Text</s></term>
4703 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
4704 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
4709 <term><bullet></term>
4712 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
4718 <para>Der Befehl <command><bullet></command> funktioniert
4719 momentan auch nur in Latex-Vorlagen.</para>
4723 <sect1 id="excel-templates">
4724 <title>Excel-Vorlagen</title>
4726 <sect2 id="excel-templates.summary">
4727 <title>Zusammenfassung</title>
4729 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
4730 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
4734 <sect2 id="excel-templates.usage">
4735 <title>Bedienung</title>
4737 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
4738 werden. Die Konfigurationsoption heißt <varname>excel_templates =
4739 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
4741 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
4742 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
4743 werden. In den normalen Verkaufsmasken taucht nun
4744 <constant>Excel</constant> als auswählbares Format auf und kann von da
4745 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
4747 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
4748 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
4749 <filename>sales_quotation.xls</filename> gespeichert.</para>
4752 <sect2 id="excel-templates.syntax">
4753 <title>Variablensyntax</title>
4755 <para>Einfache Syntax:
4756 <command><<varname>></command></para>
4758 <para>Dabei sind <constant><<</constant> und
4759 <constant>>></constant> die Delimiter. Da Excel auf festen
4760 Breiten besteht, kann der Tag künstlich verlängert werden, indem
4761 weitere <constant><</constant> oder <constant>></constant>
4762 eingefügt werden. Der Tag muss nicht symmetrisch sein.
4765 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4767 <para>Um die Limitierung der festen Breite zu reduzieren, können
4768 weitere Variablen in einem Block interpoliert werden. Whitespace wird
4769 dazwishen dann erhalten. Beispiel:</para>
4771 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4773 <para>Die Variablen werden interpoliert, und linksbündig mit
4774 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
4775 lang, werden überzählige Zeichen abgeschnitten.</para>
4777 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
4778 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
4780 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4782 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
4783 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
4787 <sect2 id="excel-templates.limitations">
4788 <title>Einschränkungen</title>
4790 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
4791 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
4792 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
4793 Text zu ersetzen.</para>
4795 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
4796 <command><%if%></command> und
4797 <command><%foreach%></command> nicht vorhanden. Der Delimiter
4798 <constant><% %></constant> kommt in den Headerinformationen
4799 evtl. vor. Deshalb wurde auf den sichereren Delimiter
4800 <constant><<</constant> und <constant>>></constant>
4804 <sect1 id="features.warehouse">
4805 <title>Mandantenkonfiguration Lager</title>
4806 Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt:
4807 Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die Möglichkeit hier über den
4808 Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. Ferner kann
4809 jede Position eines Lieferscheins ein-, bzw. ausgelagert werden (Einkauf-, bzw. Verkauf).
4810 Es können beliebig viele Lager mit beliebig vielen Lagerplätzen abgebildet werden.
4811 Die Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder Einzelposition und
4812 das Auswählen dieser Position zu einem Lager mit Lagerplatz.
4813 Dieses Verfahren lässt sich schrittweise vereinfachen, je nachdem wie die Einstellungen in
4814 der Mandatenkonfiguration gesetzt werden.
4817 <para><option>Auslagern über Standardlagerplatz</option> Hier wird ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz)
4818 in dem Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über den Standardlagerplatz (konfigurierbar pro Ware) durchführt.
4822 <para><option>Auslagern ohne Bestandsprüfung</option>Das obige Auslagern schlägt fehl, wenn die entsprechende Menge für
4823 die Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit dieser Option
4824 erlauben. Hierfür muss ein entsprechender Lagerplatz (Fehlbestand, o.ä.) konfiguriert sein.</para>
4827 Zusätzliche Funktionshinweise:
4829 <listitem><para><option>Standard-Lagerplatz</option>Ist dieser konfiguriert, wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
4830 Stammdaten-> Waren / Dienstleistung / Erzeugnis verwendet.
4833 <listitem><para><option>Standard-Lagerplatz verwenden, falls keiner in Stammdaten definiert</option>Wird beim 'Auslagern über Standardlagerplatz'
4834 keine Standardlagerplatz zu der Ware gefunden, so wird mit dieser Option einfach der Standardlagerplatz verwendet.
4842 <title>Entwicklerdokumentation</title>
4844 <sect1 id="devel.globals" xreflabel="Globale Variablen">
4845 <title>Globale Variablen</title>
4848 <title>Wie sehen globale Variablen in Perl aus?</title>
4850 <para>Globale Variablen liegen in einem speziellen namespace namens
4851 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
4852 globs global und die meisten speziellen Variablen sind...
4855 <para>Daraus ergeben sich folgende Formen:</para>
4859 <term><literal>$main::form</literal></term>
4862 <para>expliziter Namespace "main"</para>
4867 <term><literal>$::form</literal></term>
4870 <para>impliziter Namespace "main"</para>
4875 <term><literal>open FILE, "file.txt"</literal></term>
4878 <para><varname>FILE</varname> ist global</para>
4883 <term><literal>$_</literal></term>
4886 <para>speziell</para>
4891 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
4892 Schlüsselwort wie "<function>global</function>", mit dem man
4893 importieren kann. <function>my</function>, <function>our</function>
4894 und <function>local</function> machen was anderes.</para>
4898 <term><literal>my $form</literal></term>
4901 <para>lexikalische Variable, gültig bis zum Ende des
4907 <term><literal>our $form</literal></term>
4910 <para><varname>$form</varname> referenziert ab hier
4911 <varname>$PACKAGE::form</varname>.</para>
4916 <term><literal>local $form</literal></term>
4919 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
4920 des scopes zurückgesetzt</para>
4927 <title>Warum sind globale Variablen ein Problem?</title>
4929 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
4931 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
4932 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
4933 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
4934 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
4935 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
4936 Datenbankverbindungen, weil die sehr lange zum Initialisieren
4939 <para>Das zweite Problem ist <function>strict</function>. Unter
4940 <function>strict</function> werden alle Variablen die nicht explizit
4941 mit <function>Package</function>, <function>my</function> oder
4942 <function>our</function> angegeben werden als Tippfehler angemarkert,
4943 dies hat, seit der Einführung, u.a. schon so manche langwierige
4944 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
4945 angegeben werden, werden die nicht geprüft, und somit kann sich
4946 schnell ein Tippfehler einschleichen.</para>
4950 <title>Kanonische globale Variablen</title>
4952 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
4953 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
4954 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
4955 umhergereicht werden.</para>
4957 <para>Diese Variablen sind im Moment die folgenden neun:</para>
4961 <para><varname>$::form</varname></para>
4965 <para><varname>%::myconfig</varname></para>
4969 <para><varname>$::locale</varname></para>
4973 <para><varname>$::lxdebug</varname></para>
4977 <para><varname>$::auth</varname></para>
4981 <para><varname>$::lx_office_conf</varname></para>
4985 <para><varname>$::instance_conf</varname></para>
4989 <para><varname>$::dispatcher</varname></para>
4993 <para><varname>$::request</varname></para>
4997 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
4998 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
4999 Eigenschaften (Konventionen):</para>
5002 <title>$::form</title>
5006 <para>Ist ein Objekt der Klasse
5007 "<classname>Form</classname>"</para>
5011 <para>Wird nach jedem Request gelöscht</para>
5015 <para>Muss auch in Tests und Konsolenscripts vorhanden
5020 <para>Enthält am Anfang eines Requests die Requestparameter vom
5025 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
5026 cachen, das wird aber momentan absichtlich zerstört</para>
5030 <para><varname>$::form</varname> wurde unter <productname>SQL
5031 Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
5032 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
5033 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
5034 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
5035 <function>IS->retrieve_customer()</function> in Sicherheit
5038 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
5039 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
5040 3552, Stand version 2.7beta), um dies hinterher wieder auf den
5041 richtigen Wert zu setzen:</para>
5043 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
5044 $::myconfig{numberformat} = $numberformat;
5045 # (...) div Berechnungen
5046 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
5048 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
5049 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
5050 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
5051 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
5052 Es geht ziemlich sicher etwas kaputt.</para>
5054 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
5055 in den <productname>Template::Toolkit</productname> Templates
5056 außerhalb der Controller: der Ausdruck <function>[% var
5057 %]</function> greift auf <varname>$::form->{var}</varname> zu.
5058 Unter Controllern ist der Standard Scope anders, da lautet der
5059 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
5060 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
5061 <function><%var%></function> zeigt auf
5062 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
5063 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
5066 <programlisting>[%- IF business %]
5067 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
5068 [%- END %]</programlisting>
5070 <para>Entweder wird hier dann $::form->{business} ausgewertet
5071 oder aber der Funktion
5072 <function>$form->parse_html_template</function> wird explizit
5073 noch ein zusätzlicher Hash übergeben, der dann auch in den
5074 (Web-)Templates zu Verfügung steht, bspw. so:</para>
5076 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
5078 <para>Innerhalb von Schleifen wird
5079 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
5080 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
5081 welches über alle Positionen eines Lieferscheins in Schleife
5084 <programlisting>for $i (1 .. $form->{rowcount}) {
5086 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
5087 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
5088 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
5094 <title>%::myconfig</title>
5098 <para>Das einzige Hash unter den globalen Variablen</para>
5102 <para>Wird spätestens benötigt wenn auf die Datenbank
5103 zugegriffen wird</para>
5107 <para>Wird bei jedem Request neu erstellt.</para>
5111 <para>Enthält die Userdaten des aktuellen Logins</para>
5115 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
5116 extern serialisiert werden, weil da auch der Datenbankzugriff
5117 für diesen user drinsteht.</para>
5121 <para>Enthält unter anderem Listenbegrenzung vclimit,
5122 Datumsformat dateformat und Nummernformat numberformat</para>
5126 <para>Enthält Datenbankzugriffinformationen</para>
5130 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
5131 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
5132 aktuellen Users entscheiden müssen, befragen
5133 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
5134 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
5135 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
5136 Informationen über den Benutzer die über die
5137 Administrator-Schnittstelle eingegeben wurden.</para>
5141 <title>$::locale</title>
5145 <para>Objekt der Klasse "Locale"</para>
5149 <para>Wird pro Request erstellt</para>
5153 <para>Muss auch für Tests und Scripte immer verfügbar
5158 <para>Cached intern über Requestgrenzen hinweg benutzte
5163 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
5164 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
5168 <title>$::lxdebug</title>
5172 <para>Objekt der Klasse "LXDebug"</para>
5176 <para>Wird global gecached</para>
5180 <para>Muss immer verfügbar sein, in nahezu allen
5185 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
5186 bereit, wie "<function>enter_sub</function>" und
5187 "<function>leave_sub</function>", mit denen in den alten Modulen ein
5188 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
5189 der man die Wallclockzeit seit Requeststart loggen kann, sowie
5190 "<function>message</function>" und "<function>dump</function>" mit
5191 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
5194 <para>Beispielsweise so:</para>
5196 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
5197 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
5201 <title>$::auth</title>
5205 <para>Objekt der Klasse "SL::Auth"</para>
5209 <para>Wird global gecached</para>
5213 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
5217 <para>Wird nach jedem Request resettet.</para>
5221 <para><varname>$::auth</varname> stellt Funktionen bereit um die
5222 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
5223 vom aktuellen User abhängen wird das Objekt aus
5224 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
5225 Request kurz resettet.</para>
5227 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten. Dessen Einstellungen können über
5228 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert ist ein Hash mit den Werten aus der Tabelle
5229 <literal>auth.clients</literal>.</para>
5233 <title>$::lx_office_conf</title>
5237 <para>Objekt der Klasse
5238 "<classname>SL::LxOfficeConf</classname>"</para>
5242 <para>Global gecached</para>
5246 <para>Repräsentation der
5247 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
5251 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
5252 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
5253 das Programm die Konfiguration ändern kann oder sollte.</para>
5255 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
5256 Debug- und Trace-Log-Datei wie folgt konfiguriert und
5259 <programlisting>[debug]
5260 file = /tmp/kivitendo-debug.log</programlisting>
5262 <para>ist der Key <varname>file</varname> im Programm als
5263 <varname>$::lx_office_conf->{debug}{file}</varname>
5267 <para>Zugriff auf die Konfiguration erfolgt im Moment über
5268 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
5273 <title>$::instance_conf</title>
5277 <para>Objekt der Klasse
5278 "<classname>SL::InstanceConfiguration</classname>"</para>
5282 <para>wird pro Request neu erstellt</para>
5286 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
5287 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
5288 ist hier eine Mandantendatenbank. Beispielsweise überprüft
5289 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
5290 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
5294 <title>$::dispatcher</title>
5298 <para>Objekt der Klasse
5299 "<varname>SL::Dispatcher</varname>"</para>
5303 <para>wird pro Serverprozess erstellt.</para>
5307 <para>enthält Informationen über die technische Verbindung zum
5312 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
5313 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
5314 Objekt untergebracht.</para>
5318 <title>$::request</title>
5322 <para>Hashref (evtl später Objekt)</para>
5326 <para>Wird pro Request neu initialisiert.</para>
5330 <para>Keine Unterstruktur garantiert.</para>
5334 <para><varname>$::request</varname> ist ein generischer Platz um
5335 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
5336 at a distance benutzt werden, sondern um lokales memoizing zu
5337 ermöglichen, das garantiert am Ende des Requests zerstört
5340 <para>Vieles von dem, was im moment in <varname>$::form</varname>
5341 liegt, sollte eigentlich hier liegen. Die groben
5342 Differentialkriterien sind:</para>
5346 <para>Kommt es vom User, und soll unverändert wieder an den
5347 User? Dann <varname>$::form</varname>, steht da eh schon</para>
5351 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
5352 Requests gebraucht werden? Dann
5353 <varname>$::request</varname></para>
5357 <para>Muss ich von anderen Teilen des Programms lesend drauf
5358 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
5359 Wrappermethode</para>
5366 <title>Ehemalige globale Variablen</title>
5368 <para>Die folgenden Variablen waren einmal im Programm, und wurden
5372 <title>$::cgi</title>
5376 <para>war nötig, weil cookie Methoden nicht als
5377 Klassenfunktionen funktionieren</para>
5381 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
5382 Klassennamespace gehalten wird und über Requestgrenzen
5387 <para>liegt jetzt unter
5388 <varname>$::request->{cgi}</varname></para>
5394 <title>$::all_units</title>
5398 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
5399 ein paar hundert mal pro Request eine Liste der Einheiten
5400 brauchen, und de als Parameter durch einen Riesenstack von
5401 Funktionen geschleift werden müssten.</para>
5405 <para>Liegt jetzt unter
5406 <varname>$::request->{cache}{all_units}</varname></para>
5411 <function>AM->retrieve_all_units()</function> gesetzt oder
5418 <title>%::called_subs</title>
5422 <para>wurde benutzt um callsub deep recursions
5427 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
5428 möglichen Rekursioenen darstellt, und da nie welche
5433 <para>komplette recursion protection wurde entfernt.</para>
5440 <sect1 id="devel.fcgi">
5441 <title>Entwicklung unter FastCGI</title>
5443 <sect2 id="devel.fcgi.general">
5444 <title>Allgemeines</title>
5446 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
5447 werden, muss der Webserver neu gestartet werden.</para>
5449 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
5450 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
5451 müssen folgende Aspekte beachtet werden.</para>
5454 <sect2 id="devel.fcgi.exiting">
5455 <title>Programmende und Ausnahmen</title>
5457 <para>Betrifft die Funktionen <function>warn</function>,
5458 <function>die</function>, <function>exit</function>,
5459 <function>carp</function> und <function>confess</function>.</para>
5461 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
5462 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
5463 am Laufen zu halten. Man kann mit <function>die</function>,
5464 <function>confess</function> oder <function>carp</function> Fehler
5465 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
5466 eigene <function>$::form-</function>error()> tut im Prinzip das
5467 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
5468 <function>exit</function> hingegen werden nicht abgefangen.
5469 <function>warn</function> wird direkt nach STDERR, also in Server Log
5470 eine Nachricht schreiben (sofern in der Konfiguration nicht die
5471 Warnungen in das kivitendo Log umgeleitet wurden), und
5472 <function>exit</function> wird die Ausführung beenden.</para>
5474 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
5475 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
5476 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
5477 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
5480 <sect2 id="devel.fcgi.globals">
5481 <title>Globale Variablen</title>
5483 <para>Um zu vermeiden, dass Informationen von einem Request in einen
5484 anderen gelangen, müssen alle globalen Variablen vor einem Request
5485 sauber initialisiert werden. Das ist besonders wichtig im
5486 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
5487 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
5490 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
5491 abgetrennten Block, der alle kanonischen globalen Variablen listet und
5492 erklärt. Bitte keine anderen einführen ohne das sauber zu
5493 dokumentieren.</para>
5495 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
5496 man sicher geht, dass man die richtige erwischt.</para>
5499 <sect2 id="devel.fcgi.performance">
5500 <title>Performance und Statistiken</title>
5502 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
5503 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
5504 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
5505 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
5506 sind es je nach Menge der definierten Variablen 1-2s. Ab der
5507 Moose/Rose::DB Version sind es 5-6s.</para>
5509 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
5510 den kritischen Pfaden, unter 0,15 sonst.</para>
5514 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
5515 <title>SQL-Upgradedateien</title>
5517 <sect2 id="db-upgrade-files.introduction"
5518 xreflabel="Einführung in die Datenbank-Upgradedateien">
5519 <title>Einführung</title>
5521 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte gesteuert, die sich im Verzeichnis <filename>sql/Pg-upgrade2</filename>
5522 befinden. In diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren, die neben den eigentlich auszuführenden SQL- oder
5523 Perl-Befehlen einige Kontrollinformationen enthält.</para>
5525 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten, sodass Datenbankscripte zwar in einer sicheren Reihenfolge
5526 ausgeführt werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt werden, wenn die Tabelle mit <literal>CREATE
5527 TABLE</literal> angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man keine Versionsnummern braucht.</para>
5529 <para>kivitendo merkt sich dabei, welches der Upgradescripte in <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
5530 führt diese nicht erneut aus. Dazu dient die Tabelle "<literal>schema_info</literal>", die bei der Anmeldung automatisch angelegt
5534 <sect2 id="db-upgrade-files.format"
5535 xreflabel="Format der Upgradedateien">
5536 <title>Format der Kontrollinformationen</title>
5538 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5539 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5540 hat dabei das folgende Format:</para>
5542 <para>Für SQL-Upgradedateien:</para>
5544 <programlisting>-- @key: value</programlisting>
5546 <para>Für Perl-Upgradedateien:</para>
5548 <programlisting># @key: value</programlisting>
5550 <para>Leerzeichen vor "<varname>value</varname>" werden
5553 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5557 <term><varname>tag</varname></term>
5560 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5561 Dieser "tag" kann von anderen Kontrolldateien in ihren
5562 Abhängigkeiten verwendet werden (Schlüsselwort
5563 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5564 in der Datenbank eingetragen wird.</para>
5566 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5567 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5569 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5570 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5571 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5577 <term><varname>charset</varname></term>
5580 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5581 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
5582 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte hingegen müssen immer in UTF-8 encodiert sein und sollten
5583 demnach auch ein "<literal>use utf8;</literal>" enthalten.</para>
5588 <term><varname>description</varname></term>
5591 <para>Benötigt. Eine Beschreibung, was in diesem Update
5592 passiert. Diese wird dem Benutzer beim eigentlichen
5593 Datenbankupdate angezeigt. Während der Tag in englisch gehalten
5594 sein sollte, sollte die Beschreibung auf Deutsch
5600 <term><varname>depends</varname></term>
5603 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5604 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
5605 dass die in dieser Liste aufgeführten Scripte bereits
5606 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5608 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5609 Script "b" existiert, das von Änderungen in "a" abhängt, und
5610 eine neue Kontrolldatei für "c" erstellt wird, die von
5611 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5612 Tag "b" als Abhängigkeit zu definieren.</para>
5614 <para>Es ist nicht erlaubt, sich selbst referenzierende
5615 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5616 und "c" -> "a").</para>
5621 <term><varname>priority</varname></term>
5624 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5625 der Scripte ausgeführt werden, die die gleichen
5626 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5627 der Wert 1000 benutzt.</para>
5629 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5630 "depends" benutzt werden. kivitendo sortiert die auszuführenden
5631 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5632 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5633 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5634 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5635 Priorität alphabetisch nach dem "tag".</para>
5640 <term><varname>ignore</varname></term>
5643 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
5644 Skript bei der Anmeldung ignoriert und entsprechend nicht
5651 <sect2 id="db-upgrade-files.format-perl-files" xreflabel="Format von Perl-Upgradedateien">
5652 <title>Format von in Perl geschriebenen Datenbankupgradescripten</title>
5654 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so ausgeführt sondern müssen sich an gewisse Konventionen
5655 halten. Dafür bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
5657 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse dar, die vom Elternobjekt
5658 "<literal>SL::DBUpgrade2::Base</literal>" erben und eine Funktion namens "<literal>run</literal>" zur Verfügung stellen muss. Das
5659 Script wird ausgeführt, indem eine Instanz dieser Klasse erzeugt und darauf die erwähnte "<literal>run</literal>" aufgerufen
5662 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert für "<literal>@tag</literal>" ableitet. Dabei werden alle
5663 Zeichen, die in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche ersetzt. Insgesamt sieht der Paketname wie folgt
5664 aus: "<literal>SL::DBUpgrade2::tag</literal>".</para>
5666 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
5667 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
5669 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie folgt aus:</para>
5671 <programlisting># @tag: beispiel-upgrade-file42
5672 # @description: Ein schönes Beispielscript
5673 # @depends: release_3_0_0
5674 package SL::DBUpgrade2::beispiel_upgrade_file42;
5679 use parent qw(SL::DBUpgrade2::Base);
5684 # hier Aktionen ausführen
5693 <sect2 id="db-upgrade-files.dbupgrade-tool"
5694 xreflabel="Hilfsscript dbupgrade2_tool.pl">
5695 <title>Hilfsscript dbupgrade2_tool.pl</title>
5697 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
5698 existiert ein Hilfsscript namens
5699 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
5700 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
5701 liest alle Datenbankupgradescripte aus dem Verzeichnis
5702 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
5703 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
5704 von der Kommandozeile überprüft werden können.</para>
5706 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
5707 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
5708 sich aber auch Informationen auf verschiedene Art ausgeben
5713 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
5714 --list</command>"</para>
5716 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
5717 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
5718 würde. Es werden neben der Listenposition der Tag, die
5719 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
5723 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
5724 --tree</command>"</para>
5726 <para>Listet alle Tags in Baumform basierend auf den
5727 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
5728 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
5729 beim übergeordneten Script als Abhängigkeit eingetragen
5733 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
5734 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
5735 --rtree</command>"</para>
5737 <para>Listet alle Tags in Baumform basierend auf den
5738 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
5739 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
5740 die das übergeordnete Script als Abhängigkeit eingetragen
5745 <para>Baumform mit Postscriptausgabe:
5746 "<command>./scripts/dbupgrade2_tool.pl
5747 --graphviz</command>"</para>
5749 <para>Benötigt das Tool "<command>graphviz</command>", um mit
5750 seiner Hilfe die <link
5751 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
5752 Baumform</link> in eine Postscriptdatei namens
5753 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
5754 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
5755 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
5756 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
5761 <para>Scripte, von denen kein anderes Script abhängt:
5762 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
5764 <para>Listet die Tags aller Scripte auf, von denen keine anderen
5765 Scripte abhängen.</para>
5771 <sect1 id="translations-languages" xreflabel="Translations and languages">
5772 <title>Translations and languages</title>
5774 <sect2 id="translations-languages.introduction"
5775 xreflabel="Introduction to translations and languages">
5776 <title>Introduction</title>
5779 <para>Dieser Abschnitt ist in Englisch geschrieben, um
5780 internationalen Übersetzern die Arbeit zu erleichtern.</para>
5783 <para>This section describes how localization packages in kivitendo
5784 are built. Currently the only language fully supported is German, and
5785 since most of the internal messages are held in English the English
5786 version is usable too.</para>
5788 <para>A stub version of French is included but not functunal at this
5792 <sect2 id="translations-languages.character-set"
5793 xreflabel="Character set">
5794 <title>Character set</title>
5796 <para>All files included in a language pack must use UTF-8 as their encoding.</para>
5799 <sect2 id="translations-languages.file-structure"
5800 xreflabel="File structure">
5801 <title>File structure</title>
5803 <para>The structure of locales in kivitendo is:</para>
5805 <programlisting>kivitendo/locale/<langcode>/</programlisting>
5807 <para>where <langcode> stands for an abbreviation of the
5808 language package. The builtin packages use two letter <ulink
5809 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
5810 but the actual name is not relevant for the program and can easily be
5812 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
5813 tags</ulink> (i.e. "en_GB"). In fact the original language packages
5814 from SQL Ledger are named in this way.</para>
5816 <para>In such a language directory the following files are
5821 <term>LANGUAGE</term>
5824 <para>This file is mandatory.</para>
5826 <para>The <filename>LANGUAGE</filename> file contains the self
5827 descripted name of the language. It should contain a native
5828 representation first, and in parenthesis an english translation
5829 after that. Example:</para>
5831 <programlisting>Deutsch (German)</programlisting>
5839 <para>This file is mandatory.</para>
5841 <para>The central translation file. It is essentially an inline
5842 Perl script autogenerated by <command>locales.pl</command>. To
5843 generate it, generate the directory and the two files mentioned
5844 above, and execute the following command:</para>
5846 <programlisting>scripts/locales.pl <langcode></programlisting>
5848 <para>Otherwise you can simply copy one of the other languages.
5849 You will be told how many are missing like this:</para>
5851 <programlisting>$ scripts/locales.pl en
5852 English - 0.6% - 2015/2028 missing</programlisting>
5854 <para>A file named "<filename>missing</filename>" will be
5855 generated and can be edited. You can also edit the
5856 "<filename>all</filename>" file directly. Edit everything you
5857 like to fit the target language and execute
5858 <command>locales.pl</command> again. See how the missing words
5864 <term>Num2text</term>
5867 <para>Legacy code from SQL Ledger. It provides a means for
5868 numbers to be converted into natural language, like
5869 <literal>1523 => one thousand five hundred twenty
5870 three</literal>. If you want to provide it, it must be inlinable
5871 Perl code which provides a <function>num2text</function> sub. If
5872 an <function>init</function> sub exists it will be executed
5875 <para>Only used in the check and receipt printing module.</para>
5880 <term>special_chars</term>
5883 <para>kivitendo comes with a lot of interfaces to different
5884 formats, some of which are rather picky with their accepted
5885 charset. The <filename>special_chars</filename> file contains a
5886 listing of chars not suited for different file format and
5887 provides substitutions. It is written in "Simple Ini" style,
5888 containing a block for every file format.</para>
5890 <para>First entry should be the order of substitution for
5891 entries as a whitespace separated list. All entries are
5892 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
5893 and <literal>\\</literal> all work.</para>
5895 <para>After that every entry is a special char that should be
5896 translated when writing text into such a file.</para>
5898 <para>Example:</para>
5900 <programlisting>[Template/XML]
5901 order=& < > \n
5905 \n=<br></programlisting>
5907 <para>Note the importance of the order in this example.
5908 Substituting < and > befor & would lead to $gt; become
5911 <para>For a list of valid formats, see the German
5912 <filename>special_chars</filename> entry. As of this writing the
5913 following are recognized:</para>
5915 <programlisting>HTML
5920 Template/OpenDocument
5921 filenames</programlisting>
5923 <para>The last of which is very machine dependant. Remember that
5924 a lot of characters are forbidden by some filesystems, for
5925 exmaple MS Windows doesn't like ':' in its files where Linux
5926 doesn't mind that. If you want the files created with your
5927 language pack to be portable, find all chars that could cause
5933 <term>missing</term>
5936 <para>This file is not a part of the language package
5939 <para>This is a file generated by
5940 <command>scripts/locales.pl</command> while processing your
5941 locales. It's only to have the missing entries singled out and
5942 does not belong to a language package.</para>
5950 <para>This file is not a part of the language package
5953 <para>Another file generated by
5954 <command>scripts/locales.pl</command>. If for any reason a
5955 translation does not appear anymore and can be deleted, it gets
5956 moved here. The last 50 or so entries deleted are saved here in
5957 case you made a typo, so that you don't have to translate
5958 everything again. If a tranlsation is missing, the lost file is
5959 checked first. If you maintain a language package, you might
5960 want to keep this safe somewhere.</para>
5967 <sect1 id="devel.testsuite">
5968 <title>Die kivitendo-Test-Suite</title>
5970 <sect2 id="devel.testsuite.intro">
5971 <title>Einführung</title>
5973 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul <literal>Test::More</literal>.</para>
5975 <para>Die grundlegenden Fakten sind:</para>
5978 <listitem><para>Alle Tests liegen im Unterverzeichnis <filename>t/</filename>.</para></listitem>
5980 <listitem><para>Ein Script (bzw. ein Test) in <filename>t/</filename> enthält einen oder mehrere Testfälle.</para></listitem>
5982 <listitem><para>Alle Dateinamen von Tests enden auf <literal>.t</literal>. Es sind selbstständig ausführbare Perl-Scripte.</para></listitem>
5984 <listitem><para>Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in <filename>t/</filename>, deren
5985 Dateiname auf <literal>.t</literal> endet.</para></listitem>
5989 <sect2 id="devel.testsuite.prerequisites">
5990 <title>Voraussetzungen</title>
5992 <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>
5995 <listitem><para><literal>Test::Deep</literal> (Debian-Paketname: <literal>libtest-deep-perl</literal>; Fedora Core:
5996 <literal>perl-Test-Deep</literal>; openSUSE: <literal>perl-Test-Deep</literal>)</para></listitem>
5997 <listitem><para><literal>Test::Exception</literal> (Debian-Paketname: <literal>libtest-exception-perl</literal>; Fedora Core:
5998 <literal>perl-Test-Exception</literal>; openSUSE: <literal>perl-Test-Exception</literal>)</para></listitem>
5999 <listitem><para><literal>Test::Output</literal> (Debian-Paketname: <literal>libtest-output-perl</literal>; Fedora Core:
6000 <literal>perl-Test-Output</literal>; openSUSE: <literal>perl-Test-Output</literal>)</para></listitem>
6001 <listitem><para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses Modul ist ab Perl 5.10.1 Bestandteil der
6002 Perl-Distribution und kann für frühere Versionen aus dem <ulink url="http://www.cpan.org">CPAN</ulink> bezogen
6003 werden.</para></listitem>
6004 <listitem><para><literal>LWP::Simple</literal> aus dem Paket <literal>libwww-perl</literal> (Debian-Panetname:
6005 <literal>libwww-perl</literal>; Fedora Core: <literal>perl-libwww-perl</literal>; openSUSE:
6006 <literal>perl-libwww-perl</literal>)</para></listitem>
6007 <listitem><para><literal>URI::Find</literal> (Debian-Panetname: <literal>liburi-find-perl</literal>; Fedora Core:
6008 <literal>perl-URI-Find</literal>; openSUSE: <literal>perl-URI-Find</literal>)</para></listitem>
6011 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
6012 müssen in der Konfigurationsdatei im Abschnit <literal>testing/database</literal> Datenbankverbindungsparameter angegeben
6013 werden. Der hier angegebene Benutzer muss weiterhin das Recht haben, Datenbanken anzulegen und zu löschen.</para>
6016 <sect2 id="devel.testsuite.execution">
6018 Existierende Tests ausführen
6021 <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
6022 gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript <filename>t/test.pl</filename>.</para>
6024 <para>Will man die komplette Test-Suite ausführen, so muss man einfach nur <filename>t/test.pl</filename> ohne weitere Parameter aus
6025 dem kivitendo-Basisverzeichnis heraus ausführen.</para>
6027 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an <filename>t/test.pl</filename>. Beispielsweise:</para>
6029 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
6033 <sect2 id="devel.testsuite.meaning_of_scripts">
6035 Bedeutung der verschiedenen Test-Scripte
6038 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch
6039 während der Entwicklung nützliche Tests sind:</para>
6042 <listitem><para><filename>t/001compile.t</filename> -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab</para></listitem>
6043 <listitem><para><filename>t/002goodperl.t</filename> -- überprüft alle Perl-Dateien auf Anwesenheit von '<literal>use strict</literal>'-Anweisungen</para></listitem>
6044 <listitem><para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von <function>system()</function> und <function>exec()</function> auf Gültigkeit</para></listitem>
6045 <listitem><para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien Tab-Zeichen enthalten</para></listitem>
6046 <listitem><para><filename>t/006spelling.t</filename> -- sucht nach häufigen Rechtschreibfehlern</para></listitem>
6047 <listitem><para><filename>t/011pod.t</filename> -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit</para></listitem>
6050 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module.</para>
6053 <sect2 id="devel.testsuite.create_new">
6055 Neue Test-Scripte erstellen
6058 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende
6059 Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden.</para>
6061 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
6063 Ideen für neue Test-Scripte, die keine konkreten Funktionen testen
6066 <para> Ideen, die abgesehen von Funktionen noch nicht umgesetzt wurden:</para>
6069 <listitem><para>Überprüfung auf fehlende symbolische Links</para></listitem>
6070 <listitem><para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten)</para></listitem>
6071 <listitem><para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para></listitem>
6072 <listitem><para>Überprüfung auf Leerzeichen am Ende von Zeilen</para></listitem>
6073 <listitem><para>Test, ob alle zu übersetzenden Strings in <filename>locale/de/all</filename> vorhanden sind</para></listitem>
6074 <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>
6078 <sect3 id="devel.testsuite.directory_and_test_names">
6080 Konvention für Verzeichnis- und Dateinamen
6083 <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>
6086 <listitem><para>Die Dateiendung muss <filename>.t</filename> lauten.</para></listitem>
6088 <listitem><para>Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise
6089 <filename>bad_function_params.t</filename>).</para></listitem>
6091 <listitem><para>Unterverzeichnisse sollten grob nach dem Themenbereich benannt sein, mit dem sich die Scripte darin befassen
6092 (beispielsweise <filename>background_jobs</filename> für Tests rund um Hintergrund-Jobs).</para></listitem>
6094 <listitem><para>Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist
6095 (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben.</para></listitem>
6099 <sect3 id="devel.testsuite.minimal_example">
6101 Minimales Skelett für eigene Scripte
6104 <para>Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden:</para>
6106 <programlisting>use Test::More tests => 0;
6110 use Support::TestSetup;
6112 Support::TestSetup::login();</programlisting>
6114 <para>Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie
6115 <varname>$::auth</varname>, <varname>$::form</varname> oder <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
6116 <filename>config/kivitendo.conf</filename> im Abschnitt <literal>testing.login</literal> ein gültiger Login-Name eingetragen
6117 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
6119 <para>Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile <code>Support::TestSetup::login();</code>
6120 weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.</para>
6125 <sect1 id="devel.style-guide">
6126 <title>Stil-Richtlinien</title>
6128 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
6129 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
6130 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
6131 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
6133 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
6136 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
6137 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
6142 <para>Es werden keine echten Tabs sondern Leerzeichen
6147 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
6149 <programlisting>foreach my $row (@data) {
6151 # do something with $row
6155 $row->{modules} = MODULE->retrieve(
6156 id => $row->{id},
6157 date => $use_now ? localtime() : $row->{time},
6161 $report->add($row);
6166 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
6167 Zeile wie der letzte Befehl. Beispiele:</para>
6169 <programlisting>sub debug {
6175 <programlisting>if ($form->{item_rows} > 0) {
6181 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
6182 der Befehl / die öffnende schließende Klammer, die den Block
6183 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
6184 Beispiele wie bei 3. gelten.</para>
6188 <para>Die Wörter "<function>else</function>",
6189 "<function>elsif</function>", "<function>while</function>" befinden
6190 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
6193 <programlisting>if ($form->{sum} > 1000) {
6195 } elsif ($form->{sum} > 0) {
6203 } until ($a > 0);</programlisting>
6207 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
6208 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
6209 und grep-ähnliche Operatoren. Beispiel:</para>
6211 <programlisting>$main::lxdebug->message("Could not find file.");
6212 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
6216 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
6218 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
6219 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
6220 Blöcke schon. Beispiel:</para>
6222 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
6227 $form->{sum} += $form->{"row_$i"};
6228 $form->{ $form->{index} } += 1;
6230 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
6234 <para>Mehrzeilige Befehle</para>
6238 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
6239 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
6240 werden, in der die ersten Funktionsparameter in der ersten Zeile
6241 stehen. Beispiel:</para>
6243 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
6244 $form->{some_col_value});</programlisting>
6248 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
6249 besten in einer übersichtlichen Tabellenstruktur organisiert
6250 wird. Beispiel:</para>
6252 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
6253 : $form->{oldcount} ? $form->{oldcount} + 1
6254 : $form->{rowcount} - $form->{rowbase};</programlisting>
6260 <para>Kommentare</para>
6264 <para>Kommentare, die alleine in einer Zeile stehen, sollten
6265 soweit wie der Code eingerückt sein.</para>
6269 <para>Seitliche hängende Kommentare sollten einheitlich
6270 formatiert werden.</para>
6274 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
6275 auf Englisch zu verfassen. So wie ich keine Lust habe,
6276 französischen Quelltext zu lesen, sollte auch der kivitendo
6277 Quelltext für nicht-Deutschsprachige lesbar sein.
6280 <programlisting>my $found = 0;
6288 $i = 0 # initialize $i
6290 $i *= $const; # do something crazy
6291 $i = $n; # recover $i</programlisting>
6297 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
6298 Interpolation gewünscht ist. Beispiel:</para>
6300 <programlisting>$form->{sum} = 0;
6301 $form->{"row_$i"} = $form->{"row_$i"} - 5;
6302 $some_hash{42} = 54;</programlisting>
6306 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
6307 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
6308 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
6309 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
6311 <para>Als Beispiel sei die Funktion
6312 <function>print_options</function> aus
6313 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
6317 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
6318 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
6321 <para>Emacs und vim haben beide recht einfache Methoden zur
6322 Entfernung von trailing whitespace. Emacs kennt das Kommande
6323 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
6324 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
6325 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
6330 <para>Es wird kein <command>perltidy</command> verwendet.</para>
6332 <para>In der Vergangenheit wurde versucht,
6333 <command>perltidy</command> zu verwenden, um einen einheitlichen
6334 Stil zu erlangen. Es hat sich aber gezeigt, dass
6335 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
6336 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
6337 den Interessierten sind hier die
6338 <command>perltidy</command>-Optionen, die grob den beschriebenen
6339 Richtlinien entsprechen:</para>
6341 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
6342 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
6343 -lp -vt=1 -vtc=1</programlisting>
6347 <para><varname>STDERR</varname> ist tabu. Unkonditionale
6348 Debugmeldungen auch.</para>
6350 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
6351 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
6352 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
6354 <para>Die <classname>LXDebug</classname>-Methode
6355 "<function>message</function>" nimmt als ersten Paramter außerdem
6356 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
6357 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
6358 und werden in den meisten Fällen auch vom Repository
6359 zurückgewiesen.</para>
6363 <para>Alle neuen Module müssen use strict verwenden.</para>
6365 <para><varname>$form</varname>, <varname>$auth</varname>,
6366 <varname>$locale</varname>, <varname>$lxdebug</varname> und
6367 <varname>%myconfig</varname> werden derzeit aus dem main package
6368 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
6369 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
6374 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
6375 <title>Dokumentation erstellen</title>
6377 <sect2 id="devel.build-doc.introduction">
6378 <title>Einführung</title>
6380 <para>Diese Dokumentation ist in <productname>DocBook</productname>
6381 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
6382 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
6383 Editor nutzt, der spezielle Unterstützung für
6384 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
6385 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
6386 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
6390 <sect2 id="devel.build-doc.required-software">
6391 <title>Benötigte Software</title>
6393 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
6394 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
6395 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
6396 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
6397 <command>scripts/build_doc.sh</command>.</para>
6399 <para>Das Script benötigt zur Konvertierung verschiedene
6400 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
6406 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
6407 in einer halbwegs aktuellen Version</para>
6411 <para>Das Java-Build-System <ulink
6412 url="http://ant.apache.org/">Apache Ant</ulink></para>
6416 <para>Das Dokumentations-System Dobudish für
6417 <productname>DocBook</productname> 4.5, eine Zusammenstellung
6418 diverser Stylesheets und Grafiken zur Konvertierung von
6419 <productname>DocBook</productname> XML in andere Formate. Das
6420 Paket, das benötigt wird, ist zum Zeitpunkt der
6421 Dokumentationserstellung
6422 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
6423 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
6428 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
6429 sind auf allen gängigen Plattformen verfügbar. Beispiel für
6430 Debian/Ubuntu:</para>
6432 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
6434 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
6435 <filename>doc/build</filename> entpackt werden. Beispiel unter der
6436 Annahme, das <productname>Dobudish</productname> in
6437 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
6439 <programlisting>cd doc/build
6440 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
6443 <sect2 id="devel.build-doc.build">
6444 <title>PDFs und HTML-Seiten erstellen</title>
6446 <para>Die eigentliche Konvertierung erfolgt nach Installation der
6447 benötigten Software mit einem einfachen Aufruf direkt aus dem
6448 kivitendo-Installationsverzeichnis heraus:</para>
6450 <programlisting>./scripts/build_doc.sh</programlisting>
6453 <sect2 id="devel.build-doc.repository">
6454 <title>Einchecken in das Git-Repository</title>
6456 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
6457 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
6458 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
6459 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
6461 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
6462 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob