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>
274 <para>Die kivitendo ERP Installationsdatei (<filename>kivitendo-erp-3.1.0.tgz</filename>) wird im Dokumentenverzeichnis des Webservers
275 (z.B. <filename>/var/www/html/</filename>, <filename>/srv/www/htdocs</filename> oder <filename>/var/www/</filename>) entpackt:</para>
277 <programlisting>cd /var/www
278 tar xvzf kivitendo-erp-3.1.0.tgz</programlisting>
280 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
282 <programlisting>cd kivitendo-erp</programlisting>
284 <para>Alternativ können Sie auch einen Alias in der
285 Webserverkonfiguration benutzen, um auf das tatsächliche
286 Installationsverzeichnis zu verweisen.</para>
288 <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
289 beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
290 Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
291 core <constant>apache</constant> oder bei OpenSUSE <constant>wwwrun</constant>).</para>
293 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
294 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
296 <programlisting>chown -R www-data users spool webdav</programlisting>
298 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
299 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>
301 <programlisting>chown www-data templates users</programlisting>
304 <sect1 id="config.config-file">
305 <title>kivitendo-Konfigurationsdatei</title>
307 <sect2 id="config.config-file.introduction"
308 xreflabel="Einführung in die Konfigurationsdatei">
309 <title>Einführung</title>
311 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei,
312 die benötigt wird: <filename>config/kivitendo.conf</filename> (kurz:
313 "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
314 von kivitendo bzw. der Migration von älteren Versionen angelegt
317 <para>Als Vorlage dient die Datei
318 <filename>config/kivitendo.conf.default</filename> (kurz: "die
319 Default-Datei"):</para>
321 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
323 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
324 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
325 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
326 Abschnitte und Werte enthalten, die von denen der Default-Datei
331 Vor der Umbenennung in kivitendo hieß diese Datei noch <filename>config/lx_office.conf</filename>. Aus Gründen der Kompatibilität
332 wird diese Datei eingelesen, sofern die Datei <filename>config/kivitendo.conf</filename> nicht existiert.
336 <para>Diese Hauptkonfigurationsdatei ist dann eine
337 installationsspezifische Datei, d.h. sie enthält bspw. lokale
338 Passwörter und wird auch nicht im Versionsmanagement (git)
341 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
342 Mandaten, bzw. Datenbanken gleich.</para>
345 <sect2 id="config.config-file.sections-parameters">
346 <title>Abschnitte und Parameter</title>
348 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
349 entsprechend kommentiert sind:</para>
352 <listitem><para><literal>authentication</literal> (siehe Abschnitt "<xref
353 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>" in diesem Kapitel)</para></listitem>
355 <listitem><para><literal>authentication/database</literal></para></listitem>
357 <listitem><para><literal>authentication/ldap</literal></para></listitem>
359 <listitem><para><literal>system</literal></para></listitem>
361 <listitem><para><literal>paths</literal></para></listitem>
363 <listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>
365 <listitem><para><literal>applications</literal></para></listitem>
367 <listitem><para><literal>environment</literal></para></listitem>
370 <listitem><para><literal>print_templates</literal></para></listitem>
372 <listitem><para><literal>task_server</literal></para></listitem>
374 <listitem><para><literal>periodic_invoices</literal></para></listitem>
376 <listitem><para><literal>self_tests</literal></para></listitem>
378 <listitem><para><literal>console</literal></para></listitem>
380 <listitem><para><literal>testing</literal></para></listitem>
382 <listitem><para><literal>testing/database</literal></para></listitem>
384 <listitem><para><literal>debug</literal></para></listitem>
387 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
388 einzustellen oder zu kontrollieren sind, sind:</para>
390 <programlisting>[authentication]
391 admin_password = geheim
393 [authentication/database]
398 password =</programlisting>
400 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
401 <varname>[periodic_invoices]</varname> den Login eines Benutzers
402 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
403 mit Informationen über die erstellten Rechnungen bekommt.</para>
405 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten Ausführung bestimmter Aufgaben mit, den <link
406 linkend="config.task-server">Taskserver</link>. Er wird u.a. für Features wie die <link
407 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link> benötigt, erledigt aber auch andere erforderliche Aufgaben
408 und muss daher in Betrieb genommen werden. Der Taskserver benötigt zwei Konfigurationseinstellungen, die unter
409 <varname>[task_server]</varname> anzugeben sind: ein Mandant (entweder der Mandantenname oder eine Datenbank-ID, Variable
410 <varname>client</varname>), aus dem die Datenbankkonfiguration entnommen wird, sowie ein Login (Variable <varname>login</varname>)
411 eines Benutzers, der für gewisse Dinge wie die Rechnungserstellung als Verkäufer eingetragen wird.</para>
413 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
414 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
417 <sect2 id="config.config-file.prior-versions">
418 <title>Versionen vor 2.6.3</title>
420 <para>In älteren kivitendo Versionen gab es im Verzeichnis
421 <filename>config</filename> die Dateien
422 <filename>authentication.pl</filename> und
423 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
424 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
425 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
426 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
428 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
429 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
430 manuell übertragen und die alten Konfigurationsdateien anschließend
431 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
432 entsprechende Fehlermeldung an.</para>
436 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
437 <title>Anpassung der PostgreSQL-Konfiguration</title>
439 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
441 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
442 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
444 <para>kivitendo setzt zwingend voraus, dass die Datenbank Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen Serverinstallationen
445 braucht man hier meist nicht einzugreifen.</para>
447 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so
448 braucht man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
450 <programlisting>su postgres
452 exit </programlisting>
454 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
455 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
456 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
459 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
461 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
462 Versionsnummer angepasst werden.</para>
464 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
466 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
467 <literal>\l</literal> geprüft werden.</para>
470 <sect2 id="Änderungen-an-Konfigurationsdateien">
471 <title>Änderungen an Konfigurationsdateien</title>
473 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
474 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
475 <filename>/var/lib/pgsql/data/</filename> oder
476 <filename>/etc/postgresql/</filename>, muss sichergestellt werden,
477 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
478 Parameter <varname>listen_address</varname> gesteuert. Laufen
479 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
480 <literal>localhost</literal> verwendet werden. Andernfalls müssen
481 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
482 was mit dem Wert <literal>*</literal> geschieht.</para>
484 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
485 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
486 sein sollte, müssen die Berichtigungen für den Zugriff geändert
487 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
488 nögiten Verbindungen immer zuzulassen, für eine lokal laufenden
489 Datenbank zum Beispiel:</para>
491 <programlisting>local all kivitendo password
492 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
495 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
496 <title>Erweiterung für servergespeicherte Prozeduren</title>
498 <para>In der Datenbank <literal>template1</literal> muss die
499 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
500 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
501 <programlisting>su - postgres
502 psql template1</programlisting>
504 führen Sie die folgenden Kommandos aus:</para>
506 <programlisting>create language 'plpgsql';
510 <sect2 id="Datenbankbenutzer-anlegen">
511 <title>Datenbankbenutzer anlegen</title>
513 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
514 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
515 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
518 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit nein
519 beantworten, genauso ist die Berechtigung neue User (Roles) zu
520 generieren nicht nötig.</para>
521 <programlisting>su - postgres
522 createuser -d -P kivitendo
523 exit</programlisting>
525 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
526 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.
527 den hier gewählten Benutzernamen.</para>
531 <sect1 id="Apache-Konfiguration">
532 <title>Webserver-Konfiguration</title>
535 <title>Grundkonfiguration mittels CGI</title>
538 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
539 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
540 <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
543 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
544 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
545 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
546 anderen Datei hinzu, die beim Starten des Webservers eingelesen
549 <programlisting>AddHandler cgi-script .pl
550 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
552 <Directory /var/www/kivitendo-erp>
553 Options ExecCGI Includes FollowSymlinks
556 <Directory /var/www/kivitendo-erp/users>
559 </Directory></programlisting>
561 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
562 das kivitendo-Archiv entpacket haben.</para>
565 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
566 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
569 <para>Auf einigen Webservern werden manchmal die Grafiken und
570 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
571 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
573 <programlisting>EnableSendfile Off</programlisting>
576 <sect2 id="Apache-Konfiguration.FCGI"
577 xreflabel="Konfiguration für FastCGI/FCGI">
578 <title>Konfiguration für FastCGI/FCGI</title>
580 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
581 <title>Was ist FastCGI?</title>
583 <para>Direkt aus <ulink
584 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
587 <para><citation> FastCGI ist ein Standard für die Einbindung
588 externer Software zur Generierung dynamischer Webseiten in einem
589 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
590 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
591 umgehen. </citation></para>
594 <sect3 id="Apache-Konfiguration.FCGI.Warum">
595 <title>Warum FastCGI?</title>
597 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
598 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
599 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
600 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
601 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
602 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
603 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
604 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
605 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
606 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
607 deutlich länger dauert als früher, und dass davon 90% für das Laden
608 der Module verwendet wird.</para>
610 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
611 wird nur die eigentliche Programmlogik ausgeführt.</para>
614 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
615 <title>Getestete Kombinationen aus Webservern und Plugin</title>
617 <para>Folgende Kombinationen sind getestet:</para>
621 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
625 <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
629 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
630 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
631 mod_fastcgi nicht mehr explizit eingegangen.</para>
633 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
637 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern
638 bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrere Installation gibt, muss zwingend Version 0.68 oder
639 aber Version 0.72 und neuer eingesetzt werden.</para>
641 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie sich die Vorgängerversion wie folgt
644 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
648 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
649 <title>Konfiguration des Webservers</title>
651 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
652 laufen zu lassen, empfliehlt es sich die Installation ersteinmal
653 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
654 debuggen die beim ersten aufsetzen auftreten können. Sollte die
655 Installation schon funktionieren, lesen Sie weiter.</para>
657 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
658 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
660 <programlisting>a2enmod fcgid</programlisting>
662 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
663 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
664 und <function>Directory</function>-Direktiven. Dabei wird zwischen
665 dem Installationspfad von kivitendo im Dateisystem
666 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
667 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
668 ("<filename>/url/for/kivitendo-erp</filename>").</para>
670 <para>Folgender Konfigurationsschnipsel funktioniert mit
673 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
674 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
676 <Directory /path/to/kivitendo-erp>
678 Options ExecCGI Includes FollowSymlinks
683 <DirectoryMatch /path/to/kivitendo-erp/users>
686 </DirectoryMatch></programlisting>
688 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
689 die maximale Größe eines Requests. Diese sollte wie folgt
690 hochgesetzt werden:</para>
692 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
694 <para>Das ganze sollte dann so aussehen:</para>
696 <programlisting>AddHandler fcgid-script .fpl
697 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
698 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
699 FcgidMaxRequestLen 10485760
701 <Directory /path/to/kivitendo-erp>
703 Options ExecCGI Includes FollowSymlinks
708 <DirectoryMatch /path/to/kivitendo-erp/users>
711 </DirectoryMatch></programlisting>
713 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
714 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
715 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
716 gibt es hier kleine Performance-Einbußen.</para>
718 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
719 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
720 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
722 <programlisting># Zugriff über CGI
723 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
725 # Zugriff mit mod_fcgid:
726 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
727 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
729 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
730 die normale Version erreichbar, und unter
731 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
732 FastCGI-Version.</para>
737 <sect1 id="config.task-server">
738 <title>Der Task-Server</title>
740 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und
741 diese zu festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess wird u.a. für die Erzeugung der wiederkehrenden
742 Rechnungen und weitere essenzielle Aufgaben benutzt.</para>
744 <sect2 id="Konfiguration-des-Task-Servers">
745 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
747 <para>Die Konfiguration erfolgt über den Abschnitt
748 <literal>[task_server]</literal> in der Datei
749 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
750 Optionen sind:</para>
754 <term><varname>client</varname></term>
757 <para>Name oder Datenbank-ID eines vorhandenen kivitendo-Mandanten, der benutzt wird, um die zu verwendende
758 Datenbankverbindung auszulesen. Der Mandant muss in der Administration angelegt werden. Diese Option muss angegeben
761 <para>Diese Option kam mit Release v3.x.0 hinzu und muss daher in Konfigurationen, die von älteren Versionen aktualisiert
762 wurden, ergänzt werden.</para>
767 <term><varname>login</varname></term>
770 <para>gültiger kivitendo-Benutzername, der z.B. als Verkäufer beim Erzeugen wiederkehrender Rechnungen benötigt wird. Der
771 Benutzer muss in der Administration angelegt werden. Diese Option muss angegeben werden.</para>
776 <term><varname>run_as</varname></term>
779 <para>Wird der Server vom Systembenutzer <literal>root</literal>
780 gestartet, so wechselt er auf den mit <literal>run_as</literal>
781 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
782 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
784 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
785 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
786 unter dem auch der Webserver läuft.</para>
791 <term><varname>debug</varname></term>
794 <para>Schaltet Debug-Informationen an und aus.</para>
800 <sect2 id="Einbinden-in-den-Boot-Prozess">
801 <title>Automatisches Starten des Task-Servers beim Booten</title>
803 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
804 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
805 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
807 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
808 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
809 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
810 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
811 anstelle eines symbolischen Links verwendet werden können.</para>
814 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, ältere Fedora Core)</title>
816 <para>Kopieren Sie die Datei
817 <filename>scripts/boot/system-v/kivitendo-server</filename>
818 nach <filename>/etc/init.d/kivitendo-server</filename>. Passen
819 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
820 <literal>DAEMON=....</literal>). Binden Sie das Script in den
821 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
825 <para>Debian-basierende Systeme:</para>
827 <programlisting>update-rc.d kivitendo-task-server defaults
828 # Nur bei Debian Squeeze und neuer:
829 insserv kivitendo-task-server</programlisting>
833 <para>Ältere OpenSUSE und ältere Fedora Core:</para>
835 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
839 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
842 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
846 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
848 <para>Kopieren Sie die Datei
849 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
850 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
851 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
852 <literal>exec ....</literal>).</para>
854 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
857 <programlisting>service kivitendo-task-server start</programlisting>
861 <title>systemd-basierende Systeme (z.B. neure OpenSUSE, neuere Fedora Core)</title>
863 <para>Verlinken Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
864 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
865 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>). Binden Sie das Script in den Boot-Prozess ein.
868 <para>Alle hierzu benötigten Befehle sehen so aus:</para>
870 <programlisting>cd /var/www/kivitendo-erp/scripts/boot/systemd
871 ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
873 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
876 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
880 <sect2 id="Prozesskontrolle">
881 <title>Wie der Task-Server gestartet und beendet wird</title>
883 <para>Der Task-Server wird wie folgt kontrolliert:</para>
885 <programlisting>./scripts/task_server.pl Befehl</programlisting>
887 <para><literal>Befehl</literal> ist dabei eine der folgenden
892 <para><literal>start</literal> startet eine neue Instanz des
893 Task-Servers. Die Prozess-ID wird innerhalb des
894 <filename>users</filename>-Verzeichnisses abgelegt.</para>
898 <para><literal>stop</literal> beendet einen laufenden
903 <para><literal>restart</literal> beendet und startet ihn
908 <para><literal>status</literal> berichtet, ob der Task-Server
913 <para>Der Task-Server wechselt beim Starten automatisch in das
914 kivitendo-Installationsverzeichnis.</para>
916 <para>Dieselben Optionen können auch für die SystemV-basierenden
917 Runlevel-Scripte benutzt werden (siehe oben).</para>
919 <sect2 id="Prozesskontrolle2">
920 <title>Task-Server mit mehreren Mandanten</title>
922 <para>Beim Task-Server werden der zu verwendende Mandant und Login-Name des Benutzers, unter dem der Task-Server laufen soll, in die
923 Konfigurationsdatei geschrieben. Hat man mehrere Mandanten, muss man auch mehrere Konfigurationsdateien anlegen.</para>
925 <para>Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf, wo in der Kategorie <varname>[task_server]</varname> die
926 gewünschten Werte für <varname>client</varname> und <varname>login</varname> eingetragen werden.</para>
928 <para>Der alternative Task-Server wird dann mit folgendem Befehl
931 <programlisting>./scripts/task_server.pl -c config/DATEINAME.conf</programlisting>
935 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
936 <title>Benutzerauthentifizierung und Administratorpasswort</title>
938 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
939 über die Verwaltung von Gruppen und weitere Einstellungen</para>
941 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
942 <title>Grundlagen zur Benutzerauthentifizierung</title>
944 <para>kivitendo verwaltet die Benutzerinformationen in einer
945 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
946 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
947 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
948 können, müssen aber nicht unterschiedlich sein.</para>
950 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
951 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
952 abgelegt werden.</para>
954 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
955 entweder gegen die Authentifizierungsdatenbank oder gegen einen
956 LDAP-Server überprüft werden.</para>
958 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
959 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
960 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
961 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
962 einer Version vor v2.6.0 angelegt werden. Eine
963 Beispielkonfigurationsdatei
964 <filename>config/kivitendo.conf.default</filename> existiert, die als
965 Vorlage benutzt werden kann.</para>
968 <sect2 id="Administratorpasswort">
969 <title>Administratorpasswort</title>
971 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
972 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
973 nur dort und nicht mehr im Administrationsinterface selber geändert
974 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
975 Abschnitt <varname>[authentication]</varname>.</para>
978 <sect2 id="Authentifizierungsdatenbank">
979 <title>Authentifizierungsdatenbank</title>
981 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
982 Parametern in <varname>[authentication/database]</varname>
983 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
987 <term><literal>host</literal></term>
990 <para>Der Rechnername oder die IP-Adresse des
991 Datenbankservers</para>
996 <term><literal>port</literal></term>
999 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1004 <term><literal>db</literal></term>
1007 <para>Der Name der Authentifizierungsdatenbank</para>
1012 <term><literal>user</literal></term>
1015 <para>Der Benutzername, mit dem sich kivitendo beim
1016 Datenbankserver anmeldet (z.B.
1017 "<literal>postgres</literal>")</para>
1022 <term><literal>password</literal></term>
1025 <para>Das Passwort für den Datenbankbenutzer</para>
1030 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1031 automatisch anlegen (mehr dazu siehe unten).</para>
1034 <sect2 id="Passwortüberprüfung">
1035 <title>Passwortüberprüfung</title>
1037 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1038 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1039 Active-Directory-Server. Welche davon benutzt wird, regelt der
1040 Parameter <varname>module</varname> im Abschnitt
1041 <varname>[authentication]</varname>.</para>
1043 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1044 gespeichert werden, so muss der Parameter <varname>module</varname>
1045 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1046 der Administrator als auch die Benutzer selber ihre Psaswörter in
1047 kivitendo ändern.</para>
1049 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1050 benutzt werden, so muss der Parameter <varname>module</varname> auf
1051 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1052 zusätzliche Informationen über den LDAP-Server im Abschnitt
1053 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1057 <term><literal>host</literal></term>
1060 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1061 Active-Directory-Servers. Diese Angabe ist zwingend
1062 erforderlich.</para>
1067 <term><literal>port</literal></term>
1070 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1075 <term><literal>tls</literal></term>
1078 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1079 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1080 ‘<literal>0</literal>’ belassen</para>
1085 <term><literal>attribute</literal></term>
1088 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1089 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1090 meist ‘<literal>sAMAccountName</literal>’, für andere
1091 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1092 zwingend erforderlich.</para>
1097 <term><literal>base_dn</literal></term>
1100 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1101 Diese Angabe ist zwingend erforderlich.</para>
1106 <term><literal>filter</literal></term>
1109 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1110 <literal><%login%></literal>, so wird dieses durch den vom
1111 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1112 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1113 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1118 <term><literal>bind_dn</literal> und
1119 <literal>bind_password</literal></term>
1122 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1123 durchsucht werden kann (z.B. ist dies bei
1124 Active-Directory-Servern der Fall), so kann diese hier angegeben
1125 werden. Für Active-Directory-Server kann als
1126 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1127 z.B. ‘<literal>cn=Martin
1128 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1129 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1130 also ‘<literal>Martin Mustermann</literal>’.</para>
1136 <sect2 id="Name-des-Session-Cookies">
1137 <title>Name des Session-Cookies</title>
1139 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1140 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1141 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1142 Parameter <varname>cookie_name</varname> im Abschnitt
1143 <varname>[authentication]</varname>gesetzt.</para>
1145 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1146 Server existiert.</para>
1149 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1150 <title>Anlegen der Authentifizierungsdatenbank</title>
1152 <para>Nachdem alle Einstellungen in
1153 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1154 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1155 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1156 der folgenden URL erreichbar sein sollte:</para>
1159 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1163 <sect1 id="Benutzer--und-Gruppenverwaltung">
1164 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1166 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und Datenbanken angelegt werden. Dieses geschieht im
1167 Administrationsmenü, das Sie unter folgender URL finden:</para>
1170 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1172 <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
1173 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1175 <sect2 id="Zusammenhänge">
1176 <title>Zusammenhänge</title>
1178 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung in einer oder zwei Datenbanken gespeichert werden.</para>
1180 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat
1181 Zugriff auf welche Mandanten, und welche Gruppe verfügt über welche Rechte. Diese Informationen werden in der
1182 Authentifizierungsdatenbank gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter in der Konfigurationsdatei
1183 <filename>config/kivitendo.conf</filename> gespeichert werden.</para>
1185 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten, Waren) und Belege
1186 (Angebote, Lieferscheine, Rechnungen). Diese werden in einer Mandantendatenbank gespeichert. Die
1187 Verbindungsinformationen einer solchen Mandantendatenbank werden im Administrationsbereich konfiguriert, indem man einen Mandanten
1188 anlegt und dort die Parameter einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1190 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich, die Authentifizierungsdatenbank und eine der
1191 Mandantendatenbanken in ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit mehr als einem Mandanten, wird
1192 empfohlen, für die Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die nicht gleichzeitig für einen Mandanten
1193 verwendet wird.</para>
1196 <sect2 id="Mandanten-Benutzer-Gruppen">
1197 <title>Mandanten, Benutzer und Gruppen</title>
1199 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen, die sich frei zueinander zuordnen lassen.</para>
1201 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1202 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1203 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank. Diese sollte über die <link
1204 linkend="Datenbanken-anlegen">Datenbankverwaltung</link> geschehen.</para>
1206 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten soll. Sie erhält einen Loginnamen sowie ein
1207 Passwort. Weiterhin legt der Administrator fest, an welchen Mandanten sich ein Benutzer anmelden kann, was beim Login verifiziert
1210 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür
1211 vom Administrator gewisse Rechte zugeordnet. Weiterhin legt der Administrator fest, für welche Mandanten eine Gruppe gilt, und
1212 welche Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer dann an einem Mandanten an, so erhält er alle Rechte von
1213 allen denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in denen der Benutzer zum Anderen Mitglied ist, </para>
1215 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und Benutzer angelegt werden, kann im Prinzip beliebig gewählt
1216 werden. Die folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1218 <orderedlist numeration="arabic">
1220 <para>Datenbank anlegen</para>
1224 <para>Gruppen anlegen</para>
1228 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1232 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1237 <sect2 id="Datenbanken-anlegen">
1238 <title>Datenbanken anlegen</title>
1240 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1241 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1242 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1245 <sect2 id="Gruppen-anlegen">
1246 <title>Gruppen anlegen</title>
1248 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1249 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1250 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1251 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1253 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank gespeichert, gelten aber nicht automatisch für alle
1254 Mandanten. Der Administrator legt vielmehr fest, für welche Mandanten eine Gruppe gültig ist. Dies kann entweder beim Bearbeiten der
1255 Gruppe geschehen ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn man einen Mandanten bearbeitet ("für diesen
1256 Mandanten sind die Gruppen A, B und C gültig").</para>
1258 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder dieser Gruppe festgelegt werden ("in dieser Gruppe sind die
1259 Benutzer X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten eines Benutzers geschehen ("dieser Benutzer ist
1260 Mitglied in den Gruppen A, B und C").</para>
1263 <sect2 id="Benutzer-anlegen">
1264 <title>Benutzer anlegen</title>
1266 <para>Beim Anlegen von Benutzern werden für viele Parameter Standardeinstellungen vorgenommen, die den Gepflogenheiten des deutschen
1267 Raumes entsprechen.</para>
1269 <para>Zwingend anzugeben ist der Loginname. Wenn die Passwortauthentifizierung über die Datenbank eingestellt ist, so kann hier auch
1270 das Benutzerpasswort gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1273 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier auch konfiguriert werden, auf welche Mandanten der Benutzer
1274 Zugriff hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können sowohl beim Benutzer vorgenommen werden ("dieser
1275 Benutzer hat Zugriff auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen X, Y und Z") als auch beim Mandanten ("auf
1276 diesen Mandanten haben Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe sind Benutzer A, B und C
1277 Mitglieder").</para>
1280 <sect2 id="Mandanten-anlegen">
1281 <title>Mandanten anlegen</title>
1283 <para>Ein Mandant besteht aus Administrationssicht primär aus einem eindeutigen Namen. Weiterhin wird hier hinterlegt, welche
1284 Datenbank als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten einer der eben angelegten Datenbanken eingetragen
1287 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch konfiguriert werden, welche Benutzer Zugriff auf den
1288 Mandanten haben bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen können sowohl beim Mandanten vorgenommen werden
1289 ("auf diesen Mandanten haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die Gruppen X, Y und Z gültig") als auch
1290 beim Benutzer ("dieser Benutzer hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese Gruppe ist für Mandanten A, B und
1294 <sect1 id="Drucker--Systemverwaltung">
1295 <title>Drucker- und Systemverwaltung</title>
1296 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte Druckeradministration und System.</para>
1297 <sect2 id="Druckeradministration">
1298 <title>Druckeradministration</title>
1299 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig viele "Druckbefehle" im System verwalten. Diese Befehle werden mandantenweise
1300 zugeordnet. Unter Druckerbeschreibung wird der Namen des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs angezeigt wird.</para>
1301 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl, der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P meinDrucker' oder ein
1302 kompletter Pfad zu einem Skript (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh).
1303 Wird ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich ergänzt, ist
1304 bspw. das Kürzel 'epson_drucker' definiert, so wird beim Ausdruck eines Angebots folgende Vorlage geparst: sales_quotation_epson_drucker.tex.</para>
1307 <title>System sperren / entsperren</title>
1309 <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>
1310 <para>Falls die Sperre gesetzt ist, erscheint anstelle der Anmeldemaske die Information: 'kivitendo ist momentan zwecks Wartungsarbeiten nicht zugänglich.'.
1312 <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
1313 mit einem inkonsistenten Datenbestand weitergearbeitet werden.</para>
1317 <sect1 id="config.sending-email" xreflabel="E-Mail-Versand aus kivitendo heraus">
1318 <title>E-Mail-Versand aus kivitendo heraus</title>
1320 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden, z.B. um ein Angebot direkt an einen Kunden zu
1321 verschicken. Damit dies funktioniert, muss eingestellt werden, über welchen Server die E-Mails verschickt werden sollen. kivitendo
1322 unterstützt dabei zwei Mechanismen: Versand über einen lokalen E-Mail-Server (z.B. mit <productname>Postfix</productname> oder
1323 <productname>Exim</productname>, was auch die standardmäßig aktive Methode ist) sowie Versand über einen SMTP-Server (z.B. der des
1324 eigenen Internet-Providers).</para>
1326 <para>Welche Methode und welcher Server verwendet werden, wird über die Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1327 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1329 <sect2 id="config.sending-email.sendmail" xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1330 <title>Versand über lokalen E-Mail-Server</title>
1332 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie
1333 z.B. <productname>Postfix</productname>, <productname>Exim</productname> oder <productname>Sendmail</productname> läuft.</para>
1335 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1336 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1338 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet wird, dient der Parameter '<literal>sendmail =
1339 ...</literal>'. Der Standardwert verweist auf das Programm <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1340 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1342 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen dieses sprengen. Hierfür sei auf die Dokumentation des
1343 E-Mail-Servers verwiesen.</para>
1346 <sect2 id="config.sending-email.smtp" xreflabel="E-Mail-Versand über einen SMTP-Server">
1347 <title>Versand über einen SMTP-Server</title>
1349 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server vorhanden oder zwar einer vorhanden, dieser aber nicht
1350 konfiguriert ist.</para>
1352 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1353 Parameter dienen dabei der weiteren Konfiguration:</para>
1357 <term><varname>hostname</varname></term>
1359 <listitem><para>Name oder IP-Adresse des SMTP-Servers. Standardwert: '<literal>localhost</literal>'</para></listitem>
1363 <term><varname>port</varname></term>
1365 <listitem><para>Portnummer. Der Standardwert hängt von der verwendeten Verschlüsselungsmethode ab. Gilt '<literal>security =
1366 none</literal>' oder '<literal>security = tls</literal>', so ist 25 die Standardportnummer. Für '<literal>security =
1367 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht geändert werden.</para></listitem>
1371 <term><varname>security</varname></term>
1373 <listitem><para>Wahl der zu verwendenden Verschlüsselung der Verbindung mit dem Server. Standardwert ist
1374 '<literal>none</literal>', wodurch keine Verschlüsselung verwendet wird. Mit '<literal>tls</literal>' wird TLS-Verschlüsselung
1375 eingeschaltet, und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL eingeschaltet. Achtung: Für
1376 '<literal>tls</literal>' und '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt (siehe unten).</para></listitem>
1380 <term><varname>login</varname> und <varname>password</varname></term>
1382 <listitem><para>Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername
1383 und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von
1384 Verschlüsselung aktiviert werden.</para></listitem>
1388 <para>Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind:</para>
1391 <listitem><para>TLS-Verschlüsselung: Modul <literal>Net::SSLGlue</literal> (Debian-Paketname
1392 <literal>libnet-sslglue-perl</literal>, Fedora Core: <literal>perl-Net-SSLGlue</literal>, openSUSE:
1393 <literal>perl-Net-SSLGlue</literal></para></listitem>
1395 <listitem><para>SSL-Verschlüsselung: Modul <literal>Net::SMTP::SSL</literal> (Debian-Paketname
1396 <literal>libnet-smtp-ssl-perl</literal>, Fedora Core: <literal>perl-Net-SMTP-SSL</literal>, openSUSE:
1397 <literal>perl-Net-SMTP-SSL</literal></para></listitem>
1402 <sect1 id="Drucken-mit-kivitendo">
1403 <title>Drucken mit kivitendo</title>
1405 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. Um drucken zu können, braucht der Server ein geeignetes
1406 LaTeX System. Am einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter Debianoiden Betriebssystemen installiert man
1407 die Pakete mit:</para>
1409 <para><programlisting>aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1410 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1412 <para>TODO: RPM-Pakete.</para>
1414 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1416 <listitem><para>Standard</para></listitem>
1417 <listitem><para>f-tex</para></listitem>
1418 <listitem><para>RB</para></listitem>
1421 <sect2 id="Vorlagenverzeichnis-anlegen" xreflabel="Vorlagenverzeichnis anlegen">
1422 <title>Vorlagenverzeichnis anlegen</title>
1423 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1425 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1427 <para>Der Angemmeldete Benutzer muss in einer Gruppe sein, die über das
1428 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch <xref linkend="Gruppen-anlegen"/>.
1430 <para>Im Userbereich lässt sich unter:
1431 "<guimenu>System</guimenu> ->
1432 <guisubmenu>Mandantenverwaltung</guisubmenu> -> <guimenuitem>Verschiedenes</guimenuitem>" die Option
1433 "Neue Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1436 <listitem><para><option>Vorlagen auswählen</option>: Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll
1437 (<filename>Standard</filename>, <filename>f-tex</filename> oder <filename>RB</filename>.)</para></listitem>
1438 <listitem><para><option>Neuer Name</option>: Der Verzeichnisname für den neuen Vorlagensatz. Dieser kann im Rahmen der üblichen
1439 Bedingungen für Verzeichnisnamen frei gewählt werden.</para></listitem>
1442 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist für den aktuellen Mandanten ausgewählt.
1443 Der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1444 Eventuell muessen Anpassungen (Logo, Erscheinungsbild, etc) noch vorgenommen werden. Den Ordner findet man im Dateisistem unter
1445 <filename>./templates/[Neuer Name]</filename></para>
1449 <sect2 id="Vorlagen-Standard">
1450 <title>Standard</title>
1452 <para>Der Standard-Vorlagensatz von Kivitendo. Wie unter <ulink url="http://demo.kivitendo.org">http://demo.kivitendo.org</ulink> zu
1458 <title>f-tex</title>
1460 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt.</para>
1462 <sect3 id="f-tex-Feature-Übersicht">
1463 <title>Feature-Übersicht</title>
1465 <listitem><para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage für alle briefartigen Dokumente verwendet. Also
1466 Angebot, Rechnung, Performarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc..</para></listitem>
1468 <listitem><para>Leichte Anpassung an das Firmen-Layout durch verwendung eines Hintergrund-PDF. Dieses kann leicht mit dem
1469 eigenen Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp, Adobe*)</para></listitem>
1471 <listitem><para>Hintergrund-PDF umschaltbar auf "nur erste Seite" (Standard) oder "alle Seiten" (Option
1472 "<option>bgPdfFirstPageOnly</option>" in Datei <filename>letter.lco</filename>)</para></listitem>
1474 <listitem><para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1475 versendeten Dokumenten eingebunden (Option "<option>bgPdfEmailOnly</option>" in Datei
1476 <filename>letter.lco</filename>).</para></listitem>
1478 <listitem><para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch, Wiederholung von Kopfzeilen, Zwischensummen
1479 etc. (danke an Kai-Martin Knaak für die Vorarbeit)</para></listitem>
1481 <listitem><para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom Land des eigenen Unternehmens abweicht (also die
1482 Rechnung das Land verlässt).</para></listitem>
1484 <listitem><para>Multisprachfähig leicht um weitere Sprachen zu erweitern, alle Übersetzungen in der Datei
1485 <filename>translatinos.tex</filename>.</para></listitem>
1487 <listitem><para>Auflistung von Bruttopreisen für Endverbraucher.</para></listitem>
1491 <sect3 id="f-tex-Installation">
1492 <title>Die Installation</title>
1494 <listitem><para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref linkend="Vorlagenverzeichnis-anlegen"/>. Das
1495 Vorlagensystem funktioniert jetzt schon, hat allerdings noch einen Beispiel-Briefkopf.</para></listitem>
1497 <listitem><para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach <filename>./letter_head.pdf</filename>.</para></listitem>
1498 <listitem><para>Editiere den Bereich "<option>settings</option>" in der datei <filename>letter.lco</filename>.</para></listitem>
1501 <para>oder etwas Detaillierter:</para>
1504 Es wird eine Datei <filename>sample.lco</filename> erstellt und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
1505 ist dies die Datei die für die Firmenspezifischen Anpassungen gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig
1506 ist, wird in dieser Datei auf ein Hintergrundpdf verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen
1507 vorzunehmen und <filename>sample.lco</filename> unverändert zu lassen. Die die Anpassung über eine
1508 <filename>*.lco</filename>-Datei die letztlich auf <filename>letter.lco</filename> verlinkt ist ist aber auch möglich.
1512 Es wird eine Datei <filename>sample_head.pdf</filename> mit ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
1513 verlinkt. Damit gibt es schon mal eine Funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei
1514 <filename>sample_haed.pdf</filename> an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
1515 Template Verzeichniss ablegen und statt <filename>sample_head.pdf</filename> nach <filename>letter_head.pdf</filename>
1520 letzlich muss <filename>letter_head.pdf</filename> auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
1521 enthält. Bei Updates oder nach erneutem
1525 Es wird eine Datei <filename>mydata.tex.example</filename> ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
1526 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das Land verwendet. Die Datei muss also nicht angefasst
1527 werden. Die Anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig).
1530 Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc. sollten über die Hintergrund-PDF-Datei oder die
1531 <filename>*.lco</filename>-Datei erfolgen.
1535 <sect3 id="f-tex-Funktionsübersicht">
1536 <title>f-tex Funktionsübersicht</title>
1538 Das Konzept von kivitendo sieht vor, für jedes Dokument (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine LaTeX-Vorlage
1539 vorzuhalten, dies ist sehr Wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
1540 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
1541 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche LaTeX-Vorlage verwendet, welche über Codeweichen die
1542 Besonderheiten der jeweiligen Dokumente Berücksichtigt.
1546 <listitem><para>Tabellen mit oder ohne Preis</para></listitem>
1547 <listitem><para>Sprache der Tabellenüberschriften etc.</para></listitem>
1548 <listitem><para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus Angebotsnummer)</para></listitem>
1549 <listitem><para>Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus Gewerblicher
1550 Kunde)</para></listitem>
1553 <para>Nachteil:</para>
1556 LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
1557 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann natürlich
1558 auch innerhalb der Tabellendarstellung gut persönliche Anpassungen vornehmen. Aber man kann sich hier bei Veränderungen sehr
1559 schnell häftig in den Fuss schiessen.
1562 <para>Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund PDF auf Basis der
1563 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen, und sich an der Form der dargestellten Tabellen wie sie
1564 ausgeliefert werden, erfreuen.
1567 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine kontinuierliche Schritte gehen.</para>
1571 <sect3 id="f-tex-Bruttopreise">
1572 <title>Bruttopreise für Endverbraucher</title>
1574 <para>Der auszuweisende Bruttopreis wird innerhalb der LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen "alle
1575 Preise Brutto" auszuwählen, aber:</para>
1578 <para>hierfür müssen die Preise auch in Brutto in der Datenbank stehen (ja - das lässt sich über die Preisgruppen und die
1579 Zuordung einer Default-Preisgruppe handhaben)</para>
1582 <para>man darf beim Anlegen des Vorgangs nicht vergessen Dieses Häkchen zu setzen. (das ist in der Praxis wenn man sowohl
1583 Endverbraucher- wie Gewerbekunden beliefert der eigentliche Knackpunkt)</para>
1588 Es gibt mit f-tex eine weitere Alternative. Die Information ob Brutto oder Nettorechnung wird mit den Zahlarten
1589 verknüpft. Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben werden sollen, enden mit "_E" (für
1590 Endverbraucher). Falls identische Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt man diese einfach doppelt
1591 an (einmal mit der Namensendung "_E"). Gewinn:</para>
1594 <listitem><para>Die Entscheidung, ob Netopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste Verbunden.</para></listitem>
1595 <listitem><para>Die Default-Zahlart kann im Kundendatensatz hinterlegt werden, und man muss nicht mehr daran denken, "alle Preise
1596 Netto" auszuwählen.</para></listitem>
1597 <listitem><para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken reviediert werden,
1598 ohne dass sich der Auftragswert ändert.</para></listitem>
1602 <sect3 id="f-tex-lieferadressen">
1603 <title>Lieferadressen</title>
1605 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen im Adressfeld zum Einsatz. Wenn die
1606 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende Adressvariable eingesetzt. Wenn also die Lieferadresse in
1607 Straße, Hausnummer und Ort abweicht, müssen auch nur diese Felder in der Lieferadresse ausgefüllt werden. Für den Firmenname wird
1608 der Wert der Hauptadresse angezeigt.
1613 <sect2 id="Vorlagen-RB">
1616 <para>Vollständiger Dokumentensatz mit alternativem Design</para>
1617 <para>Die konzeptionelle Idee wird <ulink
1618 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1619 auf Folie 5 bis 10 vorgestellt, Detaileinstellungen dann im Readme.tex im Vorlagenverzeichnis.</para>
1623 <sect2 id="allgemeine-hinweise-zu-latex">
1624 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
1625 <para>In den allermeisten Installationen sollte drucken jetzt schon
1626 funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
1627 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
1628 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1633 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1634 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1635 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1639 <para>! Package inputenc Error: Unicode char \u8:... set up for
1640 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1641 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1642 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1643 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1644 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1648 <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
1649 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1650 Prüfen Sie den Namen in der Konfiguration (Standard:
1651 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1652 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1655 <para>Wenn sich das Problem nicht auf Grund der ausgabe im Webbrowser verifizieren lässt:</para>
1658 <para> editiere [kivitendo-home]/config/kivitendo.conf und ändere "keep_temp_files" auf 1</para>
1659 <para><programlisting>keep_temp_files = 1;</programlisting></para>
1662 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
1665 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
1668 <para>wechsele in das users Verzeichnis von kivitendo</para>
1669 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
1672 <para>LaTeX Suchpfad anpassen:</para>
1673 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
1676 <para>Finde herraus welche Datei kivitendo beim letzten Durchlauf erstellt hat</para>
1677 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
1678 <para>Es sollte die letzte Datei ganz unten sein</para>
1681 <para>für besseren Hinweis auf Fehler texdatei nochmals übersetzen</para>
1682 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
1683 <para>in der *.tex datei nach dem Fehler suchen.</para>
1689 <sect1 id="OpenDocument-Vorlagen">
1690 <title>OpenDocument-Vorlagen</title>
1692 <para>kivitendo unterstützt die Verwendung von Vorlagen im
1693 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1694 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1695 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1696 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1697 <filename>config/kivitendo.conf</filename> die Variable
1698 <literal>opendocument</literal> im Abschnitt
1699 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1700 Dieses ist die Standardeinstellung.</para>
1702 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1703 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1704 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1705 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1706 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1707 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1709 <para>Nach der Installation müssen in der Datei
1710 <filename>config/kivitendo.conf</filename> zwei weitere Variablen
1711 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1712 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1713 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1714 enthalten. Beide stehen im Abschnitt
1715 <literal>applications</literal>.</para>
1717 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
1718 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1719 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1720 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1721 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1722 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1723 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1724 werden muss. Der Nachteil ist, dass diese Methode Python und die
1725 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1730 Für die Verbindung zu OpenOffice wird normalerweise der Python-Interpreter <filename>/usr/bin/python</filename> benutzt. Sollte
1731 dies nicht der richtige sein, so kann man mit zwei Konfigurationsvariablen entscheiden, welcher Python-Interpreter genutzt
1732 wird. Mit der Option <literal>python_uno</literal> aus dem Abschnitt <literal>applications</literal> wird der Interpreter selber
1733 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert <literal>/usr/bin/python</literal>.
1737 Zusätzlich ist es möglich, Pfade anzugeben, in denen Python neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
1738 z.B. falls sich diese in einem gesonderten OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
1739 <literal>python_uno_path</literal> und befindet sich im Abschnitt <literal>environment</literal>. Sie ist standardmäßig
1740 leer. Werden hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte voneinander getrennt werden. Der Inhalt wird an den
1741 Python-Interpreter über die Umgebungsvariable <literal>PYTHONPATH</literal> übergeben.
1745 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1746 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1747 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1748 Dokumentenvorlage enthalten sein und
1749 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1750 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1751 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1752 ebenfalls enthalten sein muss.</para>
1754 <para>Als letztes muss herausgefunden werden, welchen Namen
1755 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1756 gibt. Unter Debian ist dies momentan
1757 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1758 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1759 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1760 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1761 folgender Befehl auszuführen:</para>
1763 <para><literal>mv users/.openoffice.org2
1764 users/.openoffice</literal></para>
1766 <para>Dieses Verzeichnis, wie auch das komplette
1767 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1768 sein. Dieses wurde bereits erledigt (siehe <xref
1769 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1770 erneut überprüft werden, wenn die Konvertierung nach PDF
1774 <sect1 id="config.eur">
1775 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1778 <sect2 id="config.eur.introduction"
1779 xreflabel="Einführung in die Konfiguration zur EUR">
1780 <title>Einführung</title>
1782 <para>kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1783 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals noch <filename>config/lx_office.conf</filename>)
1784 befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden.</para>
1786 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1787 die Mandantendatenbank verschoben und dabei auch gleich in drei
1788 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1789 steuern lässt.</para>
1792 <sect2 id="config.eur.parameters"
1793 xreflabel="Konfigurationsparameter für EUR">
1794 <title>Konfigurationsparameter</title>
1796 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1797 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1801 <term><varname>profit_determination</varname></term>
1804 <para>Dieser Parameter legt die Berechnungsmethode für die
1805 Gewinnermittlung fest. Er enthält entweder
1806 <literal>balance</literal> für
1807 Betriebsvermögensvergleich/Bilanzierung oder
1808 <literal>income</literal> für die
1809 Einnahmen-Überschuss-Rechnung.</para>
1814 <term><varname>accounting_method</varname></term>
1817 <para>Dieser Parameter steuert die Buchungs- und
1818 Berechnungsmethoden für die Versteuerungsart. Er enthält
1819 entweder <literal>accrual</literal> für die Soll-Versteuerung
1820 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1825 <term><varname>inventory_system</varname></term>
1828 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1829 enthält entweder <literal>perpetual</literal> für die
1830 Bestandsmethode oder <literal>periodic</literal> für die
1831 Aufwandsmethode.</para>
1836 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1837 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1838 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1839 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1840 Bestandsmethode.</para>
1842 <para>Die Konfiguration "<varname>eur</varname>" unter
1843 <varname>[system]</varname> in der <link
1844 linkend="config.config-file">Konfigurationsdatei</link>
1845 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
1846 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1849 <sect2 id="config.eur.setting-parameters">
1850 <title>Festlegen der Parameter</title>
1852 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1853 der Admininstration können diese Optionen nun unabhängig voneinander
1854 eingestellt werden.</para>
1856 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1857 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1860 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1861 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
1862 angezeigt. Unter <guimenu>System</guimenu>
1863 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> können
1864 die Einstellungen auch geändert werden. Dabei ist zu beachten,
1865 dass eine Änderung vorhandene Daten so belässt und damit
1866 evtl. die Ergebnisse verfälscht. Dies gilt vor Allem für die
1867 Warenbuchungsmethode (siehe auch
1868 <link linkend="config.eur.inventory-system-perpetual">
1869 Bemerkungen zu Bestandsmethode</link>).</para>
1872 <sect2 id="config.eur.inventory-system-perpetual">
1873 <title>Bemerkungen zu Bestandsmethode</title>
1875 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1876 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
1877 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1878 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1879 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1880 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1881 Einkaufsrechnungen berechnet wird.</para>
1883 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1884 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1885 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1889 <sect2 id="config.eur.knonw-issues">
1890 <title>Bekannte Probleme</title>
1892 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1893 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1894 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1895 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1896 die Konfigurationsvariable
1897 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1900 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1901 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1905 <sect1 id="config.skr04-update-3804">
1906 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1908 <sect2 id="config.skr04-update-3804.introduction">
1909 <title>Einführung</title>
1911 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1912 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1913 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1914 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1915 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1916 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1917 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1918 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1919 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1920 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1921 Screenshots dargestellt.</para>
1923 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1924 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1925 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1926 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1929 <sect2 id="config.skr04-update-3804.create-chart">
1930 <title>Konto 3804 manuell anlegen</title>
1932 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
1933 anzulegen und zu konfigurieren. Zuerst wird in
1934 <guimenu>System</guimenu> ->
1935 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
1936 erfassen</guimenuitem> das Konto angelegt.</para>
1939 <screeninfo>Konto 3804 erfassen</screeninfo>
1943 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
1949 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
1950 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
1951 wie im folgenden Screenshot angezeigt anpassen.
1955 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
1959 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
1965 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
1966 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
1970 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
1974 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
1980 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
1981 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
1982 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
1983 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
1987 <screeninfo>Konto 4315 anpassen</screeninfo>
1991 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
1997 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
1998 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
2002 <screeninfo>Steuerliste vergleichen</screeninfo>
2006 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
2013 <title>Verhalten des Bilanzberichts</title>
2015 Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als Grundlage für das
2016 Startdatum benutzt. Schließt man die Bücher allerdings monatsweise führt dies
2017 zu falschen Werten.</para>
2018 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau einstellen indem man:</para>
2021 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu vorher)</para>
2024 <para>immer den Jahresanfang nimmt (1.1. relativ zum Stichtag)</para>
2027 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
2028 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen gibt</para>
2029 <para>- oder mit "alle Buchungen" als Alternative"</para>
2032 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen gibt </para>
2035 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
2038 Folgende Hinweise zu den Optionen:
2039 Das "Bücher schließen Datum" ist sinnvoll, wenn man nur komplette Jahre
2040 schließt. Bei Wirtschaftsjahr = Kalendarjahr entspricht dies aber auch
2042 "Alle Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
2044 Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B. sinnvoll, wenn man
2045 am sich Anfang des zweiten Buchungsjahres befindet, und noch keinen
2046 Jahreswechsel und auch noch keine EB-Buchungen hat.
2047 Bei den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1. Tag
2048 des Wirtschaftsjahres gebucht werden.
2049 Zur Sicherheit wird das Startdatum im Bilanzbericht jetzt zusätzlich zum
2050 Stichtag mit angezeigt. Das hilft auch bei der Kontrolle für den
2051 Abgleich mit der GuV.
2053 <sect1 id="config.client">
2054 <title>Einstellungen pro Mandant</title>
2056 <para>Einige Einstellungen können von einem Benutzer mit dem
2057 <link linkend="Zusammenhänge">Recht</link> "Administration
2058 (Für die Verwaltung der aktuellen Instanz aus einem Userlogin heraus)"
2059 gemacht werden. Diese Einstellungen sind dann für die aktuellen
2060 Mandanten-Datenbank gültig. Die Einstellungen sind
2061 unter <guimenu>System</guimenu>
2062 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
2064 <para>Bitte beachten Sie die Hinweise zu den einzelnen
2065 Einstellungen. Einige Einstellungen sollten nicht ohne Weiteres
2066 im laufenden Betrieb geändert werden (siehe
2067 auch <link linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
2068 Bestandsmethode</link>).</para>
2070 <para>Die Einstellungen <literal>show_bestbefore</literal>
2071 und <literal>payments_changeable</literal> aus dem
2072 Abschnitt <literal>features</literal> und die Einstellungen im
2073 Abschnitt <literal>datev_check</literal> (sofern schon vorhanden)
2074 der <link linkend="config.config-file">kivitendo-Konfigurationsdatei</link>
2075 werden bei einem Datenbankupdate einer älteren Version automatisch
2076 übernommen. Diese Einträge können danach aus der Konfigurationsdatei
2077 entfernt werden.</para>
2080 <sect1 id="kivitendo-ERP-verwenden">
2081 <title>kivitendo ERP verwenden</title>
2083 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
2084 folgender URL erreichbar:</para>
2087 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
2089 <para>Die Administrationsseite erreichen Sie unter:</para>
2092 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
2096 <chapter id="features" xreflabel="Features und Funktionen">
2097 <title>Features und Funktionen</title>
2099 <sect1 id="features.periodic-invoices"
2100 xreflabel="Wiedekehrende Rechnungen">
2101 <title>Wiederkehrende Rechnungen</title>
2103 <sect2 id="features.periodic-invoices.introduction"
2104 xreflabel="Einführung in wiederkehrende Rechnungen">
2105 <title>Einführung</title>
2107 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
2108 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
2109 Die konfigurierten Aufträge werden später automatisch in Rechnungen
2110 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
2111 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
2112 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
2113 wiederzufinden sind.</para>
2116 <sect2 id="features.periodic-invoices.configuration"
2117 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
2118 <title>Konfiguration</title>
2120 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
2121 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
2122 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
2123 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
2124 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
2127 <para>Folgende Parameter kann man konfigurieren:</para>
2134 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
2135 erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
2136 neuen Monats).</para>
2138 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
2139 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
2140 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
2141 nächsten Periodenwechsel für alle Perioden, seit der letzten
2142 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
2143 verhindern, muss man vorher das Startdatum neu setzen.</para>
2145 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
2146 erstellt. Man kann sich diese Aufträge aber gesondert in den
2147 Berichten anzeigen lassen.</para>
2152 <term>Periodizität</term>
2155 <para>Ob monatlich, quartalsweise oder jährlich auf neue
2156 Rechnungen überprüft werden soll. Für jede Periode seit dem
2157 Startdatum wird überprüft, ob für die Periode (beginnend immer
2158 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
2159 wurde. Unter Umständen können bei einem Startdatum in der
2160 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
2165 <term>Buchen auf</term>
2168 <para>Das Forderungskonto, in der Regel "Forderungen aus
2169 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
2170 Buchungsgruppen der betreffenden Waren.</para>
2175 <term>Startdatum</term>
2178 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
2184 <term>Enddatum</term>
2187 <para>ab wann keine Rechnungen mehr erstellt werden
2193 <term>Automatische Verlängerung um x Monate</term>
2196 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
2197 eingetragenen Enddatums weiterhin erstellt werden, so kann man
2198 hier die Anzahl der Monate eingeben, um die das Enddatum
2199 automatisch nach hinten geschoben wird.</para>
2204 <term>Drucken</term>
2207 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
2208 Rechnungen auch gleich ausdrucken lassen.</para>
2213 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
2214 Informationen zu den erstellten Rechnungen verschickt werden.
2215 Konfiguriert wird dies in der <link
2216 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
2217 <filename>config/kivitendo.conf</filename> im Abschnitt
2218 <varname>[periodic_invoices]</varname>.</para>
2221 <sect2 id="features.periodic-invoices.variables">
2222 <title>Spezielle Variablen</title>
2225 Um die erzeugten Rechnungen individualisieren zu können, werden beim Umwandeln des Auftrags in eine Rechnung einige speziell
2226 formatierte Variablen durch für die jeweils aktuelle Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B. den
2227 Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei die Syntax <literal><%variablenname%></literal>.
2231 Diese Variablen werden in den folgenden Elementen des Auftrags ersetzt:
2235 <listitem><para>Bemerkungen</para></listitem>
2236 <listitem><para>Interne Bemerkungen</para></listitem>
2237 <listitem><para>Vorgangsbezeichnung</para></listitem>
2238 <listitem><para>In den Beschreibungs- und Langtextfeldern aller Positionen</para></listitem>
2241 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
2245 <term><varname><%current_quarter%></varname>, <varname><%previous_quarter%></varname>, <varname><%next_quarter%></varname></term>
2249 Aktuelles, vorheriges und nächstes Quartal als Zahl zwischen <literal>1</literal> und <literal>4</literal>.
2255 <term><varname><%current_month%></varname>, <varname><%previous_month%></varname>, <varname><%next_month%></varname></term>
2259 Aktueller, vorheriger und nächster Monat als Zahl zwischen <literal>1</literal> und <literal>12</literal>.
2265 <term><varname><%current_month_long%></varname>, <varname><%previous_month_long%></varname>, <varname><%next_month_long%></varname></term>
2269 Aktueller, vorheriger und nächster Monat als Name (<literal>Januar</literal>, <literal>Februar</literal> etc.).
2275 <term><varname><%current_year%></varname>, <varname><%previous_year%></varname>, <varname><%next_year%></varname></term>
2279 Aktuelles, vorheriges und nächstes Jahr als vierstellige Jahreszahl (<literal>2013</literal> etc.).
2285 <term><varname><%period_start_date%></varname>, <varname><%period_end_date%></varname></term>
2289 Formatiertes Datum des ersten und letzten Tages im Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im ersten
2290 Quartal von 2013 wären dies der <literal>01.01.2013</literal> und <literal>31.03.2013</literal>).
2297 <sect2 id="features.periodic-invoices.reports">
2298 <title>Auflisten</title>
2300 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
2301 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
2302 Rechnungen inaktiv", mit denen man sich einen Überglick über die
2303 wiederkehrenden Rechnungen verschaffen kann.</para>
2306 <sect2 id="features.periodic-invoices.task-server">
2307 <title>Erzeugung der eigentlichen Rechnungen</title>
2309 <para>Die zeitliche und periodische Überprüfung, ob eine
2310 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
2311 durch den <link linkend="config.task-server">Taskserver</link>, einen
2312 externen Dienst, der automatisch beim Start des Servers gestartet
2313 werden sollte.</para>
2316 <sect2 id="features.periodic-invoices.create-for-current-month">
2317 <title>Erste Rechnung für aktuellen Monat erstellen</title>
2319 <para>Will man im laufenden Monat eine monatlich wiederkehrende
2320 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
2321 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
2322 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
2323 generiert hat. Alternativ setzt man das Startdatum auf den
2324 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
2325 manuell über den Workflow.</para>
2328 <sect1 id="dokumentenvorlagen-und-variablen">
2329 <title>Dokumentenvorlagen und verfügbare Variablen</title>
2331 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
2332 <title>Einführung</title>
2334 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
2335 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
2336 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
2337 <function><%variablenname%></function> verwendet wird. Für
2338 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
2340 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
2342 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
2343 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
2344 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
2345 alle Vorlagenarten.</para>
2347 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
2348 verfügbar als hier aufgelistet werden. Die meisten davon können
2349 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
2350 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
2351 diese wie folgt erhalten werden:</para>
2355 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
2356 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
2360 <para>In <filename>Form.pm</filename> die Funktion
2361 <function>parse_template</function> suchen und hier die Zeile
2362 <command>print(STDERR Dumper($self));</command> einfügen.</para>
2366 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
2367 ein PDF für eine Rechnung erzeugen.</para>
2371 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
2372 der Variablen <varname>$self</varname> in der Form <varname>'key'
2373 => 'value',</varname>. Alle <varname>key</varname>s sind
2379 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
2380 <title>Variablen ausgeben</title>
2382 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
2383 Tags geschrieben werden, also z.B.
2384 <varname><%variablenname%></varname>.</para>
2386 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
2387 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
2388 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
2389 werden die folgenden Flags unterstützt:</para>
2393 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
2394 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
2395 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
2396 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
2400 <para><option>NOESCAPE</option> unterdrückt das Escapen von
2401 Sonderzeichen für die Vorlagensprache. Wenn also in einer
2402 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
2403 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
2404 ist dieses Flag sinnvoll.</para>
2408 <para>Beispiel:</para>
2410 <programlisting><%quototal NOFORMAT%></programlisting>
2413 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
2414 <title>Verwendung in Druckbefehlen</title>
2416 <para>In der Admininstration können Drucker definiert werden. Auch im
2417 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
2418 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
2419 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
2420 <function>`...`</function> nicht zu unerwünschtem Verhalten
2423 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
2424 für das die Telefonnummer eines Ansprechpartners als Teil der
2425 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
2426 z.B. wie folgt aussehen:</para>
2428 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
2431 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
2432 xreflabel="Anfang und Ende der Tags verändern">
2433 <title>Anfang und Ende der Tags verändern</title>
2435 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
2436 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
2437 Prozentzeichen und dem Größerzeichen endet, beispielsweise
2438 <function><%customer%></function>. Da diese Form aber z.B. in
2439 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
2440 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
2441 Stil umgestellt werden.</para>
2443 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
2444 Format gültigen Kommentarzeichen anfangen, dann
2445 <function>config:</function> enthalten, die entsprechende Option
2446 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
2447 enden. Beispiel für LaTeX:</para>
2449 <programlisting>% config: tag-style=($ $)</programlisting>
2451 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
2452 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
2453 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
2455 <programlisting><!-- config: tag-style=($ $) --></programlisting>
2458 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
2459 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
2461 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
2462 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
2463 "<filename>.ext</filename>" geeignet zu ersetzen:
2464 "<filename>.tex</filename>" für LaTeX-Vorlagen und
2465 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
2469 <term><filename>bin_list.ext</filename></term>
2472 <para>Lagerliste</para>
2477 <term><filename>check.ext</filename></term>
2485 <term><filename>invoice.ext</filename></term>
2488 <para>Rechnung</para>
2493 <term><filename>packing_list.ext</filename></term>
2496 <para>Packliste</para>
2501 <term><filename>pick_list.ext</filename></term>
2504 <para>Sammelliste</para>
2509 <term><filename>purchase_delivery_order.ext</filename></term>
2512 <para>Lieferschein (Einkauf)</para>
2517 <term><filename>purcharse_order.ext</filename></term>
2520 <para>Bestellung an Lieferanten</para>
2525 <term><filename>request_quotation.ext</filename></term>
2528 <para>Anfrage an Lieferanten</para>
2533 <term><filename>sales_delivery_order.ext</filename></term>
2536 <para>Lieferschein (Verkauf)</para>
2541 <term><filename>sales_order.ext</filename></term>
2544 <para>Bestellung</para>
2549 <term><filename>sales_quotation.ext</filename></term>
2552 <para>Angebot an Kunden</para>
2557 <term><filename>zahlungserinnerung.ext</filename></term>
2560 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2565 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2568 <para>Rechnung über Mahngebühren (Dateiname im Programm
2569 konfigurierbar)</para>
2575 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2576 <title>Sprache, Drucker und E-Mail</title>
2578 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2579 eingearbeitet. So wird aus der Vorlage
2580 <filename>sales_order.ext</filename> bei Sprache
2581 <function>de</function> und Druckerkürzel <function>lpr2</function>
2582 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2583 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2584 bekommen dann noch das Kürzel <filename>_email</filename>, der
2585 vollständige Vorlagenname wäre dann
2586 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2587 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2588 werden. Diese wird verwendet, wenn keine der anderen Varianten
2589 gefunden wird.</para>
2591 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2592 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2593 verschickt wird, ist:</para>
2597 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2601 <para><filename>sales_order_de_lpr2.tex</filename></para>
2605 <para><filename>sales_order.tex</filename></para>
2609 <para><filename>default.tex</filename></para>
2613 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2614 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2616 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2619 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2620 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2623 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2624 xreflabel="Metainformationen zur angeforderten Vorlage">
2625 <title>Metainformationen zur angeforderten Vorlage</title>
2627 <para>Diese Variablen liefern Informationen darüber welche Variante
2628 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2629 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2630 Formulare einbinden möchten.</para>
2634 <term><varname>template_meta.formname</varname></term>
2637 <para>Basisname der Vorlage. Identisch mit der <link
2638 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2639 zu den Dateinamen</link> ohne die Erweiterung. Ein
2640 Verkaufsauftrag enthält hier
2641 <constant>sales_order</constant>.</para>
2646 <term><varname>template_meta.language.description</varname></term>
2649 <para>Beschreibung der verwendeten Sprache</para>
2654 <term><varname>template_meta.language.template_code</varname></term>
2657 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2658 Kürzel das im Dateinamen verwendetet wird.</para>
2663 <term><varname>template_meta.language.output_numberformat</varname></term>
2666 <para>Zahlenformat der verwendeten Sprache in der Form
2667 "<constant>1.000,00</constant>". Experimentell! Nur
2668 interessant für Vorlagen die mit unformatierten Werten
2674 <term><varname>template_meta.language.output_dateformat</varname></term>
2677 <para>Datumsformat der verwendeten Sprache in der Form
2678 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2679 interessant für Vorlagen die mit unformatierten Werten
2685 <term><varname>template_meta.format</varname></term>
2688 <para>Das angeforderte Format. Kann im Moment die Werte
2689 <constant>pdf</constant>, <constant>postscript</constant>,
2690 <constant>html</constant>, <constant>opendocument</constant>,
2691 <constant>opendocument_pdf</constant> und
2692 <constant>excel</constant> enthalten.</para>
2697 <term><varname>template_meta.extension</varname></term>
2700 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2701 <constant>format</constant> entschieden.</para>
2706 <term><varname>template_meta.media</varname></term>
2709 <para>Ausgabemedium. Kann zur Zeit die Werte
2710 <constant>screen</constant> für Bildschirm,
2711 <constant>email</constant> für E-Mmail (triggert das
2712 <constant>_email</constant> Kürzel im Dateinamen),
2713 <constant>printer</constant> für Drucker, und
2714 <constant>queue</constant> für Warteschlange enthalten.</para>
2719 <term><varname>template_meta.printer.description</varname></term>
2722 <para>Beschreibung des ausgewählten Druckers</para>
2727 <term><varname>template_meta.printer.template_code</varname></term>
2730 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2731 dem Kürzel das im Dateinamen verwendetet wird.</para>
2736 <term><varname>template_meta.tmpfile</varname></term>
2739 <para>Datei-Prefix für temporäre Dateien.</para>
2745 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2746 <title>Stammdaten von Kunden und Lieferanten</title>
2750 <term><varname>account_number</varname></term>
2753 <para>Kontonummer</para>
2758 <term><varname>bank</varname></term>
2761 <para>Name der Bank</para>
2766 <term><varname>bank_code</varname></term>
2769 <para>Bankleitzahl</para>
2774 <term><varname>bic</varname></term>
2777 <para>Bank-Identifikations-Code (Bank Identifier Code,
2783 <term><varname>business</varname></term>
2786 <para>Kunden-/Lieferantentyp</para>
2791 <term><varname>city</varname></term>
2799 <term><varname>contact</varname></term>
2802 <para>Kontakt</para>
2807 <term><varname>country</varname></term>
2815 <term><varname>c_vendor_id</varname></term>
2818 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
2823 <term><varname>v_customer_id</varname></term>
2826 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
2831 <term><varname>cp_email</varname></term>
2834 <para>Email des Ansprechpartners</para>
2839 <term><varname>cp_givenname</varname></term>
2842 <para>Vorname des Ansprechpartners</para>
2847 <term><varname>cp_greeting</varname></term>
2850 <para>Anrede des Ansprechpartners</para>
2855 <term><varname>cp_name</varname></term>
2858 <para>Name des Ansprechpartners</para>
2863 <term><varname>cp_phone1</varname></term>
2866 <para>Telefonnummer 1 des Ansprechpartners</para>
2871 <term><varname>cp_phone2</varname></term>
2874 <para>Telefonnummer 2 des Ansprechpartners</para>
2879 <term><varname>cp_title</varname></term>
2882 <para>Titel des Ansprechpartners</para>
2887 <term><varname>creditlimit</varname></term>
2890 <para>Kreditlimit</para>
2895 <term><varname>customeremail</varname></term>
2898 <para>Email des Kunden; nur für Kunden</para>
2903 <term><varname>customerfax</varname></term>
2906 <para>Faxnummer des Kunden; nur für Kunden</para>
2911 <term><varname>customernotes</varname></term>
2914 <para>Bemerkungen beim Kunden; nur für Kunden</para>
2919 <term><varname>customernumber</varname></term>
2922 <para>Kundennummer; nur für Kunden</para>
2927 <term><varname>customerphone</varname></term>
2930 <para>Telefonnummer des Kunden; nur für Kunden</para>
2935 <term><varname>discount</varname></term>
2943 <term><varname>email</varname></term>
2946 <para>Emailadresse</para>
2951 <term><varname>fax</varname></term>
2954 <para>Faxnummer</para>
2959 <term><varname>homepage</varname></term>
2962 <para>Homepage</para>
2967 <term><varname>iban</varname></term>
2970 <para>Internationale Kontonummer (International Bank Account
2971 Number, IBAN)</para>
2976 <term><varname>language</varname></term>
2979 <para>Sprache</para>
2984 <term><varname>name</varname></term>
2987 <para>Firmenname</para>
2992 <term><varname>payment_description</varname></term>
2995 <para>Name der Zahlart</para>
3000 <term><varname>payment_terms</varname></term>
3003 <para>Zahlungskonditionen</para>
3008 <term><varname>phone</varname></term>
3011 <para>Telefonnummer</para>
3016 <term><varname>shiptocity</varname></term>
3019 <para>Stadt (Lieferadresse) <link
3020 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3025 <term><varname>shiptocontact</varname></term>
3028 <para>Kontakt (Lieferadresse) <link
3029 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3034 <term><varname>shiptocountry</varname></term>
3037 <para>Land (Lieferadresse) <link
3038 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3043 <term><varname>shiptodepartment1</varname></term>
3046 <para>Abteilung 1 (Lieferadresse) <link
3047 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3052 <term><varname>shiptodepartment2</varname></term>
3055 <para>Abteilung 2 (Lieferadresse) <link
3056 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3061 <term><varname>shiptoemail</varname></term>
3064 <para>Email (Lieferadresse) <link
3065 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3070 <term><varname>shiptofax</varname></term>
3073 <para>Fax (Lieferadresse) <link
3074 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3079 <term><varname>shiptoname</varname></term>
3082 <para>Firmenname (Lieferadresse) <link
3083 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3088 <term><varname>shiptophone</varname></term>
3091 <para>Telefonnummer (Lieferadresse) <link
3092 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3097 <term><varname>shiptostreet</varname></term>
3100 <para>Straße und Hausnummer (Lieferadresse) <link
3101 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3106 <term><varname>shiptozipcode</varname></term>
3109 <para>Postleitzahl (Lieferadresse) <link
3110 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3115 <term><varname>street</varname></term>
3118 <para>Straße und Hausnummer</para>
3123 <term><varname>taxnumber</varname></term>
3126 <para>Steuernummer</para>
3131 <term><varname>ustid</varname></term>
3134 <para>Umsatzsteuer-Identifikationsnummer</para>
3139 <term><varname>vendoremail</varname></term>
3142 <para>Email des Lieferanten; nur für Lieferanten</para>
3147 <term><varname>vendorfax</varname></term>
3150 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
3155 <term><varname>vendornotes</varname></term>
3158 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
3163 <term><varname>vendornumber</varname></term>
3166 <para>Lieferantennummer; nur für Lieferanten</para>
3171 <term><varname>vendorphone</varname></term>
3174 <para>Telefonnummer des Lieferanten; nur für
3180 <term><varname>zipcode</varname></term>
3183 <para>Postleitzahl</para>
3188 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
3189 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
3190 Stammdaten nicht eingetragen, so haben die Variablen
3191 <varname>shipto*</varname> den gleichen Wert wie die die
3192 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
3193 einige <varname>shipto*</varname>-Variablen so nicht in den
3194 Stammdaten wiederfinden sondern schlicht Kopien der
3195 Lieferdatenvariablen sind (z.B.
3196 <varname>shiptocontact</varname>).</para>
3200 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
3201 <title>Informationen über den Bearbeiter</title>
3205 <term><varname>employee_address</varname></term>
3208 <para>Adressfeld</para>
3213 <term><varname>employee_businessnumber</varname></term>
3216 <para>Firmennummer</para>
3221 <term><varname>employee_company</varname></term>
3224 <para>Firmenname</para>
3229 <term><varname>employee_co_ustid</varname></term>
3232 <para>Usatzsteuer-Identifikationsnummer</para>
3237 <term><varname>employee_duns</varname></term>
3240 <para>DUNS-Nummer</para>
3245 <term><varname>employee_email</varname></term>
3253 <term><varname>employee_fax</varname></term>
3261 <term><varname>employee_name</varname></term>
3264 <para>voller Name</para>
3269 <term><varname>employee_signature</varname></term>
3272 <para>Signatur</para>
3277 <term><varname>employee_taxnumber</varname></term>
3280 <para>Steuernummer</para>
3285 <term><varname>employee_tel</varname></term>
3288 <para>Telefonnummer</para>
3294 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
3295 <title>Informationen über den Verkäufer</title>
3299 <term><varname>salesman_address</varname></term>
3302 <para>Adressfeld</para>
3307 <term><varname>salesman_businessnumber</varname></term>
3310 <para>Firmennummer</para>
3315 <term><varname>salesman_company</varname></term>
3318 <para>Firmenname</para>
3323 <term><varname>salesman_co_ustid</varname></term>
3326 <para>Usatzsteuer-Identifikationsnummer</para>
3331 <term><varname>salesman_duns</varname></term>
3334 <para>DUNS-Nummer</para>
3339 <term><varname>salesman_email</varname></term>
3347 <term><varname>salesman_fax</varname></term>
3355 <term><varname>salesman_name</varname></term>
3358 <para>voller Name</para>
3363 <term><varname>salesman_signature</varname></term>
3366 <para>Signatur</para>
3371 <term><varname>salesman_taxnumber</varname></term>
3374 <para>Steuernummer</para>
3379 <term><varname>salesman_tel</varname></term>
3382 <para>Telefonnummer</para>
3388 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
3389 <title>Variablen für die einzelnen Steuern</title>
3393 <term><varname>tax</varname></term>
3401 <term><varname>taxbase</varname></term>
3404 <para>zu versteuernder Betrag</para>
3409 <term><varname>taxdescription</varname></term>
3412 <para>Name der Steuer</para>
3417 <term><varname>taxrate</varname></term>
3420 <para>Steuersatz</para>
3426 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
3427 <title>Variablen für Lieferbedingungen</title>
3431 <term><varname>delivery_term</varname></term>
3432 <listitem><para>Datenbank-Objekt der Lieferbedingung</para></listitem>
3435 <term><varname>delivery_term.description</varname></term>
3436 <listitem><para>Beschreibung der Lieferbedingung</para></listitem>
3439 <term><varname>delivery_term.long_description</varname></term>
3440 <listitem><para>Langtext bzw. übersetzter Langtext der Lieferbedingung</para></listitem>
3446 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
3447 <title>Variablen in Rechnungen</title>
3449 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
3450 <title>Allgemeine Variablen</title>
3454 <term><varname>creditremaining</varname></term>
3457 <para>Verbleibender Kredit</para>
3462 <term><varname>currency</varname></term>
3465 <para>Währung</para>
3470 <term><varname>cusordnumber</varname></term>
3473 <para>Bestellnummer beim Kunden</para>
3478 <term><varname>deliverydate</varname></term>
3481 <para>Lieferdatum</para>
3486 <term><varname>duedate</varname></term>
3489 <para>Fälligkeitsdatum</para>
3494 <term><varname>globalprojectnumber</varname></term>
3497 <para>Projektnummer des ganzen Beleges</para>
3502 <term><varname>globalprojectdescription</varname></term>
3505 <para>Projekbeschreibung des ganzen Beleges</para>
3510 <term><varname>intnotes</varname></term>
3513 <para>Interne Bemerkungen</para>
3518 <term><varname>invdate</varname></term>
3521 <para>Rechnungsdatum</para>
3526 <term><varname>invnumber</varname></term>
3529 <para>Rechnungsnummer</para>
3534 <term><varname>invtotal</varname></term>
3537 <para>gesamter Rechnungsbetrag</para>
3542 <term><varname>notes</varname></term>
3545 <para>Bemerkungen der Rechnung</para>
3550 <term><varname>orddate</varname></term>
3553 <para>Auftragsdatum</para>
3558 <term><varname>ordnumber</varname></term>
3561 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3562 erstellt wurde</para>
3567 <term><varname>payment_description</varname></term>
3570 <para>Name der Zahlart</para>
3575 <term><varname>payment_terms</varname></term>
3578 <para>Zahlungskonditionen</para>
3583 <term><varname>quodate</varname></term>
3586 <para>Angebotsdatum</para>
3591 <term><varname>quonumber</varname></term>
3594 <para>Angebotsnummer</para>
3599 <term><varname>shippingpoint</varname></term>
3602 <para>Versandort</para>
3607 <term><varname>shipvia</varname></term>
3610 <para>Transportmittel</para>
3615 <term><varname>subtotal</varname></term>
3618 <para>Zwischensumme aller Posten ohne Steuern</para>
3623 <term><varname>total</varname></term>
3626 <para>Restsumme der Rechnung (Summe abzüglich bereits
3627 bezahlter Posten)</para>
3632 <term><varname>transaction_description</varname></term>
3635 <para>Vorgangsbezeichnung</para>
3640 <term><varname>transdate</varname></term>
3643 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3644 erstellt wurde</para>
3650 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3651 <title>Variablen für jeden Posten auf der Rechnung</title>
3655 <term><varname>bin</varname></term>
3658 <para>Stellage</para>
3663 <term><varname>description</varname></term>
3666 <para>Artikelbeschreibung</para>
3671 <term><varname>discount</varname></term>
3674 <para>Rabatt als Betrag</para>
3679 <term><varname>discount_sub</varname></term>
3682 <para>Zwischensumme mit Rabatt</para>
3687 <term><varname>drawing</varname></term>
3690 <para>Zeichnung</para>
3695 <term><varname>ean</varname></term>
3698 <para>EAN-Code</para>
3703 <term><varname>image</varname></term>
3711 <term><varname>linetotal</varname></term>
3714 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3719 <term><varname>longdescription</varname></term>
3722 <para>Langtext</para>
3727 <term><varname>microfiche</varname></term>
3730 <para>Mikrofilm</para>
3735 <term><varname>netprice</varname></term>
3738 <para>Nettopreis</para>
3743 <term><varname>nodiscount_linetotal</varname></term>
3746 <para>Zeilensumme ohne Rabatt</para>
3751 <term><varname>nodiscount_sub</varname></term>
3754 <para>Zwischensumme ohne Rabatt</para>
3759 <term><varname>number</varname></term>
3762 <para>Artikelnummer</para>
3767 <term><varname>ordnumber_oe</varname></term>
3770 <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
3771 aus einem Sammelauftrag erstellt wurde</para>
3776 <term><varname>p_discount</varname></term>
3779 <para>Rabatt in Prozent</para>
3784 <term><varname>partnotes</varname></term>
3787 <para>Die beim Artikel gespeicherten Bemerkungen</para>
3792 <term><varname>partsgroup</varname></term>
3795 <para>Warengruppe</para>
3800 <term><varname>price_factor</varname></term>
3803 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
3809 <term><varname>price_factor_name</varname></term>
3812 <para>Der Name des Preisfaktors, sofern einer eingestellt
3818 <term><varname>projectnumber</varname></term>
3821 <para>Projektnummer</para>
3826 <term><varname>projectdescription</varname></term>
3829 <para>Projektbeschreibung</para>
3834 <term><varname>qty</varname></term>
3842 <term><varname>reqdate</varname></term>
3845 <para>Lieferdatum</para>
3850 <term><varname>runningnumber</varname></term>
3853 <para>Position auf der Rechnung (1, 2, 3...)</para>
3858 <term><varname>sellprice</varname></term>
3861 <para>Verkaufspreis</para>
3866 <term><varname>serialnumber</varname></term>
3869 <para>Seriennummer</para>
3874 <term><varname>tax_rate</varname></term>
3877 <para>Steuersatz</para>
3882 <term><varname>transdate_oe</varname></term>
3885 <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
3886 aus einem Sammelauftrag erstellt wurde</para>
3891 <term><varname>unit</varname></term>
3894 <para>Einheit</para>
3899 <term><varname>weight</varname></term>
3902 <para>Gewicht</para>
3907 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
3908 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
3909 einer <function>foreach</function>-Schleife ausgegeben werden, da
3910 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
3911 können. Die Variablen dafür lauten:</para>
3915 <term><varname>make</varname></term>
3918 <para>Lieferant</para>
3923 <term><varname>model</varname></term>
3926 <para>Lieferantenartikelnummer</para>
3932 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
3933 <title>Variablen für die einzelnen Zahlungseingänge</title>
3937 <term><varname>payment</varname></term>
3945 <term><varname>paymentaccount</varname></term>
3953 <term><varname>paymentdate</varname></term>
3961 <term><varname>paymentmemo</varname></term>
3969 <term><varname>paymentsource</varname></term>
3978 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
3979 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
3981 <para>Die vom Benutzer definierten Variablen für Kunden und
3982 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
3983 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
3984 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
3985 Variablennamen zusammen.</para>
3987 <para>Beispiel: Der Benutzer hat eine Variable namens
3988 <varname>number_of_employees</varname> definiert, die die Anzahl der
3989 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
3990 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
3995 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
3996 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
3998 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
3999 <title>Namen der Vorlagen</title>
4001 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
4002 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
4003 Erstellung einer Rechnung über die Mahngebühren und Zinsen
4004 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
4005 Vorlagenname für diese Mahnstufe mit dem Zusatz
4006 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
4007 für die ausgewählte Sprache und den ausgewählten Drucker
4011 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
4012 <title>Allgemeine Variablen in Mahnungen</title>
4014 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4015 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4016 Kunden stehen als Variablen <varname>name</varname>,
4017 <varname>street</varname>, <varname>zipcode</varname>,
4018 <varname>city</varname>, <varname>country</varname>,
4019 <varname>department_1</varname>, <varname>department_2</varname>,
4020 und <varname>email</varname> zur Verfügung.</para>
4022 <para>Weitere Variablen beinhalten:</para>
4026 <term><varname>dunning_date</varname></term>
4029 <para>Datum der Mahnung</para>
4034 <term><varname>dunning_duedate</varname></term>
4037 <para>Fälligkeitsdatum für diese Mahhnung</para>
4042 <term><varname>dunning_id</varname></term>
4045 <para>Mahnungsnummer</para>
4050 <term><varname>fee</varname></term>
4053 <para>Kummulative Mahngebühren</para>
4058 <term><varname>interest_rate</varname></term>
4061 <para>Zinssatz per anno in Prozent</para>
4066 <term><varname>total_amount</varname></term>
4069 <para>Gesamter noch zu zahlender Betrag als
4070 <function>fee</function> + <function>total_interest</function>
4071 + <function>total_open_amount</function></para>
4076 <term><varname>total_interest</varname></term>
4079 <para>Zinsen per anno über alle Rechnungen</para>
4084 <term><varname>total_open_amount</varname></term>
4087 <para>Summe über alle offene Beträge der Rechnungen</para>
4093 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
4094 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
4098 <term><varname>dn_amount</varname></term>
4101 <para>Rechnungssumme (brutto)</para>
4106 <term><varname>dn_duedate</varname></term>
4109 <para>Originales Fälligkeitsdatum der Rechnung</para>
4114 <term><varname>dn_dunning_date</varname></term>
4117 <para>Datum der Mahnung</para>
4122 <term><varname>dn_dunning_duedate</varname></term>
4125 <para>Fälligkeitsdatum der Mahnung</para>
4130 <term><varname>dn_fee</varname></term>
4133 <para>Kummulative Mahngebühr</para>
4138 <term><varname>dn_interest</varname></term>
4141 <para>Zinsen per anno für diese Rechnung</para>
4146 <term><varname>dn_invnumber</varname></term>
4149 <para>Rechnungsnummer</para>
4154 <term><varname>dn_linetotal</varname></term>
4157 <para>Noch zu zahlender Betrag (ergibt sich aus
4158 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
4159 + <varname>dn_interest</varname>)</para>
4164 <term><varname>dn_netamount</varname></term>
4167 <para>Rechnungssumme (netto)</para>
4172 <term><varname>dn_open_amount</varname></term>
4175 <para>Offener Rechnungsbetrag</para>
4180 <term><varname>dn_ordnumber</varname></term>
4183 <para>Bestellnummer</para>
4188 <term><varname>dn_transdate</varname></term>
4191 <para>Rechnungsdatum</para>
4196 <term><varname>dn_curr</varname></term>
4199 <para>Währung, in der die Rechnung erstellt wurde. (Die
4200 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
4206 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
4207 <title>Variablen in automatisch erzeugten Rechnungen über
4208 Mahngebühren</title>
4210 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4211 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4212 Kunden stehen als Variablen <varname>name</varname>,
4213 <varname>street</varname>, <varname>zipcode</varname>,
4214 <varname>city</varname>, <varname>country</varname>,
4215 <varname>department_1</varname>, <varname>department_2</varname>,
4216 und <varname>email</varname> zur Verfügung.</para>
4218 <para>Weitere Variablen beinhalten:</para>
4222 <term><varname>duedate</varname></term>
4225 <para>Fälligkeitsdatum der Rechnung</para>
4230 <term><varname>dunning_id</varname></term>
4233 <para>Mahnungsnummer</para>
4238 <term><varname>fee</varname></term>
4241 <para>Mahngebühren</para>
4246 <term><varname>interest</varname></term>
4254 <term><varname>invamount</varname></term>
4257 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
4258 <varname>interest</varname>)</para>
4263 <term><varname>invdate</varname></term>
4266 <para>Rechnungsdatum</para>
4271 <term><varname>invnumber</varname></term>
4274 <para>Rechnungsnummer</para>
4281 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
4282 <title>Variablen in anderen Vorlagen</title>
4285 <title>Einführung</title>
4287 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
4288 Rechnung. Allerdings heißen die Variablen, die mit
4289 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
4290 fangen sie mit <varname>quo</varname> für "quotation" an:
4291 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
4292 wiederum fangen sie mit <varname>ord</varname> für "order" an:
4293 <varname>ordnumber</varname> für Bestellnummer etc.</para>
4295 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
4296 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
4297 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
4298 Vorlage keine Bedeutung haben oder noch nicht belegt sein
4301 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
4302 in Rechnungen aufgeführt.</para>
4305 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
4306 <title>Angebote und Preisanfragen</title>
4310 <term><varname>quonumber</varname></term>
4313 <para>Angebots- bzw. Anfragenummer</para>
4318 <term><varname>reqdate</varname></term>
4321 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
4322 Preisanfragen)</para>
4327 <term><varname>transdate</varname></term>
4330 <para>Angebots- bzw. Anfragedatum</para>
4336 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
4337 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
4341 <term><varname>ordnumber</varname></term>
4344 <para>Auftragsnummer</para>
4349 <term><varname>reqdate</varname></term>
4352 <para>Lieferdatum</para>
4357 <term><varname>transdate</varname></term>
4360 <para>Auftragsdatum</para>
4366 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
4367 <title>Lieferscheine (Verkauf und Einkauf)</title>
4371 <term><varname>cusordnumber</varname></term>
4374 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
4375 des Lieferanten (im Einkauf)</para>
4380 <term><varname>donumber</varname></term>
4383 <para>Lieferscheinnummer</para>
4388 <term><varname>transdate</varname></term>
4391 <para>Lieferscheindatum</para>
4396 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
4397 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
4398 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
4399 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
4400 <function>foreach</function>-Schleife ausgegeben werden. Diese
4401 Variablen sind:</para>
4405 <term><varname>si_bin</varname></term>
4408 <para>Lagerplatz</para>
4413 <term><varname>si_chargenumber</varname></term>
4416 <para>Chargennummer</para>
4421 <term><varname>si_bestbefore</varname></term>
4424 <para>Mindesthaltbarkeit</para>
4429 <term><varname>si_number</varname></term>
4432 <para>Artikelnummer</para>
4437 <term><varname>si_qty</varname></term>
4440 <para>Anzahl bzw. Menge</para>
4445 <term><varname>si_runningnumber</varname></term>
4448 <para>Positionsnummer (1, 2, 3 etc)</para>
4453 <term><varname>si_unit</varname></term>
4456 <para>Einheit</para>
4461 <term><varname>si_warehouse</varname></term>
4470 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
4471 <title>Variablen für Sammelrechnung</title>
4475 <term><varname>c0total</varname></term>
4478 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
4484 <term><varname>c30total</varname></term>
4487 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
4488 und < 60 Tage</para>
4493 <term><varname>c60total</varname></term>
4496 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
4497 und < 90 Tage</para>
4502 <term><varname>c90total</varname></term>
4505 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
4511 <term><varname>total</varname></term>
4514 <para>Gesamtbetrag aller Rechnungen</para>
4519 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
4523 <term><varname>invnumber</varname></term>
4526 <para>Rechnungsnummer</para>
4531 <term><varname>invdate</varname></term>
4534 <para>Rechnungsdatum</para>
4539 <term><varname>duedate</varname></term>
4542 <para>Fälligkeitsdatum</para>
4547 <term><varname>amount</varname></term>
4550 <para>Summe der Rechnung</para>
4555 <term><varname>open</varname></term>
4558 <para>Noch offener Betrag der Rechnung</para>
4563 <term><varname>c0</varname></term>
4566 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4572 <term><varname>c30</varname></term>
4575 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4581 <term><varname>c60</varname></term>
4584 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4590 <term><varname>c90</varname></term>
4593 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4601 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4602 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4604 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4605 <title>Einfürhung</title>
4607 <para>Der Parser kennt neben den Variablen einige weitere
4608 Konstrukte, die gesondert behandelt werden. Diese sind wie
4609 Variablennamen in spezieller Weise markiert:
4610 <command><%anweisung%> ... <%end%></command></para>
4612 <para>Anmerkung zum <command><%end%></command>: Der besseren
4613 Verständlichkeit halber kann man nach dem <command>end</command>
4614 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4615 Anweisung (z.B. <command>if</command> oder
4616 <command>foreach</command>) damit abgeschlossen wird.</para>
4618 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4619 <command><%if type == "sales_quotation"%></command>, so könnte
4620 er mit <command><%end%></command> genauso abgeschlossen werden
4621 wie mit <command><%end if%></command> oder auch
4622 <command><%end type == "sales_quotation"%></command>.</para>
4625 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4626 <title>Der if-Block</title>
4628 <programlisting><%if variablenname%>
4630 <%end%></programlisting>
4632 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4633 und dem "end" werden nur ausgegeben, wenn die Variable
4634 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4636 <para>Handelt es sich bei der benannten Variable um ein Array, also um einen Variablennamen, über den man mit
4637 <command><%foreach variablenname%></command> iteriert, so wird mit diesem Konstrukt darauf getestet, ob das Array Elemente
4638 enthält. Somit würde im folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt ihrer Überschrift "Zahlungseingänge"
4639 ausgegeben, wenn tatsächlich welche getätigt wurden:</para>
4641 <programlisting><%if payment%>
4643 <%foreach payment%>
4644 Am <%paymentdate%>: <%payment%> €
4645 <%end foreach%>
4646 <%end if%></programlisting>
4648 <para>Die Bedingung kann auch negiert werden, indem das Wort
4649 <function>not</function> nach dem <filename>if</filename> verwendet
4650 wird. Beispiel:</para>
4652 <programlisting><%if not cp_greeting%>
4654 <%end%></programlisting>
4656 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4657 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4658 einer Variablen mit einer festen Zeichenkette oder einer anderen
4659 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4660 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4661 die rechte Seite des Vergleichsoperators in Anführungszeichen
4662 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4663 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4666 <programlisting><%if var1 == "Wert"%></programlisting>
4668 <para>Testet die Variable <varname>var1</varname> auf
4669 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4670 Mittels <function>!=</function> anstelle von <function>==</function>
4671 würde auf Ungleichheit getestet.</para>
4673 <programlisting><%if var1 == var2%></programlisting>
4675 <para>Testet die Variable <varname>var1</varname> auf
4676 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4677 <function>!=</function> anstelle von <function>==</function> würde
4678 auf Ungleichheit getestet.</para>
4680 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4681 auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
4682 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4683 dieselbe Syntax wie oben nur mit <function>=~</function> und
4684 <function>!~</function> als Vergleichsoperatoren.</para>
4686 <para>Beispiel für einen Test, ob die Variable
4687 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4688 <constant>schwierig</constant> enthält:</para>
4690 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4693 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4694 <title>Der foreach-Block</title>
4696 <programlisting><%foreach variablenname%>
4698 <%end%></programlisting>
4700 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4701 wie das Perl-Array der Variablen <varname>variablenname</varname>
4702 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4703 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4704 benutzt. In jedem Durchlauf werden die <link
4705 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4706 Variablen</link> jeweils auf den Wert für die aktuelle Position
4709 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
4711 <programlisting><%foreach number%>
4712 Position: <%runningnumber%>
4713 Anzahl: <%qty%>
4714 Artikelnummer: <%number%>
4715 Beschreibung: <%description%>
4717 <%end%></programlisting>
4719 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
4720 <function><%foreach%></function>-Block innerhalb einer
4721 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
4722 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
4723 Inhalt zwischen <function><%foreach%></function> und
4724 <function><%end%></function> wiederholt, nicht aber die
4725 komplette Zeile, in der er steht.</para>
4729 <sect2 id="dokumentenvorlagen-und-variablen.markup">
4730 <title>Markup-Code zur Textformatierung innerhalb von
4733 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
4734 anders formatiert haben möchte, so ist dies begrenzt möglich.
4735 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
4736 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
4737 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
4738 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
4739 (HTML oder PDF über LaTeX) umgesetzt.</para>
4741 <para>Die unterstützen Formatierungen sind:</para>
4745 <term><b>Text</b></term>
4748 <para>Text wird in Fettdruck gesetzt.</para>
4753 <term><i>Text</i></term>
4756 <para>Text wird kursiv gesetzt.</para>
4761 <term><u>Text</u></term>
4764 <para>Text wird unterstrichen.</para>
4769 <term><s>Text</s></term>
4772 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
4773 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
4778 <term><bullet></term>
4781 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
4787 <para>Der Befehl <command><bullet></command> funktioniert
4788 momentan auch nur in Latex-Vorlagen.</para>
4792 <sect1 id="excel-templates">
4793 <title>Excel-Vorlagen</title>
4795 <sect2 id="excel-templates.summary">
4796 <title>Zusammenfassung</title>
4798 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
4799 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
4803 <sect2 id="excel-templates.usage">
4804 <title>Bedienung</title>
4806 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
4807 werden. Die Konfigurationsoption heißt <varname>excel_templates =
4808 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
4810 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
4811 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
4812 werden. In den normalen Verkaufsmasken taucht nun
4813 <constant>Excel</constant> als auswählbares Format auf und kann von da
4814 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
4816 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
4817 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
4818 <filename>sales_quotation.xls</filename> gespeichert.</para>
4821 <sect2 id="excel-templates.syntax">
4822 <title>Variablensyntax</title>
4824 <para>Einfache Syntax:
4825 <command><<varname>></command></para>
4827 <para>Dabei sind <constant><<</constant> und
4828 <constant>>></constant> die Delimiter. Da Excel auf festen
4829 Breiten besteht, kann der Tag künstlich verlängert werden, indem
4830 weitere <constant><</constant> oder <constant>></constant>
4831 eingefügt werden. Der Tag muss nicht symmetrisch sein.
4834 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4836 <para>Um die Limitierung der festen Breite zu reduzieren, können
4837 weitere Variablen in einem Block interpoliert werden. Whitespace wird
4838 dazwishen dann erhalten. Beispiel:</para>
4840 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4842 <para>Die Variablen werden interpoliert, und linksbündig mit
4843 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
4844 lang, werden überzählige Zeichen abgeschnitten.</para>
4846 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
4847 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
4849 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4851 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
4852 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
4856 <sect2 id="excel-templates.limitations">
4857 <title>Einschränkungen</title>
4859 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
4860 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
4861 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
4862 Text zu ersetzen.</para>
4864 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
4865 <command><%if%></command> und
4866 <command><%foreach%></command> nicht vorhanden. Der Delimiter
4867 <constant><% %></constant> kommt in den Headerinformationen
4868 evtl. vor. Deshalb wurde auf den sichereren Delimiter
4869 <constant><<</constant> und <constant>>></constant>
4873 <sect1 id="features.warehouse">
4874 <title>Mandantenkonfiguration Lager</title>
4875 Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt:
4876 Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die Möglichkeit hier über den
4877 Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. Ferner kann
4878 jede Position eines Lieferscheins ein-, bzw. ausgelagert werden (Einkauf-, bzw. Verkauf).
4879 Es können beliebig viele Lager mit beliebig vielen Lagerplätzen abgebildet werden.
4880 Die Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder Einzelposition und
4881 das Auswählen dieser Position zu einem Lager mit Lagerplatz.
4882 Dieses Verfahren lässt sich schrittweise vereinfachen, je nachdem wie die Einstellungen in
4883 der Mandatenkonfiguration gesetzt werden.
4886 <para><option>Auslagern über Standardlagerplatz</option> Hier wird ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz)
4887 in dem Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über den Standardlagerplatz (konfigurierbar pro Ware) durchführt.
4891 <para><option>Auslagern ohne Bestandsprüfung</option>Das obige Auslagern schlägt fehl, wenn die entsprechende Menge für
4892 die Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit dieser Option
4893 erlauben. Hierfür muss ein entsprechender Lagerplatz (Fehlbestand, o.ä.) konfiguriert sein.</para>
4896 Zusätzliche Funktionshinweise:
4898 <listitem><para><option>Standard-Lagerplatz</option>Ist dieser konfiguriert, wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
4899 Stammdaten-> Waren / Dienstleistung / Erzeugnis verwendet.
4902 <listitem><para><option>Standard-Lagerplatz verwenden, falls keiner in Stammdaten definiert</option>Wird beim 'Auslagern über Standardlagerplatz'
4903 keine Standardlagerplatz zu der Ware gefunden, so wird mit dieser Option einfach der Standardlagerplatz verwendet.
4911 <title>Entwicklerdokumentation</title>
4913 <sect1 id="devel.globals" xreflabel="Globale Variablen">
4914 <title>Globale Variablen</title>
4917 <title>Wie sehen globale Variablen in Perl aus?</title>
4919 <para>Globale Variablen liegen in einem speziellen namespace namens
4920 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
4921 globs global und die meisten speziellen Variablen sind...
4924 <para>Daraus ergeben sich folgende Formen:</para>
4928 <term><literal>$main::form</literal></term>
4931 <para>expliziter Namespace "main"</para>
4936 <term><literal>$::form</literal></term>
4939 <para>impliziter Namespace "main"</para>
4944 <term><literal>open FILE, "file.txt"</literal></term>
4947 <para><varname>FILE</varname> ist global</para>
4952 <term><literal>$_</literal></term>
4955 <para>speziell</para>
4960 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
4961 Schlüsselwort wie "<function>global</function>", mit dem man
4962 importieren kann. <function>my</function>, <function>our</function>
4963 und <function>local</function> machen was anderes.</para>
4967 <term><literal>my $form</literal></term>
4970 <para>lexikalische Variable, gültig bis zum Ende des
4976 <term><literal>our $form</literal></term>
4979 <para><varname>$form</varname> referenziert ab hier
4980 <varname>$PACKAGE::form</varname>.</para>
4985 <term><literal>local $form</literal></term>
4988 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
4989 des scopes zurückgesetzt</para>
4996 <title>Warum sind globale Variablen ein Problem?</title>
4998 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
5000 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
5001 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
5002 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
5003 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
5004 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
5005 Datenbankverbindungen, weil die sehr lange zum Initialisieren
5008 <para>Das zweite Problem ist <function>strict</function>. Unter
5009 <function>strict</function> werden alle Variablen die nicht explizit
5010 mit <function>Package</function>, <function>my</function> oder
5011 <function>our</function> angegeben werden als Tippfehler angemarkert,
5012 dies hat, seit der Einführung, u.a. schon so manche langwierige
5013 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
5014 angegeben werden, werden die nicht geprüft, und somit kann sich
5015 schnell ein Tippfehler einschleichen.</para>
5019 <title>Kanonische globale Variablen</title>
5021 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
5022 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
5023 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
5024 umhergereicht werden.</para>
5026 <para>Diese Variablen sind im Moment die folgenden neun:</para>
5030 <para><varname>$::form</varname></para>
5034 <para><varname>%::myconfig</varname></para>
5038 <para><varname>$::locale</varname></para>
5042 <para><varname>$::lxdebug</varname></para>
5046 <para><varname>$::auth</varname></para>
5050 <para><varname>$::lx_office_conf</varname></para>
5054 <para><varname>$::instance_conf</varname></para>
5058 <para><varname>$::dispatcher</varname></para>
5062 <para><varname>$::request</varname></para>
5066 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
5067 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
5068 Eigenschaften (Konventionen):</para>
5071 <title>$::form</title>
5075 <para>Ist ein Objekt der Klasse
5076 "<classname>Form</classname>"</para>
5080 <para>Wird nach jedem Request gelöscht</para>
5084 <para>Muss auch in Tests und Konsolenscripts vorhanden
5089 <para>Enthält am Anfang eines Requests die Requestparameter vom
5094 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
5095 cachen, das wird aber momentan absichtlich zerstört</para>
5099 <para><varname>$::form</varname> wurde unter <productname>SQL
5100 Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
5101 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
5102 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
5103 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
5104 <function>IS->retrieve_customer()</function> in Sicherheit
5107 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
5108 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
5109 3552, Stand version 2.7beta), um dies hinterher wieder auf den
5110 richtigen Wert zu setzen:</para>
5112 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
5113 $::myconfig{numberformat} = $numberformat;
5114 # (...) div Berechnungen
5115 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
5117 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
5118 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
5119 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
5120 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
5121 Es geht ziemlich sicher etwas kaputt.</para>
5123 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
5124 in den <productname>Template::Toolkit</productname> Templates
5125 außerhalb der Controller: der Ausdruck <function>[% var
5126 %]</function> greift auf <varname>$::form->{var}</varname> zu.
5127 Unter Controllern ist der Standard Scope anders, da lautet der
5128 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
5129 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
5130 <function><%var%></function> zeigt auf
5131 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
5132 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
5135 <programlisting>[%- IF business %]
5136 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
5137 [%- END %]</programlisting>
5139 <para>Entweder wird hier dann $::form->{business} ausgewertet
5140 oder aber der Funktion
5141 <function>$form->parse_html_template</function> wird explizit
5142 noch ein zusätzlicher Hash übergeben, der dann auch in den
5143 (Web-)Templates zu Verfügung steht, bspw. so:</para>
5145 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
5147 <para>Innerhalb von Schleifen wird
5148 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
5149 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
5150 welches über alle Positionen eines Lieferscheins in Schleife
5153 <programlisting>for $i (1 .. $form->{rowcount}) {
5155 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
5156 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
5157 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
5163 <title>%::myconfig</title>
5167 <para>Das einzige Hash unter den globalen Variablen</para>
5171 <para>Wird spätestens benötigt wenn auf die Datenbank
5172 zugegriffen wird</para>
5176 <para>Wird bei jedem Request neu erstellt.</para>
5180 <para>Enthält die Userdaten des aktuellen Logins</para>
5184 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
5185 extern serialisiert werden, weil da auch der Datenbankzugriff
5186 für diesen user drinsteht.</para>
5190 <para>Enthält unter anderem Listenbegrenzung vclimit,
5191 Datumsformat dateformat und Nummernformat numberformat</para>
5195 <para>Enthält Datenbankzugriffinformationen</para>
5199 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
5200 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
5201 aktuellen Users entscheiden müssen, befragen
5202 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
5203 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
5204 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
5205 Informationen über den Benutzer die über die
5206 Administrator-Schnittstelle eingegeben wurden.</para>
5210 <title>$::locale</title>
5214 <para>Objekt der Klasse "Locale"</para>
5218 <para>Wird pro Request erstellt</para>
5222 <para>Muss auch für Tests und Scripte immer verfügbar
5227 <para>Cached intern über Requestgrenzen hinweg benutzte
5232 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
5233 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
5237 <title>$::lxdebug</title>
5241 <para>Objekt der Klasse "LXDebug"</para>
5245 <para>Wird global gecached</para>
5249 <para>Muss immer verfügbar sein, in nahezu allen
5254 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
5255 bereit, wie "<function>enter_sub</function>" und
5256 "<function>leave_sub</function>", mit denen in den alten Modulen ein
5257 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
5258 der man die Wallclockzeit seit Requeststart loggen kann, sowie
5259 "<function>message</function>" und "<function>dump</function>" mit
5260 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
5263 <para>Beispielsweise so:</para>
5265 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
5266 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
5270 <title>$::auth</title>
5274 <para>Objekt der Klasse "SL::Auth"</para>
5278 <para>Wird global gecached</para>
5282 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
5286 <para>Wird nach jedem Request resettet.</para>
5290 <para><varname>$::auth</varname> stellt Funktionen bereit um die
5291 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
5292 vom aktuellen User abhängen wird das Objekt aus
5293 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
5294 Request kurz resettet.</para>
5296 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten. Dessen Einstellungen können über
5297 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert ist ein Hash mit den Werten aus der Tabelle
5298 <literal>auth.clients</literal>.</para>
5302 <title>$::lx_office_conf</title>
5306 <para>Objekt der Klasse
5307 "<classname>SL::LxOfficeConf</classname>"</para>
5311 <para>Global gecached</para>
5315 <para>Repräsentation der
5316 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
5320 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
5321 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
5322 das Programm die Konfiguration ändern kann oder sollte.</para>
5324 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
5325 Debug- und Trace-Log-Datei wie folgt konfiguriert und
5328 <programlisting>[debug]
5329 file_name = /tmp/kivitendo-debug.log</programlisting>
5331 <para>ist der Key <varname>file</varname> im Programm als
5332 <varname>$::lx_office_conf->{debug}{file}</varname>
5336 <para>Zugriff auf die Konfiguration erfolgt im Moment über
5337 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
5342 <title>$::instance_conf</title>
5346 <para>Objekt der Klasse
5347 "<classname>SL::InstanceConfiguration</classname>"</para>
5351 <para>wird pro Request neu erstellt</para>
5355 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
5356 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
5357 ist hier eine Mandantendatenbank. Beispielsweise überprüft
5358 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
5359 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
5363 <title>$::dispatcher</title>
5367 <para>Objekt der Klasse
5368 "<varname>SL::Dispatcher</varname>"</para>
5372 <para>wird pro Serverprozess erstellt.</para>
5376 <para>enthält Informationen über die technische Verbindung zum
5381 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
5382 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
5383 Objekt untergebracht.</para>
5387 <title>$::request</title>
5391 <para>Hashref (evtl später Objekt)</para>
5395 <para>Wird pro Request neu initialisiert.</para>
5399 <para>Keine Unterstruktur garantiert.</para>
5403 <para><varname>$::request</varname> ist ein generischer Platz um
5404 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
5405 at a distance benutzt werden, sondern um lokales memoizing zu
5406 ermöglichen, das garantiert am Ende des Requests zerstört
5409 <para>Vieles von dem, was im moment in <varname>$::form</varname>
5410 liegt, sollte eigentlich hier liegen. Die groben
5411 Differentialkriterien sind:</para>
5415 <para>Kommt es vom User, und soll unverändert wieder an den
5416 User? Dann <varname>$::form</varname>, steht da eh schon</para>
5420 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
5421 Requests gebraucht werden? Dann
5422 <varname>$::request</varname></para>
5426 <para>Muss ich von anderen Teilen des Programms lesend drauf
5427 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
5428 Wrappermethode</para>
5435 <title>Ehemalige globale Variablen</title>
5437 <para>Die folgenden Variablen waren einmal im Programm, und wurden
5441 <title>$::cgi</title>
5445 <para>war nötig, weil cookie Methoden nicht als
5446 Klassenfunktionen funktionieren</para>
5450 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
5451 Klassennamespace gehalten wird und über Requestgrenzen
5456 <para>liegt jetzt unter
5457 <varname>$::request->{cgi}</varname></para>
5463 <title>$::all_units</title>
5467 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
5468 ein paar hundert mal pro Request eine Liste der Einheiten
5469 brauchen, und de als Parameter durch einen Riesenstack von
5470 Funktionen geschleift werden müssten.</para>
5474 <para>Liegt jetzt unter
5475 <varname>$::request->{cache}{all_units}</varname></para>
5480 <function>AM->retrieve_all_units()</function> gesetzt oder
5487 <title>%::called_subs</title>
5491 <para>wurde benutzt um callsub deep recursions
5496 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
5497 möglichen Rekursioenen darstellt, und da nie welche
5502 <para>komplette recursion protection wurde entfernt.</para>
5509 <sect1 id="devel.fcgi">
5510 <title>Entwicklung unter FastCGI</title>
5512 <sect2 id="devel.fcgi.general">
5513 <title>Allgemeines</title>
5515 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
5516 werden, muss der Webserver neu gestartet werden.</para>
5518 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
5519 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
5520 müssen folgende Aspekte beachtet werden.</para>
5523 <sect2 id="devel.fcgi.exiting">
5524 <title>Programmende und Ausnahmen</title>
5526 <para>Betrifft die Funktionen <function>warn</function>,
5527 <function>die</function>, <function>exit</function>,
5528 <function>carp</function> und <function>confess</function>.</para>
5530 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
5531 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
5532 am Laufen zu halten. Man kann mit <function>die</function>,
5533 <function>confess</function> oder <function>carp</function> Fehler
5534 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
5535 eigene <function>$::form-</function>error()> tut im Prinzip das
5536 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
5537 <function>exit</function> hingegen werden nicht abgefangen.
5538 <function>warn</function> wird direkt nach STDERR, also in Server Log
5539 eine Nachricht schreiben (sofern in der Konfiguration nicht die
5540 Warnungen in das kivitendo Log umgeleitet wurden), und
5541 <function>exit</function> wird die Ausführung beenden.</para>
5543 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
5544 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
5545 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
5546 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
5549 <sect2 id="devel.fcgi.globals">
5550 <title>Globale Variablen</title>
5552 <para>Um zu vermeiden, dass Informationen von einem Request in einen
5553 anderen gelangen, müssen alle globalen Variablen vor einem Request
5554 sauber initialisiert werden. Das ist besonders wichtig im
5555 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
5556 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
5559 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
5560 abgetrennten Block, der alle kanonischen globalen Variablen listet und
5561 erklärt. Bitte keine anderen einführen ohne das sauber zu
5562 dokumentieren.</para>
5564 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
5565 man sicher geht, dass man die richtige erwischt.</para>
5568 <sect2 id="devel.fcgi.performance">
5569 <title>Performance und Statistiken</title>
5571 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
5572 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
5573 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
5574 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
5575 sind es je nach Menge der definierten Variablen 1-2s. Ab der
5576 Moose/Rose::DB Version sind es 5-6s.</para>
5578 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
5579 den kritischen Pfaden, unter 0,15 sonst.</para>
5583 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
5584 <title>SQL-Upgradedateien</title>
5586 <sect2 id="db-upgrade-files.introduction"
5587 xreflabel="Einführung in die Datenbank-Upgradedateien">
5588 <title>Einführung</title>
5590 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte gesteuert, die sich im Verzeichnis <filename>sql/Pg-upgrade2</filename>
5591 befinden. In diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren, die neben den eigentlich auszuführenden SQL- oder
5592 Perl-Befehlen einige Kontrollinformationen enthält.</para>
5594 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten, sodass Datenbankscripte zwar in einer sicheren Reihenfolge
5595 ausgeführt werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt werden, wenn die Tabelle mit <literal>CREATE
5596 TABLE</literal> angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man keine Versionsnummern braucht.</para>
5598 <para>kivitendo merkt sich dabei, welches der Upgradescripte in <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
5599 führt diese nicht erneut aus. Dazu dient die Tabelle "<literal>schema_info</literal>", die bei der Anmeldung automatisch angelegt
5603 <sect2 id="db-upgrade-files.format"
5604 xreflabel="Format der Upgradedateien">
5605 <title>Format der Kontrollinformationen</title>
5607 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5608 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5609 hat dabei das folgende Format:</para>
5611 <para>Für SQL-Upgradedateien:</para>
5613 <programlisting>-- @key: value</programlisting>
5615 <para>Für Perl-Upgradedateien:</para>
5617 <programlisting># @key: value</programlisting>
5619 <para>Leerzeichen vor "<varname>value</varname>" werden
5622 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5626 <term><varname>tag</varname></term>
5629 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5630 Dieser "tag" kann von anderen Kontrolldateien in ihren
5631 Abhängigkeiten verwendet werden (Schlüsselwort
5632 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5633 in der Datenbank eingetragen wird.</para>
5635 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5636 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5638 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5639 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5640 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5646 <term><varname>charset</varname></term>
5649 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5650 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
5651 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte hingegen müssen immer in UTF-8 encodiert sein und sollten
5652 demnach auch ein "<literal>use utf8;</literal>" enthalten.</para>
5657 <term><varname>description</varname></term>
5660 <para>Benötigt. Eine Beschreibung, was in diesem Update
5661 passiert. Diese wird dem Benutzer beim eigentlichen
5662 Datenbankupdate angezeigt. Während der Tag in englisch gehalten
5663 sein sollte, sollte die Beschreibung auf Deutsch
5669 <term><varname>depends</varname></term>
5672 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5673 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
5674 dass die in dieser Liste aufgeführten Scripte bereits
5675 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5677 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5678 Script "b" existiert, das von Änderungen in "a" abhängt, und
5679 eine neue Kontrolldatei für "c" erstellt wird, die von
5680 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5681 Tag "b" als Abhängigkeit zu definieren.</para>
5683 <para>Es ist nicht erlaubt, sich selbst referenzierende
5684 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5685 und "c" -> "a").</para>
5690 <term><varname>priority</varname></term>
5693 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5694 der Scripte ausgeführt werden, die die gleichen
5695 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5696 der Wert 1000 benutzt.</para>
5698 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5699 "depends" benutzt werden. kivitendo sortiert die auszuführenden
5700 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5701 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5702 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5703 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5704 Priorität alphabetisch nach dem "tag".</para>
5709 <term><varname>ignore</varname></term>
5712 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
5713 Skript bei der Anmeldung ignoriert und entsprechend nicht
5720 <sect2 id="db-upgrade-files.format-perl-files" xreflabel="Format von Perl-Upgradedateien">
5721 <title>Format von in Perl geschriebenen Datenbankupgradescripten</title>
5723 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so ausgeführt sondern müssen sich an gewisse Konventionen
5724 halten. Dafür bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
5726 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse dar, die vom Elternobjekt
5727 "<literal>SL::DBUpgrade2::Base</literal>" erben und eine Funktion namens "<literal>run</literal>" zur Verfügung stellen muss. Das
5728 Script wird ausgeführt, indem eine Instanz dieser Klasse erzeugt und darauf die erwähnte "<literal>run</literal>" aufgerufen
5731 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert für "<literal>@tag</literal>" ableitet. Dabei werden alle
5732 Zeichen, die in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche ersetzt. Insgesamt sieht der Paketname wie folgt
5733 aus: "<literal>SL::DBUpgrade2::tag</literal>".</para>
5735 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
5736 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
5738 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie folgt aus:</para>
5740 <programlisting># @tag: beispiel-upgrade-file42
5741 # @description: Ein schönes Beispielscript
5742 # @depends: release_3_1_0
5743 package SL::DBUpgrade2::beispiel_upgrade_file42;
5748 use parent qw(SL::DBUpgrade2::Base);
5753 # hier Aktionen ausführen
5762 <sect2 id="db-upgrade-files.dbupgrade-tool"
5763 xreflabel="Hilfsscript dbupgrade2_tool.pl">
5764 <title>Hilfsscript dbupgrade2_tool.pl</title>
5766 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
5767 existiert ein Hilfsscript namens
5768 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
5769 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
5770 liest alle Datenbankupgradescripte aus dem Verzeichnis
5771 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
5772 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
5773 von der Kommandozeile überprüft werden können.</para>
5775 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
5776 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
5777 sich aber auch Informationen auf verschiedene Art ausgeben
5782 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
5783 --list</command>"</para>
5785 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
5786 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
5787 würde. Es werden neben der Listenposition der Tag, die
5788 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
5792 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
5793 --tree</command>"</para>
5795 <para>Listet alle Tags in Baumform basierend auf den
5796 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
5797 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
5798 beim übergeordneten Script als Abhängigkeit eingetragen
5802 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
5803 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
5804 --rtree</command>"</para>
5806 <para>Listet alle Tags in Baumform basierend auf den
5807 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
5808 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
5809 die das übergeordnete Script als Abhängigkeit eingetragen
5814 <para>Baumform mit Postscriptausgabe:
5815 "<command>./scripts/dbupgrade2_tool.pl
5816 --graphviz</command>"</para>
5818 <para>Benötigt das Tool "<command>graphviz</command>", um mit
5819 seiner Hilfe die <link
5820 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
5821 Baumform</link> in eine Postscriptdatei namens
5822 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
5823 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
5824 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
5825 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
5830 <para>Scripte, von denen kein anderes Script abhängt:
5831 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
5833 <para>Listet die Tags aller Scripte auf, von denen keine anderen
5834 Scripte abhängen.</para>
5840 <sect1 id="translations-languages" xreflabel="Translations and languages">
5841 <title>Translations and languages</title>
5843 <sect2 id="translations-languages.introduction"
5844 xreflabel="Introduction to translations and languages">
5845 <title>Introduction</title>
5848 <para>Dieser Abschnitt ist in Englisch geschrieben, um
5849 internationalen Übersetzern die Arbeit zu erleichtern.</para>
5852 <para>This section describes how localization packages in kivitendo
5853 are built. Currently the only language fully supported is German, and
5854 since most of the internal messages are held in English the English
5855 version is usable too.</para>
5857 <para>A stub version of French is included but not functunal at this
5861 <sect2 id="translations-languages.character-set"
5862 xreflabel="Character set">
5863 <title>Character set</title>
5865 <para>All files included in a language pack must use UTF-8 as their encoding.</para>
5868 <sect2 id="translations-languages.file-structure"
5869 xreflabel="File structure">
5870 <title>File structure</title>
5872 <para>The structure of locales in kivitendo is:</para>
5874 <programlisting>kivitendo/locale/<langcode>/</programlisting>
5876 <para>where <langcode> stands for an abbreviation of the
5877 language package. The builtin packages use two letter <ulink
5878 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
5879 but the actual name is not relevant for the program and can easily be
5881 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
5882 tags</ulink> (i.e. "en_GB"). In fact the original language packages
5883 from SQL Ledger are named in this way.</para>
5885 <para>In such a language directory the following files are
5890 <term>LANGUAGE</term>
5893 <para>This file is mandatory.</para>
5895 <para>The <filename>LANGUAGE</filename> file contains the self
5896 descripted name of the language. It should contain a native
5897 representation first, and in parenthesis an english translation
5898 after that. Example:</para>
5900 <programlisting>Deutsch (German)</programlisting>
5908 <para>This file is mandatory.</para>
5910 <para>The central translation file. It is essentially an inline
5911 Perl script autogenerated by <command>locales.pl</command>. To
5912 generate it, generate the directory and the two files mentioned
5913 above, and execute the following command:</para>
5915 <programlisting>scripts/locales.pl <langcode></programlisting>
5917 <para>Otherwise you can simply copy one of the other languages.
5918 You will be told how many are missing like this:</para>
5920 <programlisting>$ scripts/locales.pl en
5921 English - 0.6% - 2015/2028 missing</programlisting>
5923 <para>A file named "<filename>missing</filename>" will be
5924 generated and can be edited. You can also edit the
5925 "<filename>all</filename>" file directly. Edit everything you
5926 like to fit the target language and execute
5927 <command>locales.pl</command> again. See how the missing words
5933 <term>Num2text</term>
5936 <para>Legacy code from SQL Ledger. It provides a means for
5937 numbers to be converted into natural language, like
5938 <literal>1523 => one thousand five hundred twenty
5939 three</literal>. If you want to provide it, it must be inlinable
5940 Perl code which provides a <function>num2text</function> sub. If
5941 an <function>init</function> sub exists it will be executed
5944 <para>Only used in the check and receipt printing module.</para>
5949 <term>special_chars</term>
5952 <para>kivitendo comes with a lot of interfaces to different
5953 formats, some of which are rather picky with their accepted
5954 charset. The <filename>special_chars</filename> file contains a
5955 listing of chars not suited for different file format and
5956 provides substitutions. It is written in "Simple Ini" style,
5957 containing a block for every file format.</para>
5959 <para>First entry should be the order of substitution for
5960 entries as a whitespace separated list. All entries are
5961 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
5962 and <literal>\\</literal> all work.</para>
5964 <para>After that every entry is a special char that should be
5965 translated when writing text into such a file.</para>
5967 <para>Example:</para>
5969 <programlisting>[Template/XML]
5970 order=& < > \n
5974 \n=<br></programlisting>
5976 <para>Note the importance of the order in this example.
5977 Substituting < and > befor & would lead to $gt; become
5980 <para>For a list of valid formats, see the German
5981 <filename>special_chars</filename> entry. As of this writing the
5982 following are recognized:</para>
5984 <programlisting>HTML
5989 Template/OpenDocument
5990 filenames</programlisting>
5992 <para>The last of which is very machine dependant. Remember that
5993 a lot of characters are forbidden by some filesystems, for
5994 exmaple MS Windows doesn't like ':' in its files where Linux
5995 doesn't mind that. If you want the files created with your
5996 language pack to be portable, find all chars that could cause
6002 <term>missing</term>
6005 <para>This file is not a part of the language package
6008 <para>This is a file generated by
6009 <command>scripts/locales.pl</command> while processing your
6010 locales. It's only to have the missing entries singled out and
6011 does not belong to a language package.</para>
6019 <para>This file is not a part of the language package
6022 <para>Another file generated by
6023 <command>scripts/locales.pl</command>. If for any reason a
6024 translation does not appear anymore and can be deleted, it gets
6025 moved here. The last 50 or so entries deleted are saved here in
6026 case you made a typo, so that you don't have to translate
6027 everything again. If a tranlsation is missing, the lost file is
6028 checked first. If you maintain a language package, you might
6029 want to keep this safe somewhere.</para>
6036 <sect1 id="devel.testsuite">
6037 <title>Die kivitendo-Test-Suite</title>
6039 <sect2 id="devel.testsuite.intro">
6040 <title>Einführung</title>
6042 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul <literal>Test::More</literal>.</para>
6044 <para>Die grundlegenden Fakten sind:</para>
6047 <listitem><para>Alle Tests liegen im Unterverzeichnis <filename>t/</filename>.</para></listitem>
6049 <listitem><para>Ein Script (bzw. ein Test) in <filename>t/</filename> enthält einen oder mehrere Testfälle.</para></listitem>
6051 <listitem><para>Alle Dateinamen von Tests enden auf <literal>.t</literal>. Es sind selbstständig ausführbare Perl-Scripte.</para></listitem>
6053 <listitem><para>Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in <filename>t/</filename>, deren
6054 Dateiname auf <literal>.t</literal> endet.</para></listitem>
6058 <sect2 id="devel.testsuite.prerequisites">
6059 <title>Voraussetzungen</title>
6061 <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>
6064 <listitem><para><literal>Test::Deep</literal> (Debian-Paketname: <literal>libtest-deep-perl</literal>; Fedora Core:
6065 <literal>perl-Test-Deep</literal>; openSUSE: <literal>perl-Test-Deep</literal>)</para></listitem>
6066 <listitem><para><literal>Test::Exception</literal> (Debian-Paketname: <literal>libtest-exception-perl</literal>; Fedora Core:
6067 <literal>perl-Test-Exception</literal>; openSUSE: <literal>perl-Test-Exception</literal>)</para></listitem>
6068 <listitem><para><literal>Test::Output</literal> (Debian-Paketname: <literal>libtest-output-perl</literal>; Fedora Core:
6069 <literal>perl-Test-Output</literal>; openSUSE: <literal>perl-Test-Output</literal>)</para></listitem>
6070 <listitem><para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses Modul ist ab Perl 5.10.1 Bestandteil der
6071 Perl-Distribution und kann für frühere Versionen aus dem <ulink url="http://www.cpan.org">CPAN</ulink> bezogen
6072 werden.</para></listitem>
6073 <listitem><para><literal>LWP::Simple</literal> aus dem Paket <literal>libwww-perl</literal> (Debian-Panetname:
6074 <literal>libwww-perl</literal>; Fedora Core: <literal>perl-libwww-perl</literal>; openSUSE:
6075 <literal>perl-libwww-perl</literal>)</para></listitem>
6076 <listitem><para><literal>URI::Find</literal> (Debian-Panetname: <literal>liburi-find-perl</literal>; Fedora Core:
6077 <literal>perl-URI-Find</literal>; openSUSE: <literal>perl-URI-Find</literal>)</para></listitem>
6080 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
6081 müssen in der Konfigurationsdatei im Abschnit <literal>testing/database</literal> Datenbankverbindungsparameter angegeben
6082 werden. Der hier angegebene Benutzer muss weiterhin das Recht haben, Datenbanken anzulegen und zu löschen.</para>
6085 <sect2 id="devel.testsuite.execution">
6087 Existierende Tests ausführen
6090 <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
6091 gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript <filename>t/test.pl</filename>.</para>
6093 <para>Will man die komplette Test-Suite ausführen, so muss man einfach nur <filename>t/test.pl</filename> ohne weitere Parameter aus
6094 dem kivitendo-Basisverzeichnis heraus ausführen.</para>
6096 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an <filename>t/test.pl</filename>. Beispielsweise:</para>
6098 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
6102 <sect2 id="devel.testsuite.meaning_of_scripts">
6104 Bedeutung der verschiedenen Test-Scripte
6107 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch
6108 während der Entwicklung nützliche Tests sind:</para>
6111 <listitem><para><filename>t/001compile.t</filename> -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab</para></listitem>
6112 <listitem><para><filename>t/002goodperl.t</filename> -- überprüft alle Perl-Dateien auf Anwesenheit von '<literal>use strict</literal>'-Anweisungen</para></listitem>
6113 <listitem><para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von <function>system()</function> und <function>exec()</function> auf Gültigkeit</para></listitem>
6114 <listitem><para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien Tab-Zeichen enthalten</para></listitem>
6115 <listitem><para><filename>t/006spelling.t</filename> -- sucht nach häufigen Rechtschreibfehlern</para></listitem>
6116 <listitem><para><filename>t/011pod.t</filename> -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit</para></listitem>
6119 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module.</para>
6122 <sect2 id="devel.testsuite.create_new">
6124 Neue Test-Scripte erstellen
6127 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende
6128 Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden.</para>
6130 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
6132 Ideen für neue Test-Scripte, die keine konkreten Funktionen testen
6135 <para> Ideen, die abgesehen von Funktionen noch nicht umgesetzt wurden:</para>
6138 <listitem><para>Überprüfung auf fehlende symbolische Links</para></listitem>
6139 <listitem><para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten)</para></listitem>
6140 <listitem><para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para></listitem>
6141 <listitem><para>Überprüfung auf Leerzeichen am Ende von Zeilen</para></listitem>
6142 <listitem><para>Test, ob alle zu übersetzenden Strings in <filename>locale/de/all</filename> vorhanden sind</para></listitem>
6143 <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>
6147 <sect3 id="devel.testsuite.directory_and_test_names">
6149 Konvention für Verzeichnis- und Dateinamen
6152 <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>
6155 <listitem><para>Die Dateiendung muss <filename>.t</filename> lauten.</para></listitem>
6157 <listitem><para>Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise
6158 <filename>bad_function_params.t</filename>).</para></listitem>
6160 <listitem><para>Unterverzeichnisse sollten grob nach dem Themenbereich benannt sein, mit dem sich die Scripte darin befassen
6161 (beispielsweise <filename>background_jobs</filename> für Tests rund um Hintergrund-Jobs).</para></listitem>
6163 <listitem><para>Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist
6164 (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben.</para></listitem>
6168 <sect3 id="devel.testsuite.minimal_example">
6170 Minimales Skelett für eigene Scripte
6173 <para>Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden:</para>
6175 <programlisting>use Test::More tests => 0;
6179 use Support::TestSetup;
6181 Support::TestSetup::login();</programlisting>
6183 <para>Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie
6184 <varname>$::auth</varname>, <varname>$::form</varname> oder <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
6185 <filename>config/kivitendo.conf</filename> im Abschnitt <literal>testing.login</literal> ein gültiger Login-Name eingetragen
6186 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
6188 <para>Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile <code>Support::TestSetup::login();</code>
6189 weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.</para>
6194 <sect1 id="devel.style-guide">
6195 <title>Stil-Richtlinien</title>
6197 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
6198 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
6199 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
6200 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
6202 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
6205 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
6206 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
6211 <para>Es werden keine echten Tabs sondern Leerzeichen
6216 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
6218 <programlisting>foreach my $row (@data) {
6220 # do something with $row
6224 $row->{modules} = MODULE->retrieve(
6225 id => $row->{id},
6226 date => $use_now ? localtime() : $row->{time},
6230 $report->add($row);
6235 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
6236 Zeile wie der letzte Befehl. Beispiele:</para>
6238 <programlisting>sub debug {
6244 <programlisting>if ($form->{item_rows} > 0) {
6250 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
6251 der Befehl / die öffnende schließende Klammer, die den Block
6252 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
6253 Beispiele wie bei 3. gelten.</para>
6257 <para>Die Wörter "<function>else</function>",
6258 "<function>elsif</function>", "<function>while</function>" befinden
6259 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
6262 <programlisting>if ($form->{sum} > 1000) {
6264 } elsif ($form->{sum} > 0) {
6272 } until ($a > 0);</programlisting>
6276 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
6277 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
6278 und grep-ähnliche Operatoren. Beispiel:</para>
6280 <programlisting>$main::lxdebug->message("Could not find file.");
6281 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
6285 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
6287 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
6288 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
6289 Blöcke schon. Beispiel:</para>
6291 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
6296 $form->{sum} += $form->{"row_$i"};
6297 $form->{ $form->{index} } += 1;
6299 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
6303 <para>Mehrzeilige Befehle</para>
6307 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
6308 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
6309 werden, in der die ersten Funktionsparameter in der ersten Zeile
6310 stehen. Beispiel:</para>
6312 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
6313 $form->{some_col_value});</programlisting>
6317 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
6318 besten in einer übersichtlichen Tabellenstruktur organisiert
6319 wird. Beispiel:</para>
6321 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
6322 : $form->{oldcount} ? $form->{oldcount} + 1
6323 : $form->{rowcount} - $form->{rowbase};</programlisting>
6329 <para>Kommentare</para>
6333 <para>Kommentare, die alleine in einer Zeile stehen, sollten
6334 soweit wie der Code eingerückt sein.</para>
6338 <para>Seitliche hängende Kommentare sollten einheitlich
6339 formatiert werden.</para>
6343 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
6344 auf Englisch zu verfassen. So wie ich keine Lust habe,
6345 französischen Quelltext zu lesen, sollte auch der kivitendo
6346 Quelltext für nicht-Deutschsprachige lesbar sein.
6349 <programlisting>my $found = 0;
6357 $i = 0 # initialize $i
6359 $i *= $const; # do something crazy
6360 $i = $n; # recover $i</programlisting>
6366 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
6367 Interpolation gewünscht ist. Beispiel:</para>
6369 <programlisting>$form->{sum} = 0;
6370 $form->{"row_$i"} = $form->{"row_$i"} - 5;
6371 $some_hash{42} = 54;</programlisting>
6375 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
6376 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
6377 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
6378 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
6380 <para>Als Beispiel sei die Funktion
6381 <function>print_options</function> aus
6382 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
6386 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
6387 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
6390 <para>Emacs und vim haben beide recht einfache Methoden zur
6391 Entfernung von trailing whitespace. Emacs kennt das Kommande
6392 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
6393 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
6394 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
6399 <para>Es wird kein <command>perltidy</command> verwendet.</para>
6401 <para>In der Vergangenheit wurde versucht,
6402 <command>perltidy</command> zu verwenden, um einen einheitlichen
6403 Stil zu erlangen. Es hat sich aber gezeigt, dass
6404 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
6405 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
6406 den Interessierten sind hier die
6407 <command>perltidy</command>-Optionen, die grob den beschriebenen
6408 Richtlinien entsprechen:</para>
6410 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
6411 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
6412 -lp -vt=1 -vtc=1</programlisting>
6416 <para><varname>STDERR</varname> ist tabu. Unkonditionale
6417 Debugmeldungen auch.</para>
6419 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
6420 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
6421 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
6423 <para>Die <classname>LXDebug</classname>-Methode
6424 "<function>message</function>" nimmt als ersten Paramter außerdem
6425 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
6426 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
6427 und werden in den meisten Fällen auch vom Repository
6428 zurückgewiesen.</para>
6432 <para>Alle neuen Module müssen use strict verwenden.</para>
6434 <para><varname>$form</varname>, <varname>$auth</varname>,
6435 <varname>$locale</varname>, <varname>$lxdebug</varname> und
6436 <varname>%myconfig</varname> werden derzeit aus dem main package
6437 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
6438 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
6443 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
6444 <title>Dokumentation erstellen</title>
6446 <sect2 id="devel.build-doc.introduction">
6447 <title>Einführung</title>
6449 <para>Diese Dokumentation ist in <productname>DocBook</productname>
6450 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
6451 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
6452 Editor nutzt, der spezielle Unterstützung für
6453 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
6454 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
6455 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
6459 <sect2 id="devel.build-doc.required-software">
6460 <title>Benötigte Software</title>
6462 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
6463 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
6464 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
6465 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
6466 <command>scripts/build_doc.sh</command>.</para>
6468 <para>Das Script benötigt zur Konvertierung verschiedene
6469 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
6475 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
6476 in einer halbwegs aktuellen Version</para>
6480 <para>Das Java-Build-System <ulink
6481 url="http://ant.apache.org/">Apache Ant</ulink></para>
6485 <para>Das Dokumentations-System Dobudish für
6486 <productname>DocBook</productname> 4.5, eine Zusammenstellung
6487 diverser Stylesheets und Grafiken zur Konvertierung von
6488 <productname>DocBook</productname> XML in andere Formate. Das
6489 Paket, das benötigt wird, ist zum Zeitpunkt der
6490 Dokumentationserstellung
6491 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
6492 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
6497 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
6498 sind auf allen gängigen Plattformen verfügbar. Beispiel für
6499 Debian/Ubuntu:</para>
6501 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
6503 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
6504 <filename>doc/build</filename> entpackt werden. Beispiel unter der
6505 Annahme, das <productname>Dobudish</productname> in
6506 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
6508 <programlisting>cd doc/build
6509 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
6512 <sect2 id="devel.build-doc.build">
6513 <title>PDFs und HTML-Seiten erstellen</title>
6515 <para>Die eigentliche Konvertierung erfolgt nach Installation der
6516 benötigten Software mit einem einfachen Aufruf direkt aus dem
6517 kivitendo-Installationsverzeichnis heraus:</para>
6519 <programlisting>./scripts/build_doc.sh</programlisting>
6522 <sect2 id="devel.build-doc.repository">
6523 <title>Einchecken in das Git-Repository</title>
6525 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
6526 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
6527 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
6528 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
6530 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
6531 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob