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.1.0: Installation, Konfiguration, Entwicklung</title>
7 <chapter id="Aktuelle-Hinweise">
8 <title>Aktuelle Hinweise</title>
10 <para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>
14 <para>im kivitendo-Forum: <ulink
15 url="https://forum.kivitendo.org/">https://forum.kivitendo.org/</ulink></para>
18 <para>in der doc/UPGRADE Datei im doc-Verzeichnis der Installation</para>
21 <para>Im Schulungs- und Dienstleistungsangebot der entsprechenden kivitendo-Partner: <ulink
22 url="http://www.kivitendo.de/partner.html">http://www.kivitendo.de/partner.html</ulink></para>
28 <title>Installation und Grundkonfiguration</title>
30 <sect1 id="Installation-Übersicht">
31 <title>Übersicht</title>
34 Die Installation von kivitendo umfasst mehrere Schritte. Die folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
35 Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit minimalen Features möglichst schnell zum Laufen zu kriegen.
39 <listitem><para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo benötigt gewisse Ressourcen und benutzt weitere
40 Programme. Das Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert diese. Auch die Liste der benötigten Perl-Module
41 befindet sich hier.</para></listitem>
43 <listitem><para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst die "<xref
44 linkend="Manuelle-Installation-des-Programmpaketes"/>" sowie grundlegende Einstellungen, die der "<xref
45 linkend="config.config-file"/>" erläutert.</para></listitem>
47 <listitem><para><emphasis>Konfiguration externer Programme</emphasis>: hierzu gehören die Datenbank ("<xref
48 linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der Webserver ("<xref
49 linkend="Apache-Konfiguration"/>"). </para></listitem>
51 <listitem><para><emphasis>Benutzerinformationen speichern können</emphasis>: man benötigt mindestens eine Datenbank, in der
52 Informationen zur Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man das als Administrator macht, verrät "<xref
53 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para></listitem>
55 <listitem><para><emphasis>Benutzer, Gruppen und Datenbanken anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
56 linkend="Benutzer--und-Gruppenverwaltung"/>".</para></listitem>
58 <listitem><para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann kann es losgehen: "<xref
59 linkend="kivitendo-ERP-verwenden"/>"</para></listitem>
63 Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen
68 <sect1 id="Benötigte-Software-und-Pakete">
69 <title>Benötigte Software und Pakete</title>
71 <sect2 id="Betriebssystem">
72 <title>Betriebssystem</title>
74 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
75 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
76 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
77 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
78 ohne große Probleme auf den derzeit aktuellen verbreiteten
79 Distributionen läuft.</para>
81 <para>Anfang 2014 sind das folgende Systeme, von denen bekannt ist,
82 dass kivitendo auf ihnen läuft:</para>
90 <para>6.0 "Squeeze" (hier muss allerdings das Modul FCGI in der Version >= 0.72 compiled werden, und <literal>Rose::DB::Object</literal> ist zu alt)</para>
93 <para>7.0 "Wheezy"</para>
99 <para>Ubuntu 12.04 LTS "Precise Pangolin", 12.10 "Quantal Quetzal", 13.04 "Precise Pangolin" und 14.04 "Trusty Tahr" LTS Alpha</para>
103 <para>openSUSE 12.2, 12.3 und 13.1</para>
107 <para>SuSE Linux Enterprice Server 11</para>
111 <para>Fedora 16 bis 19</para>
116 <sect2 id="Pakete" xreflabel="Pakete">
117 <title>Benötigte Perl-Pakete installieren</title>
119 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
120 Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.4)
123 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht Bestandteil einer Standard-Perl-Installation sind. Um zu
124 überprüfen, ob die erforderlichen Pakete installiert und aktuell genug sind, wird ein Script mitgeliefert, das wie folgt aufgerufen
127 <programlisting>./scripts/installation_check.pl</programlisting>
129 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
132 <listitem><para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para></listitem>
134 <listitem><para><literal>Archive::Zip</literal></para></listitem>
136 <listitem><para><literal>Config::Std</literal></para></listitem>
138 <listitem><para><literal>DateTime</literal></para></listitem>
140 <listitem><para><literal>DBI</literal></para></listitem>
142 <listitem><para><literal>DBD::Pg</literal></para></listitem>
144 <listitem><para><literal>Email::Address</literal></para></listitem>
146 <listitem><para><literal>Email::MIME</literal></para></listitem>
148 <listitem><para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71 inklusive; siehe <xref linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para></listitem>
150 <listitem><para><literal>File::Copy::Recursive</literal></para></listitem>
152 <listitem><para><literal>JSON</literal></para></listitem>
154 <listitem><para><literal>List::MoreUtils</literal></para></listitem>
156 <listitem><para><literal>Net::SMTP::SSL</literal> (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "<xref
157 linkend="config.sending-email.smtp"/>")</para></listitem>
159 <listitem><para><literal>Net::SSLGlue</literal> (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "<xref
160 linkend="config.sending-email.smtp"/>")</para></listitem>
162 <listitem><para><literal>Params::Validate</literal></para></listitem>
164 <listitem><para><literal>PDF::API2</literal></para></listitem>
166 <listitem><para><literal>Rose::Object</literal></para></listitem>
168 <listitem><para><literal>Rose::DB</literal></para></listitem>
170 <listitem><para><literal>Rose::DB::Object</literal> Version 0.788 oder neuer</para></listitem>
172 <listitem><para><literal>Template</literal></para></listitem>
174 <listitem><para><literal>Text::CSV_XS</literal></para></listitem>
176 <listitem><para><literal>Text::Iconv</literal></para></listitem>
178 <listitem><para><literal>URI</literal></para></listitem>
180 <listitem><para><literal>XML::Writer</literal></para></listitem>
182 <listitem><para><literal>YAML</literal></para></listitem>
185 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen: <literal>File::Copy::Recursive</literal>.</para>
187 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen: <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
188 <literal>Net::SSLGlue</literal>.</para>
190 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
191 hinzugekommen, <literal>URI</literal> und
192 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
195 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
196 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
197 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
198 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
200 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
201 hinzugekommen.</para>
203 <para><literal>Email::Address</literal> und
204 <literal>List::MoreUtils</literal> sind schon länger feste
205 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
206 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
207 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
208 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
212 <title>Debian und Ubuntu</title>
214 <para>Alle benötigten Perl-Pakete stehen für Debian und Ubuntu als Debian-Pakete zur Verfügung. Sie können mit folgendem Befehl
215 installiert werden:</para>
217 <programlisting>apt-get install apache2 libarchive-zip-perl libclone-perl \
218 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
219 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
220 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
221 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
222 librose-db-perl librose-object-perl libsort-naturally-perl \
223 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
224 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
225 libfile-copy-recursive-perl postgresql</programlisting>
229 <title>Fedora Core</title>
231 <para>Für Fedora Core stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl installeirt werden:</para>
233 <programlisting>yum install httpd perl-Archive-Zip perl-Clone perl-DBD-Pg \
234 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
235 perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
236 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
237 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
238 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
239 perl-XML-Writer perl-YAML perl-parent postgresql-server</programlisting>
241 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
243 <programlisting>yum install perl-CPAN
244 cpan Config::Std</programlisting>
249 <title>openSUSE</title>
251 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
252 installiert werden:</para>
254 <programlisting>zypper install apache2 perl-Archive-Zip perl-Clone \
255 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
256 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
257 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
258 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
259 perl-URI perl-XML-Writer perl-YAML postgresql-server</programlisting>
261 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
263 <programlisting>yum install perl-CPAN
264 cpan Rose::Db::Object</programlisting>
270 <sect1 id="Manuelle-Installation-des-Programmpaketes"
271 xreflabel="Manuelle Installation des Programmpaketes">
272 <title>Manuelle Installation des Programmpaketes</title>
273 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github gehostet und kann
274 <ulink url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink> heruntergeladen werden.</para>
275 <para>Die kivitendo ERP Installationsdatei (<filename>kivitendo-erp-3.1.0.tgz</filename>) wird im Dokumentenverzeichnis des Webservers
276 (z.B. <filename>/var/www/html/</filename>, <filename>/srv/www/htdocs</filename> oder <filename>/var/www/</filename>) entpackt:</para>
278 <programlisting>cd /var/www
279 tar xvzf kivitendo-erp-3.1.0.tgz</programlisting>
281 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
283 <programlisting>cd kivitendo-erp</programlisting>
285 <para>Alternativ können Sie auch einen Alias in der
286 Webserverkonfiguration benutzen, um auf das tatsächliche
287 Installationsverzeichnis zu verweisen.</para>
289 <para>Bei einer Neuinstallation der Version 3.1.0 muß das WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
291 <programlisting>mkdir webdav</programlisting>
293 <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
294 beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
295 Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
296 core <constant>apache</constant> oder bei OpenSUSE <constant>wwwrun</constant>).</para>
298 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
299 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
301 <programlisting>chown -R www-data users spool webdav</programlisting>
303 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
304 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>
306 <programlisting>chown www-data templates users</programlisting>
309 <sect1 id="config.config-file">
310 <title>kivitendo-Konfigurationsdatei</title>
312 <sect2 id="config.config-file.introduction"
313 xreflabel="Einführung in die Konfigurationsdatei">
314 <title>Einführung</title>
316 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei,
317 die benötigt wird: <filename>config/kivitendo.conf</filename> (kurz:
318 "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
319 von kivitendo bzw. der Migration von älteren Versionen angelegt
322 <para>Als Vorlage dient die Datei
323 <filename>config/kivitendo.conf.default</filename> (kurz: "die
324 Default-Datei"):</para>
326 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
328 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
329 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
330 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
331 Abschnitte und Werte enthalten, die von denen der Default-Datei
336 Vor der Umbenennung in kivitendo hieß diese Datei noch <filename>config/lx_office.conf</filename>. Aus Gründen der Kompatibilität
337 wird diese Datei eingelesen, sofern die Datei <filename>config/kivitendo.conf</filename> nicht existiert.
341 <para>Diese Hauptkonfigurationsdatei ist dann eine
342 installationsspezifische Datei, d.h. sie enthält bspw. lokale
343 Passwörter und wird auch nicht im Versionsmanagement (git)
346 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
347 Mandaten, bzw. Datenbanken gleich.</para>
350 <sect2 id="config.config-file.sections-parameters">
351 <title>Abschnitte und Parameter</title>
353 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
354 entsprechend kommentiert sind:</para>
357 <listitem><para><literal>authentication</literal> (siehe Abschnitt "<xref
358 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>" in diesem Kapitel)</para></listitem>
360 <listitem><para><literal>authentication/database</literal></para></listitem>
362 <listitem><para><literal>authentication/ldap</literal></para></listitem>
364 <listitem><para><literal>system</literal></para></listitem>
366 <listitem><para><literal>paths</literal></para></listitem>
368 <listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>
370 <listitem><para><literal>applications</literal></para></listitem>
372 <listitem><para><literal>environment</literal></para></listitem>
375 <listitem><para><literal>print_templates</literal></para></listitem>
377 <listitem><para><literal>task_server</literal></para></listitem>
379 <listitem><para><literal>periodic_invoices</literal></para></listitem>
381 <listitem><para><literal>self_tests</literal></para></listitem>
383 <listitem><para><literal>console</literal></para></listitem>
385 <listitem><para><literal>testing</literal></para></listitem>
387 <listitem><para><literal>testing/database</literal></para></listitem>
389 <listitem><para><literal>debug</literal></para></listitem>
392 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
393 einzustellen oder zu kontrollieren sind, sind:</para>
395 <programlisting>[authentication]
396 admin_password = geheim
398 [authentication/database]
403 password =</programlisting>
405 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
406 <varname>[periodic_invoices]</varname> den Login eines Benutzers
407 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
408 mit Informationen über die erstellten Rechnungen bekommt.</para>
410 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten Ausführung bestimmter Aufgaben mit, den <link
411 linkend="config.task-server">Taskserver</link>. Er wird u.a. für Features wie die <link
412 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link> benötigt, erledigt aber auch andere erforderliche Aufgaben
413 und muss daher in Betrieb genommen werden. Der Taskserver benötigt zwei Konfigurationseinstellungen, die unter
414 <varname>[task_server]</varname> anzugeben sind: ein Mandant (entweder der Mandantenname oder eine Datenbank-ID, Variable
415 <varname>client</varname>), aus dem die Datenbankkonfiguration entnommen wird, sowie ein Login (Variable <varname>login</varname>)
416 eines Benutzers, der für gewisse Dinge wie die Rechnungserstellung als Verkäufer eingetragen wird.</para>
418 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
419 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
422 <sect2 id="config.config-file.prior-versions">
423 <title>Versionen vor 2.6.3</title>
425 <para>In älteren kivitendo Versionen gab es im Verzeichnis
426 <filename>config</filename> die Dateien
427 <filename>authentication.pl</filename> und
428 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
429 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
430 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
431 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
433 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
434 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
435 manuell übertragen und die alten Konfigurationsdateien anschließend
436 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
437 entsprechende Fehlermeldung an.</para>
441 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
442 <title>Anpassung der PostgreSQL-Konfiguration</title>
444 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
446 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
447 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
449 <para>kivitendo setzt zwingend voraus, dass die Datenbank Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen Serverinstallationen
450 braucht man hier meist nicht einzugreifen.</para>
452 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so
453 braucht man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
455 <programlisting>su postgres
457 exit </programlisting>
459 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
460 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
461 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
464 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
466 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
467 Versionsnummer angepasst werden.</para>
469 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
471 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
472 <literal>\l</literal> geprüft werden.</para>
475 <sect2 id="Änderungen-an-Konfigurationsdateien">
476 <title>Änderungen an Konfigurationsdateien</title>
478 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
479 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
480 <filename>/var/lib/pgsql/data/</filename> oder
481 <filename>/etc/postgresql/</filename>, muss sichergestellt werden,
482 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
483 Parameter <varname>listen_address</varname> gesteuert. Laufen
484 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
485 <literal>localhost</literal> verwendet werden. Andernfalls müssen
486 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
487 was mit dem Wert <literal>*</literal> geschieht.</para>
489 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
490 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
491 sein sollte, müssen die Berichtigungen für den Zugriff geändert
492 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
493 nögiten Verbindungen immer zuzulassen, für eine lokal laufenden
494 Datenbank zum Beispiel:</para>
496 <programlisting>local all kivitendo password
497 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
500 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
501 <title>Erweiterung für servergespeicherte Prozeduren</title>
503 <para>In der Datenbank <literal>template1</literal> muss die
504 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
505 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
506 <programlisting>su - postgres
507 psql template1</programlisting>
509 führen Sie die folgenden Kommandos aus:</para>
511 <programlisting>create language 'plpgsql';
515 <sect2 id="Datenbankbenutzer-anlegen">
516 <title>Datenbankbenutzer anlegen</title>
518 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
519 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
520 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
523 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit nein
524 beantworten, genauso ist die Berechtigung neue User (Roles) zu
525 generieren nicht nötig.</para>
526 <programlisting>su - postgres
527 createuser -d -P kivitendo
528 exit</programlisting>
530 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
531 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.
532 den hier gewählten Benutzernamen.</para>
536 <sect1 id="Apache-Konfiguration">
537 <title>Webserver-Konfiguration</title>
540 <title>Grundkonfiguration mittels CGI</title>
543 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
544 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
545 <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
548 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
549 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
550 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
551 anderen Datei hinzu, die beim Starten des Webservers eingelesen
554 <programlisting>AddHandler cgi-script .pl
555 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
557 <Directory /var/www/kivitendo-erp>
558 Options ExecCGI Includes FollowSymlinks
561 <Directory /var/www/kivitendo-erp/users>
564 </Directory></programlisting>
566 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
567 das kivitendo-Archiv entpacket haben.</para>
570 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
571 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
574 <para>Auf einigen Webservern werden manchmal die Grafiken und
575 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
576 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
578 <programlisting>EnableSendfile Off</programlisting>
581 <sect2 id="Apache-Konfiguration.FCGI"
582 xreflabel="Konfiguration für FastCGI/FCGI">
583 <title>Konfiguration für FastCGI/FCGI</title>
585 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
586 <title>Was ist FastCGI?</title>
588 <para>Direkt aus <ulink
589 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
592 <para><citation> FastCGI ist ein Standard für die Einbindung
593 externer Software zur Generierung dynamischer Webseiten in einem
594 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
595 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
596 umgehen. </citation></para>
599 <sect3 id="Apache-Konfiguration.FCGI.Warum">
600 <title>Warum FastCGI?</title>
602 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
603 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
604 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
605 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
606 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
607 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
608 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
609 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
610 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
611 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
612 deutlich länger dauert als früher, und dass davon 90% für das Laden
613 der Module verwendet wird.</para>
615 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
616 wird nur die eigentliche Programmlogik ausgeführt.</para>
619 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
620 <title>Getestete Kombinationen aus Webservern und Plugin</title>
622 <para>Folgende Kombinationen sind getestet:</para>
626 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
630 <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
634 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
635 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
636 mod_fastcgi nicht mehr explizit eingegangen.</para>
638 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
642 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern
643 bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrere Installation gibt, muss zwingend Version 0.68 oder
644 aber Version 0.72 und neuer eingesetzt werden.</para>
646 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie sich die Vorgängerversion wie folgt
649 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
653 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
654 <title>Konfiguration des Webservers</title>
656 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
657 laufen zu lassen, empfliehlt es sich die Installation ersteinmal
658 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
659 debuggen die beim ersten aufsetzen auftreten können. Sollte die
660 Installation schon funktionieren, lesen Sie weiter.</para>
662 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
663 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
665 <programlisting>a2enmod fcgid</programlisting>
667 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
668 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
669 und <function>Directory</function>-Direktiven. Dabei wird zwischen
670 dem Installationspfad von kivitendo im Dateisystem
671 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
672 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
673 ("<filename>/url/for/kivitendo-erp</filename>").</para>
675 <para>Folgender Konfigurationsschnipsel funktioniert mit
678 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
679 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
681 <Directory /path/to/kivitendo-erp>
683 Options ExecCGI Includes FollowSymlinks
688 <DirectoryMatch /path/to/kivitendo-erp/users>
691 </DirectoryMatch></programlisting>
693 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
694 die maximale Größe eines Requests. Diese sollte wie folgt
695 hochgesetzt werden:</para>
697 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
699 <para>Das ganze sollte dann so aussehen:</para>
701 <programlisting>AddHandler fcgid-script .fpl
702 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
703 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
704 FcgidMaxRequestLen 10485760
706 <Directory /path/to/kivitendo-erp>
708 Options ExecCGI Includes FollowSymlinks
713 <DirectoryMatch /path/to/kivitendo-erp/users>
716 </DirectoryMatch></programlisting>
718 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
719 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
720 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
721 gibt es hier kleine Performance-Einbußen.</para>
723 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
724 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
725 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
727 <programlisting># Zugriff über CGI
728 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
730 # Zugriff mit mod_fcgid:
731 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
732 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
734 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
735 die normale Version erreichbar, und unter
736 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
737 FastCGI-Version.</para>
742 <sect1 id="config.task-server">
743 <title>Der Task-Server</title>
745 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und
746 diese zu festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess wird u.a. für die Erzeugung der wiederkehrenden
747 Rechnungen und weitere essenzielle Aufgaben benutzt.</para>
749 <sect2 id="Konfiguration-des-Task-Servers">
750 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
752 <para>Die Konfiguration erfolgt über den Abschnitt
753 <literal>[task_server]</literal> in der Datei
754 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
755 Optionen sind:</para>
759 <term><varname>client</varname></term>
762 <para>Name oder Datenbank-ID eines vorhandenen kivitendo-Mandanten, der benutzt wird, um die zu verwendende
763 Datenbankverbindung auszulesen. Der Mandant muss in der Administration angelegt werden. Diese Option muss angegeben
766 <para>Diese Option kam mit Release v3.x.0 hinzu und muss daher in Konfigurationen, die von älteren Versionen aktualisiert
767 wurden, ergänzt werden.</para>
772 <term><varname>login</varname></term>
775 <para>gültiger kivitendo-Benutzername, der z.B. als Verkäufer beim Erzeugen wiederkehrender Rechnungen benötigt wird. Der
776 Benutzer muss in der Administration angelegt werden. Diese Option muss angegeben werden.</para>
781 <term><varname>run_as</varname></term>
784 <para>Wird der Server vom Systembenutzer <literal>root</literal>
785 gestartet, so wechselt er auf den mit <literal>run_as</literal>
786 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
787 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
789 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
790 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
791 unter dem auch der Webserver läuft.</para>
796 <term><varname>debug</varname></term>
799 <para>Schaltet Debug-Informationen an und aus.</para>
805 <sect2 id="Einbinden-in-den-Boot-Prozess">
806 <title>Automatisches Starten des Task-Servers beim Booten</title>
808 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
809 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
810 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
812 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
813 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
814 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
815 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
816 anstelle eines symbolischen Links verwendet werden können.</para>
819 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, ältere Fedora Core)</title>
821 <para>Kopieren Sie die Datei
822 <filename>scripts/boot/system-v/kivitendo-server</filename>
823 nach <filename>/etc/init.d/kivitendo-server</filename>. Passen
824 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
825 <literal>DAEMON=....</literal>). Binden Sie das Script in den
826 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
830 <para>Debian-basierende Systeme:</para>
832 <programlisting>update-rc.d kivitendo-task-server defaults
833 # Nur bei Debian Squeeze und neuer:
834 insserv kivitendo-task-server</programlisting>
838 <para>Ältere OpenSUSE und ältere Fedora Core:</para>
840 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
844 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
847 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
851 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
853 <para>Kopieren Sie die Datei
854 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
855 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
856 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
857 <literal>exec ....</literal>).</para>
859 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
862 <programlisting>service kivitendo-task-server start</programlisting>
866 <title>systemd-basierende Systeme (z.B. neure OpenSUSE, neuere Fedora Core)</title>
868 <para>Verlinken Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
869 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
870 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>). Binden Sie das Script in den Boot-Prozess ein.
873 <para>Alle hierzu benötigten Befehle sehen so aus:</para>
875 <programlisting>cd /var/www/kivitendo-erp/scripts/boot/systemd
876 ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
878 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
881 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
885 <sect2 id="Prozesskontrolle">
886 <title>Wie der Task-Server gestartet und beendet wird</title>
888 <para>Der Task-Server wird wie folgt kontrolliert:</para>
890 <programlisting>./scripts/task_server.pl Befehl</programlisting>
892 <para><literal>Befehl</literal> ist dabei eine der folgenden
897 <para><literal>start</literal> startet eine neue Instanz des
898 Task-Servers. Die Prozess-ID wird innerhalb des
899 <filename>users</filename>-Verzeichnisses abgelegt.</para>
903 <para><literal>stop</literal> beendet einen laufenden
908 <para><literal>restart</literal> beendet und startet ihn
913 <para><literal>status</literal> berichtet, ob der Task-Server
918 <para>Der Task-Server wechselt beim Starten automatisch in das
919 kivitendo-Installationsverzeichnis.</para>
921 <para>Dieselben Optionen können auch für die SystemV-basierenden
922 Runlevel-Scripte benutzt werden (siehe oben).</para>
924 <sect2 id="Prozesskontrolle2">
925 <title>Task-Server mit mehreren Mandanten</title>
927 <para>Beim Task-Server werden der zu verwendende Mandant und Login-Name des Benutzers, unter dem der Task-Server laufen soll, in die
928 Konfigurationsdatei geschrieben. Hat man mehrere Mandanten, muss man auch mehrere Konfigurationsdateien anlegen.</para>
930 <para>Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf, wo in der Kategorie <varname>[task_server]</varname> die
931 gewünschten Werte für <varname>client</varname> und <varname>login</varname> eingetragen werden.</para>
933 <para>Der alternative Task-Server wird dann mit folgendem Befehl
936 <programlisting>./scripts/task_server.pl -c config/DATEINAME.conf</programlisting>
940 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
941 <title>Benutzerauthentifizierung und Administratorpasswort</title>
943 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
944 über die Verwaltung von Gruppen und weitere Einstellungen</para>
946 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
947 <title>Grundlagen zur Benutzerauthentifizierung</title>
949 <para>kivitendo verwaltet die Benutzerinformationen in einer
950 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
951 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
952 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
953 können, müssen aber nicht unterschiedlich sein.</para>
955 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
956 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
957 abgelegt werden.</para>
959 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
960 entweder gegen die Authentifizierungsdatenbank oder gegen einen
961 LDAP-Server überprüft werden.</para>
963 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
964 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
965 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
966 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
967 einer Version vor v2.6.0 angelegt werden. Eine
968 Beispielkonfigurationsdatei
969 <filename>config/kivitendo.conf.default</filename> existiert, die als
970 Vorlage benutzt werden kann.</para>
973 <sect2 id="Administratorpasswort">
974 <title>Administratorpasswort</title>
976 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
977 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
978 nur dort und nicht mehr im Administrationsinterface selber geändert
979 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
980 Abschnitt <varname>[authentication]</varname>.</para>
983 <sect2 id="Authentifizierungsdatenbank">
984 <title>Authentifizierungsdatenbank</title>
986 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
987 Parametern in <varname>[authentication/database]</varname>
988 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
992 <term><literal>host</literal></term>
995 <para>Der Rechnername oder die IP-Adresse des
996 Datenbankservers</para>
1001 <term><literal>port</literal></term>
1004 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1009 <term><literal>db</literal></term>
1012 <para>Der Name der Authentifizierungsdatenbank</para>
1017 <term><literal>user</literal></term>
1020 <para>Der Benutzername, mit dem sich kivitendo beim
1021 Datenbankserver anmeldet (z.B.
1022 "<literal>postgres</literal>")</para>
1027 <term><literal>password</literal></term>
1030 <para>Das Passwort für den Datenbankbenutzer</para>
1035 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1036 automatisch anlegen (mehr dazu siehe unten).</para>
1039 <sect2 id="Passwortüberprüfung">
1040 <title>Passwortüberprüfung</title>
1042 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1043 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1044 Active-Directory-Server. Welche davon benutzt wird, regelt der
1045 Parameter <varname>module</varname> im Abschnitt
1046 <varname>[authentication]</varname>.</para>
1048 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1049 gespeichert werden, so muss der Parameter <varname>module</varname>
1050 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1051 der Administrator als auch die Benutzer selber ihre Psaswörter in
1052 kivitendo ändern.</para>
1054 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1055 benutzt werden, so muss der Parameter <varname>module</varname> auf
1056 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1057 zusätzliche Informationen über den LDAP-Server im Abschnitt
1058 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1062 <term><literal>host</literal></term>
1065 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1066 Active-Directory-Servers. Diese Angabe ist zwingend
1067 erforderlich.</para>
1072 <term><literal>port</literal></term>
1075 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1080 <term><literal>tls</literal></term>
1083 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1084 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1085 ‘<literal>0</literal>’ belassen</para>
1090 <term><literal>attribute</literal></term>
1093 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1094 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1095 meist ‘<literal>sAMAccountName</literal>’, für andere
1096 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1097 zwingend erforderlich.</para>
1102 <term><literal>base_dn</literal></term>
1105 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1106 Diese Angabe ist zwingend erforderlich.</para>
1111 <term><literal>filter</literal></term>
1114 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1115 <literal><%login%></literal>, so wird dieses durch den vom
1116 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1117 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1118 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1123 <term><literal>bind_dn</literal> und
1124 <literal>bind_password</literal></term>
1127 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1128 durchsucht werden kann (z.B. ist dies bei
1129 Active-Directory-Servern der Fall), so kann diese hier angegeben
1130 werden. Für Active-Directory-Server kann als
1131 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1132 z.B. ‘<literal>cn=Martin
1133 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1134 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1135 also ‘<literal>Martin Mustermann</literal>’.</para>
1141 <sect2 id="Name-des-Session-Cookies">
1142 <title>Name des Session-Cookies</title>
1144 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1145 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1146 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1147 Parameter <varname>cookie_name</varname> im Abschnitt
1148 <varname>[authentication]</varname>gesetzt.</para>
1150 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1151 Server existiert.</para>
1154 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1155 <title>Anlegen der Authentifizierungsdatenbank</title>
1157 <para>Nachdem alle Einstellungen in
1158 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1159 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1160 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1161 der folgenden URL erreichbar sein sollte:</para>
1164 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1168 <sect1 id="Benutzer--und-Gruppenverwaltung">
1169 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1171 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und Datenbanken angelegt werden. Dieses geschieht im
1172 Administrationsmenü, das Sie unter folgender URL finden:</para>
1175 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1177 <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
1178 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1180 <sect2 id="Zusammenhänge">
1181 <title>Zusammenhänge</title>
1183 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung in einer oder zwei Datenbanken gespeichert werden.</para>
1185 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat
1186 Zugriff auf welche Mandanten, und welche Gruppe verfügt über welche Rechte. Diese Informationen werden in der
1187 Authentifizierungsdatenbank gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter in der Konfigurationsdatei
1188 <filename>config/kivitendo.conf</filename> gespeichert werden.</para>
1190 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten, Waren) und Belege
1191 (Angebote, Lieferscheine, Rechnungen). Diese werden in einer Mandantendatenbank gespeichert. Die
1192 Verbindungsinformationen einer solchen Mandantendatenbank werden im Administrationsbereich konfiguriert, indem man einen Mandanten
1193 anlegt und dort die Parameter einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1195 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich, die Authentifizierungsdatenbank und eine der
1196 Mandantendatenbanken in ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit mehr als einem Mandanten, wird
1197 empfohlen, für die Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die nicht gleichzeitig für einen Mandanten
1198 verwendet wird.</para>
1201 <sect2 id="Mandanten-Benutzer-Gruppen">
1202 <title>Mandanten, Benutzer und Gruppen</title>
1204 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen, die sich frei zueinander zuordnen lassen.</para>
1206 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1207 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1208 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank. Diese sollte über die <link
1209 linkend="Datenbanken-anlegen">Datenbankverwaltung</link> geschehen.</para>
1211 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten soll. Sie erhält einen Loginnamen sowie ein
1212 Passwort. Weiterhin legt der Administrator fest, an welchen Mandanten sich ein Benutzer anmelden kann, was beim Login verifiziert
1215 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür
1216 vom Administrator gewisse Rechte zugeordnet. Weiterhin legt der Administrator fest, für welche Mandanten eine Gruppe gilt, und
1217 welche Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer dann an einem Mandanten an, so erhält er alle Rechte von
1218 allen denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in denen der Benutzer zum Anderen Mitglied ist, </para>
1220 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und Benutzer angelegt werden, kann im Prinzip beliebig gewählt
1221 werden. Die folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1223 <orderedlist numeration="arabic">
1225 <para>Datenbank anlegen</para>
1229 <para>Gruppen anlegen</para>
1233 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1237 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1242 <sect2 id="Datenbanken-anlegen">
1243 <title>Datenbanken anlegen</title>
1245 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1246 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1247 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1250 <sect2 id="Gruppen-anlegen">
1251 <title>Gruppen anlegen</title>
1253 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1254 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1255 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1256 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1258 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank gespeichert, gelten aber nicht automatisch für alle
1259 Mandanten. Der Administrator legt vielmehr fest, für welche Mandanten eine Gruppe gültig ist. Dies kann entweder beim Bearbeiten der
1260 Gruppe geschehen ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn man einen Mandanten bearbeitet ("für diesen
1261 Mandanten sind die Gruppen A, B und C gültig").</para>
1263 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder dieser Gruppe festgelegt werden ("in dieser Gruppe sind die
1264 Benutzer X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten eines Benutzers geschehen ("dieser Benutzer ist
1265 Mitglied in den Gruppen A, B und C").</para>
1268 <sect2 id="Benutzer-anlegen">
1269 <title>Benutzer anlegen</title>
1271 <para>Beim Anlegen von Benutzern werden für viele Parameter Standardeinstellungen vorgenommen, die den Gepflogenheiten des deutschen
1272 Raumes entsprechen.</para>
1274 <para>Zwingend anzugeben ist der Loginname. Wenn die Passwortauthentifizierung über die Datenbank eingestellt ist, so kann hier auch
1275 das Benutzerpasswort gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1278 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier auch konfiguriert werden, auf welche Mandanten der Benutzer
1279 Zugriff hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können sowohl beim Benutzer vorgenommen werden ("dieser
1280 Benutzer hat Zugriff auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen X, Y und Z") als auch beim Mandanten ("auf
1281 diesen Mandanten haben Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe sind Benutzer A, B und C
1282 Mitglieder").</para>
1285 <sect2 id="Mandanten-anlegen">
1286 <title>Mandanten anlegen</title>
1288 <para>Ein Mandant besteht aus Administrationssicht primär aus einem eindeutigen Namen. Weiterhin wird hier hinterlegt, welche
1289 Datenbank als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten einer der eben angelegten Datenbanken eingetragen
1292 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch konfiguriert werden, welche Benutzer Zugriff auf den
1293 Mandanten haben bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen können sowohl beim Mandanten vorgenommen werden
1294 ("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
1295 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
1299 <sect1 id="Drucker--Systemverwaltung">
1300 <title>Drucker- und Systemverwaltung</title>
1301 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte Druckeradministration und System.</para>
1302 <sect2 id="Druckeradministration">
1303 <title>Druckeradministration</title>
1304 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig viele "Druckbefehle" im System verwalten. Diese Befehle werden mandantenweise
1305 zugeordnet. Unter Druckerbeschreibung wird der Namen des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs angezeigt wird.</para>
1306 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl, der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P meinDrucker' oder ein
1307 kompletter Pfad zu einem Skript (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh).
1308 Wird ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich ergänzt, ist
1309 bspw. das Kürzel 'epson_drucker' definiert, so wird beim Ausdruck eines Angebots folgende Vorlage geparst: sales_quotation_epson_drucker.tex.</para>
1312 <title>System sperren / entsperren</title>
1314 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation sperren/entsperren'. Setz man diese Sperre so ist der Zugang zu der gesamten kivitendo Installation gesperrt.</para>
1315 <para>Falls die Sperre gesetzt ist, erscheint anstelle der Anmeldemaske die Information: 'kivitendo ist momentan zwecks Wartungsarbeiten nicht zugänglich.'.
1317 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo automatisch 'sperrt', falls es bei einem Versionsupdate zu einem Datenbankfehler kam. Somit kann hier nicht aus Versehen
1318 mit einem inkonsistenten Datenbestand weitergearbeitet werden.</para>
1322 <sect1 id="config.sending-email" xreflabel="E-Mail-Versand aus kivitendo heraus">
1323 <title>E-Mail-Versand aus kivitendo heraus</title>
1325 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden, z.B. um ein Angebot direkt an einen Kunden zu
1326 verschicken. Damit dies funktioniert, muss eingestellt werden, über welchen Server die E-Mails verschickt werden sollen. kivitendo
1327 unterstützt dabei zwei Mechanismen: Versand über einen lokalen E-Mail-Server (z.B. mit <productname>Postfix</productname> oder
1328 <productname>Exim</productname>, was auch die standardmäßig aktive Methode ist) sowie Versand über einen SMTP-Server (z.B. der des
1329 eigenen Internet-Providers).</para>
1331 <para>Welche Methode und welcher Server verwendet werden, wird über die Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1332 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1334 <sect2 id="config.sending-email.sendmail" xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1335 <title>Versand über lokalen E-Mail-Server</title>
1337 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie
1338 z.B. <productname>Postfix</productname>, <productname>Exim</productname> oder <productname>Sendmail</productname> läuft.</para>
1340 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1341 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1343 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet wird, dient der Parameter '<literal>sendmail =
1344 ...</literal>'. Der Standardwert verweist auf das Programm <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1345 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1347 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen dieses sprengen. Hierfür sei auf die Dokumentation des
1348 E-Mail-Servers verwiesen.</para>
1351 <sect2 id="config.sending-email.smtp" xreflabel="E-Mail-Versand über einen SMTP-Server">
1352 <title>Versand über einen SMTP-Server</title>
1354 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server vorhanden oder zwar einer vorhanden, dieser aber nicht
1355 konfiguriert ist.</para>
1357 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1358 Parameter dienen dabei der weiteren Konfiguration:</para>
1362 <term><varname>hostname</varname></term>
1364 <listitem><para>Name oder IP-Adresse des SMTP-Servers. Standardwert: '<literal>localhost</literal>'</para></listitem>
1368 <term><varname>port</varname></term>
1370 <listitem><para>Portnummer. Der Standardwert hängt von der verwendeten Verschlüsselungsmethode ab. Gilt '<literal>security =
1371 none</literal>' oder '<literal>security = tls</literal>', so ist 25 die Standardportnummer. Für '<literal>security =
1372 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht geändert werden.</para></listitem>
1376 <term><varname>security</varname></term>
1378 <listitem><para>Wahl der zu verwendenden Verschlüsselung der Verbindung mit dem Server. Standardwert ist
1379 '<literal>none</literal>', wodurch keine Verschlüsselung verwendet wird. Mit '<literal>tls</literal>' wird TLS-Verschlüsselung
1380 eingeschaltet, und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL eingeschaltet. Achtung: Für
1381 '<literal>tls</literal>' und '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt (siehe unten).</para></listitem>
1385 <term><varname>login</varname> und <varname>password</varname></term>
1387 <listitem><para>Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername
1388 und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von
1389 Verschlüsselung aktiviert werden.</para></listitem>
1393 <para>Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind:</para>
1396 <listitem><para>TLS-Verschlüsselung: Modul <literal>Net::SSLGlue</literal> (Debian-Paketname
1397 <literal>libnet-sslglue-perl</literal>, Fedora Core: <literal>perl-Net-SSLGlue</literal>, openSUSE:
1398 <literal>perl-Net-SSLGlue</literal></para></listitem>
1400 <listitem><para>SSL-Verschlüsselung: Modul <literal>Net::SMTP::SSL</literal> (Debian-Paketname
1401 <literal>libnet-smtp-ssl-perl</literal>, Fedora Core: <literal>perl-Net-SMTP-SSL</literal>, openSUSE:
1402 <literal>perl-Net-SMTP-SSL</literal></para></listitem>
1407 <sect1 id="Drucken-mit-kivitendo">
1408 <title>Drucken mit kivitendo</title>
1410 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. Um drucken zu können, braucht der Server ein geeignetes
1411 LaTeX System. Am einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter Debianoiden Betriebssystemen installiert man
1412 die Pakete mit:</para>
1414 <para><programlisting>aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1415 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1417 <para>TODO: RPM-Pakete.</para>
1419 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1421 <listitem><para>Standard</para></listitem>
1422 <listitem><para>f-tex</para></listitem>
1423 <listitem><para>RB</para></listitem>
1426 <sect2 id="Vorlagenverzeichnis-anlegen" xreflabel="Vorlagenverzeichnis anlegen">
1427 <title>Vorlagenverzeichnis anlegen</title>
1428 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1430 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1432 <para>Der Angemmeldete Benutzer muss in einer Gruppe sein, die über das
1433 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch <xref linkend="Gruppen-anlegen"/>.
1435 <para>Im Userbereich lässt sich unter:
1436 "<guimenu>System</guimenu> ->
1437 <guisubmenu>Mandantenverwaltung</guisubmenu> -> <guimenuitem>Verschiedenes</guimenuitem>" die Option
1438 "Neue Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1441 <listitem><para><option>Vorlagen auswählen</option>: Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll
1442 (<filename>Standard</filename>, <filename>f-tex</filename> oder <filename>RB</filename>.)</para></listitem>
1443 <listitem><para><option>Neuer Name</option>: Der Verzeichnisname für den neuen Vorlagensatz. Dieser kann im Rahmen der üblichen
1444 Bedingungen für Verzeichnisnamen frei gewählt werden.</para></listitem>
1447 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist für den aktuellen Mandanten ausgewählt.
1448 Der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1449 Eventuell muessen Anpassungen (Logo, Erscheinungsbild, etc) noch vorgenommen werden. Den Ordner findet man im Dateisistem unter
1450 <filename>./templates/[Neuer Name]</filename></para>
1454 <sect2 id="Vorlagen-Standard">
1455 <title>Standard</title>
1457 <para>Der Standard-Vorlagensatz von Kivitendo. Wie unter <ulink url="http://demo.kivitendo.org">http://demo.kivitendo.org</ulink> zu
1463 <title>f-tex</title>
1465 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt.</para>
1467 <sect3 id="f-tex-Feature-Übersicht">
1468 <title>Feature-Übersicht</title>
1470 <listitem><para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage für alle briefartigen Dokumente verwendet. Also
1471 Angebot, Rechnung, Performarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc..</para></listitem>
1473 <listitem><para>Leichte Anpassung an das Firmen-Layout durch verwendung eines Hintergrund-PDF. Dieses kann leicht mit dem
1474 eigenen Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp, Adobe*)</para></listitem>
1476 <listitem><para>Hintergrund-PDF umschaltbar auf "nur erste Seite" (Standard) oder "alle Seiten" (Option
1477 "<option>bgPdfFirstPageOnly</option>" in Datei <filename>letter.lco</filename>)</para></listitem>
1479 <listitem><para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1480 versendeten Dokumenten eingebunden (Option "<option>bgPdfEmailOnly</option>" in Datei
1481 <filename>letter.lco</filename>).</para></listitem>
1483 <listitem><para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch, Wiederholung von Kopfzeilen, Zwischensummen
1484 etc. (danke an Kai-Martin Knaak für die Vorarbeit)</para></listitem>
1486 <listitem><para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom Land des eigenen Unternehmens abweicht (also die
1487 Rechnung das Land verlässt).</para></listitem>
1489 <listitem><para>Multisprachfähig leicht um weitere Sprachen zu erweitern, alle Übersetzungen in der Datei
1490 <filename>translatinos.tex</filename>.</para></listitem>
1492 <listitem><para>Auflistung von Bruttopreisen für Endverbraucher.</para></listitem>
1496 <sect3 id="f-tex-Installation">
1497 <title>Die Installation</title>
1499 <listitem><para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref linkend="Vorlagenverzeichnis-anlegen"/>. Das
1500 Vorlagensystem funktioniert jetzt schon, hat allerdings noch einen Beispiel-Briefkopf.</para></listitem>
1502 <listitem><para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach <filename>./letter_head.pdf</filename>.</para></listitem>
1503 <listitem><para>Editiere den Bereich "<option>settings</option>" in der datei <filename>letter.lco</filename>.</para></listitem>
1506 <para>oder etwas Detaillierter:</para>
1509 Es wird eine Datei <filename>sample.lco</filename> erstellt und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
1510 ist dies die Datei die für die Firmenspezifischen Anpassungen gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig
1511 ist, wird in dieser Datei auf ein Hintergrundpdf verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen
1512 vorzunehmen und <filename>sample.lco</filename> unverändert zu lassen. Die die Anpassung über eine
1513 <filename>*.lco</filename>-Datei die letztlich auf <filename>letter.lco</filename> verlinkt ist ist aber auch möglich.
1517 Es wird eine Datei <filename>sample_head.pdf</filename> mit ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
1518 verlinkt. Damit gibt es schon mal eine Funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei
1519 <filename>sample_haed.pdf</filename> an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
1520 Template Verzeichniss ablegen und statt <filename>sample_head.pdf</filename> nach <filename>letter_head.pdf</filename>
1525 letzlich muss <filename>letter_head.pdf</filename> auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
1526 enthält. Bei Updates oder nach erneutem
1530 Es wird eine Datei <filename>mydata.tex.example</filename> ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
1531 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das Land verwendet. Die Datei muss also nicht angefasst
1532 werden. Die Anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig).
1535 Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc. sollten über die Hintergrund-PDF-Datei oder die
1536 <filename>*.lco</filename>-Datei erfolgen.
1540 <sect3 id="f-tex-Funktionsübersicht">
1541 <title>f-tex Funktionsübersicht</title>
1543 Das Konzept von kivitendo sieht vor, für jedes Dokument (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine LaTeX-Vorlage
1544 vorzuhalten, dies ist sehr Wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
1545 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
1546 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche LaTeX-Vorlage verwendet, welche über Codeweichen die
1547 Besonderheiten der jeweiligen Dokumente Berücksichtigt.
1551 <listitem><para>Tabellen mit oder ohne Preis</para></listitem>
1552 <listitem><para>Sprache der Tabellenüberschriften etc.</para></listitem>
1553 <listitem><para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus Angebotsnummer)</para></listitem>
1554 <listitem><para>Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus Gewerblicher
1555 Kunde)</para></listitem>
1558 <para>Nachteil:</para>
1561 LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
1562 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann natürlich
1563 auch innerhalb der Tabellendarstellung gut persönliche Anpassungen vornehmen. Aber man kann sich hier bei Veränderungen sehr
1564 schnell häftig in den Fuss schiessen.
1567 <para>Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund PDF auf Basis der
1568 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen, und sich an der Form der dargestellten Tabellen wie sie
1569 ausgeliefert werden, erfreuen.
1572 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine kontinuierliche Schritte gehen.</para>
1576 <sect3 id="f-tex-Bruttopreise">
1577 <title>Bruttopreise für Endverbraucher</title>
1579 <para>Der auszuweisende Bruttopreis wird innerhalb der LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen "alle
1580 Preise Brutto" auszuwählen, aber:</para>
1583 <para>hierfür müssen die Preise auch in Brutto in der Datenbank stehen (ja - das lässt sich über die Preisgruppen und die
1584 Zuordung einer Default-Preisgruppe handhaben)</para>
1587 <para>man darf beim Anlegen des Vorgangs nicht vergessen Dieses Häkchen zu setzen. (das ist in der Praxis wenn man sowohl
1588 Endverbraucher- wie Gewerbekunden beliefert der eigentliche Knackpunkt)</para>
1593 Es gibt mit f-tex eine weitere Alternative. Die Information ob Brutto oder Nettorechnung wird mit den Zahlarten
1594 verknüpft. Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben werden sollen, enden mit "_E" (für
1595 Endverbraucher). Falls identische Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt man diese einfach doppelt
1596 an (einmal mit der Namensendung "_E"). Gewinn:</para>
1599 <listitem><para>Die Entscheidung, ob Netopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste Verbunden.</para></listitem>
1600 <listitem><para>Die Default-Zahlart kann im Kundendatensatz hinterlegt werden, und man muss nicht mehr daran denken, "alle Preise
1601 Netto" auszuwählen.</para></listitem>
1602 <listitem><para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken reviediert werden,
1603 ohne dass sich der Auftragswert ändert.</para></listitem>
1607 <sect3 id="f-tex-lieferadressen">
1608 <title>Lieferadressen</title>
1610 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen im Adressfeld zum Einsatz. Wenn die
1611 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende Adressvariable eingesetzt. Wenn also die Lieferadresse in
1612 Straße, Hausnummer und Ort abweicht, müssen auch nur diese Felder in der Lieferadresse ausgefüllt werden. Für den Firmenname wird
1613 der Wert der Hauptadresse angezeigt.
1618 <sect2 id="Vorlagen-RB">
1619 <title>Der Druckvorlagensatz RB</title>
1621 <para>Hierbei handelt es sich um einen vollständigen Dokumentensatz mit alternativem Design.</para>
1622 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
1623 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1624 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die eigenen Firmendaten finden sich in der Datei Readme.tex im Vorlagenverzeichnis.</para>
1628 <sect2 id="allgemeine-hinweise-zu-latex">
1629 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
1630 <para>In den allermeisten Installationen sollte drucken jetzt schon
1631 funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
1632 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
1633 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1638 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1639 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1640 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1644 <para>! Package inputenc Error: Unicode char \u8:... set up for
1645 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1646 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1647 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1648 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1649 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1653 <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
1654 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1655 Prüfen Sie den Namen in der Konfiguration (Standard:
1656 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1657 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1660 <para>Wenn sich das Problem nicht auf Grund der ausgabe im Webbrowser verifizieren lässt:</para>
1663 <para> editiere [kivitendo-home]/config/kivitendo.conf und ändere "keep_temp_files" auf 1</para>
1664 <para><programlisting>keep_temp_files = 1;</programlisting></para>
1667 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
1670 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
1673 <para>wechsele in das users Verzeichnis von kivitendo</para>
1674 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
1677 <para>LaTeX Suchpfad anpassen:</para>
1678 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
1681 <para>Finde herraus welche Datei kivitendo beim letzten Durchlauf erstellt hat</para>
1682 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
1683 <para>Es sollte die letzte Datei ganz unten sein</para>
1686 <para>für besseren Hinweis auf Fehler texdatei nochmals übersetzen</para>
1687 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
1688 <para>in der *.tex datei nach dem Fehler suchen.</para>
1694 <sect1 id="OpenDocument-Vorlagen">
1695 <title>OpenDocument-Vorlagen</title>
1697 <para>kivitendo unterstützt die Verwendung von Vorlagen im
1698 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1699 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1700 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1701 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1702 <filename>config/kivitendo.conf</filename> die Variable
1703 <literal>opendocument</literal> im Abschnitt
1704 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1705 Dieses ist die Standardeinstellung.</para>
1707 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1708 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1709 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1710 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1711 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1712 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1714 <para>Nach der Installation müssen in der Datei
1715 <filename>config/kivitendo.conf</filename> zwei weitere Variablen
1716 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1717 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1718 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1719 enthalten. Beide stehen im Abschnitt
1720 <literal>applications</literal>.</para>
1722 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
1723 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1724 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1725 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1726 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1727 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1728 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1729 werden muss. Der Nachteil ist, dass diese Methode Python und die
1730 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1735 Für die Verbindung zu OpenOffice wird normalerweise der Python-Interpreter <filename>/usr/bin/python</filename> benutzt. Sollte
1736 dies nicht der richtige sein, so kann man mit zwei Konfigurationsvariablen entscheiden, welcher Python-Interpreter genutzt
1737 wird. Mit der Option <literal>python_uno</literal> aus dem Abschnitt <literal>applications</literal> wird der Interpreter selber
1738 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert <literal>/usr/bin/python</literal>.
1742 Zusätzlich ist es möglich, Pfade anzugeben, in denen Python neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
1743 z.B. falls sich diese in einem gesonderten OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
1744 <literal>python_uno_path</literal> und befindet sich im Abschnitt <literal>environment</literal>. Sie ist standardmäßig
1745 leer. Werden hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte voneinander getrennt werden. Der Inhalt wird an den
1746 Python-Interpreter über die Umgebungsvariable <literal>PYTHONPATH</literal> übergeben.
1750 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1751 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1752 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1753 Dokumentenvorlage enthalten sein und
1754 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1755 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1756 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1757 ebenfalls enthalten sein muss.</para>
1759 <para>Als letztes muss herausgefunden werden, welchen Namen
1760 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1761 gibt. Unter Debian ist dies momentan
1762 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1763 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1764 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1765 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1766 folgender Befehl auszuführen:</para>
1768 <para><literal>mv users/.openoffice.org2
1769 users/.openoffice</literal></para>
1771 <para>Dieses Verzeichnis, wie auch das komplette
1772 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1773 sein. Dieses wurde bereits erledigt (siehe <xref
1774 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1775 erneut überprüft werden, wenn die Konvertierung nach PDF
1779 <sect1 id="config.eur">
1780 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1783 <sect2 id="config.eur.introduction"
1784 xreflabel="Einführung in die Konfiguration zur EUR">
1785 <title>Einführung</title>
1787 <para>kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1788 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals noch <filename>config/lx_office.conf</filename>)
1789 befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden.</para>
1791 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1792 die Mandantendatenbank verschoben und dabei auch gleich in drei
1793 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1794 steuern lässt.</para>
1797 <sect2 id="config.eur.parameters"
1798 xreflabel="Konfigurationsparameter für EUR">
1799 <title>Konfigurationsparameter</title>
1801 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1802 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1806 <term><varname>profit_determination</varname></term>
1809 <para>Dieser Parameter legt die Berechnungsmethode für die
1810 Gewinnermittlung fest. Er enthält entweder
1811 <literal>balance</literal> für
1812 Betriebsvermögensvergleich/Bilanzierung oder
1813 <literal>income</literal> für die
1814 Einnahmen-Überschuss-Rechnung.</para>
1819 <term><varname>accounting_method</varname></term>
1822 <para>Dieser Parameter steuert die Buchungs- und
1823 Berechnungsmethoden für die Versteuerungsart. Er enthält
1824 entweder <literal>accrual</literal> für die Soll-Versteuerung
1825 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1830 <term><varname>inventory_system</varname></term>
1833 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1834 enthält entweder <literal>perpetual</literal> für die
1835 Bestandsmethode oder <literal>periodic</literal> für die
1836 Aufwandsmethode.</para>
1841 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1842 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1843 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1844 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1845 Bestandsmethode.</para>
1847 <para>Die Konfiguration "<varname>eur</varname>" unter
1848 <varname>[system]</varname> in der <link
1849 linkend="config.config-file">Konfigurationsdatei</link>
1850 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
1851 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1854 <sect2 id="config.eur.setting-parameters">
1855 <title>Festlegen der Parameter</title>
1857 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1858 der Admininstration können diese Optionen nun unabhängig voneinander
1859 eingestellt werden.</para>
1861 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1862 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1865 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1866 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
1867 angezeigt. Unter <guimenu>System</guimenu>
1868 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> können
1869 die Einstellungen auch geändert werden. Dabei ist zu beachten,
1870 dass eine Änderung vorhandene Daten so belässt und damit
1871 evtl. die Ergebnisse verfälscht. Dies gilt vor Allem für die
1872 Warenbuchungsmethode (siehe auch
1873 <link linkend="config.eur.inventory-system-perpetual">
1874 Bemerkungen zu Bestandsmethode</link>).</para>
1877 <sect2 id="config.eur.inventory-system-perpetual">
1878 <title>Bemerkungen zu Bestandsmethode</title>
1880 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1881 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
1882 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1883 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1884 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1885 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1886 Einkaufsrechnungen berechnet wird.</para>
1888 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1889 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1890 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1894 <sect2 id="config.eur.knonw-issues">
1895 <title>Bekannte Probleme</title>
1897 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1898 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1899 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1900 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1901 die Konfigurationsvariable
1902 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1905 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1906 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1910 <sect1 id="config.skr04-update-3804">
1911 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1913 <sect2 id="config.skr04-update-3804.introduction">
1914 <title>Einführung</title>
1916 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1917 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1918 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1919 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1920 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1921 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1922 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1923 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1924 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1925 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1926 Screenshots dargestellt.</para>
1928 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1929 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1930 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1931 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1934 <sect2 id="config.skr04-update-3804.create-chart">
1935 <title>Konto 3804 manuell anlegen</title>
1937 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
1938 anzulegen und zu konfigurieren. Zuerst wird in
1939 <guimenu>System</guimenu> ->
1940 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
1941 erfassen</guimenuitem> das Konto angelegt.</para>
1944 <screeninfo>Konto 3804 erfassen</screeninfo>
1948 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
1954 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
1955 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
1956 wie im folgenden Screenshot angezeigt anpassen.
1960 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
1964 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
1970 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
1971 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
1975 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
1979 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
1985 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
1986 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
1987 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
1988 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
1992 <screeninfo>Konto 4315 anpassen</screeninfo>
1996 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
2002 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
2003 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
2007 <screeninfo>Steuerliste vergleichen</screeninfo>
2011 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
2018 <title>Verhalten des Bilanzberichts</title>
2020 Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als Grundlage für das
2021 Startdatum benutzt. Schließt man die Bücher allerdings monatsweise führt dies
2022 zu falschen Werten.</para>
2023 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau einstellen indem man:</para>
2026 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu vorher)</para>
2029 <para>immer den Jahresanfang nimmt (1.1. relativ zum Stichtag)</para>
2032 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
2033 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen gibt</para>
2034 <para>- oder mit "alle Buchungen" als Alternative"</para>
2037 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen gibt </para>
2040 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
2043 Folgende Hinweise zu den Optionen:
2044 Das "Bücher schließen Datum" ist sinnvoll, wenn man nur komplette Jahre
2045 schließt. Bei Wirtschaftsjahr = Kalendarjahr entspricht dies aber auch
2047 "Alle Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
2049 Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B. sinnvoll, wenn man
2050 am sich Anfang des zweiten Buchungsjahres befindet, und noch keinen
2051 Jahreswechsel und auch noch keine EB-Buchungen hat.
2052 Bei den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1. Tag
2053 des Wirtschaftsjahres gebucht werden.
2054 Zur Sicherheit wird das Startdatum im Bilanzbericht jetzt zusätzlich zum
2055 Stichtag mit angezeigt. Das hilft auch bei der Kontrolle für den
2056 Abgleich mit der GuV.
2058 <sect1 id="config.client">
2059 <title>Einstellungen pro Mandant</title>
2061 <para>Einige Einstellungen können von einem Benutzer mit dem
2062 <link linkend="Zusammenhänge">Recht</link> "Administration
2063 (Für die Verwaltung der aktuellen Instanz aus einem Userlogin heraus)"
2064 gemacht werden. Diese Einstellungen sind dann für die aktuellen
2065 Mandanten-Datenbank gültig. Die Einstellungen sind
2066 unter <guimenu>System</guimenu>
2067 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
2069 <para>Bitte beachten Sie die Hinweise zu den einzelnen
2070 Einstellungen. Einige Einstellungen sollten nicht ohne Weiteres
2071 im laufenden Betrieb geändert werden (siehe
2072 auch <link linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
2073 Bestandsmethode</link>).</para>
2075 <para>Die Einstellungen <literal>show_bestbefore</literal>
2076 und <literal>payments_changeable</literal> aus dem
2077 Abschnitt <literal>features</literal> und die Einstellungen im
2078 Abschnitt <literal>datev_check</literal> (sofern schon vorhanden)
2079 der <link linkend="config.config-file">kivitendo-Konfigurationsdatei</link>
2080 werden bei einem Datenbankupdate einer älteren Version automatisch
2081 übernommen. Diese Einträge können danach aus der Konfigurationsdatei
2082 entfernt werden.</para>
2085 <sect1 id="kivitendo-ERP-verwenden">
2086 <title>kivitendo ERP verwenden</title>
2088 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
2089 folgender URL erreichbar:</para>
2092 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
2094 <para>Die Administrationsseite erreichen Sie unter:</para>
2097 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
2101 <chapter id="features" xreflabel="Features und Funktionen">
2102 <title>Features und Funktionen</title>
2104 <sect1 id="features.periodic-invoices"
2105 xreflabel="Wiedekehrende Rechnungen">
2106 <title>Wiederkehrende Rechnungen</title>
2108 <sect2 id="features.periodic-invoices.introduction"
2109 xreflabel="Einführung in wiederkehrende Rechnungen">
2110 <title>Einführung</title>
2112 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
2113 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
2114 Die konfigurierten Aufträge werden später automatisch in Rechnungen
2115 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
2116 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
2117 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
2118 wiederzufinden sind.</para>
2121 <sect2 id="features.periodic-invoices.configuration"
2122 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
2123 <title>Konfiguration</title>
2125 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
2126 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
2127 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
2128 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
2129 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
2132 <para>Folgende Parameter kann man konfigurieren:</para>
2139 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
2140 erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
2141 neuen Monats).</para>
2143 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
2144 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
2145 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
2146 nächsten Periodenwechsel für alle Perioden, seit der letzten
2147 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
2148 verhindern, muss man vorher das Startdatum neu setzen.</para>
2150 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
2151 erstellt. Man kann sich diese Aufträge aber gesondert in den
2152 Berichten anzeigen lassen.</para>
2157 <term>Periodizität</term>
2160 <para>Ob monatlich, quartalsweise oder jährlich auf neue
2161 Rechnungen überprüft werden soll. Für jede Periode seit dem
2162 Startdatum wird überprüft, ob für die Periode (beginnend immer
2163 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
2164 wurde. Unter Umständen können bei einem Startdatum in der
2165 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
2170 <term>Buchen auf</term>
2173 <para>Das Forderungskonto, in der Regel "Forderungen aus
2174 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
2175 Buchungsgruppen der betreffenden Waren.</para>
2180 <term>Startdatum</term>
2183 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
2189 <term>Enddatum</term>
2192 <para>ab wann keine Rechnungen mehr erstellt werden
2198 <term>Automatische Verlängerung um x Monate</term>
2201 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
2202 eingetragenen Enddatums weiterhin erstellt werden, so kann man
2203 hier die Anzahl der Monate eingeben, um die das Enddatum
2204 automatisch nach hinten geschoben wird.</para>
2209 <term>Drucken</term>
2212 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
2213 Rechnungen auch gleich ausdrucken lassen.</para>
2218 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
2219 Informationen zu den erstellten Rechnungen verschickt werden.
2220 Konfiguriert wird dies in der <link
2221 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
2222 <filename>config/kivitendo.conf</filename> im Abschnitt
2223 <varname>[periodic_invoices]</varname>.</para>
2226 <sect2 id="features.periodic-invoices.variables">
2227 <title>Spezielle Variablen</title>
2230 Um die erzeugten Rechnungen individualisieren zu können, werden beim Umwandeln des Auftrags in eine Rechnung einige speziell
2231 formatierte Variablen durch für die jeweils aktuelle Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B. den
2232 Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei die Syntax <literal><%variablenname%></literal>.
2236 Sofern es sich um eine Datumsvariable handelt, kann das Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
2237 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus: <literal><%variablenname
2238 FORMAT=Formatinformation%></literal>. Die zur verfügung stehenden Formatinformationen werden unten genauer beschrieben.
2242 Diese Variablen werden in den folgenden Elementen des Auftrags ersetzt:
2246 <listitem><para>Bemerkungen</para></listitem>
2247 <listitem><para>Interne Bemerkungen</para></listitem>
2248 <listitem><para>Vorgangsbezeichnung</para></listitem>
2249 <listitem><para>In den Beschreibungs- und Langtextfeldern aller Positionen</para></listitem>
2252 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
2256 <term><varname><%current_quarter%></varname>, <varname><%previous_quarter%></varname>, <varname><%next_quarter%></varname></term>
2260 Aktuelles, vorheriges und nächstes Quartal als Zahl zwischen <literal>1</literal> und <literal>4</literal>.
2266 <term><varname><%current_month%></varname>, <varname><%previous_month%></varname>, <varname><%next_month%></varname></term>
2270 Aktueller, vorheriger und nächster Monat als Zahl zwischen <literal>1</literal> und <literal>12</literal>.
2276 <term><varname><%current_month_long%></varname>, <varname><%previous_month_long%></varname>, <varname><%next_month_long%></varname></term>
2280 Aktueller, vorheriger und nächster Monat als Name (<literal>Januar</literal>, <literal>Februar</literal> etc.).
2286 <term><varname><%current_year%></varname>, <varname><%previous_year%></varname>, <varname><%next_year%></varname></term>
2290 Aktuelles, vorheriges und nächstes Jahr als vierstellige Jahreszahl (<literal>2013</literal> etc.).
2296 <term><varname><%period_start_date%></varname>, <varname><%period_end_date%></varname></term>
2300 Formatiertes Datum des ersten und letzten Tages im Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im ersten
2301 Quartal von 2013 wären dies der <literal>01.01.2013</literal> und <literal>31.03.2013</literal>).
2308 Die invidiuellen Formatinformationen bestehen aus Paaren von Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
2309 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal> durch das viertstellige Jahr ersetzt. Alle möglichen
2316 <term><varname>%a</varname></term>
2319 <para>Der abgekürzte Wochentagsname.</para>
2324 <term><varname>%A</varname></term>
2327 <para>Der ausgeschriebene Wochentagsname.</para>
2332 <term><varname>%b</varname></term>
2335 <para>Der abgekürzte Monatsname.</para>
2340 <term><varname>%B</varname></term>
2343 <para>Der ausgeschriebene Monatsname.</para>
2348 <term><varname>%C</varname></term>
2351 <para>Das Jahrhundert (Jahr/100) als eine zweistellige Zahl.</para>
2356 <term><varname>%d</varname></term>
2359 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
2364 <term><varname>%D</varname></term>
2367 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
2372 <term><varname>%e</varname></term>
2375 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings werden führende Nullen durch Leerzeichen ersetzt.</para>
2380 <term><varname>%F</varname></term>
2383 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
2388 <term><varname>%j</varname></term>
2391 <para>Der Tag im Jahr als Zahl zwischen 001 und 366 inklusive.</para>
2396 <term><varname>%m</varname></term>
2399 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
2404 <term><varname>%u</varname></term>
2407 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei die 1 dem Montag entspricht.</para>
2412 <term><varname>%U</varname></term>
2415 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive, wobei der erste Sonntag im Jahr das Startdatum von Woche 01 ist.</para>
2420 <term><varname>%V</varname></term>
2423 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53 inklusive, wobei Woche 01 die erste Woche, von der mindestens vier Tage im Jahr liegen; Montag ist erster Tag der Woche.</para>
2428 <term><varname>%w</varname></term>
2431 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei die 0 dem Sonntag entspricht.</para>
2436 <term><varname>%W</varname></term>
2439 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive, wobei der erste Montag im Jahr das Startdatum von Woche 01 ist.</para>
2444 <term><varname>%y</varname></term>
2447 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99 inklusive.</para>
2452 <term><varname>%Y</varname></term>
2455 <para>Das Jahr als vierstellige Zahl.</para>
2460 <term><varname>%%</varname></term>
2463 <para>Das Prozentzeichen selber.</para>
2469 Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode
2470 dauert: <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%> bis <%period_end_date FORMAT=%m/%Y%></literal>
2474 <sect2 id="features.periodic-invoices.reports">
2475 <title>Auflisten</title>
2477 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
2478 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
2479 Rechnungen inaktiv", mit denen man sich einen Überglick über die
2480 wiederkehrenden Rechnungen verschaffen kann.</para>
2483 <sect2 id="features.periodic-invoices.task-server">
2484 <title>Erzeugung der eigentlichen Rechnungen</title>
2486 <para>Die zeitliche und periodische Überprüfung, ob eine
2487 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
2488 durch den <link linkend="config.task-server">Taskserver</link>, einen
2489 externen Dienst, der automatisch beim Start des Servers gestartet
2490 werden sollte.</para>
2493 <sect2 id="features.periodic-invoices.create-for-current-month">
2494 <title>Erste Rechnung für aktuellen Monat erstellen</title>
2496 <para>Will man im laufenden Monat eine monatlich wiederkehrende
2497 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
2498 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
2499 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
2500 generiert hat. Alternativ setzt man das Startdatum auf den
2501 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
2502 manuell über den Workflow.</para>
2505 <sect1 id="dokumentenvorlagen-und-variablen">
2506 <title>Dokumentenvorlagen und verfügbare Variablen</title>
2508 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
2509 <title>Einführung</title>
2511 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
2512 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
2513 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
2514 <function><%variablenname%></function> verwendet wird. Für
2515 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
2517 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
2519 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
2520 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
2521 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
2522 alle Vorlagenarten.</para>
2524 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
2525 verfügbar als hier aufgelistet werden. Die meisten davon können
2526 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
2527 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
2528 diese wie folgt erhalten werden:</para>
2532 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
2533 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
2537 <para>In <filename>Form.pm</filename> die Funktion
2538 <function>parse_template</function> suchen und hier die Zeile
2539 <command>print(STDERR Dumper($self));</command> einfügen.</para>
2543 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
2544 ein PDF für eine Rechnung erzeugen.</para>
2548 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
2549 der Variablen <varname>$self</varname> in der Form <varname>'key'
2550 => 'value',</varname>. Alle <varname>key</varname>s sind
2556 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
2557 <title>Variablen ausgeben</title>
2559 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
2560 Tags geschrieben werden, also z.B.
2561 <varname><%variablenname%></varname>.</para>
2563 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
2564 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
2565 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
2566 werden die folgenden Flags unterstützt:</para>
2570 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
2571 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
2572 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
2573 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
2577 <para><option>NOESCAPE</option> unterdrückt das Escapen von
2578 Sonderzeichen für die Vorlagensprache. Wenn also in einer
2579 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
2580 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
2581 ist dieses Flag sinnvoll.</para>
2585 <para>Beispiel:</para>
2587 <programlisting><%quototal NOFORMAT%></programlisting>
2590 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
2591 <title>Verwendung in Druckbefehlen</title>
2593 <para>In der Admininstration können Drucker definiert werden. Auch im
2594 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
2595 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
2596 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
2597 <function>`...`</function> nicht zu unerwünschtem Verhalten
2600 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
2601 für das die Telefonnummer eines Ansprechpartners als Teil der
2602 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
2603 z.B. wie folgt aussehen:</para>
2605 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
2608 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
2609 xreflabel="Anfang und Ende der Tags verändern">
2610 <title>Anfang und Ende der Tags verändern</title>
2612 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
2613 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
2614 Prozentzeichen und dem Größerzeichen endet, beispielsweise
2615 <function><%customer%></function>. Da diese Form aber z.B. in
2616 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
2617 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
2618 Stil umgestellt werden.</para>
2620 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
2621 Format gültigen Kommentarzeichen anfangen, dann
2622 <function>config:</function> enthalten, die entsprechende Option
2623 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
2624 enden. Beispiel für LaTeX:</para>
2626 <programlisting>% config: tag-style=($ $)</programlisting>
2628 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
2629 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
2630 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
2632 <programlisting><!-- config: tag-style=($ $) --></programlisting>
2635 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
2636 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
2638 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
2639 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
2640 "<filename>.ext</filename>" geeignet zu ersetzen:
2641 "<filename>.tex</filename>" für LaTeX-Vorlagen und
2642 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
2646 <term><filename>bin_list.ext</filename></term>
2649 <para>Lagerliste</para>
2654 <term><filename>check.ext</filename></term>
2662 <term><filename>invoice.ext</filename></term>
2665 <para>Rechnung</para>
2670 <term><filename>packing_list.ext</filename></term>
2673 <para>Packliste</para>
2678 <term><filename>pick_list.ext</filename></term>
2681 <para>Sammelliste</para>
2686 <term><filename>purchase_delivery_order.ext</filename></term>
2689 <para>Lieferschein (Einkauf)</para>
2694 <term><filename>purcharse_order.ext</filename></term>
2697 <para>Bestellung an Lieferanten</para>
2702 <term><filename>request_quotation.ext</filename></term>
2705 <para>Anfrage an Lieferanten</para>
2710 <term><filename>sales_delivery_order.ext</filename></term>
2713 <para>Lieferschein (Verkauf)</para>
2718 <term><filename>sales_order.ext</filename></term>
2721 <para>Bestellung</para>
2726 <term><filename>sales_quotation.ext</filename></term>
2729 <para>Angebot an Kunden</para>
2734 <term><filename>zahlungserinnerung.ext</filename></term>
2737 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2742 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2745 <para>Rechnung über Mahngebühren (Dateiname im Programm
2746 konfigurierbar)</para>
2752 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2753 <title>Sprache, Drucker und E-Mail</title>
2755 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2756 eingearbeitet. So wird aus der Vorlage
2757 <filename>sales_order.ext</filename> bei Sprache
2758 <function>de</function> und Druckerkürzel <function>lpr2</function>
2759 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2760 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2761 bekommen dann noch das Kürzel <filename>_email</filename>, der
2762 vollständige Vorlagenname wäre dann
2763 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2764 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2765 werden. Diese wird verwendet, wenn keine der anderen Varianten
2766 gefunden wird.</para>
2768 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2769 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2770 verschickt wird, ist:</para>
2774 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2778 <para><filename>sales_order_de_lpr2.tex</filename></para>
2782 <para><filename>sales_order.tex</filename></para>
2786 <para><filename>default.tex</filename></para>
2790 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2791 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2793 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2796 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2797 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2800 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2801 xreflabel="Metainformationen zur angeforderten Vorlage">
2802 <title>Metainformationen zur angeforderten Vorlage</title>
2804 <para>Diese Variablen liefern Informationen darüber welche Variante
2805 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2806 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2807 Formulare einbinden möchten.</para>
2811 <term><varname>template_meta.formname</varname></term>
2814 <para>Basisname der Vorlage. Identisch mit der <link
2815 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2816 zu den Dateinamen</link> ohne die Erweiterung. Ein
2817 Verkaufsauftrag enthält hier
2818 <constant>sales_order</constant>.</para>
2823 <term><varname>template_meta.language.description</varname></term>
2826 <para>Beschreibung der verwendeten Sprache</para>
2831 <term><varname>template_meta.language.template_code</varname></term>
2834 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2835 Kürzel das im Dateinamen verwendetet wird.</para>
2840 <term><varname>template_meta.language.output_numberformat</varname></term>
2843 <para>Zahlenformat der verwendeten Sprache in der Form
2844 "<constant>1.000,00</constant>". Experimentell! Nur
2845 interessant für Vorlagen die mit unformatierten Werten
2851 <term><varname>template_meta.language.output_dateformat</varname></term>
2854 <para>Datumsformat der verwendeten Sprache in der Form
2855 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2856 interessant für Vorlagen die mit unformatierten Werten
2862 <term><varname>template_meta.format</varname></term>
2865 <para>Das angeforderte Format. Kann im Moment die Werte
2866 <constant>pdf</constant>, <constant>postscript</constant>,
2867 <constant>html</constant>, <constant>opendocument</constant>,
2868 <constant>opendocument_pdf</constant> und
2869 <constant>excel</constant> enthalten.</para>
2874 <term><varname>template_meta.extension</varname></term>
2877 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2878 <constant>format</constant> entschieden.</para>
2883 <term><varname>template_meta.media</varname></term>
2886 <para>Ausgabemedium. Kann zur Zeit die Werte
2887 <constant>screen</constant> für Bildschirm,
2888 <constant>email</constant> für E-Mmail (triggert das
2889 <constant>_email</constant> Kürzel im Dateinamen),
2890 <constant>printer</constant> für Drucker, und
2891 <constant>queue</constant> für Warteschlange enthalten.</para>
2896 <term><varname>template_meta.printer.description</varname></term>
2899 <para>Beschreibung des ausgewählten Druckers</para>
2904 <term><varname>template_meta.printer.template_code</varname></term>
2907 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2908 dem Kürzel das im Dateinamen verwendetet wird.</para>
2913 <term><varname>template_meta.tmpfile</varname></term>
2916 <para>Datei-Prefix für temporäre Dateien.</para>
2922 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2923 <title>Stammdaten von Kunden und Lieferanten</title>
2927 <term><varname>account_number</varname></term>
2930 <para>Kontonummer</para>
2935 <term><varname>bank</varname></term>
2938 <para>Name der Bank</para>
2943 <term><varname>bank_code</varname></term>
2946 <para>Bankleitzahl</para>
2951 <term><varname>bic</varname></term>
2954 <para>Bank-Identifikations-Code (Bank Identifier Code,
2960 <term><varname>business</varname></term>
2963 <para>Kunden-/Lieferantentyp</para>
2968 <term><varname>city</varname></term>
2976 <term><varname>contact</varname></term>
2979 <para>Kontakt</para>
2984 <term><varname>country</varname></term>
2992 <term><varname>c_vendor_id</varname></term>
2995 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
3000 <term><varname>v_customer_id</varname></term>
3003 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
3008 <term><varname>cp_email</varname></term>
3011 <para>Email des Ansprechpartners</para>
3016 <term><varname>cp_givenname</varname></term>
3019 <para>Vorname des Ansprechpartners</para>
3024 <term><varname>cp_greeting</varname></term>
3027 <para>Anrede des Ansprechpartners</para>
3032 <term><varname>cp_name</varname></term>
3035 <para>Name des Ansprechpartners</para>
3040 <term><varname>cp_phone1</varname></term>
3043 <para>Telefonnummer 1 des Ansprechpartners</para>
3048 <term><varname>cp_phone2</varname></term>
3051 <para>Telefonnummer 2 des Ansprechpartners</para>
3056 <term><varname>cp_title</varname></term>
3059 <para>Titel des Ansprechpartners</para>
3064 <term><varname>creditlimit</varname></term>
3067 <para>Kreditlimit</para>
3072 <term><varname>customeremail</varname></term>
3075 <para>Email des Kunden; nur für Kunden</para>
3080 <term><varname>customerfax</varname></term>
3083 <para>Faxnummer des Kunden; nur für Kunden</para>
3088 <term><varname>customernotes</varname></term>
3091 <para>Bemerkungen beim Kunden; nur für Kunden</para>
3096 <term><varname>customernumber</varname></term>
3099 <para>Kundennummer; nur für Kunden</para>
3104 <term><varname>customerphone</varname></term>
3107 <para>Telefonnummer des Kunden; nur für Kunden</para>
3112 <term><varname>discount</varname></term>
3120 <term><varname>email</varname></term>
3123 <para>Emailadresse</para>
3128 <term><varname>fax</varname></term>
3131 <para>Faxnummer</para>
3136 <term><varname>homepage</varname></term>
3139 <para>Homepage</para>
3144 <term><varname>iban</varname></term>
3147 <para>Internationale Kontonummer (International Bank Account
3148 Number, IBAN)</para>
3153 <term><varname>language</varname></term>
3156 <para>Sprache</para>
3161 <term><varname>name</varname></term>
3164 <para>Firmenname</para>
3169 <term><varname>payment_description</varname></term>
3172 <para>Name der Zahlart</para>
3177 <term><varname>payment_terms</varname></term>
3180 <para>Zahlungskonditionen</para>
3185 <term><varname>phone</varname></term>
3188 <para>Telefonnummer</para>
3193 <term><varname>shiptocity</varname></term>
3196 <para>Stadt (Lieferadresse) <link
3197 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3202 <term><varname>shiptocontact</varname></term>
3205 <para>Kontakt (Lieferadresse) <link
3206 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3211 <term><varname>shiptocountry</varname></term>
3214 <para>Land (Lieferadresse) <link
3215 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3220 <term><varname>shiptodepartment1</varname></term>
3223 <para>Abteilung 1 (Lieferadresse) <link
3224 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3229 <term><varname>shiptodepartment2</varname></term>
3232 <para>Abteilung 2 (Lieferadresse) <link
3233 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3238 <term><varname>shiptoemail</varname></term>
3241 <para>Email (Lieferadresse) <link
3242 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3247 <term><varname>shiptofax</varname></term>
3250 <para>Fax (Lieferadresse) <link
3251 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3256 <term><varname>shiptoname</varname></term>
3259 <para>Firmenname (Lieferadresse) <link
3260 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3265 <term><varname>shiptophone</varname></term>
3268 <para>Telefonnummer (Lieferadresse) <link
3269 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3274 <term><varname>shiptostreet</varname></term>
3277 <para>Straße und Hausnummer (Lieferadresse) <link
3278 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3283 <term><varname>shiptozipcode</varname></term>
3286 <para>Postleitzahl (Lieferadresse) <link
3287 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3292 <term><varname>street</varname></term>
3295 <para>Straße und Hausnummer</para>
3300 <term><varname>taxnumber</varname></term>
3303 <para>Steuernummer</para>
3308 <term><varname>ustid</varname></term>
3311 <para>Umsatzsteuer-Identifikationsnummer</para>
3316 <term><varname>vendoremail</varname></term>
3319 <para>Email des Lieferanten; nur für Lieferanten</para>
3324 <term><varname>vendorfax</varname></term>
3327 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
3332 <term><varname>vendornotes</varname></term>
3335 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
3340 <term><varname>vendornumber</varname></term>
3343 <para>Lieferantennummer; nur für Lieferanten</para>
3348 <term><varname>vendorphone</varname></term>
3351 <para>Telefonnummer des Lieferanten; nur für
3357 <term><varname>zipcode</varname></term>
3360 <para>Postleitzahl</para>
3365 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
3366 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
3367 Stammdaten nicht eingetragen, so haben die Variablen
3368 <varname>shipto*</varname> den gleichen Wert wie die die
3369 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
3370 einige <varname>shipto*</varname>-Variablen so nicht in den
3371 Stammdaten wiederfinden sondern schlicht Kopien der
3372 Lieferdatenvariablen sind (z.B.
3373 <varname>shiptocontact</varname>).</para>
3377 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
3378 <title>Informationen über den Bearbeiter</title>
3382 <term><varname>employee_address</varname></term>
3385 <para>Adressfeld</para>
3390 <term><varname>employee_businessnumber</varname></term>
3393 <para>Firmennummer</para>
3398 <term><varname>employee_company</varname></term>
3401 <para>Firmenname</para>
3406 <term><varname>employee_co_ustid</varname></term>
3409 <para>Usatzsteuer-Identifikationsnummer</para>
3414 <term><varname>employee_duns</varname></term>
3417 <para>DUNS-Nummer</para>
3422 <term><varname>employee_email</varname></term>
3430 <term><varname>employee_fax</varname></term>
3438 <term><varname>employee_name</varname></term>
3441 <para>voller Name</para>
3446 <term><varname>employee_signature</varname></term>
3449 <para>Signatur</para>
3454 <term><varname>employee_taxnumber</varname></term>
3457 <para>Steuernummer</para>
3462 <term><varname>employee_tel</varname></term>
3465 <para>Telefonnummer</para>
3471 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
3472 <title>Informationen über den Verkäufer</title>
3476 <term><varname>salesman_address</varname></term>
3479 <para>Adressfeld</para>
3484 <term><varname>salesman_businessnumber</varname></term>
3487 <para>Firmennummer</para>
3492 <term><varname>salesman_company</varname></term>
3495 <para>Firmenname</para>
3500 <term><varname>salesman_co_ustid</varname></term>
3503 <para>Usatzsteuer-Identifikationsnummer</para>
3508 <term><varname>salesman_duns</varname></term>
3511 <para>DUNS-Nummer</para>
3516 <term><varname>salesman_email</varname></term>
3524 <term><varname>salesman_fax</varname></term>
3532 <term><varname>salesman_name</varname></term>
3535 <para>voller Name</para>
3540 <term><varname>salesman_signature</varname></term>
3543 <para>Signatur</para>
3548 <term><varname>salesman_taxnumber</varname></term>
3551 <para>Steuernummer</para>
3556 <term><varname>salesman_tel</varname></term>
3559 <para>Telefonnummer</para>
3565 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
3566 <title>Variablen für die einzelnen Steuern</title>
3570 <term><varname>tax</varname></term>
3578 <term><varname>taxbase</varname></term>
3581 <para>zu versteuernder Betrag</para>
3586 <term><varname>taxdescription</varname></term>
3589 <para>Name der Steuer</para>
3594 <term><varname>taxrate</varname></term>
3597 <para>Steuersatz</para>
3603 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
3604 <title>Variablen für Lieferbedingungen</title>
3608 <term><varname>delivery_term</varname></term>
3609 <listitem><para>Datenbank-Objekt der Lieferbedingung</para></listitem>
3612 <term><varname>delivery_term.description</varname></term>
3613 <listitem><para>Beschreibung der Lieferbedingung</para></listitem>
3616 <term><varname>delivery_term.long_description</varname></term>
3617 <listitem><para>Langtext bzw. übersetzter Langtext der Lieferbedingung</para></listitem>
3623 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
3624 <title>Variablen in Rechnungen</title>
3626 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
3627 <title>Allgemeine Variablen</title>
3631 <term><varname>creditremaining</varname></term>
3634 <para>Verbleibender Kredit</para>
3639 <term><varname>currency</varname></term>
3642 <para>Währung</para>
3647 <term><varname>cusordnumber</varname></term>
3650 <para>Bestellnummer beim Kunden</para>
3655 <term><varname>deliverydate</varname></term>
3658 <para>Lieferdatum</para>
3663 <term><varname>duedate</varname></term>
3666 <para>Fälligkeitsdatum</para>
3671 <term><varname>globalprojectnumber</varname></term>
3674 <para>Projektnummer des ganzen Beleges</para>
3679 <term><varname>globalprojectdescription</varname></term>
3682 <para>Projekbeschreibung des ganzen Beleges</para>
3687 <term><varname>intnotes</varname></term>
3690 <para>Interne Bemerkungen</para>
3695 <term><varname>invdate</varname></term>
3698 <para>Rechnungsdatum</para>
3703 <term><varname>invnumber</varname></term>
3706 <para>Rechnungsnummer</para>
3711 <term><varname>invtotal</varname></term>
3714 <para>gesamter Rechnungsbetrag</para>
3719 <term><varname>notes</varname></term>
3722 <para>Bemerkungen der Rechnung</para>
3727 <term><varname>orddate</varname></term>
3730 <para>Auftragsdatum</para>
3735 <term><varname>ordnumber</varname></term>
3738 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3739 erstellt wurde</para>
3744 <term><varname>payment_description</varname></term>
3747 <para>Name der Zahlart</para>
3752 <term><varname>payment_terms</varname></term>
3755 <para>Zahlungskonditionen</para>
3760 <term><varname>quodate</varname></term>
3763 <para>Angebotsdatum</para>
3768 <term><varname>quonumber</varname></term>
3771 <para>Angebotsnummer</para>
3776 <term><varname>shippingpoint</varname></term>
3779 <para>Versandort</para>
3784 <term><varname>shipvia</varname></term>
3787 <para>Transportmittel</para>
3792 <term><varname>subtotal</varname></term>
3795 <para>Zwischensumme aller Posten ohne Steuern</para>
3800 <term><varname>total</varname></term>
3803 <para>Restsumme der Rechnung (Summe abzüglich bereits
3804 bezahlter Posten)</para>
3809 <term><varname>transaction_description</varname></term>
3812 <para>Vorgangsbezeichnung</para>
3817 <term><varname>transdate</varname></term>
3820 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3821 erstellt wurde</para>
3827 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3828 <title>Variablen für jeden Posten auf der Rechnung</title>
3832 <term><varname>bin</varname></term>
3835 <para>Stellage</para>
3840 <term><varname>description</varname></term>
3843 <para>Artikelbeschreibung</para>
3848 <term><varname>discount</varname></term>
3851 <para>Rabatt als Betrag</para>
3856 <term><varname>discount_sub</varname></term>
3859 <para>Zwischensumme mit Rabatt</para>
3864 <term><varname>drawing</varname></term>
3867 <para>Zeichnung</para>
3872 <term><varname>ean</varname></term>
3875 <para>EAN-Code</para>
3880 <term><varname>image</varname></term>
3888 <term><varname>linetotal</varname></term>
3891 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3896 <term><varname>longdescription</varname></term>
3899 <para>Langtext</para>
3904 <term><varname>microfiche</varname></term>
3907 <para>Mikrofilm</para>
3912 <term><varname>netprice</varname></term>
3915 <para>Alternative zu <varname>sellprice</varname>, aber <varname>netprice</varname> entspricht dem effektiven Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor. <varname>netprice</varname> wird rückgerechnet aus Zeilensumme / Menge. Diese Variable ist nützlich, wenn man den gewährten Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge * Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll. <varname>netprice</varname> hat nichts mit Netto/Brutto im Sinne von Steuern zu tun.</para>
3920 <term><varname>nodiscount_linetotal</varname></term>
3923 <para>Zeilensumme ohne Rabatt</para>
3928 <term><varname>nodiscount_sub</varname></term>
3931 <para>Zwischensumme ohne Rabatt</para>
3936 <term><varname>number</varname></term>
3939 <para>Artikelnummer</para>
3944 <term><varname>ordnumber_oe</varname></term>
3947 <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
3948 aus einem Sammelauftrag erstellt wurde</para>
3953 <term><varname>donumber_do</varname></term>
3956 <para>Lieferscheinnummer desjenigen Lieferscheins, aus dem die Position stammt, sofern die Rechnung aus einem oder
3957 mehreren Lieferscheinen erstellt wurde</para>
3962 <term><varname>p_discount</varname></term>
3965 <para>Rabatt in Prozent</para>
3970 <term><varname>partnotes</varname></term>
3973 <para>Die beim Artikel gespeicherten Bemerkungen</para>
3978 <term><varname>partsgroup</varname></term>
3981 <para>Warengruppe</para>
3986 <term><varname>price_factor</varname></term>
3989 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
3995 <term><varname>price_factor_name</varname></term>
3998 <para>Der Name des Preisfaktors, sofern einer eingestellt
4004 <term><varname>projectnumber</varname></term>
4007 <para>Projektnummer</para>
4012 <term><varname>projectdescription</varname></term>
4015 <para>Projektbeschreibung</para>
4020 <term><varname>qty</varname></term>
4028 <term><varname>reqdate</varname></term>
4031 <para>Lieferdatum</para>
4036 <term><varname>runningnumber</varname></term>
4039 <para>Position auf der Rechnung (1, 2, 3...)</para>
4044 <term><varname>sellprice</varname></term>
4047 <para>Verkaufspreis</para>
4052 <term><varname>serialnumber</varname></term>
4055 <para>Seriennummer</para>
4060 <term><varname>tax_rate</varname></term>
4063 <para>Steuersatz</para>
4068 <term><varname>transdate_oe</varname></term>
4071 <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
4072 aus einem Sammelauftrag erstellt wurde</para>
4077 <term><varname>unit</varname></term>
4080 <para>Einheit</para>
4085 <term><varname>weight</varname></term>
4088 <para>Gewicht</para>
4093 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
4094 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
4095 einer <function>foreach</function>-Schleife ausgegeben werden, da
4096 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
4097 können. Die Variablen dafür lauten:</para>
4101 <term><varname>make</varname></term>
4104 <para>Lieferant</para>
4109 <term><varname>model</varname></term>
4112 <para>Lieferantenartikelnummer</para>
4118 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
4119 <title>Variablen für die einzelnen Zahlungseingänge</title>
4123 <term><varname>payment</varname></term>
4131 <term><varname>paymentaccount</varname></term>
4139 <term><varname>paymentdate</varname></term>
4147 <term><varname>paymentmemo</varname></term>
4155 <term><varname>paymentsource</varname></term>
4164 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
4165 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
4167 <para>Die vom Benutzer definierten Variablen für Kunden und
4168 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
4169 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
4170 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
4171 Variablennamen zusammen.</para>
4173 <para>Beispiel: Der Benutzer hat eine Variable namens
4174 <varname>number_of_employees</varname> definiert, die die Anzahl der
4175 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
4176 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
4181 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
4182 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
4184 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
4185 <title>Namen der Vorlagen</title>
4187 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
4188 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
4189 Erstellung einer Rechnung über die Mahngebühren und Zinsen
4190 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
4191 Vorlagenname für diese Mahnstufe mit dem Zusatz
4192 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
4193 für die ausgewählte Sprache und den ausgewählten Drucker
4197 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
4198 <title>Allgemeine Variablen in Mahnungen</title>
4200 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4201 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4202 Kunden stehen als Variablen <varname>name</varname>,
4203 <varname>street</varname>, <varname>zipcode</varname>,
4204 <varname>city</varname>, <varname>country</varname>,
4205 <varname>department_1</varname>, <varname>department_2</varname>,
4206 und <varname>email</varname> zur Verfügung.</para>
4208 <para>Weitere Variablen beinhalten:</para>
4212 <term><varname>dunning_date</varname></term>
4215 <para>Datum der Mahnung</para>
4220 <term><varname>dunning_duedate</varname></term>
4223 <para>Fälligkeitsdatum für diese Mahhnung</para>
4228 <term><varname>dunning_id</varname></term>
4231 <para>Mahnungsnummer</para>
4236 <term><varname>fee</varname></term>
4239 <para>Kummulative Mahngebühren</para>
4244 <term><varname>interest_rate</varname></term>
4247 <para>Zinssatz per anno in Prozent</para>
4252 <term><varname>total_amount</varname></term>
4255 <para>Gesamter noch zu zahlender Betrag als
4256 <function>fee</function> + <function>total_interest</function>
4257 + <function>total_open_amount</function></para>
4262 <term><varname>total_interest</varname></term>
4265 <para>Zinsen per anno über alle Rechnungen</para>
4270 <term><varname>total_open_amount</varname></term>
4273 <para>Summe über alle offene Beträge der Rechnungen</para>
4279 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
4280 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
4284 <term><varname>dn_amount</varname></term>
4287 <para>Rechnungssumme (brutto)</para>
4292 <term><varname>dn_duedate</varname></term>
4295 <para>Originales Fälligkeitsdatum der Rechnung</para>
4300 <term><varname>dn_dunning_date</varname></term>
4303 <para>Datum der Mahnung</para>
4308 <term><varname>dn_dunning_duedate</varname></term>
4311 <para>Fälligkeitsdatum der Mahnung</para>
4316 <term><varname>dn_fee</varname></term>
4319 <para>Kummulative Mahngebühr</para>
4324 <term><varname>dn_interest</varname></term>
4327 <para>Zinsen per anno für diese Rechnung</para>
4332 <term><varname>dn_invnumber</varname></term>
4335 <para>Rechnungsnummer</para>
4340 <term><varname>dn_linetotal</varname></term>
4343 <para>Noch zu zahlender Betrag (ergibt sich aus
4344 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
4345 + <varname>dn_interest</varname>)</para>
4350 <term><varname>dn_netamount</varname></term>
4353 <para>Rechnungssumme (netto)</para>
4358 <term><varname>dn_open_amount</varname></term>
4361 <para>Offener Rechnungsbetrag</para>
4366 <term><varname>dn_ordnumber</varname></term>
4369 <para>Bestellnummer</para>
4374 <term><varname>dn_transdate</varname></term>
4377 <para>Rechnungsdatum</para>
4382 <term><varname>dn_curr</varname></term>
4385 <para>Währung, in der die Rechnung erstellt wurde. (Die
4386 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
4392 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
4393 <title>Variablen in automatisch erzeugten Rechnungen über
4394 Mahngebühren</title>
4396 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4397 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4398 Kunden stehen als Variablen <varname>name</varname>,
4399 <varname>street</varname>, <varname>zipcode</varname>,
4400 <varname>city</varname>, <varname>country</varname>,
4401 <varname>department_1</varname>, <varname>department_2</varname>,
4402 und <varname>email</varname> zur Verfügung.</para>
4404 <para>Weitere Variablen beinhalten:</para>
4408 <term><varname>duedate</varname></term>
4411 <para>Fälligkeitsdatum der Rechnung</para>
4416 <term><varname>dunning_id</varname></term>
4419 <para>Mahnungsnummer</para>
4424 <term><varname>fee</varname></term>
4427 <para>Mahngebühren</para>
4432 <term><varname>interest</varname></term>
4440 <term><varname>invamount</varname></term>
4443 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
4444 <varname>interest</varname>)</para>
4449 <term><varname>invdate</varname></term>
4452 <para>Rechnungsdatum</para>
4457 <term><varname>invnumber</varname></term>
4460 <para>Rechnungsnummer</para>
4467 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
4468 <title>Variablen in anderen Vorlagen</title>
4471 <title>Einführung</title>
4473 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
4474 Rechnung. Allerdings heißen die Variablen, die mit
4475 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
4476 fangen sie mit <varname>quo</varname> für "quotation" an:
4477 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
4478 wiederum fangen sie mit <varname>ord</varname> für "order" an:
4479 <varname>ordnumber</varname> für Bestellnummer etc.</para>
4481 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
4482 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
4483 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
4484 Vorlage keine Bedeutung haben oder noch nicht belegt sein
4487 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
4488 in Rechnungen aufgeführt.</para>
4491 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
4492 <title>Angebote und Preisanfragen</title>
4496 <term><varname>quonumber</varname></term>
4499 <para>Angebots- bzw. Anfragenummer</para>
4504 <term><varname>reqdate</varname></term>
4507 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
4508 Preisanfragen)</para>
4513 <term><varname>transdate</varname></term>
4516 <para>Angebots- bzw. Anfragedatum</para>
4522 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
4523 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
4527 <term><varname>ordnumber</varname></term>
4530 <para>Auftragsnummer</para>
4535 <term><varname>reqdate</varname></term>
4538 <para>Lieferdatum</para>
4543 <term><varname>transdate</varname></term>
4546 <para>Auftragsdatum</para>
4552 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
4553 <title>Lieferscheine (Verkauf und Einkauf)</title>
4557 <term><varname>cusordnumber</varname></term>
4560 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
4561 des Lieferanten (im Einkauf)</para>
4566 <term><varname>donumber</varname></term>
4569 <para>Lieferscheinnummer</para>
4574 <term><varname>transdate</varname></term>
4577 <para>Lieferscheindatum</para>
4582 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
4583 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
4584 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
4585 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
4586 <function>foreach</function>-Schleife ausgegeben werden. Diese
4587 Variablen sind:</para>
4591 <term><varname>si_bin</varname></term>
4594 <para>Lagerplatz</para>
4599 <term><varname>si_chargenumber</varname></term>
4602 <para>Chargennummer</para>
4607 <term><varname>si_bestbefore</varname></term>
4610 <para>Mindesthaltbarkeit</para>
4615 <term><varname>si_number</varname></term>
4618 <para>Artikelnummer</para>
4623 <term><varname>si_qty</varname></term>
4626 <para>Anzahl bzw. Menge</para>
4631 <term><varname>si_runningnumber</varname></term>
4634 <para>Positionsnummer (1, 2, 3 etc)</para>
4639 <term><varname>si_unit</varname></term>
4642 <para>Einheit</para>
4647 <term><varname>si_warehouse</varname></term>
4656 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
4657 <title>Variablen für Sammelrechnung</title>
4661 <term><varname>c0total</varname></term>
4664 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
4670 <term><varname>c30total</varname></term>
4673 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
4674 und < 60 Tage</para>
4679 <term><varname>c60total</varname></term>
4682 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
4683 und < 90 Tage</para>
4688 <term><varname>c90total</varname></term>
4691 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
4697 <term><varname>total</varname></term>
4700 <para>Gesamtbetrag aller Rechnungen</para>
4705 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
4709 <term><varname>invnumber</varname></term>
4712 <para>Rechnungsnummer</para>
4717 <term><varname>invdate</varname></term>
4720 <para>Rechnungsdatum</para>
4725 <term><varname>duedate</varname></term>
4728 <para>Fälligkeitsdatum</para>
4733 <term><varname>amount</varname></term>
4736 <para>Summe der Rechnung</para>
4741 <term><varname>open</varname></term>
4744 <para>Noch offener Betrag der Rechnung</para>
4749 <term><varname>c0</varname></term>
4752 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4758 <term><varname>c30</varname></term>
4761 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4767 <term><varname>c60</varname></term>
4770 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4776 <term><varname>c90</varname></term>
4779 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4787 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4788 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4790 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4791 <title>Einfürhung</title>
4793 <para>Der Parser kennt neben den Variablen einige weitere
4794 Konstrukte, die gesondert behandelt werden. Diese sind wie
4795 Variablennamen in spezieller Weise markiert:
4796 <command><%anweisung%> ... <%end%></command></para>
4798 <para>Anmerkung zum <command><%end%></command>: Der besseren
4799 Verständlichkeit halber kann man nach dem <command>end</command>
4800 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4801 Anweisung (z.B. <command>if</command> oder
4802 <command>foreach</command>) damit abgeschlossen wird.</para>
4804 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4805 <command><%if type == "sales_quotation"%></command>, so könnte
4806 er mit <command><%end%></command> genauso abgeschlossen werden
4807 wie mit <command><%end if%></command> oder auch
4808 <command><%end type == "sales_quotation"%></command>.</para>
4811 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4812 <title>Der if-Block</title>
4814 <programlisting><%if variablenname%>
4816 <%end%></programlisting>
4818 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4819 und dem "end" werden nur ausgegeben, wenn die Variable
4820 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4822 <para>Handelt es sich bei der benannten Variable um ein Array, also um einen Variablennamen, über den man mit
4823 <command><%foreach variablenname%></command> iteriert, so wird mit diesem Konstrukt darauf getestet, ob das Array Elemente
4824 enthält. Somit würde im folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt ihrer Überschrift "Zahlungseingänge"
4825 ausgegeben, wenn tatsächlich welche getätigt wurden:</para>
4827 <programlisting><%if payment%>
4829 <%foreach payment%>
4830 Am <%paymentdate%>: <%payment%> €
4831 <%end foreach%>
4832 <%end if%></programlisting>
4834 <para>Die Bedingung kann auch negiert werden, indem das Wort
4835 <function>not</function> nach dem <filename>if</filename> verwendet
4836 wird. Beispiel:</para>
4838 <programlisting><%if not cp_greeting%>
4840 <%end%></programlisting>
4842 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4843 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4844 einer Variablen mit einer festen Zeichenkette oder einer anderen
4845 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4846 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4847 die rechte Seite des Vergleichsoperators in Anführungszeichen
4848 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4849 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4852 <programlisting><%if var1 == "Wert"%></programlisting>
4854 <para>Testet die Variable <varname>var1</varname> auf
4855 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4856 Mittels <function>!=</function> anstelle von <function>==</function>
4857 würde auf Ungleichheit getestet.</para>
4859 <programlisting><%if var1 == var2%></programlisting>
4861 <para>Testet die Variable <varname>var1</varname> auf
4862 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4863 <function>!=</function> anstelle von <function>==</function> würde
4864 auf Ungleichheit getestet.</para>
4866 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4867 auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
4868 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4869 dieselbe Syntax wie oben nur mit <function>=~</function> und
4870 <function>!~</function> als Vergleichsoperatoren.</para>
4872 <para>Beispiel für einen Test, ob die Variable
4873 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4874 <constant>schwierig</constant> enthält:</para>
4876 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4879 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4880 <title>Der foreach-Block</title>
4882 <programlisting><%foreach variablenname%>
4884 <%end%></programlisting>
4886 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4887 wie das Perl-Array der Variablen <varname>variablenname</varname>
4888 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4889 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4890 benutzt. In jedem Durchlauf werden die <link
4891 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4892 Variablen</link> jeweils auf den Wert für die aktuelle Position
4895 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
4897 <programlisting><%foreach number%>
4898 Position: <%runningnumber%>
4899 Anzahl: <%qty%>
4900 Artikelnummer: <%number%>
4901 Beschreibung: <%description%>
4903 <%end%></programlisting>
4905 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
4906 <function><%foreach%></function>-Block innerhalb einer
4907 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
4908 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
4909 Inhalt zwischen <function><%foreach%></function> und
4910 <function><%end%></function> wiederholt, nicht aber die
4911 komplette Zeile, in der er steht.</para>
4915 <sect2 id="dokumentenvorlagen-und-variablen.markup">
4916 <title>Markup-Code zur Textformatierung innerhalb von
4919 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
4920 anders formatiert haben möchte, so ist dies begrenzt möglich.
4921 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
4922 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
4923 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
4924 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
4925 (HTML oder PDF über LaTeX) umgesetzt.</para>
4927 <para>Die unterstützen Formatierungen sind:</para>
4931 <term><b>Text</b></term>
4934 <para>Text wird in Fettdruck gesetzt.</para>
4939 <term><i>Text</i></term>
4942 <para>Text wird kursiv gesetzt.</para>
4947 <term><u>Text</u></term>
4950 <para>Text wird unterstrichen.</para>
4955 <term><s>Text</s></term>
4958 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
4959 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
4964 <term><bullet></term>
4967 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
4973 <para>Der Befehl <command><bullet></command> funktioniert
4974 momentan auch nur in Latex-Vorlagen.</para>
4978 <sect1 id="excel-templates">
4979 <title>Excel-Vorlagen</title>
4981 <sect2 id="excel-templates.summary">
4982 <title>Zusammenfassung</title>
4984 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
4985 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
4989 <sect2 id="excel-templates.usage">
4990 <title>Bedienung</title>
4992 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
4993 werden. Die Konfigurationsoption heißt <varname>excel_templates =
4994 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
4996 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
4997 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
4998 werden. In den normalen Verkaufsmasken taucht nun
4999 <constant>Excel</constant> als auswählbares Format auf und kann von da
5000 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
5002 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
5003 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
5004 <filename>sales_quotation.xls</filename> gespeichert.</para>
5007 <sect2 id="excel-templates.syntax">
5008 <title>Variablensyntax</title>
5010 <para>Einfache Syntax:
5011 <command><<varname>></command></para>
5013 <para>Dabei sind <constant><<</constant> und
5014 <constant>>></constant> die Delimiter. Da Excel auf festen
5015 Breiten besteht, kann der Tag künstlich verlängert werden, indem
5016 weitere <constant><</constant> oder <constant>></constant>
5017 eingefügt werden. Der Tag muss nicht symmetrisch sein.
5020 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
5022 <para>Um die Limitierung der festen Breite zu reduzieren, können
5023 weitere Variablen in einem Block interpoliert werden. Whitespace wird
5024 dazwishen dann erhalten. Beispiel:</para>
5026 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
5028 <para>Die Variablen werden interpoliert, und linksbündig mit
5029 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
5030 lang, werden überzählige Zeichen abgeschnitten.</para>
5032 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
5033 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
5035 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
5037 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
5038 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
5042 <sect2 id="excel-templates.limitations">
5043 <title>Einschränkungen</title>
5045 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
5046 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
5047 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
5048 Text zu ersetzen.</para>
5050 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
5051 <command><%if%></command> und
5052 <command><%foreach%></command> nicht vorhanden. Der Delimiter
5053 <constant><% %></constant> kommt in den Headerinformationen
5054 evtl. vor. Deshalb wurde auf den sichereren Delimiter
5055 <constant><<</constant> und <constant>>></constant>
5059 <sect1 id="features.warehouse">
5060 <title>Mandantenkonfiguration Lager</title>
5061 Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt:
5062 Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die Möglichkeit hier über den
5063 Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. Ferner kann
5064 jede Position eines Lieferscheins ein-, bzw. ausgelagert werden (Einkauf-, bzw. Verkauf).
5065 Es können beliebig viele Lager mit beliebig vielen Lagerplätzen abgebildet werden.
5066 Die Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder Einzelposition und
5067 das Auswählen dieser Position zu einem Lager mit Lagerplatz.
5068 Dieses Verfahren lässt sich schrittweise vereinfachen, je nachdem wie die Einstellungen in
5069 der Mandatenkonfiguration gesetzt werden.
5072 <para><option>Auslagern über Standardlagerplatz</option> Hier wird ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz)
5073 in dem Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über den Standardlagerplatz (konfigurierbar pro Ware) durchführt.
5077 <para><option>Auslagern ohne Bestandsprüfung</option>Das obige Auslagern schlägt fehl, wenn die entsprechende Menge für
5078 die Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit dieser Option
5079 erlauben. Hierfür muss ein entsprechender Lagerplatz (Fehlbestand, o.ä.) konfiguriert sein.</para>
5082 Zusätzliche Funktionshinweise:
5084 <listitem><para><option>Standard-Lagerplatz</option>Ist dieser konfiguriert, wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
5085 Stammdaten-> Waren / Dienstleistung / Erzeugnis verwendet.
5088 <listitem><para><option>Standard-Lagerplatz verwenden, falls keiner in Stammdaten definiert</option>Wird beim 'Auslagern über Standardlagerplatz'
5089 keine Standardlagerplatz zu der Ware gefunden, so wird mit dieser Option einfach der Standardlagerplatz verwendet.
5097 <title>Entwicklerdokumentation</title>
5099 <sect1 id="devel.globals" xreflabel="Globale Variablen">
5100 <title>Globale Variablen</title>
5103 <title>Wie sehen globale Variablen in Perl aus?</title>
5105 <para>Globale Variablen liegen in einem speziellen namespace namens
5106 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
5107 globs global und die meisten speziellen Variablen sind...
5110 <para>Daraus ergeben sich folgende Formen:</para>
5114 <term><literal>$main::form</literal></term>
5117 <para>expliziter Namespace "main"</para>
5122 <term><literal>$::form</literal></term>
5125 <para>impliziter Namespace "main"</para>
5130 <term><literal>open FILE, "file.txt"</literal></term>
5133 <para><varname>FILE</varname> ist global</para>
5138 <term><literal>$_</literal></term>
5141 <para>speziell</para>
5146 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
5147 Schlüsselwort wie "<function>global</function>", mit dem man
5148 importieren kann. <function>my</function>, <function>our</function>
5149 und <function>local</function> machen was anderes.</para>
5153 <term><literal>my $form</literal></term>
5156 <para>lexikalische Variable, gültig bis zum Ende des
5162 <term><literal>our $form</literal></term>
5165 <para><varname>$form</varname> referenziert ab hier
5166 <varname>$PACKAGE::form</varname>.</para>
5171 <term><literal>local $form</literal></term>
5174 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
5175 des scopes zurückgesetzt</para>
5182 <title>Warum sind globale Variablen ein Problem?</title>
5184 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
5186 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
5187 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
5188 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
5189 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
5190 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
5191 Datenbankverbindungen, weil die sehr lange zum Initialisieren
5194 <para>Das zweite Problem ist <function>strict</function>. Unter
5195 <function>strict</function> werden alle Variablen die nicht explizit
5196 mit <function>Package</function>, <function>my</function> oder
5197 <function>our</function> angegeben werden als Tippfehler angemarkert,
5198 dies hat, seit der Einführung, u.a. schon so manche langwierige
5199 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
5200 angegeben werden, werden die nicht geprüft, und somit kann sich
5201 schnell ein Tippfehler einschleichen.</para>
5205 <title>Kanonische globale Variablen</title>
5207 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
5208 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
5209 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
5210 umhergereicht werden.</para>
5212 <para>Diese Variablen sind im Moment die folgenden neun:</para>
5216 <para><varname>$::form</varname></para>
5220 <para><varname>%::myconfig</varname></para>
5224 <para><varname>$::locale</varname></para>
5228 <para><varname>$::lxdebug</varname></para>
5232 <para><varname>$::auth</varname></para>
5236 <para><varname>$::lx_office_conf</varname></para>
5240 <para><varname>$::instance_conf</varname></para>
5244 <para><varname>$::dispatcher</varname></para>
5248 <para><varname>$::request</varname></para>
5252 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
5253 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
5254 Eigenschaften (Konventionen):</para>
5257 <title>$::form</title>
5261 <para>Ist ein Objekt der Klasse
5262 "<classname>Form</classname>"</para>
5266 <para>Wird nach jedem Request gelöscht</para>
5270 <para>Muss auch in Tests und Konsolenscripts vorhanden
5275 <para>Enthält am Anfang eines Requests die Requestparameter vom
5280 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
5281 cachen, das wird aber momentan absichtlich zerstört</para>
5285 <para><varname>$::form</varname> wurde unter <productname>SQL
5286 Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
5287 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
5288 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
5289 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
5290 <function>IS->retrieve_customer()</function> in Sicherheit
5293 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
5294 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
5295 3552, Stand version 2.7beta), um dies hinterher wieder auf den
5296 richtigen Wert zu setzen:</para>
5298 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
5299 $::myconfig{numberformat} = $numberformat;
5300 # (...) div Berechnungen
5301 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
5303 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
5304 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
5305 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
5306 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
5307 Es geht ziemlich sicher etwas kaputt.</para>
5309 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
5310 in den <productname>Template::Toolkit</productname> Templates
5311 außerhalb der Controller: der Ausdruck <function>[% var
5312 %]</function> greift auf <varname>$::form->{var}</varname> zu.
5313 Unter Controllern ist der Standard Scope anders, da lautet der
5314 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
5315 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
5316 <function><%var%></function> zeigt auf
5317 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
5318 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
5321 <programlisting>[%- IF business %]
5322 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
5323 [%- END %]</programlisting>
5325 <para>Entweder wird hier dann $::form->{business} ausgewertet
5326 oder aber der Funktion
5327 <function>$form->parse_html_template</function> wird explizit
5328 noch ein zusätzlicher Hash übergeben, der dann auch in den
5329 (Web-)Templates zu Verfügung steht, bspw. so:</para>
5331 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
5333 <para>Innerhalb von Schleifen wird
5334 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
5335 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
5336 welches über alle Positionen eines Lieferscheins in Schleife
5339 <programlisting>for $i (1 .. $form->{rowcount}) {
5341 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
5342 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
5343 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
5349 <title>%::myconfig</title>
5353 <para>Das einzige Hash unter den globalen Variablen</para>
5357 <para>Wird spätestens benötigt wenn auf die Datenbank
5358 zugegriffen wird</para>
5362 <para>Wird bei jedem Request neu erstellt.</para>
5366 <para>Enthält die Userdaten des aktuellen Logins</para>
5370 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
5371 extern serialisiert werden, weil da auch der Datenbankzugriff
5372 für diesen user drinsteht.</para>
5376 <para>Enthält unter anderem Listenbegrenzung vclimit,
5377 Datumsformat dateformat und Nummernformat numberformat</para>
5381 <para>Enthält Datenbankzugriffinformationen</para>
5385 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
5386 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
5387 aktuellen Users entscheiden müssen, befragen
5388 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
5389 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
5390 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
5391 Informationen über den Benutzer die über die
5392 Administrator-Schnittstelle eingegeben wurden.</para>
5396 <title>$::locale</title>
5400 <para>Objekt der Klasse "Locale"</para>
5404 <para>Wird pro Request erstellt</para>
5408 <para>Muss auch für Tests und Scripte immer verfügbar
5413 <para>Cached intern über Requestgrenzen hinweg benutzte
5418 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
5419 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
5423 <title>$::lxdebug</title>
5427 <para>Objekt der Klasse "LXDebug"</para>
5431 <para>Wird global gecached</para>
5435 <para>Muss immer verfügbar sein, in nahezu allen
5440 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
5441 bereit, wie "<function>enter_sub</function>" und
5442 "<function>leave_sub</function>", mit denen in den alten Modulen ein
5443 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
5444 der man die Wallclockzeit seit Requeststart loggen kann, sowie
5445 "<function>message</function>" und "<function>dump</function>" mit
5446 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
5449 <para>Beispielsweise so:</para>
5451 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
5452 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
5456 <title>$::auth</title>
5460 <para>Objekt der Klasse "SL::Auth"</para>
5464 <para>Wird global gecached</para>
5468 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
5472 <para>Wird nach jedem Request resettet.</para>
5476 <para><varname>$::auth</varname> stellt Funktionen bereit um die
5477 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
5478 vom aktuellen User abhängen wird das Objekt aus
5479 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
5480 Request kurz resettet.</para>
5482 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten. Dessen Einstellungen können über
5483 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert ist ein Hash mit den Werten aus der Tabelle
5484 <literal>auth.clients</literal>.</para>
5488 <title>$::lx_office_conf</title>
5492 <para>Objekt der Klasse
5493 "<classname>SL::LxOfficeConf</classname>"</para>
5497 <para>Global gecached</para>
5501 <para>Repräsentation der
5502 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
5506 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
5507 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
5508 das Programm die Konfiguration ändern kann oder sollte.</para>
5510 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
5511 Debug- und Trace-Log-Datei wie folgt konfiguriert und
5514 <programlisting>[debug]
5515 file_name = /tmp/kivitendo-debug.log</programlisting>
5517 <para>ist der Key <varname>file</varname> im Programm als
5518 <varname>$::lx_office_conf->{debug}{file}</varname>
5522 <para>Zugriff auf die Konfiguration erfolgt im Moment über
5523 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
5528 <title>$::instance_conf</title>
5532 <para>Objekt der Klasse
5533 "<classname>SL::InstanceConfiguration</classname>"</para>
5537 <para>wird pro Request neu erstellt</para>
5541 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
5542 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
5543 ist hier eine Mandantendatenbank. Beispielsweise überprüft
5544 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
5545 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
5549 <title>$::dispatcher</title>
5553 <para>Objekt der Klasse
5554 "<varname>SL::Dispatcher</varname>"</para>
5558 <para>wird pro Serverprozess erstellt.</para>
5562 <para>enthält Informationen über die technische Verbindung zum
5567 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
5568 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
5569 Objekt untergebracht.</para>
5573 <title>$::request</title>
5577 <para>Hashref (evtl später Objekt)</para>
5581 <para>Wird pro Request neu initialisiert.</para>
5585 <para>Keine Unterstruktur garantiert.</para>
5589 <para><varname>$::request</varname> ist ein generischer Platz um
5590 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
5591 at a distance benutzt werden, sondern um lokales memoizing zu
5592 ermöglichen, das garantiert am Ende des Requests zerstört
5595 <para>Vieles von dem, was im moment in <varname>$::form</varname>
5596 liegt, sollte eigentlich hier liegen. Die groben
5597 Differentialkriterien sind:</para>
5601 <para>Kommt es vom User, und soll unverändert wieder an den
5602 User? Dann <varname>$::form</varname>, steht da eh schon</para>
5606 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
5607 Requests gebraucht werden? Dann
5608 <varname>$::request</varname></para>
5612 <para>Muss ich von anderen Teilen des Programms lesend drauf
5613 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
5614 Wrappermethode</para>
5621 <title>Ehemalige globale Variablen</title>
5623 <para>Die folgenden Variablen waren einmal im Programm, und wurden
5627 <title>$::cgi</title>
5631 <para>war nötig, weil cookie Methoden nicht als
5632 Klassenfunktionen funktionieren</para>
5636 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
5637 Klassennamespace gehalten wird und über Requestgrenzen
5642 <para>liegt jetzt unter
5643 <varname>$::request->{cgi}</varname></para>
5649 <title>$::all_units</title>
5653 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
5654 ein paar hundert mal pro Request eine Liste der Einheiten
5655 brauchen, und de als Parameter durch einen Riesenstack von
5656 Funktionen geschleift werden müssten.</para>
5660 <para>Liegt jetzt unter
5661 <varname>$::request->{cache}{all_units}</varname></para>
5666 <function>AM->retrieve_all_units()</function> gesetzt oder
5673 <title>%::called_subs</title>
5677 <para>wurde benutzt um callsub deep recursions
5682 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
5683 möglichen Rekursioenen darstellt, und da nie welche
5688 <para>komplette recursion protection wurde entfernt.</para>
5695 <sect1 id="devel.fcgi">
5696 <title>Entwicklung unter FastCGI</title>
5698 <sect2 id="devel.fcgi.general">
5699 <title>Allgemeines</title>
5701 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
5702 werden, muss der Webserver neu gestartet werden.</para>
5704 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
5705 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
5706 müssen folgende Aspekte beachtet werden.</para>
5709 <sect2 id="devel.fcgi.exiting">
5710 <title>Programmende und Ausnahmen</title>
5712 <para>Betrifft die Funktionen <function>warn</function>,
5713 <function>die</function>, <function>exit</function>,
5714 <function>carp</function> und <function>confess</function>.</para>
5716 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
5717 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
5718 am Laufen zu halten. Man kann mit <function>die</function>,
5719 <function>confess</function> oder <function>carp</function> Fehler
5720 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
5721 eigene <function>$::form-</function>error()> tut im Prinzip das
5722 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
5723 <function>exit</function> hingegen werden nicht abgefangen.
5724 <function>warn</function> wird direkt nach STDERR, also in Server Log
5725 eine Nachricht schreiben (sofern in der Konfiguration nicht die
5726 Warnungen in das kivitendo Log umgeleitet wurden), und
5727 <function>exit</function> wird die Ausführung beenden.</para>
5729 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
5730 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
5731 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
5732 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
5735 <sect2 id="devel.fcgi.globals">
5736 <title>Globale Variablen</title>
5738 <para>Um zu vermeiden, dass Informationen von einem Request in einen
5739 anderen gelangen, müssen alle globalen Variablen vor einem Request
5740 sauber initialisiert werden. Das ist besonders wichtig im
5741 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
5742 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
5745 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
5746 abgetrennten Block, der alle kanonischen globalen Variablen listet und
5747 erklärt. Bitte keine anderen einführen ohne das sauber zu
5748 dokumentieren.</para>
5750 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
5751 man sicher geht, dass man die richtige erwischt.</para>
5754 <sect2 id="devel.fcgi.performance">
5755 <title>Performance und Statistiken</title>
5757 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
5758 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
5759 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
5760 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
5761 sind es je nach Menge der definierten Variablen 1-2s. Ab der
5762 Moose/Rose::DB Version sind es 5-6s.</para>
5764 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
5765 den kritischen Pfaden, unter 0,15 sonst.</para>
5769 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
5770 <title>SQL-Upgradedateien</title>
5772 <sect2 id="db-upgrade-files.introduction"
5773 xreflabel="Einführung in die Datenbank-Upgradedateien">
5774 <title>Einführung</title>
5776 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte gesteuert, die sich im Verzeichnis <filename>sql/Pg-upgrade2</filename>
5777 befinden. In diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren, die neben den eigentlich auszuführenden SQL- oder
5778 Perl-Befehlen einige Kontrollinformationen enthält.</para>
5780 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten, sodass Datenbankscripte zwar in einer sicheren Reihenfolge
5781 ausgeführt werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt werden, wenn die Tabelle mit <literal>CREATE
5782 TABLE</literal> angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man keine Versionsnummern braucht.</para>
5784 <para>kivitendo merkt sich dabei, welches der Upgradescripte in <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
5785 führt diese nicht erneut aus. Dazu dient die Tabelle "<literal>schema_info</literal>", die bei der Anmeldung automatisch angelegt
5789 <sect2 id="db-upgrade-files.format"
5790 xreflabel="Format der Upgradedateien">
5791 <title>Format der Kontrollinformationen</title>
5793 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5794 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5795 hat dabei das folgende Format:</para>
5797 <para>Für SQL-Upgradedateien:</para>
5799 <programlisting>-- @key: value</programlisting>
5801 <para>Für Perl-Upgradedateien:</para>
5803 <programlisting># @key: value</programlisting>
5805 <para>Leerzeichen vor "<varname>value</varname>" werden
5808 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5812 <term><varname>tag</varname></term>
5815 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5816 Dieser "tag" kann von anderen Kontrolldateien in ihren
5817 Abhängigkeiten verwendet werden (Schlüsselwort
5818 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5819 in der Datenbank eingetragen wird.</para>
5821 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5822 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5824 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5825 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5826 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5832 <term><varname>charset</varname></term>
5835 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5836 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
5837 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte hingegen müssen immer in UTF-8 encodiert sein und sollten
5838 demnach auch ein "<literal>use utf8;</literal>" enthalten.</para>
5843 <term><varname>description</varname></term>
5846 <para>Benötigt. Eine Beschreibung, was in diesem Update
5847 passiert. Diese wird dem Benutzer beim eigentlichen
5848 Datenbankupdate angezeigt. Während der Tag in englisch gehalten
5849 sein sollte, sollte die Beschreibung auf Deutsch
5855 <term><varname>depends</varname></term>
5858 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5859 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
5860 dass die in dieser Liste aufgeführten Scripte bereits
5861 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5863 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5864 Script "b" existiert, das von Änderungen in "a" abhängt, und
5865 eine neue Kontrolldatei für "c" erstellt wird, die von
5866 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5867 Tag "b" als Abhängigkeit zu definieren.</para>
5869 <para>Es ist nicht erlaubt, sich selbst referenzierende
5870 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5871 und "c" -> "a").</para>
5876 <term><varname>priority</varname></term>
5879 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5880 der Scripte ausgeführt werden, die die gleichen
5881 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5882 der Wert 1000 benutzt.</para>
5884 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5885 "depends" benutzt werden. kivitendo sortiert die auszuführenden
5886 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5887 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5888 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5889 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5890 Priorität alphabetisch nach dem "tag".</para>
5895 <term><varname>ignore</varname></term>
5898 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
5899 Skript bei der Anmeldung ignoriert und entsprechend nicht
5906 <sect2 id="db-upgrade-files.format-perl-files" xreflabel="Format von Perl-Upgradedateien">
5907 <title>Format von in Perl geschriebenen Datenbankupgradescripten</title>
5909 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so ausgeführt sondern müssen sich an gewisse Konventionen
5910 halten. Dafür bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
5912 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse dar, die vom Elternobjekt
5913 "<literal>SL::DBUpgrade2::Base</literal>" erben und eine Funktion namens "<literal>run</literal>" zur Verfügung stellen muss. Das
5914 Script wird ausgeführt, indem eine Instanz dieser Klasse erzeugt und darauf die erwähnte "<literal>run</literal>" aufgerufen
5917 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert für "<literal>@tag</literal>" ableitet. Dabei werden alle
5918 Zeichen, die in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche ersetzt. Insgesamt sieht der Paketname wie folgt
5919 aus: "<literal>SL::DBUpgrade2::tag</literal>".</para>
5921 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
5922 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
5924 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie folgt aus:</para>
5926 <programlisting># @tag: beispiel-upgrade-file42
5927 # @description: Ein schönes Beispielscript
5928 # @depends: release_3_1_0
5929 package SL::DBUpgrade2::beispiel_upgrade_file42;
5934 use parent qw(SL::DBUpgrade2::Base);
5939 # hier Aktionen ausführen
5948 <sect2 id="db-upgrade-files.dbupgrade-tool"
5949 xreflabel="Hilfsscript dbupgrade2_tool.pl">
5950 <title>Hilfsscript dbupgrade2_tool.pl</title>
5952 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
5953 existiert ein Hilfsscript namens
5954 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
5955 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
5956 liest alle Datenbankupgradescripte aus dem Verzeichnis
5957 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
5958 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
5959 von der Kommandozeile überprüft werden können.</para>
5961 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
5962 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
5963 sich aber auch Informationen auf verschiedene Art ausgeben
5968 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
5969 --list</command>"</para>
5971 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
5972 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
5973 würde. Es werden neben der Listenposition der Tag, die
5974 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
5978 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
5979 --tree</command>"</para>
5981 <para>Listet alle Tags in Baumform basierend auf den
5982 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
5983 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
5984 beim übergeordneten Script als Abhängigkeit eingetragen
5988 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
5989 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
5990 --rtree</command>"</para>
5992 <para>Listet alle Tags in Baumform basierend auf den
5993 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
5994 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
5995 die das übergeordnete Script als Abhängigkeit eingetragen
6000 <para>Baumform mit Postscriptausgabe:
6001 "<command>./scripts/dbupgrade2_tool.pl
6002 --graphviz</command>"</para>
6004 <para>Benötigt das Tool "<command>graphviz</command>", um mit
6005 seiner Hilfe die <link
6006 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
6007 Baumform</link> in eine Postscriptdatei namens
6008 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
6009 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
6010 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
6011 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
6016 <para>Scripte, von denen kein anderes Script abhängt:
6017 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
6019 <para>Listet die Tags aller Scripte auf, von denen keine anderen
6020 Scripte abhängen.</para>
6026 <sect1 id="translations-languages" xreflabel="Translations and languages">
6027 <title>Translations and languages</title>
6029 <sect2 id="translations-languages.introduction"
6030 xreflabel="Introduction to translations and languages">
6031 <title>Introduction</title>
6034 <para>Dieser Abschnitt ist in Englisch geschrieben, um
6035 internationalen Übersetzern die Arbeit zu erleichtern.</para>
6038 <para>This section describes how localization packages in kivitendo
6039 are built. Currently the only language fully supported is German, and
6040 since most of the internal messages are held in English the English
6041 version is usable too.</para>
6043 <para>A stub version of French is included but not functunal at this
6047 <sect2 id="translations-languages.character-set"
6048 xreflabel="Character set">
6049 <title>Character set</title>
6051 <para>All files included in a language pack must use UTF-8 as their encoding.</para>
6054 <sect2 id="translations-languages.file-structure"
6055 xreflabel="File structure">
6056 <title>File structure</title>
6058 <para>The structure of locales in kivitendo is:</para>
6060 <programlisting>kivitendo/locale/<langcode>/</programlisting>
6062 <para>where <langcode> stands for an abbreviation of the
6063 language package. The builtin packages use two letter <ulink
6064 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
6065 but the actual name is not relevant for the program and can easily be
6067 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
6068 tags</ulink> (i.e. "en_GB"). In fact the original language packages
6069 from SQL Ledger are named in this way.</para>
6071 <para>In such a language directory the following files are
6076 <term>LANGUAGE</term>
6079 <para>This file is mandatory.</para>
6081 <para>The <filename>LANGUAGE</filename> file contains the self
6082 descripted name of the language. It should contain a native
6083 representation first, and in parenthesis an english translation
6084 after that. Example:</para>
6086 <programlisting>Deutsch (German)</programlisting>
6094 <para>This file is mandatory.</para>
6096 <para>The central translation file. It is essentially an inline
6097 Perl script autogenerated by <command>locales.pl</command>. To
6098 generate it, generate the directory and the two files mentioned
6099 above, and execute the following command:</para>
6101 <programlisting>scripts/locales.pl <langcode></programlisting>
6103 <para>Otherwise you can simply copy one of the other languages.
6104 You will be told how many are missing like this:</para>
6106 <programlisting>$ scripts/locales.pl en
6107 English - 0.6% - 2015/2028 missing</programlisting>
6109 <para>A file named "<filename>missing</filename>" will be
6110 generated and can be edited. You can also edit the
6111 "<filename>all</filename>" file directly. Edit everything you
6112 like to fit the target language and execute
6113 <command>locales.pl</command> again. See how the missing words
6119 <term>Num2text</term>
6122 <para>Legacy code from SQL Ledger. It provides a means for
6123 numbers to be converted into natural language, like
6124 <literal>1523 => one thousand five hundred twenty
6125 three</literal>. If you want to provide it, it must be inlinable
6126 Perl code which provides a <function>num2text</function> sub. If
6127 an <function>init</function> sub exists it will be executed
6130 <para>Only used in the check and receipt printing module.</para>
6135 <term>special_chars</term>
6138 <para>kivitendo comes with a lot of interfaces to different
6139 formats, some of which are rather picky with their accepted
6140 charset. The <filename>special_chars</filename> file contains a
6141 listing of chars not suited for different file format and
6142 provides substitutions. It is written in "Simple Ini" style,
6143 containing a block for every file format.</para>
6145 <para>First entry should be the order of substitution for
6146 entries as a whitespace separated list. All entries are
6147 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
6148 and <literal>\\</literal> all work.</para>
6150 <para>After that every entry is a special char that should be
6151 translated when writing text into such a file.</para>
6153 <para>Example:</para>
6155 <programlisting>[Template/XML]
6156 order=& < > \n
6160 \n=<br></programlisting>
6162 <para>Note the importance of the order in this example.
6163 Substituting < and > befor & would lead to $gt; become
6166 <para>For a list of valid formats, see the German
6167 <filename>special_chars</filename> entry. As of this writing the
6168 following are recognized:</para>
6170 <programlisting>HTML
6175 Template/OpenDocument
6176 filenames</programlisting>
6178 <para>The last of which is very machine dependant. Remember that
6179 a lot of characters are forbidden by some filesystems, for
6180 exmaple MS Windows doesn't like ':' in its files where Linux
6181 doesn't mind that. If you want the files created with your
6182 language pack to be portable, find all chars that could cause
6188 <term>missing</term>
6191 <para>This file is not a part of the language package
6194 <para>This is a file generated by
6195 <command>scripts/locales.pl</command> while processing your
6196 locales. It's only to have the missing entries singled out and
6197 does not belong to a language package.</para>
6205 <para>This file is not a part of the language package
6208 <para>Another file generated by
6209 <command>scripts/locales.pl</command>. If for any reason a
6210 translation does not appear anymore and can be deleted, it gets
6211 moved here. The last 50 or so entries deleted are saved here in
6212 case you made a typo, so that you don't have to translate
6213 everything again. If a tranlsation is missing, the lost file is
6214 checked first. If you maintain a language package, you might
6215 want to keep this safe somewhere.</para>
6222 <sect1 id="devel.testsuite">
6223 <title>Die kivitendo-Test-Suite</title>
6225 <sect2 id="devel.testsuite.intro">
6226 <title>Einführung</title>
6228 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul <literal>Test::More</literal>.</para>
6230 <para>Die grundlegenden Fakten sind:</para>
6233 <listitem><para>Alle Tests liegen im Unterverzeichnis <filename>t/</filename>.</para></listitem>
6235 <listitem><para>Ein Script (bzw. ein Test) in <filename>t/</filename> enthält einen oder mehrere Testfälle.</para></listitem>
6237 <listitem><para>Alle Dateinamen von Tests enden auf <literal>.t</literal>. Es sind selbstständig ausführbare Perl-Scripte.</para></listitem>
6239 <listitem><para>Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in <filename>t/</filename>, deren
6240 Dateiname auf <literal>.t</literal> endet.</para></listitem>
6244 <sect2 id="devel.testsuite.prerequisites">
6245 <title>Voraussetzungen</title>
6247 <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>
6250 <listitem><para><literal>Test::Deep</literal> (Debian-Paketname: <literal>libtest-deep-perl</literal>; Fedora Core:
6251 <literal>perl-Test-Deep</literal>; openSUSE: <literal>perl-Test-Deep</literal>)</para></listitem>
6252 <listitem><para><literal>Test::Exception</literal> (Debian-Paketname: <literal>libtest-exception-perl</literal>; Fedora Core:
6253 <literal>perl-Test-Exception</literal>; openSUSE: <literal>perl-Test-Exception</literal>)</para></listitem>
6254 <listitem><para><literal>Test::Output</literal> (Debian-Paketname: <literal>libtest-output-perl</literal>; Fedora Core:
6255 <literal>perl-Test-Output</literal>; openSUSE: <literal>perl-Test-Output</literal>)</para></listitem>
6256 <listitem><para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses Modul ist ab Perl 5.10.1 Bestandteil der
6257 Perl-Distribution und kann für frühere Versionen aus dem <ulink url="http://www.cpan.org">CPAN</ulink> bezogen
6258 werden.</para></listitem>
6259 <listitem><para><literal>LWP::Simple</literal> aus dem Paket <literal>libwww-perl</literal> (Debian-Panetname:
6260 <literal>libwww-perl</literal>; Fedora Core: <literal>perl-libwww-perl</literal>; openSUSE:
6261 <literal>perl-libwww-perl</literal>)</para></listitem>
6262 <listitem><para><literal>URI::Find</literal> (Debian-Panetname: <literal>liburi-find-perl</literal>; Fedora Core:
6263 <literal>perl-URI-Find</literal>; openSUSE: <literal>perl-URI-Find</literal>)</para></listitem>
6266 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
6267 müssen in der Konfigurationsdatei im Abschnit <literal>testing/database</literal> Datenbankverbindungsparameter angegeben
6268 werden. Der hier angegebene Benutzer muss weiterhin das Recht haben, Datenbanken anzulegen und zu löschen.</para>
6271 <sect2 id="devel.testsuite.execution">
6273 Existierende Tests ausführen
6276 <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
6277 gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript <filename>t/test.pl</filename>.</para>
6279 <para>Will man die komplette Test-Suite ausführen, so muss man einfach nur <filename>t/test.pl</filename> ohne weitere Parameter aus
6280 dem kivitendo-Basisverzeichnis heraus ausführen.</para>
6282 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an <filename>t/test.pl</filename>. Beispielsweise:</para>
6284 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
6288 <sect2 id="devel.testsuite.meaning_of_scripts">
6290 Bedeutung der verschiedenen Test-Scripte
6293 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch
6294 während der Entwicklung nützliche Tests sind:</para>
6297 <listitem><para><filename>t/001compile.t</filename> -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab</para></listitem>
6298 <listitem><para><filename>t/002goodperl.t</filename> -- überprüft alle Perl-Dateien auf Anwesenheit von '<literal>use strict</literal>'-Anweisungen</para></listitem>
6299 <listitem><para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von <function>system()</function> und <function>exec()</function> auf Gültigkeit</para></listitem>
6300 <listitem><para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien Tab-Zeichen enthalten</para></listitem>
6301 <listitem><para><filename>t/006spelling.t</filename> -- sucht nach häufigen Rechtschreibfehlern</para></listitem>
6302 <listitem><para><filename>t/011pod.t</filename> -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit</para></listitem>
6305 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module.</para>
6308 <sect2 id="devel.testsuite.create_new">
6310 Neue Test-Scripte erstellen
6313 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende
6314 Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden.</para>
6316 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
6318 Ideen für neue Test-Scripte, die keine konkreten Funktionen testen
6321 <para> Ideen, die abgesehen von Funktionen noch nicht umgesetzt wurden:</para>
6324 <listitem><para>Überprüfung auf fehlende symbolische Links</para></listitem>
6325 <listitem><para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten)</para></listitem>
6326 <listitem><para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para></listitem>
6327 <listitem><para>Überprüfung auf Leerzeichen am Ende von Zeilen</para></listitem>
6328 <listitem><para>Test, ob alle zu übersetzenden Strings in <filename>locale/de/all</filename> vorhanden sind</para></listitem>
6329 <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>
6333 <sect3 id="devel.testsuite.directory_and_test_names">
6335 Konvention für Verzeichnis- und Dateinamen
6338 <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>
6341 <listitem><para>Die Dateiendung muss <filename>.t</filename> lauten.</para></listitem>
6343 <listitem><para>Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise
6344 <filename>bad_function_params.t</filename>).</para></listitem>
6346 <listitem><para>Unterverzeichnisse sollten grob nach dem Themenbereich benannt sein, mit dem sich die Scripte darin befassen
6347 (beispielsweise <filename>background_jobs</filename> für Tests rund um Hintergrund-Jobs).</para></listitem>
6349 <listitem><para>Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist
6350 (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben.</para></listitem>
6354 <sect3 id="devel.testsuite.minimal_example">
6356 Minimales Skelett für eigene Scripte
6359 <para>Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden:</para>
6361 <programlisting>use Test::More tests => 0;
6365 use Support::TestSetup;
6367 Support::TestSetup::login();</programlisting>
6369 <para>Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie
6370 <varname>$::auth</varname>, <varname>$::form</varname> oder <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
6371 <filename>config/kivitendo.conf</filename> im Abschnitt <literal>testing.login</literal> ein gültiger Login-Name eingetragen
6372 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
6374 <para>Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile <code>Support::TestSetup::login();</code>
6375 weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.</para>
6380 <sect1 id="devel.style-guide">
6381 <title>Stil-Richtlinien</title>
6383 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
6384 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
6385 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
6386 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
6388 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
6391 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
6392 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
6397 <para>Es werden keine echten Tabs sondern Leerzeichen
6402 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
6404 <programlisting>foreach my $row (@data) {
6406 # do something with $row
6410 $row->{modules} = MODULE->retrieve(
6411 id => $row->{id},
6412 date => $use_now ? localtime() : $row->{time},
6416 $report->add($row);
6421 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
6422 Zeile wie der letzte Befehl. Beispiele:</para>
6424 <programlisting>sub debug {
6430 <programlisting>if ($form->{item_rows} > 0) {
6436 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
6437 der Befehl / die öffnende schließende Klammer, die den Block
6438 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
6439 Beispiele wie bei 3. gelten.</para>
6443 <para>Die Wörter "<function>else</function>",
6444 "<function>elsif</function>", "<function>while</function>" befinden
6445 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
6448 <programlisting>if ($form->{sum} > 1000) {
6450 } elsif ($form->{sum} > 0) {
6458 } until ($a > 0);</programlisting>
6462 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
6463 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
6464 und grep-ähnliche Operatoren. Beispiel:</para>
6466 <programlisting>$main::lxdebug->message("Could not find file.");
6467 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
6471 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
6473 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
6474 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
6475 Blöcke schon. Beispiel:</para>
6477 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
6482 $form->{sum} += $form->{"row_$i"};
6483 $form->{ $form->{index} } += 1;
6485 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
6489 <para>Mehrzeilige Befehle</para>
6493 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
6494 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
6495 werden, in der die ersten Funktionsparameter in der ersten Zeile
6496 stehen. Beispiel:</para>
6498 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
6499 $form->{some_col_value});</programlisting>
6503 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
6504 besten in einer übersichtlichen Tabellenstruktur organisiert
6505 wird. Beispiel:</para>
6507 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
6508 : $form->{oldcount} ? $form->{oldcount} + 1
6509 : $form->{rowcount} - $form->{rowbase};</programlisting>
6515 <para>Kommentare</para>
6519 <para>Kommentare, die alleine in einer Zeile stehen, sollten
6520 soweit wie der Code eingerückt sein.</para>
6524 <para>Seitliche hängende Kommentare sollten einheitlich
6525 formatiert werden.</para>
6529 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
6530 auf Englisch zu verfassen. So wie ich keine Lust habe,
6531 französischen Quelltext zu lesen, sollte auch der kivitendo
6532 Quelltext für nicht-Deutschsprachige lesbar sein.
6535 <programlisting>my $found = 0;
6543 $i = 0 # initialize $i
6545 $i *= $const; # do something crazy
6546 $i = $n; # recover $i</programlisting>
6552 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
6553 Interpolation gewünscht ist. Beispiel:</para>
6555 <programlisting>$form->{sum} = 0;
6556 $form->{"row_$i"} = $form->{"row_$i"} - 5;
6557 $some_hash{42} = 54;</programlisting>
6561 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
6562 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
6563 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
6564 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
6566 <para>Als Beispiel sei die Funktion
6567 <function>print_options</function> aus
6568 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
6572 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
6573 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
6576 <para>Emacs und vim haben beide recht einfache Methoden zur
6577 Entfernung von trailing whitespace. Emacs kennt das Kommande
6578 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
6579 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
6580 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
6585 <para>Es wird kein <command>perltidy</command> verwendet.</para>
6587 <para>In der Vergangenheit wurde versucht,
6588 <command>perltidy</command> zu verwenden, um einen einheitlichen
6589 Stil zu erlangen. Es hat sich aber gezeigt, dass
6590 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
6591 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
6592 den Interessierten sind hier die
6593 <command>perltidy</command>-Optionen, die grob den beschriebenen
6594 Richtlinien entsprechen:</para>
6596 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
6597 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
6598 -lp -vt=1 -vtc=1</programlisting>
6602 <para><varname>STDERR</varname> ist tabu. Unkonditionale
6603 Debugmeldungen auch.</para>
6605 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
6606 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
6607 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
6609 <para>Die <classname>LXDebug</classname>-Methode
6610 "<function>message</function>" nimmt als ersten Paramter außerdem
6611 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
6612 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
6613 und werden in den meisten Fällen auch vom Repository
6614 zurückgewiesen.</para>
6618 <para>Alle neuen Module müssen use strict verwenden.</para>
6620 <para><varname>$form</varname>, <varname>$auth</varname>,
6621 <varname>$locale</varname>, <varname>$lxdebug</varname> und
6622 <varname>%myconfig</varname> werden derzeit aus dem main package
6623 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
6624 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
6629 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
6630 <title>Dokumentation erstellen</title>
6632 <sect2 id="devel.build-doc.introduction">
6633 <title>Einführung</title>
6635 <para>Diese Dokumentation ist in <productname>DocBook</productname>
6636 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
6637 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
6638 Editor nutzt, der spezielle Unterstützung für
6639 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
6640 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
6641 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
6645 <sect2 id="devel.build-doc.required-software">
6646 <title>Benötigte Software</title>
6648 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
6649 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
6650 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
6651 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
6652 <command>scripts/build_doc.sh</command>.</para>
6654 <para>Das Script benötigt zur Konvertierung verschiedene
6655 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
6661 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
6662 in einer halbwegs aktuellen Version</para>
6666 <para>Das Java-Build-System <ulink
6667 url="http://ant.apache.org/">Apache Ant</ulink></para>
6671 <para>Das Dokumentations-System Dobudish für
6672 <productname>DocBook</productname> 4.5, eine Zusammenstellung
6673 diverser Stylesheets und Grafiken zur Konvertierung von
6674 <productname>DocBook</productname> XML in andere Formate. Das
6675 Paket, das benötigt wird, ist zum Zeitpunkt der
6676 Dokumentationserstellung
6677 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
6678 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
6683 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
6684 sind auf allen gängigen Plattformen verfügbar. Beispiel für
6685 Debian/Ubuntu:</para>
6687 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
6689 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
6690 <filename>doc/build</filename> entpackt werden. Beispiel unter der
6691 Annahme, das <productname>Dobudish</productname> in
6692 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
6694 <programlisting>cd doc/build
6695 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
6698 <sect2 id="devel.build-doc.build">
6699 <title>PDFs und HTML-Seiten erstellen</title>
6701 <para>Die eigentliche Konvertierung erfolgt nach Installation der
6702 benötigten Software mit einem einfachen Aufruf direkt aus dem
6703 kivitendo-Installationsverzeichnis heraus:</para>
6705 <programlisting>./scripts/build_doc.sh</programlisting>
6708 <sect2 id="devel.build-doc.repository">
6709 <title>Einchecken in das Git-Repository</title>
6711 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
6712 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
6713 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
6714 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
6716 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
6717 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob