1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <book id="kivitendo-documentation" lang="de">
5 <title>kivitendo 3.1.0: Installation, Konfiguration, Entwicklung</title>
7 <chapter id="Aktuelle-Hinweise">
8 <title>Aktuelle Hinweise</title>
10 <para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>
14 <para>im kivitendo-Forum: <ulink
15 url="https://forum.kivitendo.org/">https://forum.kivitendo.org/</ulink></para>
18 <para>in der doc/UPGRADE Datei im doc-Verzeichnis der Installation</para>
21 <para>Im Schulungs- und Dienstleistungsangebot der entsprechenden kivitendo-Partner: <ulink
22 url="http://www.kivitendo.de/partner.html">http://www.kivitendo.de/partner.html</ulink></para>
28 <title>Installation und Grundkonfiguration</title>
30 <sect1 id="Installation-Übersicht">
31 <title>Übersicht</title>
34 Die Installation von kivitendo umfasst mehrere Schritte. Die folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
35 Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit minimalen Features möglichst schnell zum Laufen zu kriegen.
39 <listitem><para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo benötigt gewisse Ressourcen und benutzt weitere
40 Programme. Das Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert diese. Auch die Liste der benötigten Perl-Module
41 befindet sich hier.</para></listitem>
43 <listitem><para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst die "<xref
44 linkend="Manuelle-Installation-des-Programmpaketes"/>" sowie grundlegende Einstellungen, die der "<xref
45 linkend="config.config-file"/>" erläutert.</para></listitem>
47 <listitem><para><emphasis>Konfiguration externer Programme</emphasis>: hierzu gehören die Datenbank ("<xref
48 linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der Webserver ("<xref
49 linkend="Apache-Konfiguration"/>"). </para></listitem>
51 <listitem><para><emphasis>Benutzerinformationen speichern können</emphasis>: man benötigt mindestens eine Datenbank, in der
52 Informationen zur Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man das als Administrator macht, verrät "<xref
53 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para></listitem>
55 <listitem><para><emphasis>Benutzer, Gruppen und Datenbanken anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
56 linkend="Benutzer--und-Gruppenverwaltung"/>".</para></listitem>
58 <listitem><para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann kann es losgehen: "<xref
59 linkend="kivitendo-ERP-verwenden"/>"</para></listitem>
63 Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen
68 <sect1 id="Benötigte-Software-und-Pakete">
69 <title>Benötigte Software und Pakete</title>
71 <sect2 id="Betriebssystem">
72 <title>Betriebssystem</title>
74 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
75 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
76 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
77 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
78 ohne große Probleme auf den derzeit aktuellen verbreiteten
79 Distributionen läuft.</para>
81 <para>Anfang 2014 sind das folgende Systeme, von denen bekannt ist,
82 dass kivitendo auf ihnen läuft:</para>
90 <para>6.0 "Squeeze" (hier muss allerdings das Modul FCGI in der Version >= 0.72 compiled werden, und <literal>Rose::DB::Object</literal> ist zu alt)</para>
93 <para>7.0 "Wheezy"</para>
99 <para>Ubuntu 12.04 LTS "Precise Pangolin", 12.10 "Quantal Quetzal", 13.04 "Precise Pangolin" und 14.04 "Trusty Tahr" LTS Alpha</para>
103 <para>openSUSE 12.2, 12.3 und 13.1</para>
107 <para>SuSE Linux Enterprice Server 11</para>
111 <para>Fedora 16 bis 19</para>
116 <sect2 id="Pakete" xreflabel="Pakete">
117 <title>Benötigte Perl-Pakete installieren</title>
119 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
120 Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.4)
123 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht Bestandteil einer Standard-Perl-Installation sind. Um zu
124 überprüfen, ob die erforderlichen Pakete installiert und aktuell genug sind, wird ein Script mitgeliefert, das wie folgt aufgerufen
127 <programlisting>./scripts/installation_check.pl</programlisting>
129 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
132 <listitem><para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para></listitem>
134 <listitem><para><literal>Archive::Zip</literal></para></listitem>
136 <listitem><para><literal>Config::Std</literal></para></listitem>
138 <listitem><para><literal>DateTime</literal></para></listitem>
140 <listitem><para><literal>DBI</literal></para></listitem>
142 <listitem><para><literal>DBD::Pg</literal></para></listitem>
144 <listitem><para><literal>Email::Address</literal></para></listitem>
146 <listitem><para><literal>Email::MIME</literal></para></listitem>
148 <listitem><para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71 inklusive; siehe <xref linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para></listitem>
150 <listitem><para><literal>File::Copy::Recursive</literal></para></listitem>
152 <listitem><para><literal>JSON</literal></para></listitem>
154 <listitem><para><literal>List::MoreUtils</literal></para></listitem>
156 <listitem><para><literal>Net::SMTP::SSL</literal> (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "<xref
157 linkend="config.sending-email.smtp"/>")</para></listitem>
159 <listitem><para><literal>Net::SSLGlue</literal> (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "<xref
160 linkend="config.sending-email.smtp"/>")</para></listitem>
162 <listitem><para><literal>Params::Validate</literal></para></listitem>
164 <listitem><para><literal>PDF::API2</literal></para></listitem>
166 <listitem><para><literal>Rose::Object</literal></para></listitem>
168 <listitem><para><literal>Rose::DB</literal></para></listitem>
170 <listitem><para><literal>Rose::DB::Object</literal> Version 0.788 oder neuer</para></listitem>
172 <listitem><para><literal>Template</literal></para></listitem>
174 <listitem><para><literal>Text::CSV_XS</literal></para></listitem>
176 <listitem><para><literal>Text::Iconv</literal></para></listitem>
178 <listitem><para><literal>URI</literal></para></listitem>
180 <listitem><para><literal>XML::Writer</literal></para></listitem>
182 <listitem><para><literal>YAML</literal></para></listitem>
185 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen: <literal>File::Copy::Recursive</literal>.</para>
187 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen: <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
188 <literal>Net::SSLGlue</literal>.</para>
190 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
191 hinzugekommen, <literal>URI</literal> und
192 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
195 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
196 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
197 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
198 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
200 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
201 hinzugekommen.</para>
203 <para><literal>Email::Address</literal> und
204 <literal>List::MoreUtils</literal> sind schon länger feste
205 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
206 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
207 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
208 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
212 <title>Debian und Ubuntu</title>
214 <para>Alle benötigten Perl-Pakete stehen für Debian und Ubuntu als Debian-Pakete zur Verfügung. Sie können mit folgendem Befehl
215 installiert werden:</para>
217 <programlisting>apt-get install apache2 libarchive-zip-perl libclone-perl \
218 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
219 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
220 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
221 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
222 librose-db-perl librose-object-perl libsort-naturally-perl \
223 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
224 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
225 libfile-copy-recursive-perl postgresql</programlisting>
229 <title>Fedora Core</title>
231 <para>Für Fedora Core stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl installeirt werden:</para>
233 <programlisting>yum install httpd perl-Archive-Zip perl-Clone perl-DBD-Pg \
234 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
235 perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
236 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
237 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
238 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
239 perl-XML-Writer perl-YAML perl-parent postgresql-server</programlisting>
241 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
243 <programlisting>yum install perl-CPAN
244 cpan Config::Std</programlisting>
249 <title>openSUSE</title>
251 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
252 installiert werden:</para>
254 <programlisting>zypper install apache2 perl-Archive-Zip perl-Clone \
255 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
256 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
257 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
258 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
259 perl-URI perl-XML-Writer perl-YAML postgresql-server</programlisting>
261 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
263 <programlisting>yum install perl-CPAN
264 cpan Rose::Db::Object</programlisting>
270 <sect1 id="Manuelle-Installation-des-Programmpaketes"
271 xreflabel="Manuelle Installation des Programmpaketes">
272 <title>Manuelle Installation des Programmpaketes</title>
273 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github gehostet und kann
274 <ulink url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink> heruntergeladen werden.</para>
275 <para>Die kivitendo ERP Installationsdatei (<filename>kivitendo-erp-3.1.0.tgz</filename>) wird im Dokumentenverzeichnis des Webservers
276 (z.B. <filename>/var/www/html/</filename>, <filename>/srv/www/htdocs</filename> oder <filename>/var/www/</filename>) entpackt:</para>
278 <programlisting>cd /var/www
279 tar xvzf kivitendo-erp-3.1.0.tgz</programlisting>
281 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
283 <programlisting>cd kivitendo-erp</programlisting>
285 <para>Alternativ können Sie auch einen Alias in der
286 Webserverkonfiguration benutzen, um auf das tatsächliche
287 Installationsverzeichnis zu verweisen.</para>
289 <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
290 beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
291 Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
292 core <constant>apache</constant> oder bei OpenSUSE <constant>wwwrun</constant>).</para>
294 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
295 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
297 <programlisting>chown -R www-data users spool webdav</programlisting>
299 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
300 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>
302 <programlisting>chown www-data templates users</programlisting>
305 <sect1 id="config.config-file">
306 <title>kivitendo-Konfigurationsdatei</title>
308 <sect2 id="config.config-file.introduction"
309 xreflabel="Einführung in die Konfigurationsdatei">
310 <title>Einführung</title>
312 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei,
313 die benötigt wird: <filename>config/kivitendo.conf</filename> (kurz:
314 "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
315 von kivitendo bzw. der Migration von älteren Versionen angelegt
318 <para>Als Vorlage dient die Datei
319 <filename>config/kivitendo.conf.default</filename> (kurz: "die
320 Default-Datei"):</para>
322 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
324 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
325 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
326 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
327 Abschnitte und Werte enthalten, die von denen der Default-Datei
332 Vor der Umbenennung in kivitendo hieß diese Datei noch <filename>config/lx_office.conf</filename>. Aus Gründen der Kompatibilität
333 wird diese Datei eingelesen, sofern die Datei <filename>config/kivitendo.conf</filename> nicht existiert.
337 <para>Diese Hauptkonfigurationsdatei ist dann eine
338 installationsspezifische Datei, d.h. sie enthält bspw. lokale
339 Passwörter und wird auch nicht im Versionsmanagement (git)
342 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
343 Mandaten, bzw. Datenbanken gleich.</para>
346 <sect2 id="config.config-file.sections-parameters">
347 <title>Abschnitte und Parameter</title>
349 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
350 entsprechend kommentiert sind:</para>
353 <listitem><para><literal>authentication</literal> (siehe Abschnitt "<xref
354 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>" in diesem Kapitel)</para></listitem>
356 <listitem><para><literal>authentication/database</literal></para></listitem>
358 <listitem><para><literal>authentication/ldap</literal></para></listitem>
360 <listitem><para><literal>system</literal></para></listitem>
362 <listitem><para><literal>paths</literal></para></listitem>
364 <listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>
366 <listitem><para><literal>applications</literal></para></listitem>
368 <listitem><para><literal>environment</literal></para></listitem>
371 <listitem><para><literal>print_templates</literal></para></listitem>
373 <listitem><para><literal>task_server</literal></para></listitem>
375 <listitem><para><literal>periodic_invoices</literal></para></listitem>
377 <listitem><para><literal>self_tests</literal></para></listitem>
379 <listitem><para><literal>console</literal></para></listitem>
381 <listitem><para><literal>testing</literal></para></listitem>
383 <listitem><para><literal>testing/database</literal></para></listitem>
385 <listitem><para><literal>debug</literal></para></listitem>
388 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
389 einzustellen oder zu kontrollieren sind, sind:</para>
391 <programlisting>[authentication]
392 admin_password = geheim
394 [authentication/database]
399 password =</programlisting>
401 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
402 <varname>[periodic_invoices]</varname> den Login eines Benutzers
403 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
404 mit Informationen über die erstellten Rechnungen bekommt.</para>
406 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten Ausführung bestimmter Aufgaben mit, den <link
407 linkend="config.task-server">Taskserver</link>. Er wird u.a. für Features wie die <link
408 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link> benötigt, erledigt aber auch andere erforderliche Aufgaben
409 und muss daher in Betrieb genommen werden. Der Taskserver benötigt zwei Konfigurationseinstellungen, die unter
410 <varname>[task_server]</varname> anzugeben sind: ein Mandant (entweder der Mandantenname oder eine Datenbank-ID, Variable
411 <varname>client</varname>), aus dem die Datenbankkonfiguration entnommen wird, sowie ein Login (Variable <varname>login</varname>)
412 eines Benutzers, der für gewisse Dinge wie die Rechnungserstellung als Verkäufer eingetragen wird.</para>
414 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
415 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
418 <sect2 id="config.config-file.prior-versions">
419 <title>Versionen vor 2.6.3</title>
421 <para>In älteren kivitendo Versionen gab es im Verzeichnis
422 <filename>config</filename> die Dateien
423 <filename>authentication.pl</filename> und
424 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
425 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
426 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
427 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
429 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
430 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
431 manuell übertragen und die alten Konfigurationsdateien anschließend
432 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
433 entsprechende Fehlermeldung an.</para>
437 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
438 <title>Anpassung der PostgreSQL-Konfiguration</title>
440 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
442 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
443 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
445 <para>kivitendo setzt zwingend voraus, dass die Datenbank Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen Serverinstallationen
446 braucht man hier meist nicht einzugreifen.</para>
448 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so
449 braucht man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
451 <programlisting>su postgres
453 exit </programlisting>
455 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
456 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
457 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
460 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
462 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
463 Versionsnummer angepasst werden.</para>
465 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
467 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
468 <literal>\l</literal> geprüft werden.</para>
471 <sect2 id="Änderungen-an-Konfigurationsdateien">
472 <title>Änderungen an Konfigurationsdateien</title>
474 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
475 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
476 <filename>/var/lib/pgsql/data/</filename> oder
477 <filename>/etc/postgresql/</filename>, muss sichergestellt werden,
478 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
479 Parameter <varname>listen_address</varname> gesteuert. Laufen
480 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
481 <literal>localhost</literal> verwendet werden. Andernfalls müssen
482 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
483 was mit dem Wert <literal>*</literal> geschieht.</para>
485 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
486 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
487 sein sollte, müssen die Berichtigungen für den Zugriff geändert
488 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
489 nögiten Verbindungen immer zuzulassen, für eine lokal laufenden
490 Datenbank zum Beispiel:</para>
492 <programlisting>local all kivitendo password
493 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
496 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
497 <title>Erweiterung für servergespeicherte Prozeduren</title>
499 <para>In der Datenbank <literal>template1</literal> muss die
500 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
501 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
502 <programlisting>su - postgres
503 psql template1</programlisting>
505 führen Sie die folgenden Kommandos aus:</para>
507 <programlisting>create language 'plpgsql';
511 <sect2 id="Datenbankbenutzer-anlegen">
512 <title>Datenbankbenutzer anlegen</title>
514 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
515 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
516 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
519 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit nein
520 beantworten, genauso ist die Berechtigung neue User (Roles) zu
521 generieren nicht nötig.</para>
522 <programlisting>su - postgres
523 createuser -d -P kivitendo
524 exit</programlisting>
526 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
527 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.
528 den hier gewählten Benutzernamen.</para>
532 <sect1 id="Apache-Konfiguration">
533 <title>Webserver-Konfiguration</title>
536 <title>Grundkonfiguration mittels CGI</title>
539 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
540 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
541 <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
544 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
545 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
546 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
547 anderen Datei hinzu, die beim Starten des Webservers eingelesen
550 <programlisting>AddHandler cgi-script .pl
551 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
553 <Directory /var/www/kivitendo-erp>
554 Options ExecCGI Includes FollowSymlinks
557 <Directory /var/www/kivitendo-erp/users>
560 </Directory></programlisting>
562 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
563 das kivitendo-Archiv entpacket haben.</para>
566 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
567 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
570 <para>Auf einigen Webservern werden manchmal die Grafiken und
571 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
572 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
574 <programlisting>EnableSendfile Off</programlisting>
577 <sect2 id="Apache-Konfiguration.FCGI"
578 xreflabel="Konfiguration für FastCGI/FCGI">
579 <title>Konfiguration für FastCGI/FCGI</title>
581 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
582 <title>Was ist FastCGI?</title>
584 <para>Direkt aus <ulink
585 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
588 <para><citation> FastCGI ist ein Standard für die Einbindung
589 externer Software zur Generierung dynamischer Webseiten in einem
590 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
591 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
592 umgehen. </citation></para>
595 <sect3 id="Apache-Konfiguration.FCGI.Warum">
596 <title>Warum FastCGI?</title>
598 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
599 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
600 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
601 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
602 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
603 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
604 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
605 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
606 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
607 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
608 deutlich länger dauert als früher, und dass davon 90% für das Laden
609 der Module verwendet wird.</para>
611 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
612 wird nur die eigentliche Programmlogik ausgeführt.</para>
615 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
616 <title>Getestete Kombinationen aus Webservern und Plugin</title>
618 <para>Folgende Kombinationen sind getestet:</para>
622 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
626 <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
630 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
631 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
632 mod_fastcgi nicht mehr explizit eingegangen.</para>
634 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
638 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern
639 bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrere Installation gibt, muss zwingend Version 0.68 oder
640 aber Version 0.72 und neuer eingesetzt werden.</para>
642 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie sich die Vorgängerversion wie folgt
645 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
649 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
650 <title>Konfiguration des Webservers</title>
652 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
653 laufen zu lassen, empfliehlt es sich die Installation ersteinmal
654 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
655 debuggen die beim ersten aufsetzen auftreten können. Sollte die
656 Installation schon funktionieren, lesen Sie weiter.</para>
658 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
659 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
661 <programlisting>a2enmod fcgid</programlisting>
663 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
664 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
665 und <function>Directory</function>-Direktiven. Dabei wird zwischen
666 dem Installationspfad von kivitendo im Dateisystem
667 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
668 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
669 ("<filename>/url/for/kivitendo-erp</filename>").</para>
671 <para>Folgender Konfigurationsschnipsel funktioniert mit
674 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
675 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
677 <Directory /path/to/kivitendo-erp>
679 Options ExecCGI Includes FollowSymlinks
684 <DirectoryMatch /path/to/kivitendo-erp/users>
687 </DirectoryMatch></programlisting>
689 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
690 die maximale Größe eines Requests. Diese sollte wie folgt
691 hochgesetzt werden:</para>
693 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
695 <para>Das ganze sollte dann so aussehen:</para>
697 <programlisting>AddHandler fcgid-script .fpl
698 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
699 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
700 FcgidMaxRequestLen 10485760
702 <Directory /path/to/kivitendo-erp>
704 Options ExecCGI Includes FollowSymlinks
709 <DirectoryMatch /path/to/kivitendo-erp/users>
712 </DirectoryMatch></programlisting>
714 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
715 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
716 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
717 gibt es hier kleine Performance-Einbußen.</para>
719 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
720 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
721 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
723 <programlisting># Zugriff über CGI
724 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
726 # Zugriff mit mod_fcgid:
727 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
728 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
730 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
731 die normale Version erreichbar, und unter
732 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
733 FastCGI-Version.</para>
738 <sect1 id="config.task-server">
739 <title>Der Task-Server</title>
741 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und
742 diese zu festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess wird u.a. für die Erzeugung der wiederkehrenden
743 Rechnungen und weitere essenzielle Aufgaben benutzt.</para>
745 <sect2 id="Konfiguration-des-Task-Servers">
746 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
748 <para>Die Konfiguration erfolgt über den Abschnitt
749 <literal>[task_server]</literal> in der Datei
750 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
751 Optionen sind:</para>
755 <term><varname>client</varname></term>
758 <para>Name oder Datenbank-ID eines vorhandenen kivitendo-Mandanten, der benutzt wird, um die zu verwendende
759 Datenbankverbindung auszulesen. Der Mandant muss in der Administration angelegt werden. Diese Option muss angegeben
762 <para>Diese Option kam mit Release v3.x.0 hinzu und muss daher in Konfigurationen, die von älteren Versionen aktualisiert
763 wurden, ergänzt werden.</para>
768 <term><varname>login</varname></term>
771 <para>gültiger kivitendo-Benutzername, der z.B. als Verkäufer beim Erzeugen wiederkehrender Rechnungen benötigt wird. Der
772 Benutzer muss in der Administration angelegt werden. Diese Option muss angegeben werden.</para>
777 <term><varname>run_as</varname></term>
780 <para>Wird der Server vom Systembenutzer <literal>root</literal>
781 gestartet, so wechselt er auf den mit <literal>run_as</literal>
782 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
783 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
785 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
786 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
787 unter dem auch der Webserver läuft.</para>
792 <term><varname>debug</varname></term>
795 <para>Schaltet Debug-Informationen an und aus.</para>
801 <sect2 id="Einbinden-in-den-Boot-Prozess">
802 <title>Automatisches Starten des Task-Servers beim Booten</title>
804 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
805 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
806 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
808 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
809 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
810 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
811 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
812 anstelle eines symbolischen Links verwendet werden können.</para>
815 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, ältere Fedora Core)</title>
817 <para>Kopieren Sie die Datei
818 <filename>scripts/boot/system-v/kivitendo-server</filename>
819 nach <filename>/etc/init.d/kivitendo-server</filename>. Passen
820 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
821 <literal>DAEMON=....</literal>). Binden Sie das Script in den
822 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
826 <para>Debian-basierende Systeme:</para>
828 <programlisting>update-rc.d kivitendo-task-server defaults
829 # Nur bei Debian Squeeze und neuer:
830 insserv kivitendo-task-server</programlisting>
834 <para>Ältere OpenSUSE und ältere Fedora Core:</para>
836 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
840 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
843 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
847 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
849 <para>Kopieren Sie die Datei
850 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
851 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
852 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
853 <literal>exec ....</literal>).</para>
855 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
858 <programlisting>service kivitendo-task-server start</programlisting>
862 <title>systemd-basierende Systeme (z.B. neure OpenSUSE, neuere Fedora Core)</title>
864 <para>Verlinken Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
865 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
866 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>). Binden Sie das Script in den Boot-Prozess ein.
869 <para>Alle hierzu benötigten Befehle sehen so aus:</para>
871 <programlisting>cd /var/www/kivitendo-erp/scripts/boot/systemd
872 ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
874 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
877 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
881 <sect2 id="Prozesskontrolle">
882 <title>Wie der Task-Server gestartet und beendet wird</title>
884 <para>Der Task-Server wird wie folgt kontrolliert:</para>
886 <programlisting>./scripts/task_server.pl Befehl</programlisting>
888 <para><literal>Befehl</literal> ist dabei eine der folgenden
893 <para><literal>start</literal> startet eine neue Instanz des
894 Task-Servers. Die Prozess-ID wird innerhalb des
895 <filename>users</filename>-Verzeichnisses abgelegt.</para>
899 <para><literal>stop</literal> beendet einen laufenden
904 <para><literal>restart</literal> beendet und startet ihn
909 <para><literal>status</literal> berichtet, ob der Task-Server
914 <para>Der Task-Server wechselt beim Starten automatisch in das
915 kivitendo-Installationsverzeichnis.</para>
917 <para>Dieselben Optionen können auch für die SystemV-basierenden
918 Runlevel-Scripte benutzt werden (siehe oben).</para>
920 <sect2 id="Prozesskontrolle2">
921 <title>Task-Server mit mehreren Mandanten</title>
923 <para>Beim Task-Server werden der zu verwendende Mandant und Login-Name des Benutzers, unter dem der Task-Server laufen soll, in die
924 Konfigurationsdatei geschrieben. Hat man mehrere Mandanten, muss man auch mehrere Konfigurationsdateien anlegen.</para>
926 <para>Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf, wo in der Kategorie <varname>[task_server]</varname> die
927 gewünschten Werte für <varname>client</varname> und <varname>login</varname> eingetragen werden.</para>
929 <para>Der alternative Task-Server wird dann mit folgendem Befehl
932 <programlisting>./scripts/task_server.pl -c config/DATEINAME.conf</programlisting>
936 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
937 <title>Benutzerauthentifizierung und Administratorpasswort</title>
939 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
940 über die Verwaltung von Gruppen und weitere Einstellungen</para>
942 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
943 <title>Grundlagen zur Benutzerauthentifizierung</title>
945 <para>kivitendo verwaltet die Benutzerinformationen in einer
946 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
947 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
948 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
949 können, müssen aber nicht unterschiedlich sein.</para>
951 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
952 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
953 abgelegt werden.</para>
955 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
956 entweder gegen die Authentifizierungsdatenbank oder gegen einen
957 LDAP-Server überprüft werden.</para>
959 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
960 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
961 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
962 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
963 einer Version vor v2.6.0 angelegt werden. Eine
964 Beispielkonfigurationsdatei
965 <filename>config/kivitendo.conf.default</filename> existiert, die als
966 Vorlage benutzt werden kann.</para>
969 <sect2 id="Administratorpasswort">
970 <title>Administratorpasswort</title>
972 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
973 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
974 nur dort und nicht mehr im Administrationsinterface selber geändert
975 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
976 Abschnitt <varname>[authentication]</varname>.</para>
979 <sect2 id="Authentifizierungsdatenbank">
980 <title>Authentifizierungsdatenbank</title>
982 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
983 Parametern in <varname>[authentication/database]</varname>
984 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
988 <term><literal>host</literal></term>
991 <para>Der Rechnername oder die IP-Adresse des
992 Datenbankservers</para>
997 <term><literal>port</literal></term>
1000 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1005 <term><literal>db</literal></term>
1008 <para>Der Name der Authentifizierungsdatenbank</para>
1013 <term><literal>user</literal></term>
1016 <para>Der Benutzername, mit dem sich kivitendo beim
1017 Datenbankserver anmeldet (z.B.
1018 "<literal>postgres</literal>")</para>
1023 <term><literal>password</literal></term>
1026 <para>Das Passwort für den Datenbankbenutzer</para>
1031 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1032 automatisch anlegen (mehr dazu siehe unten).</para>
1035 <sect2 id="Passwortüberprüfung">
1036 <title>Passwortüberprüfung</title>
1038 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1039 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1040 Active-Directory-Server. Welche davon benutzt wird, regelt der
1041 Parameter <varname>module</varname> im Abschnitt
1042 <varname>[authentication]</varname>.</para>
1044 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1045 gespeichert werden, so muss der Parameter <varname>module</varname>
1046 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1047 der Administrator als auch die Benutzer selber ihre Psaswörter in
1048 kivitendo ändern.</para>
1050 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1051 benutzt werden, so muss der Parameter <varname>module</varname> auf
1052 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1053 zusätzliche Informationen über den LDAP-Server im Abschnitt
1054 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1058 <term><literal>host</literal></term>
1061 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1062 Active-Directory-Servers. Diese Angabe ist zwingend
1063 erforderlich.</para>
1068 <term><literal>port</literal></term>
1071 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1076 <term><literal>tls</literal></term>
1079 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1080 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1081 ‘<literal>0</literal>’ belassen</para>
1086 <term><literal>attribute</literal></term>
1089 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1090 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1091 meist ‘<literal>sAMAccountName</literal>’, für andere
1092 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1093 zwingend erforderlich.</para>
1098 <term><literal>base_dn</literal></term>
1101 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1102 Diese Angabe ist zwingend erforderlich.</para>
1107 <term><literal>filter</literal></term>
1110 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1111 <literal><%login%></literal>, so wird dieses durch den vom
1112 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1113 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1114 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1119 <term><literal>bind_dn</literal> und
1120 <literal>bind_password</literal></term>
1123 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1124 durchsucht werden kann (z.B. ist dies bei
1125 Active-Directory-Servern der Fall), so kann diese hier angegeben
1126 werden. Für Active-Directory-Server kann als
1127 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1128 z.B. ‘<literal>cn=Martin
1129 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1130 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1131 also ‘<literal>Martin Mustermann</literal>’.</para>
1137 <sect2 id="Name-des-Session-Cookies">
1138 <title>Name des Session-Cookies</title>
1140 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1141 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1142 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1143 Parameter <varname>cookie_name</varname> im Abschnitt
1144 <varname>[authentication]</varname>gesetzt.</para>
1146 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1147 Server existiert.</para>
1150 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1151 <title>Anlegen der Authentifizierungsdatenbank</title>
1153 <para>Nachdem alle Einstellungen in
1154 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1155 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1156 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1157 der folgenden URL erreichbar sein sollte:</para>
1160 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1164 <sect1 id="Benutzer--und-Gruppenverwaltung">
1165 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1167 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und Datenbanken angelegt werden. Dieses geschieht im
1168 Administrationsmenü, das Sie unter folgender URL finden:</para>
1171 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1173 <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
1174 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1176 <sect2 id="Zusammenhänge">
1177 <title>Zusammenhänge</title>
1179 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung in einer oder zwei Datenbanken gespeichert werden.</para>
1181 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat
1182 Zugriff auf welche Mandanten, und welche Gruppe verfügt über welche Rechte. Diese Informationen werden in der
1183 Authentifizierungsdatenbank gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter in der Konfigurationsdatei
1184 <filename>config/kivitendo.conf</filename> gespeichert werden.</para>
1186 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten, Waren) und Belege
1187 (Angebote, Lieferscheine, Rechnungen). Diese werden in einer Mandantendatenbank gespeichert. Die
1188 Verbindungsinformationen einer solchen Mandantendatenbank werden im Administrationsbereich konfiguriert, indem man einen Mandanten
1189 anlegt und dort die Parameter einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1191 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich, die Authentifizierungsdatenbank und eine der
1192 Mandantendatenbanken in ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit mehr als einem Mandanten, wird
1193 empfohlen, für die Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die nicht gleichzeitig für einen Mandanten
1194 verwendet wird.</para>
1197 <sect2 id="Mandanten-Benutzer-Gruppen">
1198 <title>Mandanten, Benutzer und Gruppen</title>
1200 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen, die sich frei zueinander zuordnen lassen.</para>
1202 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1203 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1204 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank. Diese sollte über die <link
1205 linkend="Datenbanken-anlegen">Datenbankverwaltung</link> geschehen.</para>
1207 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten soll. Sie erhält einen Loginnamen sowie ein
1208 Passwort. Weiterhin legt der Administrator fest, an welchen Mandanten sich ein Benutzer anmelden kann, was beim Login verifiziert
1211 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür
1212 vom Administrator gewisse Rechte zugeordnet. Weiterhin legt der Administrator fest, für welche Mandanten eine Gruppe gilt, und
1213 welche Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer dann an einem Mandanten an, so erhält er alle Rechte von
1214 allen denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in denen der Benutzer zum Anderen Mitglied ist, </para>
1216 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und Benutzer angelegt werden, kann im Prinzip beliebig gewählt
1217 werden. Die folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1219 <orderedlist numeration="arabic">
1221 <para>Datenbank anlegen</para>
1225 <para>Gruppen anlegen</para>
1229 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1233 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1238 <sect2 id="Datenbanken-anlegen">
1239 <title>Datenbanken anlegen</title>
1241 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1242 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1243 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1246 <sect2 id="Gruppen-anlegen">
1247 <title>Gruppen anlegen</title>
1249 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1250 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1251 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1252 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1254 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank gespeichert, gelten aber nicht automatisch für alle
1255 Mandanten. Der Administrator legt vielmehr fest, für welche Mandanten eine Gruppe gültig ist. Dies kann entweder beim Bearbeiten der
1256 Gruppe geschehen ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn man einen Mandanten bearbeitet ("für diesen
1257 Mandanten sind die Gruppen A, B und C gültig").</para>
1259 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder dieser Gruppe festgelegt werden ("in dieser Gruppe sind die
1260 Benutzer X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten eines Benutzers geschehen ("dieser Benutzer ist
1261 Mitglied in den Gruppen A, B und C").</para>
1264 <sect2 id="Benutzer-anlegen">
1265 <title>Benutzer anlegen</title>
1267 <para>Beim Anlegen von Benutzern werden für viele Parameter Standardeinstellungen vorgenommen, die den Gepflogenheiten des deutschen
1268 Raumes entsprechen.</para>
1270 <para>Zwingend anzugeben ist der Loginname. Wenn die Passwortauthentifizierung über die Datenbank eingestellt ist, so kann hier auch
1271 das Benutzerpasswort gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1274 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier auch konfiguriert werden, auf welche Mandanten der Benutzer
1275 Zugriff hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können sowohl beim Benutzer vorgenommen werden ("dieser
1276 Benutzer hat Zugriff auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen X, Y und Z") als auch beim Mandanten ("auf
1277 diesen Mandanten haben Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe sind Benutzer A, B und C
1278 Mitglieder").</para>
1281 <sect2 id="Mandanten-anlegen">
1282 <title>Mandanten anlegen</title>
1284 <para>Ein Mandant besteht aus Administrationssicht primär aus einem eindeutigen Namen. Weiterhin wird hier hinterlegt, welche
1285 Datenbank als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten einer der eben angelegten Datenbanken eingetragen
1288 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch konfiguriert werden, welche Benutzer Zugriff auf den
1289 Mandanten haben bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen können sowohl beim Mandanten vorgenommen werden
1290 ("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
1291 beim Benutzer ("dieser Benutzer hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese Gruppe ist für Mandanten A, B und
1295 <sect1 id="Drucker--Systemverwaltung">
1296 <title>Drucker- und Systemverwaltung</title>
1297 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte Druckeradministration und System.</para>
1298 <sect2 id="Druckeradministration">
1299 <title>Druckeradministration</title>
1300 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig viele "Druckbefehle" im System verwalten. Diese Befehle werden mandantenweise
1301 zugeordnet. Unter Druckerbeschreibung wird der Namen des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs angezeigt wird.</para>
1302 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl, der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P meinDrucker' oder ein
1303 kompletter Pfad zu einem Skript (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh).
1304 Wird ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich ergänzt, ist
1305 bspw. das Kürzel 'epson_drucker' definiert, so wird beim Ausdruck eines Angebots folgende Vorlage geparst: sales_quotation_epson_drucker.tex.</para>
1308 <title>System sperren / entsperren</title>
1310 <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>
1311 <para>Falls die Sperre gesetzt ist, erscheint anstelle der Anmeldemaske die Information: 'kivitendo ist momentan zwecks Wartungsarbeiten nicht zugänglich.'.
1313 <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
1314 mit einem inkonsistenten Datenbestand weitergearbeitet werden.</para>
1318 <sect1 id="config.sending-email" xreflabel="E-Mail-Versand aus kivitendo heraus">
1319 <title>E-Mail-Versand aus kivitendo heraus</title>
1321 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden, z.B. um ein Angebot direkt an einen Kunden zu
1322 verschicken. Damit dies funktioniert, muss eingestellt werden, über welchen Server die E-Mails verschickt werden sollen. kivitendo
1323 unterstützt dabei zwei Mechanismen: Versand über einen lokalen E-Mail-Server (z.B. mit <productname>Postfix</productname> oder
1324 <productname>Exim</productname>, was auch die standardmäßig aktive Methode ist) sowie Versand über einen SMTP-Server (z.B. der des
1325 eigenen Internet-Providers).</para>
1327 <para>Welche Methode und welcher Server verwendet werden, wird über die Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1328 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1330 <sect2 id="config.sending-email.sendmail" xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1331 <title>Versand über lokalen E-Mail-Server</title>
1333 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie
1334 z.B. <productname>Postfix</productname>, <productname>Exim</productname> oder <productname>Sendmail</productname> läuft.</para>
1336 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1337 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1339 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet wird, dient der Parameter '<literal>sendmail =
1340 ...</literal>'. Der Standardwert verweist auf das Programm <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1341 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1343 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen dieses sprengen. Hierfür sei auf die Dokumentation des
1344 E-Mail-Servers verwiesen.</para>
1347 <sect2 id="config.sending-email.smtp" xreflabel="E-Mail-Versand über einen SMTP-Server">
1348 <title>Versand über einen SMTP-Server</title>
1350 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server vorhanden oder zwar einer vorhanden, dieser aber nicht
1351 konfiguriert ist.</para>
1353 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1354 Parameter dienen dabei der weiteren Konfiguration:</para>
1358 <term><varname>hostname</varname></term>
1360 <listitem><para>Name oder IP-Adresse des SMTP-Servers. Standardwert: '<literal>localhost</literal>'</para></listitem>
1364 <term><varname>port</varname></term>
1366 <listitem><para>Portnummer. Der Standardwert hängt von der verwendeten Verschlüsselungsmethode ab. Gilt '<literal>security =
1367 none</literal>' oder '<literal>security = tls</literal>', so ist 25 die Standardportnummer. Für '<literal>security =
1368 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht geändert werden.</para></listitem>
1372 <term><varname>security</varname></term>
1374 <listitem><para>Wahl der zu verwendenden Verschlüsselung der Verbindung mit dem Server. Standardwert ist
1375 '<literal>none</literal>', wodurch keine Verschlüsselung verwendet wird. Mit '<literal>tls</literal>' wird TLS-Verschlüsselung
1376 eingeschaltet, und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL eingeschaltet. Achtung: Für
1377 '<literal>tls</literal>' und '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt (siehe unten).</para></listitem>
1381 <term><varname>login</varname> und <varname>password</varname></term>
1383 <listitem><para>Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername
1384 und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von
1385 Verschlüsselung aktiviert werden.</para></listitem>
1389 <para>Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind:</para>
1392 <listitem><para>TLS-Verschlüsselung: Modul <literal>Net::SSLGlue</literal> (Debian-Paketname
1393 <literal>libnet-sslglue-perl</literal>, Fedora Core: <literal>perl-Net-SSLGlue</literal>, openSUSE:
1394 <literal>perl-Net-SSLGlue</literal></para></listitem>
1396 <listitem><para>SSL-Verschlüsselung: Modul <literal>Net::SMTP::SSL</literal> (Debian-Paketname
1397 <literal>libnet-smtp-ssl-perl</literal>, Fedora Core: <literal>perl-Net-SMTP-SSL</literal>, openSUSE:
1398 <literal>perl-Net-SMTP-SSL</literal></para></listitem>
1403 <sect1 id="Drucken-mit-kivitendo">
1404 <title>Drucken mit kivitendo</title>
1406 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. Um drucken zu können, braucht der Server ein geeignetes
1407 LaTeX System. Am einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter Debianoiden Betriebssystemen installiert man
1408 die Pakete mit:</para>
1410 <para><programlisting>aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1411 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1413 <para>TODO: RPM-Pakete.</para>
1415 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1417 <listitem><para>Standard</para></listitem>
1418 <listitem><para>f-tex</para></listitem>
1419 <listitem><para>RB</para></listitem>
1422 <sect2 id="Vorlagenverzeichnis-anlegen" xreflabel="Vorlagenverzeichnis anlegen">
1423 <title>Vorlagenverzeichnis anlegen</title>
1424 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1426 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1428 <para>Der Angemmeldete Benutzer muss in einer Gruppe sein, die über das
1429 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch <xref linkend="Gruppen-anlegen"/>.
1431 <para>Im Userbereich lässt sich unter:
1432 "<guimenu>System</guimenu> ->
1433 <guisubmenu>Mandantenverwaltung</guisubmenu> -> <guimenuitem>Verschiedenes</guimenuitem>" die Option
1434 "Neue Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1437 <listitem><para><option>Vorlagen auswählen</option>: Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll
1438 (<filename>Standard</filename>, <filename>f-tex</filename> oder <filename>RB</filename>.)</para></listitem>
1439 <listitem><para><option>Neuer Name</option>: Der Verzeichnisname für den neuen Vorlagensatz. Dieser kann im Rahmen der üblichen
1440 Bedingungen für Verzeichnisnamen frei gewählt werden.</para></listitem>
1443 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist für den aktuellen Mandanten ausgewählt.
1444 Der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1445 Eventuell muessen Anpassungen (Logo, Erscheinungsbild, etc) noch vorgenommen werden. Den Ordner findet man im Dateisistem unter
1446 <filename>./templates/[Neuer Name]</filename></para>
1450 <sect2 id="Vorlagen-Standard">
1451 <title>Standard</title>
1453 <para>Der Standard-Vorlagensatz von Kivitendo. Wie unter <ulink url="http://demo.kivitendo.org">http://demo.kivitendo.org</ulink> zu
1459 <title>f-tex</title>
1461 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt.</para>
1463 <sect3 id="f-tex-Feature-Übersicht">
1464 <title>Feature-Übersicht</title>
1466 <listitem><para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage für alle briefartigen Dokumente verwendet. Also
1467 Angebot, Rechnung, Performarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc..</para></listitem>
1469 <listitem><para>Leichte Anpassung an das Firmen-Layout durch verwendung eines Hintergrund-PDF. Dieses kann leicht mit dem
1470 eigenen Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp, Adobe*)</para></listitem>
1472 <listitem><para>Hintergrund-PDF umschaltbar auf "nur erste Seite" (Standard) oder "alle Seiten" (Option
1473 "<option>bgPdfFirstPageOnly</option>" in Datei <filename>letter.lco</filename>)</para></listitem>
1475 <listitem><para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1476 versendeten Dokumenten eingebunden (Option "<option>bgPdfEmailOnly</option>" in Datei
1477 <filename>letter.lco</filename>).</para></listitem>
1479 <listitem><para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch, Wiederholung von Kopfzeilen, Zwischensummen
1480 etc. (danke an Kai-Martin Knaak für die Vorarbeit)</para></listitem>
1482 <listitem><para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom Land des eigenen Unternehmens abweicht (also die
1483 Rechnung das Land verlässt).</para></listitem>
1485 <listitem><para>Multisprachfähig leicht um weitere Sprachen zu erweitern, alle Übersetzungen in der Datei
1486 <filename>translatinos.tex</filename>.</para></listitem>
1488 <listitem><para>Auflistung von Bruttopreisen für Endverbraucher.</para></listitem>
1492 <sect3 id="f-tex-Installation">
1493 <title>Die Installation</title>
1495 <listitem><para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref linkend="Vorlagenverzeichnis-anlegen"/>. Das
1496 Vorlagensystem funktioniert jetzt schon, hat allerdings noch einen Beispiel-Briefkopf.</para></listitem>
1498 <listitem><para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach <filename>./letter_head.pdf</filename>.</para></listitem>
1499 <listitem><para>Editiere den Bereich "<option>settings</option>" in der datei <filename>letter.lco</filename>.</para></listitem>
1502 <para>oder etwas Detaillierter:</para>
1505 Es wird eine Datei <filename>sample.lco</filename> erstellt und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
1506 ist dies die Datei die für die Firmenspezifischen Anpassungen gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig
1507 ist, wird in dieser Datei auf ein Hintergrundpdf verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen
1508 vorzunehmen und <filename>sample.lco</filename> unverändert zu lassen. Die die Anpassung über eine
1509 <filename>*.lco</filename>-Datei die letztlich auf <filename>letter.lco</filename> verlinkt ist ist aber auch möglich.
1513 Es wird eine Datei <filename>sample_head.pdf</filename> mit ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
1514 verlinkt. Damit gibt es schon mal eine Funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei
1515 <filename>sample_haed.pdf</filename> an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
1516 Template Verzeichniss ablegen und statt <filename>sample_head.pdf</filename> nach <filename>letter_head.pdf</filename>
1521 letzlich muss <filename>letter_head.pdf</filename> auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
1522 enthält. Bei Updates oder nach erneutem
1526 Es wird eine Datei <filename>mydata.tex.example</filename> ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
1527 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das Land verwendet. Die Datei muss also nicht angefasst
1528 werden. Die Anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig).
1531 Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc. sollten über die Hintergrund-PDF-Datei oder die
1532 <filename>*.lco</filename>-Datei erfolgen.
1536 <sect3 id="f-tex-Funktionsübersicht">
1537 <title>f-tex Funktionsübersicht</title>
1539 Das Konzept von kivitendo sieht vor, für jedes Dokument (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine LaTeX-Vorlage
1540 vorzuhalten, dies ist sehr Wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
1541 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
1542 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche LaTeX-Vorlage verwendet, welche über Codeweichen die
1543 Besonderheiten der jeweiligen Dokumente Berücksichtigt.
1547 <listitem><para>Tabellen mit oder ohne Preis</para></listitem>
1548 <listitem><para>Sprache der Tabellenüberschriften etc.</para></listitem>
1549 <listitem><para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus Angebotsnummer)</para></listitem>
1550 <listitem><para>Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus Gewerblicher
1551 Kunde)</para></listitem>
1554 <para>Nachteil:</para>
1557 LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
1558 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann natürlich
1559 auch innerhalb der Tabellendarstellung gut persönliche Anpassungen vornehmen. Aber man kann sich hier bei Veränderungen sehr
1560 schnell häftig in den Fuss schiessen.
1563 <para>Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund PDF auf Basis der
1564 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen, und sich an der Form der dargestellten Tabellen wie sie
1565 ausgeliefert werden, erfreuen.
1568 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine kontinuierliche Schritte gehen.</para>
1572 <sect3 id="f-tex-Bruttopreise">
1573 <title>Bruttopreise für Endverbraucher</title>
1575 <para>Der auszuweisende Bruttopreis wird innerhalb der LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen "alle
1576 Preise Brutto" auszuwählen, aber:</para>
1579 <para>hierfür müssen die Preise auch in Brutto in der Datenbank stehen (ja - das lässt sich über die Preisgruppen und die
1580 Zuordung einer Default-Preisgruppe handhaben)</para>
1583 <para>man darf beim Anlegen des Vorgangs nicht vergessen Dieses Häkchen zu setzen. (das ist in der Praxis wenn man sowohl
1584 Endverbraucher- wie Gewerbekunden beliefert der eigentliche Knackpunkt)</para>
1589 Es gibt mit f-tex eine weitere Alternative. Die Information ob Brutto oder Nettorechnung wird mit den Zahlarten
1590 verknüpft. Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben werden sollen, enden mit "_E" (für
1591 Endverbraucher). Falls identische Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt man diese einfach doppelt
1592 an (einmal mit der Namensendung "_E"). Gewinn:</para>
1595 <listitem><para>Die Entscheidung, ob Netopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste Verbunden.</para></listitem>
1596 <listitem><para>Die Default-Zahlart kann im Kundendatensatz hinterlegt werden, und man muss nicht mehr daran denken, "alle Preise
1597 Netto" auszuwählen.</para></listitem>
1598 <listitem><para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken reviediert werden,
1599 ohne dass sich der Auftragswert ändert.</para></listitem>
1603 <sect3 id="f-tex-lieferadressen">
1604 <title>Lieferadressen</title>
1606 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen im Adressfeld zum Einsatz. Wenn die
1607 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende Adressvariable eingesetzt. Wenn also die Lieferadresse in
1608 Straße, Hausnummer und Ort abweicht, müssen auch nur diese Felder in der Lieferadresse ausgefüllt werden. Für den Firmenname wird
1609 der Wert der Hauptadresse angezeigt.
1614 <sect2 id="Vorlagen-RB">
1617 <para>Vollständiger Dokumentensatz mit alternativem Design</para>
1618 <para>Die konzeptionelle Idee wird <ulink
1619 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1620 auf Folie 5 bis 10 vorgestellt, Detaileinstellungen dann im Readme.tex im Vorlagenverzeichnis.</para>
1624 <sect2 id="allgemeine-hinweise-zu-latex">
1625 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
1626 <para>In den allermeisten Installationen sollte drucken jetzt schon
1627 funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
1628 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
1629 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1634 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1635 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1636 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1640 <para>! Package inputenc Error: Unicode char \u8:... set up for
1641 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1642 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1643 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1644 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1645 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1649 <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
1650 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1651 Prüfen Sie den Namen in der Konfiguration (Standard:
1652 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1653 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1656 <para>Wenn sich das Problem nicht auf Grund der ausgabe im Webbrowser verifizieren lässt:</para>
1659 <para> editiere [kivitendo-home]/config/kivitendo.conf und ändere "keep_temp_files" auf 1</para>
1660 <para><programlisting>keep_temp_files = 1;</programlisting></para>
1663 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
1666 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
1669 <para>wechsele in das users Verzeichnis von kivitendo</para>
1670 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
1673 <para>LaTeX Suchpfad anpassen:</para>
1674 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
1677 <para>Finde herraus welche Datei kivitendo beim letzten Durchlauf erstellt hat</para>
1678 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
1679 <para>Es sollte die letzte Datei ganz unten sein</para>
1682 <para>für besseren Hinweis auf Fehler texdatei nochmals übersetzen</para>
1683 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
1684 <para>in der *.tex datei nach dem Fehler suchen.</para>
1690 <sect1 id="OpenDocument-Vorlagen">
1691 <title>OpenDocument-Vorlagen</title>
1693 <para>kivitendo unterstützt die Verwendung von Vorlagen im
1694 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1695 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1696 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1697 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1698 <filename>config/kivitendo.conf</filename> die Variable
1699 <literal>opendocument</literal> im Abschnitt
1700 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1701 Dieses ist die Standardeinstellung.</para>
1703 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1704 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1705 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1706 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1707 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1708 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1710 <para>Nach der Installation müssen in der Datei
1711 <filename>config/kivitendo.conf</filename> zwei weitere Variablen
1712 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1713 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1714 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1715 enthalten. Beide stehen im Abschnitt
1716 <literal>applications</literal>.</para>
1718 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
1719 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1720 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1721 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1722 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1723 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1724 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1725 werden muss. Der Nachteil ist, dass diese Methode Python und die
1726 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1731 Für die Verbindung zu OpenOffice wird normalerweise der Python-Interpreter <filename>/usr/bin/python</filename> benutzt. Sollte
1732 dies nicht der richtige sein, so kann man mit zwei Konfigurationsvariablen entscheiden, welcher Python-Interpreter genutzt
1733 wird. Mit der Option <literal>python_uno</literal> aus dem Abschnitt <literal>applications</literal> wird der Interpreter selber
1734 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert <literal>/usr/bin/python</literal>.
1738 Zusätzlich ist es möglich, Pfade anzugeben, in denen Python neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
1739 z.B. falls sich diese in einem gesonderten OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
1740 <literal>python_uno_path</literal> und befindet sich im Abschnitt <literal>environment</literal>. Sie ist standardmäßig
1741 leer. Werden hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte voneinander getrennt werden. Der Inhalt wird an den
1742 Python-Interpreter über die Umgebungsvariable <literal>PYTHONPATH</literal> übergeben.
1746 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1747 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1748 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1749 Dokumentenvorlage enthalten sein und
1750 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1751 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1752 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1753 ebenfalls enthalten sein muss.</para>
1755 <para>Als letztes muss herausgefunden werden, welchen Namen
1756 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1757 gibt. Unter Debian ist dies momentan
1758 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1759 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1760 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1761 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1762 folgender Befehl auszuführen:</para>
1764 <para><literal>mv users/.openoffice.org2
1765 users/.openoffice</literal></para>
1767 <para>Dieses Verzeichnis, wie auch das komplette
1768 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1769 sein. Dieses wurde bereits erledigt (siehe <xref
1770 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1771 erneut überprüft werden, wenn die Konvertierung nach PDF
1775 <sect1 id="config.eur">
1776 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1779 <sect2 id="config.eur.introduction"
1780 xreflabel="Einführung in die Konfiguration zur EUR">
1781 <title>Einführung</title>
1783 <para>kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1784 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals noch <filename>config/lx_office.conf</filename>)
1785 befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden.</para>
1787 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1788 die Mandantendatenbank verschoben und dabei auch gleich in drei
1789 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1790 steuern lässt.</para>
1793 <sect2 id="config.eur.parameters"
1794 xreflabel="Konfigurationsparameter für EUR">
1795 <title>Konfigurationsparameter</title>
1797 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1798 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1802 <term><varname>profit_determination</varname></term>
1805 <para>Dieser Parameter legt die Berechnungsmethode für die
1806 Gewinnermittlung fest. Er enthält entweder
1807 <literal>balance</literal> für
1808 Betriebsvermögensvergleich/Bilanzierung oder
1809 <literal>income</literal> für die
1810 Einnahmen-Überschuss-Rechnung.</para>
1815 <term><varname>accounting_method</varname></term>
1818 <para>Dieser Parameter steuert die Buchungs- und
1819 Berechnungsmethoden für die Versteuerungsart. Er enthält
1820 entweder <literal>accrual</literal> für die Soll-Versteuerung
1821 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1826 <term><varname>inventory_system</varname></term>
1829 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1830 enthält entweder <literal>perpetual</literal> für die
1831 Bestandsmethode oder <literal>periodic</literal> für die
1832 Aufwandsmethode.</para>
1837 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1838 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1839 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1840 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1841 Bestandsmethode.</para>
1843 <para>Die Konfiguration "<varname>eur</varname>" unter
1844 <varname>[system]</varname> in der <link
1845 linkend="config.config-file">Konfigurationsdatei</link>
1846 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
1847 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1850 <sect2 id="config.eur.setting-parameters">
1851 <title>Festlegen der Parameter</title>
1853 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1854 der Admininstration können diese Optionen nun unabhängig voneinander
1855 eingestellt werden.</para>
1857 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1858 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1861 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1862 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
1863 angezeigt. Unter <guimenu>System</guimenu>
1864 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> können
1865 die Einstellungen auch geändert werden. Dabei ist zu beachten,
1866 dass eine Änderung vorhandene Daten so belässt und damit
1867 evtl. die Ergebnisse verfälscht. Dies gilt vor Allem für die
1868 Warenbuchungsmethode (siehe auch
1869 <link linkend="config.eur.inventory-system-perpetual">
1870 Bemerkungen zu Bestandsmethode</link>).</para>
1873 <sect2 id="config.eur.inventory-system-perpetual">
1874 <title>Bemerkungen zu Bestandsmethode</title>
1876 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1877 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
1878 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1879 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1880 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1881 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1882 Einkaufsrechnungen berechnet wird.</para>
1884 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1885 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1886 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1890 <sect2 id="config.eur.knonw-issues">
1891 <title>Bekannte Probleme</title>
1893 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1894 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1895 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1896 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1897 die Konfigurationsvariable
1898 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1901 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1902 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1906 <sect1 id="config.skr04-update-3804">
1907 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1909 <sect2 id="config.skr04-update-3804.introduction">
1910 <title>Einführung</title>
1912 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1913 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1914 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1915 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1916 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1917 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1918 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1919 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1920 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1921 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1922 Screenshots dargestellt.</para>
1924 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1925 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1926 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1927 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1930 <sect2 id="config.skr04-update-3804.create-chart">
1931 <title>Konto 3804 manuell anlegen</title>
1933 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
1934 anzulegen und zu konfigurieren. Zuerst wird in
1935 <guimenu>System</guimenu> ->
1936 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
1937 erfassen</guimenuitem> das Konto angelegt.</para>
1940 <screeninfo>Konto 3804 erfassen</screeninfo>
1944 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
1950 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
1951 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
1952 wie im folgenden Screenshot angezeigt anpassen.
1956 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
1960 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
1966 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
1967 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
1971 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
1975 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
1981 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
1982 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
1983 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
1984 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
1988 <screeninfo>Konto 4315 anpassen</screeninfo>
1992 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
1998 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
1999 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
2003 <screeninfo>Steuerliste vergleichen</screeninfo>
2007 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
2014 <title>Verhalten des Bilanzberichts</title>
2016 Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als Grundlage für das
2017 Startdatum benutzt. Schließt man die Bücher allerdings monatsweise führt dies
2018 zu falschen Werten.</para>
2019 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau einstellen indem man:</para>
2022 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu vorher)</para>
2025 <para>immer den Jahresanfang nimmt (1.1. relativ zum Stichtag)</para>
2028 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
2029 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen gibt</para>
2030 <para>- oder mit "alle Buchungen" als Alternative"</para>
2033 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen gibt </para>
2036 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
2039 Folgende Hinweise zu den Optionen:
2040 Das "Bücher schließen Datum" ist sinnvoll, wenn man nur komplette Jahre
2041 schließt. Bei Wirtschaftsjahr = Kalendarjahr entspricht dies aber auch
2043 "Alle Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
2045 Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B. sinnvoll, wenn man
2046 am sich Anfang des zweiten Buchungsjahres befindet, und noch keinen
2047 Jahreswechsel und auch noch keine EB-Buchungen hat.
2048 Bei den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1. Tag
2049 des Wirtschaftsjahres gebucht werden.
2050 Zur Sicherheit wird das Startdatum im Bilanzbericht jetzt zusätzlich zum
2051 Stichtag mit angezeigt. Das hilft auch bei der Kontrolle für den
2052 Abgleich mit der GuV.
2054 <sect1 id="config.client">
2055 <title>Einstellungen pro Mandant</title>
2057 <para>Einige Einstellungen können von einem Benutzer mit dem
2058 <link linkend="Zusammenhänge">Recht</link> "Administration
2059 (Für die Verwaltung der aktuellen Instanz aus einem Userlogin heraus)"
2060 gemacht werden. Diese Einstellungen sind dann für die aktuellen
2061 Mandanten-Datenbank gültig. Die Einstellungen sind
2062 unter <guimenu>System</guimenu>
2063 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
2065 <para>Bitte beachten Sie die Hinweise zu den einzelnen
2066 Einstellungen. Einige Einstellungen sollten nicht ohne Weiteres
2067 im laufenden Betrieb geändert werden (siehe
2068 auch <link linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
2069 Bestandsmethode</link>).</para>
2071 <para>Die Einstellungen <literal>show_bestbefore</literal>
2072 und <literal>payments_changeable</literal> aus dem
2073 Abschnitt <literal>features</literal> und die Einstellungen im
2074 Abschnitt <literal>datev_check</literal> (sofern schon vorhanden)
2075 der <link linkend="config.config-file">kivitendo-Konfigurationsdatei</link>
2076 werden bei einem Datenbankupdate einer älteren Version automatisch
2077 übernommen. Diese Einträge können danach aus der Konfigurationsdatei
2078 entfernt werden.</para>
2081 <sect1 id="kivitendo-ERP-verwenden">
2082 <title>kivitendo ERP verwenden</title>
2084 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
2085 folgender URL erreichbar:</para>
2088 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
2090 <para>Die Administrationsseite erreichen Sie unter:</para>
2093 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
2097 <chapter id="features" xreflabel="Features und Funktionen">
2098 <title>Features und Funktionen</title>
2100 <sect1 id="features.periodic-invoices"
2101 xreflabel="Wiedekehrende Rechnungen">
2102 <title>Wiederkehrende Rechnungen</title>
2104 <sect2 id="features.periodic-invoices.introduction"
2105 xreflabel="Einführung in wiederkehrende Rechnungen">
2106 <title>Einführung</title>
2108 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
2109 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
2110 Die konfigurierten Aufträge werden später automatisch in Rechnungen
2111 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
2112 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
2113 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
2114 wiederzufinden sind.</para>
2117 <sect2 id="features.periodic-invoices.configuration"
2118 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
2119 <title>Konfiguration</title>
2121 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
2122 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
2123 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
2124 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
2125 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
2128 <para>Folgende Parameter kann man konfigurieren:</para>
2135 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
2136 erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
2137 neuen Monats).</para>
2139 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
2140 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
2141 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
2142 nächsten Periodenwechsel für alle Perioden, seit der letzten
2143 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
2144 verhindern, muss man vorher das Startdatum neu setzen.</para>
2146 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
2147 erstellt. Man kann sich diese Aufträge aber gesondert in den
2148 Berichten anzeigen lassen.</para>
2153 <term>Periodizität</term>
2156 <para>Ob monatlich, quartalsweise oder jährlich auf neue
2157 Rechnungen überprüft werden soll. Für jede Periode seit dem
2158 Startdatum wird überprüft, ob für die Periode (beginnend immer
2159 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
2160 wurde. Unter Umständen können bei einem Startdatum in der
2161 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
2166 <term>Buchen auf</term>
2169 <para>Das Forderungskonto, in der Regel "Forderungen aus
2170 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
2171 Buchungsgruppen der betreffenden Waren.</para>
2176 <term>Startdatum</term>
2179 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
2185 <term>Enddatum</term>
2188 <para>ab wann keine Rechnungen mehr erstellt werden
2194 <term>Automatische Verlängerung um x Monate</term>
2197 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
2198 eingetragenen Enddatums weiterhin erstellt werden, so kann man
2199 hier die Anzahl der Monate eingeben, um die das Enddatum
2200 automatisch nach hinten geschoben wird.</para>
2205 <term>Drucken</term>
2208 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
2209 Rechnungen auch gleich ausdrucken lassen.</para>
2214 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
2215 Informationen zu den erstellten Rechnungen verschickt werden.
2216 Konfiguriert wird dies in der <link
2217 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
2218 <filename>config/kivitendo.conf</filename> im Abschnitt
2219 <varname>[periodic_invoices]</varname>.</para>
2222 <sect2 id="features.periodic-invoices.variables">
2223 <title>Spezielle Variablen</title>
2226 Um die erzeugten Rechnungen individualisieren zu können, werden beim Umwandeln des Auftrags in eine Rechnung einige speziell
2227 formatierte Variablen durch für die jeweils aktuelle Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B. den
2228 Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei die Syntax <literal><%variablenname%></literal>.
2232 Diese Variablen werden in den folgenden Elementen des Auftrags ersetzt:
2236 <listitem><para>Bemerkungen</para></listitem>
2237 <listitem><para>Interne Bemerkungen</para></listitem>
2238 <listitem><para>Vorgangsbezeichnung</para></listitem>
2239 <listitem><para>In den Beschreibungs- und Langtextfeldern aller Positionen</para></listitem>
2242 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
2246 <term><varname><%current_quarter%></varname>, <varname><%previous_quarter%></varname>, <varname><%next_quarter%></varname></term>
2250 Aktuelles, vorheriges und nächstes Quartal als Zahl zwischen <literal>1</literal> und <literal>4</literal>.
2256 <term><varname><%current_month%></varname>, <varname><%previous_month%></varname>, <varname><%next_month%></varname></term>
2260 Aktueller, vorheriger und nächster Monat als Zahl zwischen <literal>1</literal> und <literal>12</literal>.
2266 <term><varname><%current_month_long%></varname>, <varname><%previous_month_long%></varname>, <varname><%next_month_long%></varname></term>
2270 Aktueller, vorheriger und nächster Monat als Name (<literal>Januar</literal>, <literal>Februar</literal> etc.).
2276 <term><varname><%current_year%></varname>, <varname><%previous_year%></varname>, <varname><%next_year%></varname></term>
2280 Aktuelles, vorheriges und nächstes Jahr als vierstellige Jahreszahl (<literal>2013</literal> etc.).
2286 <term><varname><%period_start_date%></varname>, <varname><%period_end_date%></varname></term>
2290 Formatiertes Datum des ersten und letzten Tages im Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im ersten
2291 Quartal von 2013 wären dies der <literal>01.01.2013</literal> und <literal>31.03.2013</literal>).
2298 <sect2 id="features.periodic-invoices.reports">
2299 <title>Auflisten</title>
2301 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
2302 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
2303 Rechnungen inaktiv", mit denen man sich einen Überglick über die
2304 wiederkehrenden Rechnungen verschaffen kann.</para>
2307 <sect2 id="features.periodic-invoices.task-server">
2308 <title>Erzeugung der eigentlichen Rechnungen</title>
2310 <para>Die zeitliche und periodische Überprüfung, ob eine
2311 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
2312 durch den <link linkend="config.task-server">Taskserver</link>, einen
2313 externen Dienst, der automatisch beim Start des Servers gestartet
2314 werden sollte.</para>
2317 <sect2 id="features.periodic-invoices.create-for-current-month">
2318 <title>Erste Rechnung für aktuellen Monat erstellen</title>
2320 <para>Will man im laufenden Monat eine monatlich wiederkehrende
2321 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
2322 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
2323 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
2324 generiert hat. Alternativ setzt man das Startdatum auf den
2325 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
2326 manuell über den Workflow.</para>
2329 <sect1 id="dokumentenvorlagen-und-variablen">
2330 <title>Dokumentenvorlagen und verfügbare Variablen</title>
2332 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
2333 <title>Einführung</title>
2335 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
2336 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
2337 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
2338 <function><%variablenname%></function> verwendet wird. Für
2339 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
2341 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
2343 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
2344 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
2345 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
2346 alle Vorlagenarten.</para>
2348 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
2349 verfügbar als hier aufgelistet werden. Die meisten davon können
2350 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
2351 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
2352 diese wie folgt erhalten werden:</para>
2356 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
2357 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
2361 <para>In <filename>Form.pm</filename> die Funktion
2362 <function>parse_template</function> suchen und hier die Zeile
2363 <command>print(STDERR Dumper($self));</command> einfügen.</para>
2367 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
2368 ein PDF für eine Rechnung erzeugen.</para>
2372 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
2373 der Variablen <varname>$self</varname> in der Form <varname>'key'
2374 => 'value',</varname>. Alle <varname>key</varname>s sind
2380 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
2381 <title>Variablen ausgeben</title>
2383 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
2384 Tags geschrieben werden, also z.B.
2385 <varname><%variablenname%></varname>.</para>
2387 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
2388 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
2389 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
2390 werden die folgenden Flags unterstützt:</para>
2394 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
2395 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
2396 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
2397 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
2401 <para><option>NOESCAPE</option> unterdrückt das Escapen von
2402 Sonderzeichen für die Vorlagensprache. Wenn also in einer
2403 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
2404 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
2405 ist dieses Flag sinnvoll.</para>
2409 <para>Beispiel:</para>
2411 <programlisting><%quototal NOFORMAT%></programlisting>
2414 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
2415 <title>Verwendung in Druckbefehlen</title>
2417 <para>In der Admininstration können Drucker definiert werden. Auch im
2418 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
2419 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
2420 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
2421 <function>`...`</function> nicht zu unerwünschtem Verhalten
2424 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
2425 für das die Telefonnummer eines Ansprechpartners als Teil der
2426 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
2427 z.B. wie folgt aussehen:</para>
2429 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
2432 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
2433 xreflabel="Anfang und Ende der Tags verändern">
2434 <title>Anfang und Ende der Tags verändern</title>
2436 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
2437 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
2438 Prozentzeichen und dem Größerzeichen endet, beispielsweise
2439 <function><%customer%></function>. Da diese Form aber z.B. in
2440 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
2441 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
2442 Stil umgestellt werden.</para>
2444 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
2445 Format gültigen Kommentarzeichen anfangen, dann
2446 <function>config:</function> enthalten, die entsprechende Option
2447 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
2448 enden. Beispiel für LaTeX:</para>
2450 <programlisting>% config: tag-style=($ $)</programlisting>
2452 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
2453 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
2454 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
2456 <programlisting><!-- config: tag-style=($ $) --></programlisting>
2459 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
2460 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
2462 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
2463 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
2464 "<filename>.ext</filename>" geeignet zu ersetzen:
2465 "<filename>.tex</filename>" für LaTeX-Vorlagen und
2466 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
2470 <term><filename>bin_list.ext</filename></term>
2473 <para>Lagerliste</para>
2478 <term><filename>check.ext</filename></term>
2486 <term><filename>invoice.ext</filename></term>
2489 <para>Rechnung</para>
2494 <term><filename>packing_list.ext</filename></term>
2497 <para>Packliste</para>
2502 <term><filename>pick_list.ext</filename></term>
2505 <para>Sammelliste</para>
2510 <term><filename>purchase_delivery_order.ext</filename></term>
2513 <para>Lieferschein (Einkauf)</para>
2518 <term><filename>purcharse_order.ext</filename></term>
2521 <para>Bestellung an Lieferanten</para>
2526 <term><filename>request_quotation.ext</filename></term>
2529 <para>Anfrage an Lieferanten</para>
2534 <term><filename>sales_delivery_order.ext</filename></term>
2537 <para>Lieferschein (Verkauf)</para>
2542 <term><filename>sales_order.ext</filename></term>
2545 <para>Bestellung</para>
2550 <term><filename>sales_quotation.ext</filename></term>
2553 <para>Angebot an Kunden</para>
2558 <term><filename>zahlungserinnerung.ext</filename></term>
2561 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2566 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2569 <para>Rechnung über Mahngebühren (Dateiname im Programm
2570 konfigurierbar)</para>
2576 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2577 <title>Sprache, Drucker und E-Mail</title>
2579 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2580 eingearbeitet. So wird aus der Vorlage
2581 <filename>sales_order.ext</filename> bei Sprache
2582 <function>de</function> und Druckerkürzel <function>lpr2</function>
2583 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2584 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2585 bekommen dann noch das Kürzel <filename>_email</filename>, der
2586 vollständige Vorlagenname wäre dann
2587 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2588 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2589 werden. Diese wird verwendet, wenn keine der anderen Varianten
2590 gefunden wird.</para>
2592 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2593 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2594 verschickt wird, ist:</para>
2598 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2602 <para><filename>sales_order_de_lpr2.tex</filename></para>
2606 <para><filename>sales_order.tex</filename></para>
2610 <para><filename>default.tex</filename></para>
2614 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2615 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2617 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2620 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2621 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2624 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2625 xreflabel="Metainformationen zur angeforderten Vorlage">
2626 <title>Metainformationen zur angeforderten Vorlage</title>
2628 <para>Diese Variablen liefern Informationen darüber welche Variante
2629 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2630 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2631 Formulare einbinden möchten.</para>
2635 <term><varname>template_meta.formname</varname></term>
2638 <para>Basisname der Vorlage. Identisch mit der <link
2639 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2640 zu den Dateinamen</link> ohne die Erweiterung. Ein
2641 Verkaufsauftrag enthält hier
2642 <constant>sales_order</constant>.</para>
2647 <term><varname>template_meta.language.description</varname></term>
2650 <para>Beschreibung der verwendeten Sprache</para>
2655 <term><varname>template_meta.language.template_code</varname></term>
2658 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2659 Kürzel das im Dateinamen verwendetet wird.</para>
2664 <term><varname>template_meta.language.output_numberformat</varname></term>
2667 <para>Zahlenformat der verwendeten Sprache in der Form
2668 "<constant>1.000,00</constant>". Experimentell! Nur
2669 interessant für Vorlagen die mit unformatierten Werten
2675 <term><varname>template_meta.language.output_dateformat</varname></term>
2678 <para>Datumsformat der verwendeten Sprache in der Form
2679 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2680 interessant für Vorlagen die mit unformatierten Werten
2686 <term><varname>template_meta.format</varname></term>
2689 <para>Das angeforderte Format. Kann im Moment die Werte
2690 <constant>pdf</constant>, <constant>postscript</constant>,
2691 <constant>html</constant>, <constant>opendocument</constant>,
2692 <constant>opendocument_pdf</constant> und
2693 <constant>excel</constant> enthalten.</para>
2698 <term><varname>template_meta.extension</varname></term>
2701 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2702 <constant>format</constant> entschieden.</para>
2707 <term><varname>template_meta.media</varname></term>
2710 <para>Ausgabemedium. Kann zur Zeit die Werte
2711 <constant>screen</constant> für Bildschirm,
2712 <constant>email</constant> für E-Mmail (triggert das
2713 <constant>_email</constant> Kürzel im Dateinamen),
2714 <constant>printer</constant> für Drucker, und
2715 <constant>queue</constant> für Warteschlange enthalten.</para>
2720 <term><varname>template_meta.printer.description</varname></term>
2723 <para>Beschreibung des ausgewählten Druckers</para>
2728 <term><varname>template_meta.printer.template_code</varname></term>
2731 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2732 dem Kürzel das im Dateinamen verwendetet wird.</para>
2737 <term><varname>template_meta.tmpfile</varname></term>
2740 <para>Datei-Prefix für temporäre Dateien.</para>
2746 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2747 <title>Stammdaten von Kunden und Lieferanten</title>
2751 <term><varname>account_number</varname></term>
2754 <para>Kontonummer</para>
2759 <term><varname>bank</varname></term>
2762 <para>Name der Bank</para>
2767 <term><varname>bank_code</varname></term>
2770 <para>Bankleitzahl</para>
2775 <term><varname>bic</varname></term>
2778 <para>Bank-Identifikations-Code (Bank Identifier Code,
2784 <term><varname>business</varname></term>
2787 <para>Kunden-/Lieferantentyp</para>
2792 <term><varname>city</varname></term>
2800 <term><varname>contact</varname></term>
2803 <para>Kontakt</para>
2808 <term><varname>country</varname></term>
2816 <term><varname>c_vendor_id</varname></term>
2819 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
2824 <term><varname>v_customer_id</varname></term>
2827 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
2832 <term><varname>cp_email</varname></term>
2835 <para>Email des Ansprechpartners</para>
2840 <term><varname>cp_givenname</varname></term>
2843 <para>Vorname des Ansprechpartners</para>
2848 <term><varname>cp_greeting</varname></term>
2851 <para>Anrede des Ansprechpartners</para>
2856 <term><varname>cp_name</varname></term>
2859 <para>Name des Ansprechpartners</para>
2864 <term><varname>cp_phone1</varname></term>
2867 <para>Telefonnummer 1 des Ansprechpartners</para>
2872 <term><varname>cp_phone2</varname></term>
2875 <para>Telefonnummer 2 des Ansprechpartners</para>
2880 <term><varname>cp_title</varname></term>
2883 <para>Titel des Ansprechpartners</para>
2888 <term><varname>creditlimit</varname></term>
2891 <para>Kreditlimit</para>
2896 <term><varname>customeremail</varname></term>
2899 <para>Email des Kunden; nur für Kunden</para>
2904 <term><varname>customerfax</varname></term>
2907 <para>Faxnummer des Kunden; nur für Kunden</para>
2912 <term><varname>customernotes</varname></term>
2915 <para>Bemerkungen beim Kunden; nur für Kunden</para>
2920 <term><varname>customernumber</varname></term>
2923 <para>Kundennummer; nur für Kunden</para>
2928 <term><varname>customerphone</varname></term>
2931 <para>Telefonnummer des Kunden; nur für Kunden</para>
2936 <term><varname>discount</varname></term>
2944 <term><varname>email</varname></term>
2947 <para>Emailadresse</para>
2952 <term><varname>fax</varname></term>
2955 <para>Faxnummer</para>
2960 <term><varname>homepage</varname></term>
2963 <para>Homepage</para>
2968 <term><varname>iban</varname></term>
2971 <para>Internationale Kontonummer (International Bank Account
2972 Number, IBAN)</para>
2977 <term><varname>language</varname></term>
2980 <para>Sprache</para>
2985 <term><varname>name</varname></term>
2988 <para>Firmenname</para>
2993 <term><varname>payment_description</varname></term>
2996 <para>Name der Zahlart</para>
3001 <term><varname>payment_terms</varname></term>
3004 <para>Zahlungskonditionen</para>
3009 <term><varname>phone</varname></term>
3012 <para>Telefonnummer</para>
3017 <term><varname>shiptocity</varname></term>
3020 <para>Stadt (Lieferadresse) <link
3021 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3026 <term><varname>shiptocontact</varname></term>
3029 <para>Kontakt (Lieferadresse) <link
3030 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3035 <term><varname>shiptocountry</varname></term>
3038 <para>Land (Lieferadresse) <link
3039 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3044 <term><varname>shiptodepartment1</varname></term>
3047 <para>Abteilung 1 (Lieferadresse) <link
3048 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3053 <term><varname>shiptodepartment2</varname></term>
3056 <para>Abteilung 2 (Lieferadresse) <link
3057 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3062 <term><varname>shiptoemail</varname></term>
3065 <para>Email (Lieferadresse) <link
3066 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3071 <term><varname>shiptofax</varname></term>
3074 <para>Fax (Lieferadresse) <link
3075 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3080 <term><varname>shiptoname</varname></term>
3083 <para>Firmenname (Lieferadresse) <link
3084 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3089 <term><varname>shiptophone</varname></term>
3092 <para>Telefonnummer (Lieferadresse) <link
3093 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3098 <term><varname>shiptostreet</varname></term>
3101 <para>Straße und Hausnummer (Lieferadresse) <link
3102 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3107 <term><varname>shiptozipcode</varname></term>
3110 <para>Postleitzahl (Lieferadresse) <link
3111 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3116 <term><varname>street</varname></term>
3119 <para>Straße und Hausnummer</para>
3124 <term><varname>taxnumber</varname></term>
3127 <para>Steuernummer</para>
3132 <term><varname>ustid</varname></term>
3135 <para>Umsatzsteuer-Identifikationsnummer</para>
3140 <term><varname>vendoremail</varname></term>
3143 <para>Email des Lieferanten; nur für Lieferanten</para>
3148 <term><varname>vendorfax</varname></term>
3151 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
3156 <term><varname>vendornotes</varname></term>
3159 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
3164 <term><varname>vendornumber</varname></term>
3167 <para>Lieferantennummer; nur für Lieferanten</para>
3172 <term><varname>vendorphone</varname></term>
3175 <para>Telefonnummer des Lieferanten; nur für
3181 <term><varname>zipcode</varname></term>
3184 <para>Postleitzahl</para>
3189 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
3190 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
3191 Stammdaten nicht eingetragen, so haben die Variablen
3192 <varname>shipto*</varname> den gleichen Wert wie die die
3193 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
3194 einige <varname>shipto*</varname>-Variablen so nicht in den
3195 Stammdaten wiederfinden sondern schlicht Kopien der
3196 Lieferdatenvariablen sind (z.B.
3197 <varname>shiptocontact</varname>).</para>
3201 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
3202 <title>Informationen über den Bearbeiter</title>
3206 <term><varname>employee_address</varname></term>
3209 <para>Adressfeld</para>
3214 <term><varname>employee_businessnumber</varname></term>
3217 <para>Firmennummer</para>
3222 <term><varname>employee_company</varname></term>
3225 <para>Firmenname</para>
3230 <term><varname>employee_co_ustid</varname></term>
3233 <para>Usatzsteuer-Identifikationsnummer</para>
3238 <term><varname>employee_duns</varname></term>
3241 <para>DUNS-Nummer</para>
3246 <term><varname>employee_email</varname></term>
3254 <term><varname>employee_fax</varname></term>
3262 <term><varname>employee_name</varname></term>
3265 <para>voller Name</para>
3270 <term><varname>employee_signature</varname></term>
3273 <para>Signatur</para>
3278 <term><varname>employee_taxnumber</varname></term>
3281 <para>Steuernummer</para>
3286 <term><varname>employee_tel</varname></term>
3289 <para>Telefonnummer</para>
3295 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
3296 <title>Informationen über den Verkäufer</title>
3300 <term><varname>salesman_address</varname></term>
3303 <para>Adressfeld</para>
3308 <term><varname>salesman_businessnumber</varname></term>
3311 <para>Firmennummer</para>
3316 <term><varname>salesman_company</varname></term>
3319 <para>Firmenname</para>
3324 <term><varname>salesman_co_ustid</varname></term>
3327 <para>Usatzsteuer-Identifikationsnummer</para>
3332 <term><varname>salesman_duns</varname></term>
3335 <para>DUNS-Nummer</para>
3340 <term><varname>salesman_email</varname></term>
3348 <term><varname>salesman_fax</varname></term>
3356 <term><varname>salesman_name</varname></term>
3359 <para>voller Name</para>
3364 <term><varname>salesman_signature</varname></term>
3367 <para>Signatur</para>
3372 <term><varname>salesman_taxnumber</varname></term>
3375 <para>Steuernummer</para>
3380 <term><varname>salesman_tel</varname></term>
3383 <para>Telefonnummer</para>
3389 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
3390 <title>Variablen für die einzelnen Steuern</title>
3394 <term><varname>tax</varname></term>
3402 <term><varname>taxbase</varname></term>
3405 <para>zu versteuernder Betrag</para>
3410 <term><varname>taxdescription</varname></term>
3413 <para>Name der Steuer</para>
3418 <term><varname>taxrate</varname></term>
3421 <para>Steuersatz</para>
3427 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
3428 <title>Variablen für Lieferbedingungen</title>
3432 <term><varname>delivery_term</varname></term>
3433 <listitem><para>Datenbank-Objekt der Lieferbedingung</para></listitem>
3436 <term><varname>delivery_term.description</varname></term>
3437 <listitem><para>Beschreibung der Lieferbedingung</para></listitem>
3440 <term><varname>delivery_term.long_description</varname></term>
3441 <listitem><para>Langtext bzw. übersetzter Langtext der Lieferbedingung</para></listitem>
3447 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
3448 <title>Variablen in Rechnungen</title>
3450 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
3451 <title>Allgemeine Variablen</title>
3455 <term><varname>creditremaining</varname></term>
3458 <para>Verbleibender Kredit</para>
3463 <term><varname>currency</varname></term>
3466 <para>Währung</para>
3471 <term><varname>cusordnumber</varname></term>
3474 <para>Bestellnummer beim Kunden</para>
3479 <term><varname>deliverydate</varname></term>
3482 <para>Lieferdatum</para>
3487 <term><varname>duedate</varname></term>
3490 <para>Fälligkeitsdatum</para>
3495 <term><varname>globalprojectnumber</varname></term>
3498 <para>Projektnummer des ganzen Beleges</para>
3503 <term><varname>globalprojectdescription</varname></term>
3506 <para>Projekbeschreibung des ganzen Beleges</para>
3511 <term><varname>intnotes</varname></term>
3514 <para>Interne Bemerkungen</para>
3519 <term><varname>invdate</varname></term>
3522 <para>Rechnungsdatum</para>
3527 <term><varname>invnumber</varname></term>
3530 <para>Rechnungsnummer</para>
3535 <term><varname>invtotal</varname></term>
3538 <para>gesamter Rechnungsbetrag</para>
3543 <term><varname>notes</varname></term>
3546 <para>Bemerkungen der Rechnung</para>
3551 <term><varname>orddate</varname></term>
3554 <para>Auftragsdatum</para>
3559 <term><varname>ordnumber</varname></term>
3562 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3563 erstellt wurde</para>
3568 <term><varname>payment_description</varname></term>
3571 <para>Name der Zahlart</para>
3576 <term><varname>payment_terms</varname></term>
3579 <para>Zahlungskonditionen</para>
3584 <term><varname>quodate</varname></term>
3587 <para>Angebotsdatum</para>
3592 <term><varname>quonumber</varname></term>
3595 <para>Angebotsnummer</para>
3600 <term><varname>shippingpoint</varname></term>
3603 <para>Versandort</para>
3608 <term><varname>shipvia</varname></term>
3611 <para>Transportmittel</para>
3616 <term><varname>subtotal</varname></term>
3619 <para>Zwischensumme aller Posten ohne Steuern</para>
3624 <term><varname>total</varname></term>
3627 <para>Restsumme der Rechnung (Summe abzüglich bereits
3628 bezahlter Posten)</para>
3633 <term><varname>transaction_description</varname></term>
3636 <para>Vorgangsbezeichnung</para>
3641 <term><varname>transdate</varname></term>
3644 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3645 erstellt wurde</para>
3651 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3652 <title>Variablen für jeden Posten auf der Rechnung</title>
3656 <term><varname>bin</varname></term>
3659 <para>Stellage</para>
3664 <term><varname>description</varname></term>
3667 <para>Artikelbeschreibung</para>
3672 <term><varname>discount</varname></term>
3675 <para>Rabatt als Betrag</para>
3680 <term><varname>discount_sub</varname></term>
3683 <para>Zwischensumme mit Rabatt</para>
3688 <term><varname>drawing</varname></term>
3691 <para>Zeichnung</para>
3696 <term><varname>ean</varname></term>
3699 <para>EAN-Code</para>
3704 <term><varname>image</varname></term>
3712 <term><varname>linetotal</varname></term>
3715 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3720 <term><varname>longdescription</varname></term>
3723 <para>Langtext</para>
3728 <term><varname>microfiche</varname></term>
3731 <para>Mikrofilm</para>
3736 <term><varname>netprice</varname></term>
3739 <para>Nettopreis</para>
3744 <term><varname>nodiscount_linetotal</varname></term>
3747 <para>Zeilensumme ohne Rabatt</para>
3752 <term><varname>nodiscount_sub</varname></term>
3755 <para>Zwischensumme ohne Rabatt</para>
3760 <term><varname>number</varname></term>
3763 <para>Artikelnummer</para>
3768 <term><varname>ordnumber_oe</varname></term>
3771 <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
3772 aus einem Sammelauftrag erstellt wurde</para>
3777 <term><varname>p_discount</varname></term>
3780 <para>Rabatt in Prozent</para>
3785 <term><varname>partnotes</varname></term>
3788 <para>Die beim Artikel gespeicherten Bemerkungen</para>
3793 <term><varname>partsgroup</varname></term>
3796 <para>Warengruppe</para>
3801 <term><varname>price_factor</varname></term>
3804 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
3810 <term><varname>price_factor_name</varname></term>
3813 <para>Der Name des Preisfaktors, sofern einer eingestellt
3819 <term><varname>projectnumber</varname></term>
3822 <para>Projektnummer</para>
3827 <term><varname>projectdescription</varname></term>
3830 <para>Projektbeschreibung</para>
3835 <term><varname>qty</varname></term>
3843 <term><varname>reqdate</varname></term>
3846 <para>Lieferdatum</para>
3851 <term><varname>runningnumber</varname></term>
3854 <para>Position auf der Rechnung (1, 2, 3...)</para>
3859 <term><varname>sellprice</varname></term>
3862 <para>Verkaufspreis</para>
3867 <term><varname>serialnumber</varname></term>
3870 <para>Seriennummer</para>
3875 <term><varname>tax_rate</varname></term>
3878 <para>Steuersatz</para>
3883 <term><varname>transdate_oe</varname></term>
3886 <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
3887 aus einem Sammelauftrag erstellt wurde</para>
3892 <term><varname>unit</varname></term>
3895 <para>Einheit</para>
3900 <term><varname>weight</varname></term>
3903 <para>Gewicht</para>
3908 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
3909 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
3910 einer <function>foreach</function>-Schleife ausgegeben werden, da
3911 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
3912 können. Die Variablen dafür lauten:</para>
3916 <term><varname>make</varname></term>
3919 <para>Lieferant</para>
3924 <term><varname>model</varname></term>
3927 <para>Lieferantenartikelnummer</para>
3933 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
3934 <title>Variablen für die einzelnen Zahlungseingänge</title>
3938 <term><varname>payment</varname></term>
3946 <term><varname>paymentaccount</varname></term>
3954 <term><varname>paymentdate</varname></term>
3962 <term><varname>paymentmemo</varname></term>
3970 <term><varname>paymentsource</varname></term>
3979 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
3980 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
3982 <para>Die vom Benutzer definierten Variablen für Kunden und
3983 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
3984 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
3985 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
3986 Variablennamen zusammen.</para>
3988 <para>Beispiel: Der Benutzer hat eine Variable namens
3989 <varname>number_of_employees</varname> definiert, die die Anzahl der
3990 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
3991 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
3996 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
3997 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
3999 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
4000 <title>Namen der Vorlagen</title>
4002 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
4003 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
4004 Erstellung einer Rechnung über die Mahngebühren und Zinsen
4005 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
4006 Vorlagenname für diese Mahnstufe mit dem Zusatz
4007 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
4008 für die ausgewählte Sprache und den ausgewählten Drucker
4012 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
4013 <title>Allgemeine Variablen in Mahnungen</title>
4015 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4016 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4017 Kunden stehen als Variablen <varname>name</varname>,
4018 <varname>street</varname>, <varname>zipcode</varname>,
4019 <varname>city</varname>, <varname>country</varname>,
4020 <varname>department_1</varname>, <varname>department_2</varname>,
4021 und <varname>email</varname> zur Verfügung.</para>
4023 <para>Weitere Variablen beinhalten:</para>
4027 <term><varname>dunning_date</varname></term>
4030 <para>Datum der Mahnung</para>
4035 <term><varname>dunning_duedate</varname></term>
4038 <para>Fälligkeitsdatum für diese Mahhnung</para>
4043 <term><varname>dunning_id</varname></term>
4046 <para>Mahnungsnummer</para>
4051 <term><varname>fee</varname></term>
4054 <para>Kummulative Mahngebühren</para>
4059 <term><varname>interest_rate</varname></term>
4062 <para>Zinssatz per anno in Prozent</para>
4067 <term><varname>total_amount</varname></term>
4070 <para>Gesamter noch zu zahlender Betrag als
4071 <function>fee</function> + <function>total_interest</function>
4072 + <function>total_open_amount</function></para>
4077 <term><varname>total_interest</varname></term>
4080 <para>Zinsen per anno über alle Rechnungen</para>
4085 <term><varname>total_open_amount</varname></term>
4088 <para>Summe über alle offene Beträge der Rechnungen</para>
4094 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
4095 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
4099 <term><varname>dn_amount</varname></term>
4102 <para>Rechnungssumme (brutto)</para>
4107 <term><varname>dn_duedate</varname></term>
4110 <para>Originales Fälligkeitsdatum der Rechnung</para>
4115 <term><varname>dn_dunning_date</varname></term>
4118 <para>Datum der Mahnung</para>
4123 <term><varname>dn_dunning_duedate</varname></term>
4126 <para>Fälligkeitsdatum der Mahnung</para>
4131 <term><varname>dn_fee</varname></term>
4134 <para>Kummulative Mahngebühr</para>
4139 <term><varname>dn_interest</varname></term>
4142 <para>Zinsen per anno für diese Rechnung</para>
4147 <term><varname>dn_invnumber</varname></term>
4150 <para>Rechnungsnummer</para>
4155 <term><varname>dn_linetotal</varname></term>
4158 <para>Noch zu zahlender Betrag (ergibt sich aus
4159 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
4160 + <varname>dn_interest</varname>)</para>
4165 <term><varname>dn_netamount</varname></term>
4168 <para>Rechnungssumme (netto)</para>
4173 <term><varname>dn_open_amount</varname></term>
4176 <para>Offener Rechnungsbetrag</para>
4181 <term><varname>dn_ordnumber</varname></term>
4184 <para>Bestellnummer</para>
4189 <term><varname>dn_transdate</varname></term>
4192 <para>Rechnungsdatum</para>
4197 <term><varname>dn_curr</varname></term>
4200 <para>Währung, in der die Rechnung erstellt wurde. (Die
4201 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
4207 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
4208 <title>Variablen in automatisch erzeugten Rechnungen über
4209 Mahngebühren</title>
4211 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4212 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4213 Kunden stehen als Variablen <varname>name</varname>,
4214 <varname>street</varname>, <varname>zipcode</varname>,
4215 <varname>city</varname>, <varname>country</varname>,
4216 <varname>department_1</varname>, <varname>department_2</varname>,
4217 und <varname>email</varname> zur Verfügung.</para>
4219 <para>Weitere Variablen beinhalten:</para>
4223 <term><varname>duedate</varname></term>
4226 <para>Fälligkeitsdatum der Rechnung</para>
4231 <term><varname>dunning_id</varname></term>
4234 <para>Mahnungsnummer</para>
4239 <term><varname>fee</varname></term>
4242 <para>Mahngebühren</para>
4247 <term><varname>interest</varname></term>
4255 <term><varname>invamount</varname></term>
4258 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
4259 <varname>interest</varname>)</para>
4264 <term><varname>invdate</varname></term>
4267 <para>Rechnungsdatum</para>
4272 <term><varname>invnumber</varname></term>
4275 <para>Rechnungsnummer</para>
4282 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
4283 <title>Variablen in anderen Vorlagen</title>
4286 <title>Einführung</title>
4288 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
4289 Rechnung. Allerdings heißen die Variablen, die mit
4290 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
4291 fangen sie mit <varname>quo</varname> für "quotation" an:
4292 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
4293 wiederum fangen sie mit <varname>ord</varname> für "order" an:
4294 <varname>ordnumber</varname> für Bestellnummer etc.</para>
4296 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
4297 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
4298 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
4299 Vorlage keine Bedeutung haben oder noch nicht belegt sein
4302 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
4303 in Rechnungen aufgeführt.</para>
4306 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
4307 <title>Angebote und Preisanfragen</title>
4311 <term><varname>quonumber</varname></term>
4314 <para>Angebots- bzw. Anfragenummer</para>
4319 <term><varname>reqdate</varname></term>
4322 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
4323 Preisanfragen)</para>
4328 <term><varname>transdate</varname></term>
4331 <para>Angebots- bzw. Anfragedatum</para>
4337 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
4338 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
4342 <term><varname>ordnumber</varname></term>
4345 <para>Auftragsnummer</para>
4350 <term><varname>reqdate</varname></term>
4353 <para>Lieferdatum</para>
4358 <term><varname>transdate</varname></term>
4361 <para>Auftragsdatum</para>
4367 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
4368 <title>Lieferscheine (Verkauf und Einkauf)</title>
4372 <term><varname>cusordnumber</varname></term>
4375 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
4376 des Lieferanten (im Einkauf)</para>
4381 <term><varname>donumber</varname></term>
4384 <para>Lieferscheinnummer</para>
4389 <term><varname>transdate</varname></term>
4392 <para>Lieferscheindatum</para>
4397 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
4398 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
4399 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
4400 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
4401 <function>foreach</function>-Schleife ausgegeben werden. Diese
4402 Variablen sind:</para>
4406 <term><varname>si_bin</varname></term>
4409 <para>Lagerplatz</para>
4414 <term><varname>si_chargenumber</varname></term>
4417 <para>Chargennummer</para>
4422 <term><varname>si_bestbefore</varname></term>
4425 <para>Mindesthaltbarkeit</para>
4430 <term><varname>si_number</varname></term>
4433 <para>Artikelnummer</para>
4438 <term><varname>si_qty</varname></term>
4441 <para>Anzahl bzw. Menge</para>
4446 <term><varname>si_runningnumber</varname></term>
4449 <para>Positionsnummer (1, 2, 3 etc)</para>
4454 <term><varname>si_unit</varname></term>
4457 <para>Einheit</para>
4462 <term><varname>si_warehouse</varname></term>
4471 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
4472 <title>Variablen für Sammelrechnung</title>
4476 <term><varname>c0total</varname></term>
4479 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
4485 <term><varname>c30total</varname></term>
4488 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
4489 und < 60 Tage</para>
4494 <term><varname>c60total</varname></term>
4497 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
4498 und < 90 Tage</para>
4503 <term><varname>c90total</varname></term>
4506 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
4512 <term><varname>total</varname></term>
4515 <para>Gesamtbetrag aller Rechnungen</para>
4520 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
4524 <term><varname>invnumber</varname></term>
4527 <para>Rechnungsnummer</para>
4532 <term><varname>invdate</varname></term>
4535 <para>Rechnungsdatum</para>
4540 <term><varname>duedate</varname></term>
4543 <para>Fälligkeitsdatum</para>
4548 <term><varname>amount</varname></term>
4551 <para>Summe der Rechnung</para>
4556 <term><varname>open</varname></term>
4559 <para>Noch offener Betrag der Rechnung</para>
4564 <term><varname>c0</varname></term>
4567 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4573 <term><varname>c30</varname></term>
4576 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4582 <term><varname>c60</varname></term>
4585 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4591 <term><varname>c90</varname></term>
4594 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4602 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4603 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4605 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4606 <title>Einfürhung</title>
4608 <para>Der Parser kennt neben den Variablen einige weitere
4609 Konstrukte, die gesondert behandelt werden. Diese sind wie
4610 Variablennamen in spezieller Weise markiert:
4611 <command><%anweisung%> ... <%end%></command></para>
4613 <para>Anmerkung zum <command><%end%></command>: Der besseren
4614 Verständlichkeit halber kann man nach dem <command>end</command>
4615 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4616 Anweisung (z.B. <command>if</command> oder
4617 <command>foreach</command>) damit abgeschlossen wird.</para>
4619 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4620 <command><%if type == "sales_quotation"%></command>, so könnte
4621 er mit <command><%end%></command> genauso abgeschlossen werden
4622 wie mit <command><%end if%></command> oder auch
4623 <command><%end type == "sales_quotation"%></command>.</para>
4626 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4627 <title>Der if-Block</title>
4629 <programlisting><%if variablenname%>
4631 <%end%></programlisting>
4633 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4634 und dem "end" werden nur ausgegeben, wenn die Variable
4635 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4637 <para>Handelt es sich bei der benannten Variable um ein Array, also um einen Variablennamen, über den man mit
4638 <command><%foreach variablenname%></command> iteriert, so wird mit diesem Konstrukt darauf getestet, ob das Array Elemente
4639 enthält. Somit würde im folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt ihrer Überschrift "Zahlungseingänge"
4640 ausgegeben, wenn tatsächlich welche getätigt wurden:</para>
4642 <programlisting><%if payment%>
4644 <%foreach payment%>
4645 Am <%paymentdate%>: <%payment%> €
4646 <%end foreach%>
4647 <%end if%></programlisting>
4649 <para>Die Bedingung kann auch negiert werden, indem das Wort
4650 <function>not</function> nach dem <filename>if</filename> verwendet
4651 wird. Beispiel:</para>
4653 <programlisting><%if not cp_greeting%>
4655 <%end%></programlisting>
4657 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4658 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4659 einer Variablen mit einer festen Zeichenkette oder einer anderen
4660 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4661 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4662 die rechte Seite des Vergleichsoperators in Anführungszeichen
4663 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4664 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4667 <programlisting><%if var1 == "Wert"%></programlisting>
4669 <para>Testet die Variable <varname>var1</varname> auf
4670 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4671 Mittels <function>!=</function> anstelle von <function>==</function>
4672 würde auf Ungleichheit getestet.</para>
4674 <programlisting><%if var1 == var2%></programlisting>
4676 <para>Testet die Variable <varname>var1</varname> auf
4677 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4678 <function>!=</function> anstelle von <function>==</function> würde
4679 auf Ungleichheit getestet.</para>
4681 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4682 auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
4683 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4684 dieselbe Syntax wie oben nur mit <function>=~</function> und
4685 <function>!~</function> als Vergleichsoperatoren.</para>
4687 <para>Beispiel für einen Test, ob die Variable
4688 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4689 <constant>schwierig</constant> enthält:</para>
4691 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4694 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4695 <title>Der foreach-Block</title>
4697 <programlisting><%foreach variablenname%>
4699 <%end%></programlisting>
4701 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4702 wie das Perl-Array der Variablen <varname>variablenname</varname>
4703 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4704 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4705 benutzt. In jedem Durchlauf werden die <link
4706 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4707 Variablen</link> jeweils auf den Wert für die aktuelle Position
4710 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
4712 <programlisting><%foreach number%>
4713 Position: <%runningnumber%>
4714 Anzahl: <%qty%>
4715 Artikelnummer: <%number%>
4716 Beschreibung: <%description%>
4718 <%end%></programlisting>
4720 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
4721 <function><%foreach%></function>-Block innerhalb einer
4722 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
4723 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
4724 Inhalt zwischen <function><%foreach%></function> und
4725 <function><%end%></function> wiederholt, nicht aber die
4726 komplette Zeile, in der er steht.</para>
4730 <sect2 id="dokumentenvorlagen-und-variablen.markup">
4731 <title>Markup-Code zur Textformatierung innerhalb von
4734 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
4735 anders formatiert haben möchte, so ist dies begrenzt möglich.
4736 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
4737 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
4738 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
4739 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
4740 (HTML oder PDF über LaTeX) umgesetzt.</para>
4742 <para>Die unterstützen Formatierungen sind:</para>
4746 <term><b>Text</b></term>
4749 <para>Text wird in Fettdruck gesetzt.</para>
4754 <term><i>Text</i></term>
4757 <para>Text wird kursiv gesetzt.</para>
4762 <term><u>Text</u></term>
4765 <para>Text wird unterstrichen.</para>
4770 <term><s>Text</s></term>
4773 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
4774 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
4779 <term><bullet></term>
4782 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
4788 <para>Der Befehl <command><bullet></command> funktioniert
4789 momentan auch nur in Latex-Vorlagen.</para>
4793 <sect1 id="excel-templates">
4794 <title>Excel-Vorlagen</title>
4796 <sect2 id="excel-templates.summary">
4797 <title>Zusammenfassung</title>
4799 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
4800 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
4804 <sect2 id="excel-templates.usage">
4805 <title>Bedienung</title>
4807 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
4808 werden. Die Konfigurationsoption heißt <varname>excel_templates =
4809 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
4811 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
4812 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
4813 werden. In den normalen Verkaufsmasken taucht nun
4814 <constant>Excel</constant> als auswählbares Format auf und kann von da
4815 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
4817 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
4818 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
4819 <filename>sales_quotation.xls</filename> gespeichert.</para>
4822 <sect2 id="excel-templates.syntax">
4823 <title>Variablensyntax</title>
4825 <para>Einfache Syntax:
4826 <command><<varname>></command></para>
4828 <para>Dabei sind <constant><<</constant> und
4829 <constant>>></constant> die Delimiter. Da Excel auf festen
4830 Breiten besteht, kann der Tag künstlich verlängert werden, indem
4831 weitere <constant><</constant> oder <constant>></constant>
4832 eingefügt werden. Der Tag muss nicht symmetrisch sein.
4835 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4837 <para>Um die Limitierung der festen Breite zu reduzieren, können
4838 weitere Variablen in einem Block interpoliert werden. Whitespace wird
4839 dazwishen dann erhalten. Beispiel:</para>
4841 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4843 <para>Die Variablen werden interpoliert, und linksbündig mit
4844 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
4845 lang, werden überzählige Zeichen abgeschnitten.</para>
4847 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
4848 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
4850 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4852 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
4853 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
4857 <sect2 id="excel-templates.limitations">
4858 <title>Einschränkungen</title>
4860 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
4861 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
4862 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
4863 Text zu ersetzen.</para>
4865 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
4866 <command><%if%></command> und
4867 <command><%foreach%></command> nicht vorhanden. Der Delimiter
4868 <constant><% %></constant> kommt in den Headerinformationen
4869 evtl. vor. Deshalb wurde auf den sichereren Delimiter
4870 <constant><<</constant> und <constant>>></constant>
4874 <sect1 id="features.warehouse">
4875 <title>Mandantenkonfiguration Lager</title>
4876 Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt:
4877 Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die Möglichkeit hier über den
4878 Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. Ferner kann
4879 jede Position eines Lieferscheins ein-, bzw. ausgelagert werden (Einkauf-, bzw. Verkauf).
4880 Es können beliebig viele Lager mit beliebig vielen Lagerplätzen abgebildet werden.
4881 Die Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder Einzelposition und
4882 das Auswählen dieser Position zu einem Lager mit Lagerplatz.
4883 Dieses Verfahren lässt sich schrittweise vereinfachen, je nachdem wie die Einstellungen in
4884 der Mandatenkonfiguration gesetzt werden.
4887 <para><option>Auslagern über Standardlagerplatz</option> Hier wird ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz)
4888 in dem Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über den Standardlagerplatz (konfigurierbar pro Ware) durchführt.
4892 <para><option>Auslagern ohne Bestandsprüfung</option>Das obige Auslagern schlägt fehl, wenn die entsprechende Menge für
4893 die Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit dieser Option
4894 erlauben. Hierfür muss ein entsprechender Lagerplatz (Fehlbestand, o.ä.) konfiguriert sein.</para>
4897 Zusätzliche Funktionshinweise:
4899 <listitem><para><option>Standard-Lagerplatz</option>Ist dieser konfiguriert, wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
4900 Stammdaten-> Waren / Dienstleistung / Erzeugnis verwendet.
4903 <listitem><para><option>Standard-Lagerplatz verwenden, falls keiner in Stammdaten definiert</option>Wird beim 'Auslagern über Standardlagerplatz'
4904 keine Standardlagerplatz zu der Ware gefunden, so wird mit dieser Option einfach der Standardlagerplatz verwendet.
4912 <title>Entwicklerdokumentation</title>
4914 <sect1 id="devel.globals" xreflabel="Globale Variablen">
4915 <title>Globale Variablen</title>
4918 <title>Wie sehen globale Variablen in Perl aus?</title>
4920 <para>Globale Variablen liegen in einem speziellen namespace namens
4921 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
4922 globs global und die meisten speziellen Variablen sind...
4925 <para>Daraus ergeben sich folgende Formen:</para>
4929 <term><literal>$main::form</literal></term>
4932 <para>expliziter Namespace "main"</para>
4937 <term><literal>$::form</literal></term>
4940 <para>impliziter Namespace "main"</para>
4945 <term><literal>open FILE, "file.txt"</literal></term>
4948 <para><varname>FILE</varname> ist global</para>
4953 <term><literal>$_</literal></term>
4956 <para>speziell</para>
4961 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
4962 Schlüsselwort wie "<function>global</function>", mit dem man
4963 importieren kann. <function>my</function>, <function>our</function>
4964 und <function>local</function> machen was anderes.</para>
4968 <term><literal>my $form</literal></term>
4971 <para>lexikalische Variable, gültig bis zum Ende des
4977 <term><literal>our $form</literal></term>
4980 <para><varname>$form</varname> referenziert ab hier
4981 <varname>$PACKAGE::form</varname>.</para>
4986 <term><literal>local $form</literal></term>
4989 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
4990 des scopes zurückgesetzt</para>
4997 <title>Warum sind globale Variablen ein Problem?</title>
4999 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
5001 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
5002 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
5003 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
5004 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
5005 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
5006 Datenbankverbindungen, weil die sehr lange zum Initialisieren
5009 <para>Das zweite Problem ist <function>strict</function>. Unter
5010 <function>strict</function> werden alle Variablen die nicht explizit
5011 mit <function>Package</function>, <function>my</function> oder
5012 <function>our</function> angegeben werden als Tippfehler angemarkert,
5013 dies hat, seit der Einführung, u.a. schon so manche langwierige
5014 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
5015 angegeben werden, werden die nicht geprüft, und somit kann sich
5016 schnell ein Tippfehler einschleichen.</para>
5020 <title>Kanonische globale Variablen</title>
5022 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
5023 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
5024 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
5025 umhergereicht werden.</para>
5027 <para>Diese Variablen sind im Moment die folgenden neun:</para>
5031 <para><varname>$::form</varname></para>
5035 <para><varname>%::myconfig</varname></para>
5039 <para><varname>$::locale</varname></para>
5043 <para><varname>$::lxdebug</varname></para>
5047 <para><varname>$::auth</varname></para>
5051 <para><varname>$::lx_office_conf</varname></para>
5055 <para><varname>$::instance_conf</varname></para>
5059 <para><varname>$::dispatcher</varname></para>
5063 <para><varname>$::request</varname></para>
5067 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
5068 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
5069 Eigenschaften (Konventionen):</para>
5072 <title>$::form</title>
5076 <para>Ist ein Objekt der Klasse
5077 "<classname>Form</classname>"</para>
5081 <para>Wird nach jedem Request gelöscht</para>
5085 <para>Muss auch in Tests und Konsolenscripts vorhanden
5090 <para>Enthält am Anfang eines Requests die Requestparameter vom
5095 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
5096 cachen, das wird aber momentan absichtlich zerstört</para>
5100 <para><varname>$::form</varname> wurde unter <productname>SQL
5101 Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
5102 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
5103 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
5104 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
5105 <function>IS->retrieve_customer()</function> in Sicherheit
5108 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
5109 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
5110 3552, Stand version 2.7beta), um dies hinterher wieder auf den
5111 richtigen Wert zu setzen:</para>
5113 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
5114 $::myconfig{numberformat} = $numberformat;
5115 # (...) div Berechnungen
5116 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
5118 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
5119 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
5120 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
5121 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
5122 Es geht ziemlich sicher etwas kaputt.</para>
5124 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
5125 in den <productname>Template::Toolkit</productname> Templates
5126 außerhalb der Controller: der Ausdruck <function>[% var
5127 %]</function> greift auf <varname>$::form->{var}</varname> zu.
5128 Unter Controllern ist der Standard Scope anders, da lautet der
5129 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
5130 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
5131 <function><%var%></function> zeigt auf
5132 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
5133 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
5136 <programlisting>[%- IF business %]
5137 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
5138 [%- END %]</programlisting>
5140 <para>Entweder wird hier dann $::form->{business} ausgewertet
5141 oder aber der Funktion
5142 <function>$form->parse_html_template</function> wird explizit
5143 noch ein zusätzlicher Hash übergeben, der dann auch in den
5144 (Web-)Templates zu Verfügung steht, bspw. so:</para>
5146 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
5148 <para>Innerhalb von Schleifen wird
5149 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
5150 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
5151 welches über alle Positionen eines Lieferscheins in Schleife
5154 <programlisting>for $i (1 .. $form->{rowcount}) {
5156 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
5157 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
5158 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
5164 <title>%::myconfig</title>
5168 <para>Das einzige Hash unter den globalen Variablen</para>
5172 <para>Wird spätestens benötigt wenn auf die Datenbank
5173 zugegriffen wird</para>
5177 <para>Wird bei jedem Request neu erstellt.</para>
5181 <para>Enthält die Userdaten des aktuellen Logins</para>
5185 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
5186 extern serialisiert werden, weil da auch der Datenbankzugriff
5187 für diesen user drinsteht.</para>
5191 <para>Enthält unter anderem Listenbegrenzung vclimit,
5192 Datumsformat dateformat und Nummernformat numberformat</para>
5196 <para>Enthält Datenbankzugriffinformationen</para>
5200 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
5201 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
5202 aktuellen Users entscheiden müssen, befragen
5203 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
5204 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
5205 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
5206 Informationen über den Benutzer die über die
5207 Administrator-Schnittstelle eingegeben wurden.</para>
5211 <title>$::locale</title>
5215 <para>Objekt der Klasse "Locale"</para>
5219 <para>Wird pro Request erstellt</para>
5223 <para>Muss auch für Tests und Scripte immer verfügbar
5228 <para>Cached intern über Requestgrenzen hinweg benutzte
5233 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
5234 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
5238 <title>$::lxdebug</title>
5242 <para>Objekt der Klasse "LXDebug"</para>
5246 <para>Wird global gecached</para>
5250 <para>Muss immer verfügbar sein, in nahezu allen
5255 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
5256 bereit, wie "<function>enter_sub</function>" und
5257 "<function>leave_sub</function>", mit denen in den alten Modulen ein
5258 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
5259 der man die Wallclockzeit seit Requeststart loggen kann, sowie
5260 "<function>message</function>" und "<function>dump</function>" mit
5261 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
5264 <para>Beispielsweise so:</para>
5266 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
5267 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
5271 <title>$::auth</title>
5275 <para>Objekt der Klasse "SL::Auth"</para>
5279 <para>Wird global gecached</para>
5283 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
5287 <para>Wird nach jedem Request resettet.</para>
5291 <para><varname>$::auth</varname> stellt Funktionen bereit um die
5292 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
5293 vom aktuellen User abhängen wird das Objekt aus
5294 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
5295 Request kurz resettet.</para>
5297 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten. Dessen Einstellungen können über
5298 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert ist ein Hash mit den Werten aus der Tabelle
5299 <literal>auth.clients</literal>.</para>
5303 <title>$::lx_office_conf</title>
5307 <para>Objekt der Klasse
5308 "<classname>SL::LxOfficeConf</classname>"</para>
5312 <para>Global gecached</para>
5316 <para>Repräsentation der
5317 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
5321 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
5322 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
5323 das Programm die Konfiguration ändern kann oder sollte.</para>
5325 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
5326 Debug- und Trace-Log-Datei wie folgt konfiguriert und
5329 <programlisting>[debug]
5330 file_name = /tmp/kivitendo-debug.log</programlisting>
5332 <para>ist der Key <varname>file</varname> im Programm als
5333 <varname>$::lx_office_conf->{debug}{file}</varname>
5337 <para>Zugriff auf die Konfiguration erfolgt im Moment über
5338 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
5343 <title>$::instance_conf</title>
5347 <para>Objekt der Klasse
5348 "<classname>SL::InstanceConfiguration</classname>"</para>
5352 <para>wird pro Request neu erstellt</para>
5356 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
5357 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
5358 ist hier eine Mandantendatenbank. Beispielsweise überprüft
5359 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
5360 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
5364 <title>$::dispatcher</title>
5368 <para>Objekt der Klasse
5369 "<varname>SL::Dispatcher</varname>"</para>
5373 <para>wird pro Serverprozess erstellt.</para>
5377 <para>enthält Informationen über die technische Verbindung zum
5382 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
5383 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
5384 Objekt untergebracht.</para>
5388 <title>$::request</title>
5392 <para>Hashref (evtl später Objekt)</para>
5396 <para>Wird pro Request neu initialisiert.</para>
5400 <para>Keine Unterstruktur garantiert.</para>
5404 <para><varname>$::request</varname> ist ein generischer Platz um
5405 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
5406 at a distance benutzt werden, sondern um lokales memoizing zu
5407 ermöglichen, das garantiert am Ende des Requests zerstört
5410 <para>Vieles von dem, was im moment in <varname>$::form</varname>
5411 liegt, sollte eigentlich hier liegen. Die groben
5412 Differentialkriterien sind:</para>
5416 <para>Kommt es vom User, und soll unverändert wieder an den
5417 User? Dann <varname>$::form</varname>, steht da eh schon</para>
5421 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
5422 Requests gebraucht werden? Dann
5423 <varname>$::request</varname></para>
5427 <para>Muss ich von anderen Teilen des Programms lesend drauf
5428 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
5429 Wrappermethode</para>
5436 <title>Ehemalige globale Variablen</title>
5438 <para>Die folgenden Variablen waren einmal im Programm, und wurden
5442 <title>$::cgi</title>
5446 <para>war nötig, weil cookie Methoden nicht als
5447 Klassenfunktionen funktionieren</para>
5451 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
5452 Klassennamespace gehalten wird und über Requestgrenzen
5457 <para>liegt jetzt unter
5458 <varname>$::request->{cgi}</varname></para>
5464 <title>$::all_units</title>
5468 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
5469 ein paar hundert mal pro Request eine Liste der Einheiten
5470 brauchen, und de als Parameter durch einen Riesenstack von
5471 Funktionen geschleift werden müssten.</para>
5475 <para>Liegt jetzt unter
5476 <varname>$::request->{cache}{all_units}</varname></para>
5481 <function>AM->retrieve_all_units()</function> gesetzt oder
5488 <title>%::called_subs</title>
5492 <para>wurde benutzt um callsub deep recursions
5497 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
5498 möglichen Rekursioenen darstellt, und da nie welche
5503 <para>komplette recursion protection wurde entfernt.</para>
5510 <sect1 id="devel.fcgi">
5511 <title>Entwicklung unter FastCGI</title>
5513 <sect2 id="devel.fcgi.general">
5514 <title>Allgemeines</title>
5516 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
5517 werden, muss der Webserver neu gestartet werden.</para>
5519 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
5520 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
5521 müssen folgende Aspekte beachtet werden.</para>
5524 <sect2 id="devel.fcgi.exiting">
5525 <title>Programmende und Ausnahmen</title>
5527 <para>Betrifft die Funktionen <function>warn</function>,
5528 <function>die</function>, <function>exit</function>,
5529 <function>carp</function> und <function>confess</function>.</para>
5531 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
5532 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
5533 am Laufen zu halten. Man kann mit <function>die</function>,
5534 <function>confess</function> oder <function>carp</function> Fehler
5535 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
5536 eigene <function>$::form-</function>error()> tut im Prinzip das
5537 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
5538 <function>exit</function> hingegen werden nicht abgefangen.
5539 <function>warn</function> wird direkt nach STDERR, also in Server Log
5540 eine Nachricht schreiben (sofern in der Konfiguration nicht die
5541 Warnungen in das kivitendo Log umgeleitet wurden), und
5542 <function>exit</function> wird die Ausführung beenden.</para>
5544 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
5545 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
5546 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
5547 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
5550 <sect2 id="devel.fcgi.globals">
5551 <title>Globale Variablen</title>
5553 <para>Um zu vermeiden, dass Informationen von einem Request in einen
5554 anderen gelangen, müssen alle globalen Variablen vor einem Request
5555 sauber initialisiert werden. Das ist besonders wichtig im
5556 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
5557 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
5560 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
5561 abgetrennten Block, der alle kanonischen globalen Variablen listet und
5562 erklärt. Bitte keine anderen einführen ohne das sauber zu
5563 dokumentieren.</para>
5565 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
5566 man sicher geht, dass man die richtige erwischt.</para>
5569 <sect2 id="devel.fcgi.performance">
5570 <title>Performance und Statistiken</title>
5572 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
5573 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
5574 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
5575 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
5576 sind es je nach Menge der definierten Variablen 1-2s. Ab der
5577 Moose/Rose::DB Version sind es 5-6s.</para>
5579 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
5580 den kritischen Pfaden, unter 0,15 sonst.</para>
5584 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
5585 <title>SQL-Upgradedateien</title>
5587 <sect2 id="db-upgrade-files.introduction"
5588 xreflabel="Einführung in die Datenbank-Upgradedateien">
5589 <title>Einführung</title>
5591 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte gesteuert, die sich im Verzeichnis <filename>sql/Pg-upgrade2</filename>
5592 befinden. In diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren, die neben den eigentlich auszuführenden SQL- oder
5593 Perl-Befehlen einige Kontrollinformationen enthält.</para>
5595 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten, sodass Datenbankscripte zwar in einer sicheren Reihenfolge
5596 ausgeführt werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt werden, wenn die Tabelle mit <literal>CREATE
5597 TABLE</literal> angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man keine Versionsnummern braucht.</para>
5599 <para>kivitendo merkt sich dabei, welches der Upgradescripte in <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
5600 führt diese nicht erneut aus. Dazu dient die Tabelle "<literal>schema_info</literal>", die bei der Anmeldung automatisch angelegt
5604 <sect2 id="db-upgrade-files.format"
5605 xreflabel="Format der Upgradedateien">
5606 <title>Format der Kontrollinformationen</title>
5608 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5609 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5610 hat dabei das folgende Format:</para>
5612 <para>Für SQL-Upgradedateien:</para>
5614 <programlisting>-- @key: value</programlisting>
5616 <para>Für Perl-Upgradedateien:</para>
5618 <programlisting># @key: value</programlisting>
5620 <para>Leerzeichen vor "<varname>value</varname>" werden
5623 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5627 <term><varname>tag</varname></term>
5630 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5631 Dieser "tag" kann von anderen Kontrolldateien in ihren
5632 Abhängigkeiten verwendet werden (Schlüsselwort
5633 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5634 in der Datenbank eingetragen wird.</para>
5636 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5637 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5639 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5640 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5641 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5647 <term><varname>charset</varname></term>
5650 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5651 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
5652 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte hingegen müssen immer in UTF-8 encodiert sein und sollten
5653 demnach auch ein "<literal>use utf8;</literal>" enthalten.</para>
5658 <term><varname>description</varname></term>
5661 <para>Benötigt. Eine Beschreibung, was in diesem Update
5662 passiert. Diese wird dem Benutzer beim eigentlichen
5663 Datenbankupdate angezeigt. Während der Tag in englisch gehalten
5664 sein sollte, sollte die Beschreibung auf Deutsch
5670 <term><varname>depends</varname></term>
5673 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5674 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
5675 dass die in dieser Liste aufgeführten Scripte bereits
5676 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5678 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5679 Script "b" existiert, das von Änderungen in "a" abhängt, und
5680 eine neue Kontrolldatei für "c" erstellt wird, die von
5681 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5682 Tag "b" als Abhängigkeit zu definieren.</para>
5684 <para>Es ist nicht erlaubt, sich selbst referenzierende
5685 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5686 und "c" -> "a").</para>
5691 <term><varname>priority</varname></term>
5694 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5695 der Scripte ausgeführt werden, die die gleichen
5696 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5697 der Wert 1000 benutzt.</para>
5699 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5700 "depends" benutzt werden. kivitendo sortiert die auszuführenden
5701 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5702 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5703 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5704 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5705 Priorität alphabetisch nach dem "tag".</para>
5710 <term><varname>ignore</varname></term>
5713 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
5714 Skript bei der Anmeldung ignoriert und entsprechend nicht
5721 <sect2 id="db-upgrade-files.format-perl-files" xreflabel="Format von Perl-Upgradedateien">
5722 <title>Format von in Perl geschriebenen Datenbankupgradescripten</title>
5724 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so ausgeführt sondern müssen sich an gewisse Konventionen
5725 halten. Dafür bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
5727 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse dar, die vom Elternobjekt
5728 "<literal>SL::DBUpgrade2::Base</literal>" erben und eine Funktion namens "<literal>run</literal>" zur Verfügung stellen muss. Das
5729 Script wird ausgeführt, indem eine Instanz dieser Klasse erzeugt und darauf die erwähnte "<literal>run</literal>" aufgerufen
5732 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert für "<literal>@tag</literal>" ableitet. Dabei werden alle
5733 Zeichen, die in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche ersetzt. Insgesamt sieht der Paketname wie folgt
5734 aus: "<literal>SL::DBUpgrade2::tag</literal>".</para>
5736 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
5737 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
5739 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie folgt aus:</para>
5741 <programlisting># @tag: beispiel-upgrade-file42
5742 # @description: Ein schönes Beispielscript
5743 # @depends: release_3_1_0
5744 package SL::DBUpgrade2::beispiel_upgrade_file42;
5749 use parent qw(SL::DBUpgrade2::Base);
5754 # hier Aktionen ausführen
5763 <sect2 id="db-upgrade-files.dbupgrade-tool"
5764 xreflabel="Hilfsscript dbupgrade2_tool.pl">
5765 <title>Hilfsscript dbupgrade2_tool.pl</title>
5767 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
5768 existiert ein Hilfsscript namens
5769 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
5770 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
5771 liest alle Datenbankupgradescripte aus dem Verzeichnis
5772 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
5773 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
5774 von der Kommandozeile überprüft werden können.</para>
5776 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
5777 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
5778 sich aber auch Informationen auf verschiedene Art ausgeben
5783 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
5784 --list</command>"</para>
5786 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
5787 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
5788 würde. Es werden neben der Listenposition der Tag, die
5789 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
5793 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
5794 --tree</command>"</para>
5796 <para>Listet alle Tags in Baumform basierend auf den
5797 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
5798 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
5799 beim übergeordneten Script als Abhängigkeit eingetragen
5803 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
5804 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
5805 --rtree</command>"</para>
5807 <para>Listet alle Tags in Baumform basierend auf den
5808 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
5809 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
5810 die das übergeordnete Script als Abhängigkeit eingetragen
5815 <para>Baumform mit Postscriptausgabe:
5816 "<command>./scripts/dbupgrade2_tool.pl
5817 --graphviz</command>"</para>
5819 <para>Benötigt das Tool "<command>graphviz</command>", um mit
5820 seiner Hilfe die <link
5821 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
5822 Baumform</link> in eine Postscriptdatei namens
5823 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
5824 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
5825 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
5826 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
5831 <para>Scripte, von denen kein anderes Script abhängt:
5832 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
5834 <para>Listet die Tags aller Scripte auf, von denen keine anderen
5835 Scripte abhängen.</para>
5841 <sect1 id="translations-languages" xreflabel="Translations and languages">
5842 <title>Translations and languages</title>
5844 <sect2 id="translations-languages.introduction"
5845 xreflabel="Introduction to translations and languages">
5846 <title>Introduction</title>
5849 <para>Dieser Abschnitt ist in Englisch geschrieben, um
5850 internationalen Übersetzern die Arbeit zu erleichtern.</para>
5853 <para>This section describes how localization packages in kivitendo
5854 are built. Currently the only language fully supported is German, and
5855 since most of the internal messages are held in English the English
5856 version is usable too.</para>
5858 <para>A stub version of French is included but not functunal at this
5862 <sect2 id="translations-languages.character-set"
5863 xreflabel="Character set">
5864 <title>Character set</title>
5866 <para>All files included in a language pack must use UTF-8 as their encoding.</para>
5869 <sect2 id="translations-languages.file-structure"
5870 xreflabel="File structure">
5871 <title>File structure</title>
5873 <para>The structure of locales in kivitendo is:</para>
5875 <programlisting>kivitendo/locale/<langcode>/</programlisting>
5877 <para>where <langcode> stands for an abbreviation of the
5878 language package. The builtin packages use two letter <ulink
5879 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
5880 but the actual name is not relevant for the program and can easily be
5882 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
5883 tags</ulink> (i.e. "en_GB"). In fact the original language packages
5884 from SQL Ledger are named in this way.</para>
5886 <para>In such a language directory the following files are
5891 <term>LANGUAGE</term>
5894 <para>This file is mandatory.</para>
5896 <para>The <filename>LANGUAGE</filename> file contains the self
5897 descripted name of the language. It should contain a native
5898 representation first, and in parenthesis an english translation
5899 after that. Example:</para>
5901 <programlisting>Deutsch (German)</programlisting>
5909 <para>This file is mandatory.</para>
5911 <para>The central translation file. It is essentially an inline
5912 Perl script autogenerated by <command>locales.pl</command>. To
5913 generate it, generate the directory and the two files mentioned
5914 above, and execute the following command:</para>
5916 <programlisting>scripts/locales.pl <langcode></programlisting>
5918 <para>Otherwise you can simply copy one of the other languages.
5919 You will be told how many are missing like this:</para>
5921 <programlisting>$ scripts/locales.pl en
5922 English - 0.6% - 2015/2028 missing</programlisting>
5924 <para>A file named "<filename>missing</filename>" will be
5925 generated and can be edited. You can also edit the
5926 "<filename>all</filename>" file directly. Edit everything you
5927 like to fit the target language and execute
5928 <command>locales.pl</command> again. See how the missing words
5934 <term>Num2text</term>
5937 <para>Legacy code from SQL Ledger. It provides a means for
5938 numbers to be converted into natural language, like
5939 <literal>1523 => one thousand five hundred twenty
5940 three</literal>. If you want to provide it, it must be inlinable
5941 Perl code which provides a <function>num2text</function> sub. If
5942 an <function>init</function> sub exists it will be executed
5945 <para>Only used in the check and receipt printing module.</para>
5950 <term>special_chars</term>
5953 <para>kivitendo comes with a lot of interfaces to different
5954 formats, some of which are rather picky with their accepted
5955 charset. The <filename>special_chars</filename> file contains a
5956 listing of chars not suited for different file format and
5957 provides substitutions. It is written in "Simple Ini" style,
5958 containing a block for every file format.</para>
5960 <para>First entry should be the order of substitution for
5961 entries as a whitespace separated list. All entries are
5962 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
5963 and <literal>\\</literal> all work.</para>
5965 <para>After that every entry is a special char that should be
5966 translated when writing text into such a file.</para>
5968 <para>Example:</para>
5970 <programlisting>[Template/XML]
5971 order=& < > \n
5975 \n=<br></programlisting>
5977 <para>Note the importance of the order in this example.
5978 Substituting < and > befor & would lead to $gt; become
5981 <para>For a list of valid formats, see the German
5982 <filename>special_chars</filename> entry. As of this writing the
5983 following are recognized:</para>
5985 <programlisting>HTML
5990 Template/OpenDocument
5991 filenames</programlisting>
5993 <para>The last of which is very machine dependant. Remember that
5994 a lot of characters are forbidden by some filesystems, for
5995 exmaple MS Windows doesn't like ':' in its files where Linux
5996 doesn't mind that. If you want the files created with your
5997 language pack to be portable, find all chars that could cause
6003 <term>missing</term>
6006 <para>This file is not a part of the language package
6009 <para>This is a file generated by
6010 <command>scripts/locales.pl</command> while processing your
6011 locales. It's only to have the missing entries singled out and
6012 does not belong to a language package.</para>
6020 <para>This file is not a part of the language package
6023 <para>Another file generated by
6024 <command>scripts/locales.pl</command>. If for any reason a
6025 translation does not appear anymore and can be deleted, it gets
6026 moved here. The last 50 or so entries deleted are saved here in
6027 case you made a typo, so that you don't have to translate
6028 everything again. If a tranlsation is missing, the lost file is
6029 checked first. If you maintain a language package, you might
6030 want to keep this safe somewhere.</para>
6037 <sect1 id="devel.testsuite">
6038 <title>Die kivitendo-Test-Suite</title>
6040 <sect2 id="devel.testsuite.intro">
6041 <title>Einführung</title>
6043 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul <literal>Test::More</literal>.</para>
6045 <para>Die grundlegenden Fakten sind:</para>
6048 <listitem><para>Alle Tests liegen im Unterverzeichnis <filename>t/</filename>.</para></listitem>
6050 <listitem><para>Ein Script (bzw. ein Test) in <filename>t/</filename> enthält einen oder mehrere Testfälle.</para></listitem>
6052 <listitem><para>Alle Dateinamen von Tests enden auf <literal>.t</literal>. Es sind selbstständig ausführbare Perl-Scripte.</para></listitem>
6054 <listitem><para>Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in <filename>t/</filename>, deren
6055 Dateiname auf <literal>.t</literal> endet.</para></listitem>
6059 <sect2 id="devel.testsuite.prerequisites">
6060 <title>Voraussetzungen</title>
6062 <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>
6065 <listitem><para><literal>Test::Deep</literal> (Debian-Paketname: <literal>libtest-deep-perl</literal>; Fedora Core:
6066 <literal>perl-Test-Deep</literal>; openSUSE: <literal>perl-Test-Deep</literal>)</para></listitem>
6067 <listitem><para><literal>Test::Exception</literal> (Debian-Paketname: <literal>libtest-exception-perl</literal>; Fedora Core:
6068 <literal>perl-Test-Exception</literal>; openSUSE: <literal>perl-Test-Exception</literal>)</para></listitem>
6069 <listitem><para><literal>Test::Output</literal> (Debian-Paketname: <literal>libtest-output-perl</literal>; Fedora Core:
6070 <literal>perl-Test-Output</literal>; openSUSE: <literal>perl-Test-Output</literal>)</para></listitem>
6071 <listitem><para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses Modul ist ab Perl 5.10.1 Bestandteil der
6072 Perl-Distribution und kann für frühere Versionen aus dem <ulink url="http://www.cpan.org">CPAN</ulink> bezogen
6073 werden.</para></listitem>
6074 <listitem><para><literal>LWP::Simple</literal> aus dem Paket <literal>libwww-perl</literal> (Debian-Panetname:
6075 <literal>libwww-perl</literal>; Fedora Core: <literal>perl-libwww-perl</literal>; openSUSE:
6076 <literal>perl-libwww-perl</literal>)</para></listitem>
6077 <listitem><para><literal>URI::Find</literal> (Debian-Panetname: <literal>liburi-find-perl</literal>; Fedora Core:
6078 <literal>perl-URI-Find</literal>; openSUSE: <literal>perl-URI-Find</literal>)</para></listitem>
6081 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
6082 müssen in der Konfigurationsdatei im Abschnit <literal>testing/database</literal> Datenbankverbindungsparameter angegeben
6083 werden. Der hier angegebene Benutzer muss weiterhin das Recht haben, Datenbanken anzulegen und zu löschen.</para>
6086 <sect2 id="devel.testsuite.execution">
6088 Existierende Tests ausführen
6091 <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
6092 gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript <filename>t/test.pl</filename>.</para>
6094 <para>Will man die komplette Test-Suite ausführen, so muss man einfach nur <filename>t/test.pl</filename> ohne weitere Parameter aus
6095 dem kivitendo-Basisverzeichnis heraus ausführen.</para>
6097 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an <filename>t/test.pl</filename>. Beispielsweise:</para>
6099 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
6103 <sect2 id="devel.testsuite.meaning_of_scripts">
6105 Bedeutung der verschiedenen Test-Scripte
6108 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch
6109 während der Entwicklung nützliche Tests sind:</para>
6112 <listitem><para><filename>t/001compile.t</filename> -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab</para></listitem>
6113 <listitem><para><filename>t/002goodperl.t</filename> -- überprüft alle Perl-Dateien auf Anwesenheit von '<literal>use strict</literal>'-Anweisungen</para></listitem>
6114 <listitem><para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von <function>system()</function> und <function>exec()</function> auf Gültigkeit</para></listitem>
6115 <listitem><para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien Tab-Zeichen enthalten</para></listitem>
6116 <listitem><para><filename>t/006spelling.t</filename> -- sucht nach häufigen Rechtschreibfehlern</para></listitem>
6117 <listitem><para><filename>t/011pod.t</filename> -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit</para></listitem>
6120 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module.</para>
6123 <sect2 id="devel.testsuite.create_new">
6125 Neue Test-Scripte erstellen
6128 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende
6129 Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden.</para>
6131 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
6133 Ideen für neue Test-Scripte, die keine konkreten Funktionen testen
6136 <para> Ideen, die abgesehen von Funktionen noch nicht umgesetzt wurden:</para>
6139 <listitem><para>Überprüfung auf fehlende symbolische Links</para></listitem>
6140 <listitem><para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten)</para></listitem>
6141 <listitem><para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para></listitem>
6142 <listitem><para>Überprüfung auf Leerzeichen am Ende von Zeilen</para></listitem>
6143 <listitem><para>Test, ob alle zu übersetzenden Strings in <filename>locale/de/all</filename> vorhanden sind</para></listitem>
6144 <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>
6148 <sect3 id="devel.testsuite.directory_and_test_names">
6150 Konvention für Verzeichnis- und Dateinamen
6153 <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>
6156 <listitem><para>Die Dateiendung muss <filename>.t</filename> lauten.</para></listitem>
6158 <listitem><para>Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise
6159 <filename>bad_function_params.t</filename>).</para></listitem>
6161 <listitem><para>Unterverzeichnisse sollten grob nach dem Themenbereich benannt sein, mit dem sich die Scripte darin befassen
6162 (beispielsweise <filename>background_jobs</filename> für Tests rund um Hintergrund-Jobs).</para></listitem>
6164 <listitem><para>Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist
6165 (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben.</para></listitem>
6169 <sect3 id="devel.testsuite.minimal_example">
6171 Minimales Skelett für eigene Scripte
6174 <para>Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden:</para>
6176 <programlisting>use Test::More tests => 0;
6180 use Support::TestSetup;
6182 Support::TestSetup::login();</programlisting>
6184 <para>Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie
6185 <varname>$::auth</varname>, <varname>$::form</varname> oder <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
6186 <filename>config/kivitendo.conf</filename> im Abschnitt <literal>testing.login</literal> ein gültiger Login-Name eingetragen
6187 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
6189 <para>Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile <code>Support::TestSetup::login();</code>
6190 weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.</para>
6195 <sect1 id="devel.style-guide">
6196 <title>Stil-Richtlinien</title>
6198 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
6199 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
6200 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
6201 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
6203 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
6206 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
6207 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
6212 <para>Es werden keine echten Tabs sondern Leerzeichen
6217 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
6219 <programlisting>foreach my $row (@data) {
6221 # do something with $row
6225 $row->{modules} = MODULE->retrieve(
6226 id => $row->{id},
6227 date => $use_now ? localtime() : $row->{time},
6231 $report->add($row);
6236 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
6237 Zeile wie der letzte Befehl. Beispiele:</para>
6239 <programlisting>sub debug {
6245 <programlisting>if ($form->{item_rows} > 0) {
6251 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
6252 der Befehl / die öffnende schließende Klammer, die den Block
6253 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
6254 Beispiele wie bei 3. gelten.</para>
6258 <para>Die Wörter "<function>else</function>",
6259 "<function>elsif</function>", "<function>while</function>" befinden
6260 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
6263 <programlisting>if ($form->{sum} > 1000) {
6265 } elsif ($form->{sum} > 0) {
6273 } until ($a > 0);</programlisting>
6277 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
6278 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
6279 und grep-ähnliche Operatoren. Beispiel:</para>
6281 <programlisting>$main::lxdebug->message("Could not find file.");
6282 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
6286 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
6288 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
6289 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
6290 Blöcke schon. Beispiel:</para>
6292 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
6297 $form->{sum} += $form->{"row_$i"};
6298 $form->{ $form->{index} } += 1;
6300 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
6304 <para>Mehrzeilige Befehle</para>
6308 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
6309 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
6310 werden, in der die ersten Funktionsparameter in der ersten Zeile
6311 stehen. Beispiel:</para>
6313 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
6314 $form->{some_col_value});</programlisting>
6318 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
6319 besten in einer übersichtlichen Tabellenstruktur organisiert
6320 wird. Beispiel:</para>
6322 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
6323 : $form->{oldcount} ? $form->{oldcount} + 1
6324 : $form->{rowcount} - $form->{rowbase};</programlisting>
6330 <para>Kommentare</para>
6334 <para>Kommentare, die alleine in einer Zeile stehen, sollten
6335 soweit wie der Code eingerückt sein.</para>
6339 <para>Seitliche hängende Kommentare sollten einheitlich
6340 formatiert werden.</para>
6344 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
6345 auf Englisch zu verfassen. So wie ich keine Lust habe,
6346 französischen Quelltext zu lesen, sollte auch der kivitendo
6347 Quelltext für nicht-Deutschsprachige lesbar sein.
6350 <programlisting>my $found = 0;
6358 $i = 0 # initialize $i
6360 $i *= $const; # do something crazy
6361 $i = $n; # recover $i</programlisting>
6367 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
6368 Interpolation gewünscht ist. Beispiel:</para>
6370 <programlisting>$form->{sum} = 0;
6371 $form->{"row_$i"} = $form->{"row_$i"} - 5;
6372 $some_hash{42} = 54;</programlisting>
6376 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
6377 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
6378 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
6379 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
6381 <para>Als Beispiel sei die Funktion
6382 <function>print_options</function> aus
6383 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
6387 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
6388 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
6391 <para>Emacs und vim haben beide recht einfache Methoden zur
6392 Entfernung von trailing whitespace. Emacs kennt das Kommande
6393 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
6394 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
6395 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
6400 <para>Es wird kein <command>perltidy</command> verwendet.</para>
6402 <para>In der Vergangenheit wurde versucht,
6403 <command>perltidy</command> zu verwenden, um einen einheitlichen
6404 Stil zu erlangen. Es hat sich aber gezeigt, dass
6405 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
6406 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
6407 den Interessierten sind hier die
6408 <command>perltidy</command>-Optionen, die grob den beschriebenen
6409 Richtlinien entsprechen:</para>
6411 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
6412 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
6413 -lp -vt=1 -vtc=1</programlisting>
6417 <para><varname>STDERR</varname> ist tabu. Unkonditionale
6418 Debugmeldungen auch.</para>
6420 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
6421 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
6422 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
6424 <para>Die <classname>LXDebug</classname>-Methode
6425 "<function>message</function>" nimmt als ersten Paramter außerdem
6426 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
6427 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
6428 und werden in den meisten Fällen auch vom Repository
6429 zurückgewiesen.</para>
6433 <para>Alle neuen Module müssen use strict verwenden.</para>
6435 <para><varname>$form</varname>, <varname>$auth</varname>,
6436 <varname>$locale</varname>, <varname>$lxdebug</varname> und
6437 <varname>%myconfig</varname> werden derzeit aus dem main package
6438 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
6439 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
6444 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
6445 <title>Dokumentation erstellen</title>
6447 <sect2 id="devel.build-doc.introduction">
6448 <title>Einführung</title>
6450 <para>Diese Dokumentation ist in <productname>DocBook</productname>
6451 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
6452 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
6453 Editor nutzt, der spezielle Unterstützung für
6454 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
6455 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
6456 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
6460 <sect2 id="devel.build-doc.required-software">
6461 <title>Benötigte Software</title>
6463 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
6464 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
6465 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
6466 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
6467 <command>scripts/build_doc.sh</command>.</para>
6469 <para>Das Script benötigt zur Konvertierung verschiedene
6470 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
6476 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
6477 in einer halbwegs aktuellen Version</para>
6481 <para>Das Java-Build-System <ulink
6482 url="http://ant.apache.org/">Apache Ant</ulink></para>
6486 <para>Das Dokumentations-System Dobudish für
6487 <productname>DocBook</productname> 4.5, eine Zusammenstellung
6488 diverser Stylesheets und Grafiken zur Konvertierung von
6489 <productname>DocBook</productname> XML in andere Formate. Das
6490 Paket, das benötigt wird, ist zum Zeitpunkt der
6491 Dokumentationserstellung
6492 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
6493 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
6498 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
6499 sind auf allen gängigen Plattformen verfügbar. Beispiel für
6500 Debian/Ubuntu:</para>
6502 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
6504 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
6505 <filename>doc/build</filename> entpackt werden. Beispiel unter der
6506 Annahme, das <productname>Dobudish</productname> in
6507 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
6509 <programlisting>cd doc/build
6510 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
6513 <sect2 id="devel.build-doc.build">
6514 <title>PDFs und HTML-Seiten erstellen</title>
6516 <para>Die eigentliche Konvertierung erfolgt nach Installation der
6517 benötigten Software mit einem einfachen Aufruf direkt aus dem
6518 kivitendo-Installationsverzeichnis heraus:</para>
6520 <programlisting>./scripts/build_doc.sh</programlisting>
6523 <sect2 id="devel.build-doc.repository">
6524 <title>Einchecken in das Git-Repository</title>
6526 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
6527 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
6528 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
6529 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
6531 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
6532 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob