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: Installation, Konfiguration, Entwicklung</title>
7 <chapter id="Aktuelle-Hinweise">
8 <title>Aktuelle Hinweise</title>
10 <para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>
14 <para>im kivitendo-Forum: <ulink
15 url="https://forum.kivitendo.org/">https://forum.kivitendo.org/</ulink></para>
21 <title>Installation und Grundkonfiguration</title>
23 <sect1 id="Installation-Übersicht">
24 <title>Übersicht</title>
27 Die Installation von kivitendo umfasst mehrere Schritte. Die folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
28 Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit minimalen Features möglichst schnell zum Laufen zu kriegen.
32 <listitem><para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo benötigt gewisse Ressourcen und benutzt weitere
33 Programme. Das Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert diese. Auch die Liste der benötigten Perl-Module
34 befindet sich hier.</para></listitem>
36 <listitem><para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst die "<xref
37 linkend="Manuelle-Installation-des-Programmpaketes"/>" sowie grundlegende Einstellungen, die der "<xref
38 linkend="config.config-file"/>" erläutert.</para></listitem>
40 <listitem><para><emphasis>Konfiguration externer Programme</emphasis>: hierzu gehören die Datenbank ("<xref
41 linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der Webserver ("<xref
42 linkend="Apache-Konfiguration"/>"). </para></listitem>
44 <listitem><para><emphasis>Benutzerinformationen speichern können</emphasis>: man benötigt mindestens eine Datenbank, in der
45 Informationen zur Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man das als Administrator macht, verrät "<xref
46 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para></listitem>
48 <listitem><para><emphasis>Benutzer, Gruppen und Datenbanken anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
49 linkend="Benutzer--und-Gruppenverwaltung"/>".</para></listitem>
51 <listitem><para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann kann es losgehen: "<xref
52 linkend="kivitendo-ERP-verwenden"/>"</para></listitem>
56 Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls wichtig und dienen sollten vor einer ernsthaften Inbetriebnahme gelesen
61 <sect1 id="Benötigte-Software-und-Pakete">
62 <title>Benötigte Software und Pakete</title>
64 <sect2 id="Betriebssystem">
65 <title>Betriebssystem</title>
67 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
68 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
69 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
70 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
71 ohne große Probleme auf den derzeit aktuellen verbreiteten
72 Distributionen läuft.</para>
74 <para>Mitte 2012 sind das folgende Systeme, von denen bekannt ist,
75 dass kivitendo auf ihnen läuft:</para>
83 <para>6.0 "Squeeze" (hier muss allerdings das Modul FCGI in der Version >= 0.72 compiled werden)</para>
86 <para>7.0 "Wheezy"</para>
92 <para>Ubuntu 10.04 LTS "Lucid Lynx", 12.04 LTS "Precise Pangolin" und 12.10 "Oneiric Ocelot"`</para>
96 <para>openSUSE 12.1 und 12.2</para>
100 <para>SuSE Linux Enterprice Server 11</para>
104 <para>Fedora 16 und 17</para>
109 <sect2 id="Pakete" xreflabel="Pakete">
110 <title>Benötigte Perl-Pakete installieren</title>
112 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
113 Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2)
116 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht Bestandteil einer Standard-Perl-Installation sind. Um zu
117 überprüfen, ob die erforderlichen Pakete installiert und aktuell genug sind, wird ein Script mitgeliefert, das wie folgt aufgerufen
120 <programlisting>./scripts/installation_check.pl</programlisting>
122 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
125 <listitem><para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para></listitem>
127 <listitem><para><literal>Archive::Zip</literal></para></listitem>
129 <listitem><para><literal>Config::Std</literal></para></listitem>
131 <listitem><para><literal>DateTime</literal></para></listitem>
133 <listitem><para><literal>DBI</literal></para></listitem>
135 <listitem><para><literal>DBD::Pg</literal></para></listitem>
137 <listitem><para><literal>Email::Address</literal></para></listitem>
139 <listitem><para><literal>Email::MIME</literal></para></listitem>
141 <listitem><para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71 inklusive; siehe <xref linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para></listitem>
143 <listitem><para><literal>JSON</literal></para></listitem>
145 <listitem><para><literal>List::MoreUtils</literal></para></listitem>
147 <listitem><para><literal>Net::SMTP::SSL</literal> (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "<xref
148 linkend="config.sending-email.smtp"/>")</para></listitem>
150 <listitem><para><literal>Net::SSLGlue</literal> (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "<xref
151 linkend="config.sending-email.smtp"/>")</para></listitem>
153 <listitem><para><literal>Params::Validate</literal></para></listitem>
155 <listitem><para><literal>PDF::API2</literal></para></listitem>
157 <listitem><para><literal>Rose::Object</literal></para></listitem>
159 <listitem><para><literal>Rose::DB</literal></para></listitem>
161 <listitem><para><literal>Rose::DB::Object</literal></para></listitem>
163 <listitem><para><literal>Template</literal></para></listitem>
165 <listitem><para><literal>Text::CSV_XS</literal></para></listitem>
167 <listitem><para><literal>Text::Iconv</literal></para></listitem>
169 <listitem><para><literal>URI</literal></para></listitem>
171 <listitem><para><literal>XML::Writer</literal></para></listitem>
173 <listitem><para><literal>YAML</literal></para></listitem>
176 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen: <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
177 <literal>Net::SSLGlue</literal>.</para>
179 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
180 hinzugekommen, <literal>URI</literal> und
181 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
184 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
185 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
186 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
187 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
189 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
190 hinzugekommen.</para>
192 <para><literal>Email::Address</literal> und
193 <literal>List::MoreUtils</literal> sind schon länger feste
194 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
195 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
196 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
197 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
201 <title>Debian und Ubuntu</title>
203 <para>Alle benötigten Perl-Pakete stehen für Debian und Ubuntu als Debian-Pakete zur Verfügung. Sie können mit folgendem Befehl
204 installiert werden:</para>
206 <programlisting>apt-get install apache2 libarchive-zip-perl libclone-perl \
207 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
208 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
209 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
210 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
211 librose-db-perl librose-object-perl libsort-naturally-perl \
212 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
213 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
214 postgresql</programlisting>
218 <title>Fedora Core</title>
220 <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>
222 <programlisting>yum install httpd perl-Archive-Zip perl-Clone perl-DBD-Pg \
223 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
224 perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
225 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
226 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
227 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
228 perl-XML-Writer perl-YAML perl-parent postgresql-server</programlisting>
230 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
232 <programlisting>yum install perl-CPAN
233 cpan Config::Std</programlisting>
238 <title>openSUSE</title>
240 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
241 installiert werden:</para>
243 <programlisting>zypper install apache2 perl-Archive-Zip perl-Clone \
244 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
245 perl-Email-MIME perl-FastCGI perl-JSON perl-List-MoreUtils \
246 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
247 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
248 perl-URI perl-XML-Writer perl-YAML postgresql-server</programlisting>
250 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
252 <programlisting>yum install perl-CPAN
253 cpan Rose::Db::Object</programlisting>
259 <sect1 id="Manuelle-Installation-des-Programmpaketes"
260 xreflabel="Manuelle Installation des Programmpaketes">
261 <title>Manuelle Installation des Programmpaketes</title>
263 <para>Die kivitendo ERP Installationsdatei (<filename>kivitendo-erp-2.6.3.tgz</filename>) wird im Dokumentenverzeichnis des Webservers
264 (z.B. <filename>/var/www/html/</filename>, <filename>/srv/www/htdocs</filename> oder <filename>/var/www/</filename>) entpackt:</para>
266 <programlisting>cd /var/www
267 tar xvzf kivitendo-erp-2.6.3.tgz</programlisting>
269 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
271 <programlisting>cd kivitendo-erp</programlisting>
273 <para>Alternativ können Sie auch einen Alias in der
274 Webserverkonfiguration benutzen, um auf das tatsächliche
275 Installationsverzeichnis zu verweisen.</para>
277 <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
278 beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
279 Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
280 core <constant>apache</constant> oder bei OpenSUSE <constant>wwwrun</constant>).</para>
282 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
283 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
285 <programlisting>chown -R www-data users spool webdav</programlisting>
287 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
288 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>
290 <programlisting>chown www-data templates users</programlisting>
293 <sect1 id="config.config-file">
294 <title>kivitendo-Konfigurationsdatei</title>
296 <sect2 id="config.config-file.introduction"
297 xreflabel="Einführung in die Konfigurationsdatei">
298 <title>Einführung</title>
300 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei,
301 die benötigt wird: <filename>config/kivitendo.conf</filename> (kurz:
302 "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
303 von kivitendo bzw. der Migration von älteren Versionen angelegt
306 <para>Als Vorlage dient die Datei
307 <filename>config/kivitendo.conf.default</filename> (kurz: "die
308 Default-Datei"):</para>
310 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
312 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
313 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
314 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
315 Abschnitte und Werte enthalten, die von denen der Default-Datei
320 Vor der Umbenennung in kivitendo hieß diese Datei noch <filename>config/lx_office.conf</filename>. Aus Gründen der Kompatibilität
321 wird diese Datei eingelesen, sofern die Datei <filename>config/kivitendo.conf</filename> nicht existiert.
325 <para>Diese Hauptkonfigurationsdatei ist dann eine
326 installationsspezifische Datei, d.h. sie enthält bspw. lokale
327 Passwörter und wird auch nicht im Versionsmanagement (git)
330 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
331 Mandaten, bzw. Datenbanken gleich.</para>
334 <sect2 id="config.config-file.sections-parameters">
335 <title>Abschnitte und Parameter</title>
337 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
338 entsprechend kommentiert sind:</para>
341 <listitem><para><literal>authentication</literal> (siehe Abschnitt "<xref
342 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>" in diesem Kapitel)</para></listitem>
344 <listitem><para><literal>authentication/database</literal></para></listitem>
346 <listitem><para><literal>authentication/ldap</literal></para></listitem>
348 <listitem><para><literal>system</literal></para></listitem>
350 <listitem><para><literal>features</literal> (siehe Kapitel "<xref linkend="features"/>")</para></listitem>
352 <listitem><para><literal>paths</literal></para></listitem>
354 <listitem><para><literal>applications</literal></para></listitem>
356 <listitem><para><literal>environment</literal></para></listitem>
358 <listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>
360 <listitem><para><literal>print_templates</literal></para></listitem>
362 <listitem><para><literal>task_server</literal></para></listitem>
364 <listitem><para><literal>periodic_invoices</literal></para></listitem>
366 <listitem><para><literal>console</literal></para></listitem>
368 <listitem><para><literal>debug</literal></para></listitem>
371 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
372 einzustellen oder zu kontrollieren sind, sind:</para>
374 <programlisting>[authentication]
375 admin_password = geheim
377 [authentication/database]
385 dbcharset = UTF-8</programlisting>
387 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
388 <varname>[periodic_invoices]</varname> den Login eines Benutzers
389 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
390 mit Informationen über die erstellten Rechnungen bekommt.</para>
392 <para>Nutzt man den <link
393 linkend="config.task-server">Taskserver</link> für <link
394 linkend="features.periodic-invoices">wiederkehrende Rechnungen</link>,
395 muss unter <varname>[task_server]</varname> ein Login eines Benutzers
396 angegeben werden, mit dem sich der Taskserver an kivitendo bei der
397 Datenbank anmeldet, die dem Benutzer zugewiesen ist.</para>
399 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
400 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
403 <sect2 id="config.config-file.prior-versions">
404 <title>Versionen vor 2.6.3</title>
406 <para>In älteren kivitendo Versionen gab es im Verzeichnis
407 <filename>config</filename> die Dateien
408 <filename>authentication.pl</filename> und
409 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
410 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
411 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
412 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
414 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
415 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
416 manuell übertragen und die alten Konfigurationsdateien anschließend
417 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
418 entsprechende Fehlermeldung an.</para>
422 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
423 <title>Anpassung der PostgreSQL-Konfiguration</title>
425 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
427 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
428 <title>Zeichensätze/die Verwendung von UTF-8</title>
430 <para>Bei aktuellen Serverinstallationen braucht man hier meist nicht
433 <para>Dieses kann überprüft werden: ist das Encoding der Datenbank
434 “template1” “UTF8”, so braucht man nichts weiteres diesbezüglich
435 unternehmen. Zum Testen:
437 <programlisting>su postgres
439 exit </programlisting>
441 Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
442 UTF-8-Encoding anzulegen und diesen zu verwenden. Unter Debian und
443 Ubuntu kann dies z.B. für PostgreSQL 8.2 mit dem folgenden Befehl
446 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2 clustername</programlisting>
448 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
449 Versionsnummer angepasst werden.</para>
451 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
453 <para>Wurde PostgreSQL nicht mit UTF-8 als Encoding initialisiert und
454 ist ein Neuanlegen eines weiteren Clusters nicht möglich, so kann
455 kivitendo mit ISO-8859-15 als Encoding betrieben werden.</para>
457 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
458 <literal>\l</literal> geprüft werden.</para>
461 <sect2 id="Änderungen-an-Konfigurationsdateien">
462 <title>Änderungen an Konfigurationsdateien</title>
464 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
465 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
466 <filename>/var/lib/pgsql/data/</filename> oder
467 <filename>/etc/postgresql/</filename>, muss sichergestellt werden,
468 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
469 Parameter <varname>listen_address</varname> gesteuert. Laufen
470 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
471 <literal>localhost</literal> verwendet werden. Andernfalls müssen
472 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
473 was mit dem Wert <literal>*</literal> geschieht.</para>
475 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
476 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
477 sein sollte, müssen die Berichtigungen für den Zugriff geändert
478 werden. Hier gibt es mehrere Möglichkeiten. sinnvoll ist es nur die
479 nögiten Verbindungen immer zuzulassen, für eine lokal laufenden
480 Datenbank zum Beispiel:</para>
482 <programlisting>local all kivitendo password
483 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
486 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
487 <title>Erweiterung für servergespeicherte Prozeduren</title>
489 <para>In der Datenbank <literal>template1</literal> muss die
490 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
491 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
492 <programlisting>su - postgres
493 psql template1</programlisting>
495 führen Sie die folgenden Kommandos aus:</para>
497 <programlisting>create language 'plpgsql';
501 <sect2 id="Datenbankbenutzer-anlegen">
502 <title>Datenbankbenutzer anlegen</title>
504 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
505 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
506 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
509 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit nein
510 beantworten, genauso ist die Berechtigung neue User (Roles) zu
511 generieren nicht nötig.</para>
512 <programlisting>su - postgres
513 createuser -d -P kivitendo
514 exit</programlisting>
516 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
517 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.
518 den hier gewählten Benutzernamen.</para>
522 <sect1 id="Apache-Konfiguration">
523 <title>Webserver-Konfiguration</title>
526 <title>Grundkonfiguration mittels CGI</title>
529 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
530 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
531 <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
534 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
535 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
536 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
537 anderen Datei hinzu, die beim Starten des Webservers eingelesen
540 <programlisting>AddHandler cgi-script .pl
541 Alias /kivitendo-erp/ /var/www/kiviteno-erp/
543 <Directory /var/www/kivitendo-erp>
544 Options ExecCGI Includes FollowSymlinks
547 <Directory /var/www/kivitendo-erp/users>
550 </Directory></programlisting>
552 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
553 das kivitendo-Archiv entpacket haben.</para>
556 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
557 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
560 <para>Auf einigen Webservern werden manchmal die Grafiken und
561 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
562 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
564 <programlisting>EnableSendfile Off</programlisting>
567 <sect2 id="Apache-Konfiguration.FCGI"
568 xreflabel="Konfiguration für FastCGI/FCGI">
569 <title>Konfiguration für FastCGI/FCGI</title>
571 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
572 <title>Was ist FastCGI?</title>
574 <para>Direkt aus <ulink
575 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
578 <para><citation> FastCGI ist ein Standard für die Einbindung
579 externer Software zur Generierung dynamischer Webseiten in einem
580 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
581 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
582 umgehen. </citation></para>
585 <sect3 id="Apache-Konfiguration.FCGI.Warum">
586 <title>Warum FastCGI?</title>
588 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
589 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
590 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
591 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
592 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
593 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
594 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
595 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
596 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
597 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
598 deutlich länger dauert als früher, und dass davon 90% für das Laden
599 der Module verwendet wird.</para>
601 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
602 wird nur die eigentliche Programmlogik ausgeführt.</para>
605 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
606 <title>Getestete Kombinationen aus Webservern und Plugin</title>
608 <para>Folgende Kombinationen sind getestet:</para>
612 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
616 <para>Apache 2.2.11 (Ubuntu) und mod_fastcgi.</para>
620 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
621 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
622 mod_fastcgi nicht mehr explizit eingegangen.</para>
624 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
628 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern
629 bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrere Installation gibt, muss zwingend Version 0.68 oder
630 aber Version 0.72 und neuer eingesetzt werden.</para>
632 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie sich die Vorgängerversion wie folgt
635 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
639 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
640 <title>Konfiguration des Webservers</title>
642 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
643 laufen zu lassen, empfliehlt es sich die Installation ersteinmal
644 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
645 debuggen die beim ersten aufsetzen auftreten können. Sollte die
646 Installation schon funktionieren, lesen Sie weiter.</para>
648 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
649 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
651 <programlisting>a2enmod fcgid</programlisting>
653 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
654 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
655 und <function>Directory</function>-Direktiven. Dabei wird zwischen
656 dem Installationspfad von kivitendo im Dateisystem
657 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
658 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
659 ("<filename>/url/for/kivitendo-erp</filename>").</para>
661 <para>Folgender Konfigurationsschnipsel funktioniert mit
664 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
665 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
667 <Directory /path/to/kivitendo-erp>
669 Options ExecCGI Includes FollowSymlinks
674 <DirectoryMatch /path/to/kivitendo-erp/users>
677 </DirectoryMatch></programlisting>
679 <para>Seit mod_fcgid-Version 2.6.3 gelten sehr kleine Grenzen für
680 die maximale Größe eines Requests. Diese sollte wie folgt
681 hochgesetzt werden:</para>
683 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
685 <para>Das ganze sollte dann so aussehen:</para>
687 <programlisting>AddHandler fcgid-script .fpl
688 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
689 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
690 FcgidMaxRequestLen 10485760
692 <Directory /path/to/kivitendo-erp>
694 Options ExecCGI Includes FollowSymlinks
699 <DirectoryMatch /path/to/kivitendo-erp/users>
702 </DirectoryMatch></programlisting>
704 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
705 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
706 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
707 gibt es hier kleine Performance-Einbußen.</para>
709 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
710 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
711 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
713 <programlisting># Zugriff über CGI
714 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
716 # Zugriff mit mod_fcgid:
717 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
718 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
720 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
721 die normale Version erreichbar, und unter
722 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
723 FastCGI-Version.</para>
728 <sect1 id="config.task-server">
729 <title>Der Task-Server</title>
731 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
732 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
733 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
734 wird bisher nur für die Erzeugung der wiederkehrenden Rechnungen
735 benutzt, wird aber in Zukunft deutlich mehr Aufgaben übertragen
738 <sect2 id="Konfiguration-des-Task-Servers">
739 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
741 <para>Die Konfiguration erfolgt über den Abschnitt
742 <literal>[task_server]</literal> in der Datei
743 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
744 Optionen sind:</para>
748 <term><varname>login</varname></term>
751 <para>gültiger kivitendo-Benutzername, der benutzt wird, um die
752 zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss
753 in der Administration angelegt werden. Diese Option muss
754 angegeben werden.</para>
759 <term><varname>run_as</varname></term>
762 <para>Wird der Server vom Systembenutzer <literal>root</literal>
763 gestartet, so wechselt er auf den mit <literal>run_as</literal>
764 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
765 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
767 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
768 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
769 unter dem auch der Webserver läuft.</para>
774 <term><varname>debug</varname></term>
777 <para>Schaltet Debug-Informationen an und aus.</para>
783 <sect2 id="Einbinden-in-den-Boot-Prozess">
784 <title>Automatisches Starten des Task-Servers beim Booten</title>
786 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
787 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
788 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
790 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
791 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
792 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
793 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
794 anstelle eines symbolischen Links verwendet werden können.</para>
797 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, ältere Fedora Core)</title>
799 <para>Kopieren Sie die Datei
800 <filename>scripts/boot/system-v/kivitendo-server</filename>
801 nach <filename>/etc/init.d/kivitendo-server</filename>. Passen
802 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
803 <literal>DAEMON=....</literal>). Binden Sie das Script in den
804 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
808 <para>Debian-basierende Systeme:</para>
810 <programlisting>update-rc.d kivitendo-task-server defaults
811 # Nur bei Debian Squeeze und neuer:
812 insserv kivitendo-task-server</programlisting>
816 <para>Ältere OpenSUSE und ältere Fedora Core:</para>
818 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
822 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
825 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
829 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
831 <para>Kopieren Sie die Datei
832 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
833 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
834 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
835 <literal>exec ....</literal>).</para>
837 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
840 <programlisting>service kivitendo-task-server start</programlisting>
844 <title>systemd-basierende Systeme (z.B. neure OpenSUSE, neuere Fedora Core)</title>
846 <para>Verlinken Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
847 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
848 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>). Binden Sie das Script in den Boot-Prozess ein.
851 <para>Alle hierzu benötigten Befehle sehen so aus:</para>
853 <programlisting>cd /var/www/kivitendo-erp/scripts/boot/systemd
854 ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
856 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
859 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
863 <sect2 id="Prozesskontrolle">
864 <title>Wie der Task-Server gestartet und beendet wird</title>
866 <para>Der Task-Server wird wie folgt kontrolliert:</para>
868 <programlisting>./scripts/task_server.pl Befehl</programlisting>
870 <para><literal>Befehl</literal> ist dabei eine der folgenden
875 <para><literal>start</literal> startet eine neue Instanz des
876 Task-Servers. Die Prozess-ID wird innerhalb des
877 <filename>users</filename>-Verzeichnisses abgelegt.</para>
881 <para><literal>stop</literal> beendet einen laufenden
886 <para><literal>restart</literal> beendet und startet ihn
891 <para><literal>status</literal> berichtet, ob der Task-Server
896 <para>Der Task-Server wechselt beim Starten automatisch in das
897 kivitendo-Installationsverzeichnis.</para>
899 <para>Dieselben Optionen können auch für die SystemV-basierenden
900 Runlevel-Scripte benutzt werden (siehe oben).</para>
902 <sect2 id="Prozesskontrolle2">
903 <title>Task-Server mit mehreren Mandanten</title>
905 <para>Beim Task-Server wird der Login-Name des Benutzers, unter dem der
906 Task-Server laufen soll, in die Konfigurationsdatei geschrieben. Hat
907 man mehrere Mandanten muß man auch mehrere Konfigurationsdateien
910 <para>Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf,
911 wo in der Kategorie [task_server] der gewünschte "login" steht.</para>
913 <para>Der alternative Task-Server wird dann mit folgendem Befehl
916 <programlisting>./scripts/task_server.pl -c config/DATEINAME.conf</programlisting>
920 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
921 <title>Benutzerauthentifizierung und Administratorpasswort</title>
923 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
924 über die Verwaltung von Gruppen und weitere Einstellungen</para>
926 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
927 <title>Grundlagen zur Benutzerauthentifizierung</title>
929 <para>kivitendo verwaltet die Benutzerinformationen in einer
930 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
931 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
932 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
933 können, müssen aber nicht unterschiedlich sein.</para>
935 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
936 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
937 abgelegt werden.</para>
939 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
940 entweder gegen die Authentifizierungsdatenbank oder gegen einen
941 LDAP-Server überprüft werden.</para>
943 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
944 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
945 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
946 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
947 einer Version vor v2.6.0 angelegt werden. Eine
948 Beispielkonfigurationsdatei
949 <filename>config/kivitendo.conf.default</filename> existiert, die als
950 Vorlage benutzt werden kann.</para>
953 <sect2 id="Administratorpasswort">
954 <title>Administratorpasswort</title>
956 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
957 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
958 nur dort und nicht mehr im Administrationsinterface selber geändert
959 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
960 Abschnitt <varname>[authentication]</varname>.</para>
963 <sect2 id="Authentifizierungsdatenbank">
964 <title>Authentifizierungsdatenbank</title>
966 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
967 Parametern in <varname>[authentication/database]</varname>
968 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
972 <term><literal>host</literal></term>
975 <para>Der Rechnername oder die IP-Adresse des
976 Datenbankservers</para>
981 <term><literal>port</literal></term>
984 <para>Die Portnummer des Datenbankservers, meist 5432</para>
989 <term><literal>db</literal></term>
992 <para>Der Name der Authentifizierungsdatenbank</para>
997 <term><literal>user</literal></term>
1000 <para>Der Benutzername, mit dem sich kivitendo beim
1001 Datenbankserver anmeldet (z.B.
1002 "<literal>postgres</literal>")</para>
1007 <term><literal>password</literal></term>
1010 <para>Das Passwort für den Datenbankbenutzer</para>
1015 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1016 automatisch anlegen (mehr dazu siehe unten).</para>
1019 <sect2 id="Passwortüberprüfung">
1020 <title>Passwortüberprüfung</title>
1022 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1023 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1024 Active-Directory-Server. Welche davon benutzt wird, regelt der
1025 Parameter <varname>module</varname> im Abschnitt
1026 <varname>[authentication]</varname>.</para>
1028 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1029 gespeichert werden, so muss der Parameter <varname>module</varname>
1030 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1031 der Administrator als auch die Benutzer selber ihre Psaswörter in
1032 kivitendo ändern.</para>
1034 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1035 benutzt werden, so muss der Parameter <varname>module</varname> auf
1036 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1037 zusätzliche Informationen über den LDAP-Server im Abschnitt
1038 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1042 <term><literal>host</literal></term>
1045 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1046 Active-Directory-Servers. Diese Angabe ist zwingend
1047 erforderlich.</para>
1052 <term><literal>port</literal></term>
1055 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1060 <term><literal>tls</literal></term>
1063 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1064 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1065 ‘<literal>0</literal>’ belassen</para>
1070 <term><literal>attribute</literal></term>
1073 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1074 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1075 meist ‘<literal>sAMAccountName</literal>’, für andere
1076 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1077 zwingend erforderlich.</para>
1082 <term><literal>base_dn</literal></term>
1085 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1086 Diese Angabe ist zwingend erforderlich.</para>
1091 <term><literal>filter</literal></term>
1094 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1095 <literal><%login%></literal>, so wird dieses durch den vom
1096 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1097 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1098 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1103 <term><literal>bind_dn</literal> und
1104 <literal>bind_password</literal></term>
1107 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1108 durchsucht werden kann (z.B. ist dies bei
1109 Active-Directory-Servern der Fall), so kann diese hier angegeben
1110 werden. Für Active-Directory-Server kann als
1111 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1112 z.B. ‘<literal>cn=Martin
1113 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1114 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1115 also ‘<literal>Martin Mustermann</literal>’.</para>
1121 <sect2 id="Name-des-Session-Cookies">
1122 <title>Name des Session-Cookies</title>
1124 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1125 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1126 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1127 Parameter <varname>cookie_name</varname> im Abschnitt
1128 <varname>[authentication]</varname>gesetzt.</para>
1130 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1131 Server existiert.</para>
1134 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1135 <title>Anlegen der Authentifizierungsdatenbank</title>
1137 <para>Nachdem alle Einstellungen in
1138 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1139 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1140 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1141 der folgenden URL erreichbar sein sollte:</para>
1144 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
1148 <sect1 id="Benutzer--und-Gruppenverwaltung">
1149 <title>Benutzer- und Gruppenverwaltung</title>
1151 <para>Nach der Installation müssen Benutzer, Gruppen und Datenbanken
1152 angelegt werden. Dieses geschieht im Administrationsmenü, das Sie unter
1153 folgender URL finden:</para>
1156 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
1158 <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
1159 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1161 <sect2 id="Zusammenhänge">
1162 <title>Zusammenhänge</title>
1164 <para>kivitendo verwendet eine Datenbank zum Speichern all seiner
1165 Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um
1166 mit kivitendo arbeiten zu können, muss eine Person einen
1167 Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine
1168 Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist
1169 möglich und normal, dass mehreren Benutzern die selbe Datenbank
1170 zugewiesen wird, sodass sie alle mit den selben Daten arbeiten
1173 <para>Die Basisdaten der Benutzer, die in der Administration
1174 eingegeben werden können, werden in einer zweiten Datenbank
1175 gespeichert, der bereits erwähnten Authentifizierungsdatenbank. Diese
1176 ist also den Produktivdaten enthaltenden Datenbanken vorgeschaltet.
1177 Pro kivitendo-Installation gibt es nur eine
1178 Authentifizierungsdatenbank, aber beliebig viele Datenbanken mit
1181 <para>kivitendo kann seinen Benutzern Zugriff auf bestimmte
1182 Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht
1183 gestattet, so werden der entsprechenden Menüpunkte auch nicht
1184 angezeigt. Diese Rechte werden ebenfalls in der
1185 Authentifizierungsdatenbank gespeichert.</para>
1187 <para>Um Rechte verteilen zu können, verwendet kivitendo ein
1188 Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche
1189 erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder
1190 mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen
1191 Funktionen, die mindestens einer Gruppe erlaubt sind, in der der
1192 Benutzer Mitglied ist.</para>
1194 <para>Die allgemeine Reihenfolge, in der Datenbanken, Gruppen und
1195 Benutzer angelegt werden sollten, lautet:</para>
1197 <orderedlist numeration="arabic">
1199 <para>Datenbank anlegen</para>
1203 <para>Gruppen anlegen</para>
1207 <para>Benutzer anlegen</para>
1211 <para>Benutzer den Gruppen zuordnen</para>
1216 <sect2 id="Datenbanken-anlegen">
1217 <title>Datenbanken anlegen</title>
1219 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1220 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1221 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1223 <para>Wenn Sie für die kivitendo-Installation nicht Unicode (UTF-8) sondern den europäischen Schriftsatz ISO-8859-15 benutzen
1224 wollen, so müssen Sie vor dem Anlegen der Datenbank in der Datei <filename>config/kivitendo.conf</filename> die Variable
1225 <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf den Wert ‘<literal>ISO-8859-15</literal>’ setzen.</para>
1227 <para>Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz
1228 verwenden müssen, da diese Einstellungen momentan global in kivitendo
1229 vorgenommen wird und nicht nach Datenbank unterschieden werden kann.
1230 Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz
1231 angelegt worden sein.</para>
1234 <sect2 id="Gruppen-anlegen">
1235 <title>Gruppen anlegen</title>
1237 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1238 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1239 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1240 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1242 <para>Benutzergruppen sind unabhängig von Datenbanken, da sie in der
1243 Authentifizierungsdatenbank gespeichert werden. Sie gelten für alle
1244 Datenbanken, die in dieser Installation verwaltet werden.</para>
1247 <sect2 id="Benutzer-anlegen">
1248 <title>Benutzer anlegen</title>
1250 <para>Beim Anlegen von Benutzern werden für viele Parameter
1251 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1252 deutschen Raumes entsprechen.</para>
1254 <para>Zwingend anzugeben sind der Loginname sowie die komplette
1255 Datenbankkonfiguration. Wenn die Passwortauthentifizierung über die
1256 Datenbank eingestellt ist, so kann hier auch das Benutzerpasswort
1257 gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung
1258 aktiv, so ist das Passwort-Feld deaktiviert.</para>
1260 <para>In der Datenbankkonfiguration müssen die Zugriffsdaten einer der
1261 eben angelegten Datenbanken eingetragen werden.</para>
1264 <sect2 id="Gruppenmitgliedschaften-verwalten">
1265 <title>Gruppenmitgliedschaften verwalten</title>
1267 <para>Nach dem Anlegen von Benutzern und Gruppen müssen Benutzer den
1268 Gruppen zugewiesen werden. Dazu gibt es zwei Möglichkeiten:</para>
1270 <orderedlist numeration="arabic">
1272 <para>In der Gruppenverwaltung wählt man eine Gruppe aus. Im
1273 folgenden Dialog kann man dann einzeln die Benutzer der Gruppe
1278 <para>In der Gruppenverwaltung wählt man das Tool zur Verwaltung
1279 der Gruppenmitgliedschaft. Hier wird eine Matrix angezeigt, die
1280 alle im System angelegten Gruppen und Benutzer enthält. Durch
1281 Setzen der Häkchen wird der Benutzer in der ausgewählten Zeile der
1282 Gruppe in der ausgewählten Spalte hinzugefügt.</para>
1287 <sect2 id="Migration-alter-Installationen">
1288 <title>Migration alter Installationen</title>
1290 <para>Wenn kivitendo 2.6.3 über eine ältere Version installiert wird,
1291 in der die Benutzerdaten noch im Dateisystem im Verzeichnis
1292 <literal>users</literal> verwaltet wurden, so bietet kivitendo die
1293 Möglichkeit, diese Benutzerdaten automatisch in die
1294 Authentifizierungsdatenbank zu übernehmen. Dies geschieht, wenn man
1295 sich nach dem Update der Installation das erste Mal im
1296 Administrationsbereich anmeldet. Findet kivitendo die Datei
1297 <literal>users/members</literal>, so wird der Migrationsprozess
1300 <para>Der Migrationsprozess ist nahezu vollautomatisch. Alle
1301 Benutzerdaten können übernommen werden. Nach den Benutzerdaten bietet
1302 kivitendo noch die Möglichkeit an, dass automatisch eine
1303 Benutzergruppe angelegt wird. Dieser Gruppe wird Zugriff auf alle
1304 Funktionen von kivitendo gewährt. Alle migrierten Benutzern werden
1305 Mitglied in dieser Gruppe. Damit wird das Verhalten von kivitendo bis
1306 Version 2.4.3 inklusive wiederhergestellt, und die Benutzer können
1307 sich sofort wieder anmelden und mit dem System arbeiten.</para>
1311 <sect1 id="config.sending-email" xreflabel="E-Mail-Versand aus kivitendo heraus">
1312 <title>E-Mail-Versand aus kivitendo heraus</title>
1314 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden, z.B. um ein Angebot direkt an einen Kunden zu
1315 verschicken. Damit dies funktioniert, muss eingestellt werden, über welchen Server die E-Mails verschickt werden sollen. kivitendo
1316 unterstützt dabei zwei Mechanismen: Versand über einen lokalen E-Mail-Server (z.B. mit <productname>Postfix</productname> oder
1317 <productname>Exim</productname>, was auch die standardmäßig aktive Methode ist) sowie Versand über einen SMTP-Server (z.B. der des
1318 eigenen Internet-Providers).</para>
1320 <para>Welche Methode und welcher Server verwendet werden, wird über die Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1321 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1323 <sect2 id="config.sending-email.sendmail" xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1324 <title>Versand über lokalen E-Mail-Server</title>
1326 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie
1327 z.B. <productname>Postfix</productname>, <productname>Exim</productname> oder <productname>Sendmail</productname> läuft.</para>
1329 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1330 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1332 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet wird, dient der Parameter '<literal>sendmail =
1333 ...</literal>'. Der Standardwert verweist auf das Programm <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1334 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1336 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen dieses sprengen. Hierfür sei auf die Dokumentation des
1337 E-Mail-Servers verwiesen.</para>
1340 <sect2 id="config.sending-email.smtp" xreflabel="E-Mail-Versand über einen SMTP-Server">
1341 <title>Versand über einen SMTP-Server</title>
1343 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server vorhanden oder zwar einer vorhanden, dieser aber nicht
1344 konfiguriert ist.</para>
1346 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1347 Parameter dienen dabei der weiteren Konfiguration:</para>
1351 <term><varname>hostname</varname></term>
1353 <listitem><para>Name oder IP-Adresse des SMTP-Servers. Standardwert: '<literal>localhost</literal>'</para></listitem>
1357 <term><varname>port</varname></term>
1359 <listitem><para>Portnummer. Der Standardwert hängt von der verwendeten Verschlüsselungsmethode ab. Gilt '<literal>security =
1360 none</literal>' oder '<literal>security = tls</literal>', so ist 25 die Standardportnummer. Für '<literal>security =
1361 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht geändert werden.</para></listitem>
1365 <term><varname>security</varname></term>
1367 <listitem><para>Wahl der zu verwendenden Verschlüsselung der Verbindung mit dem Server. Standardwert ist
1368 '<literal>none</literal>', wodurch keine Verschlüsselung verwendet wird. Mit '<literal>tls</literal>' wird TLS-Verschlüsselung
1369 eingeschaltet, und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL eingeschaltet. Achtung: Für
1370 '<literal>tls</literal>' und '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt (siehe unten).</para></listitem>
1374 <term><varname>login</varname> und <varname>password</varname></term>
1376 <listitem><para>Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername
1377 und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von
1378 Verschlüsselung aktiviert werden.</para></listitem>
1382 <para>Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind:</para>
1385 <listitem><para>TLS-Verschlüsselung: Modul <literal>Net::SSLGlue</literal> (Debian-Paketname
1386 <literal>libnet-sslglue-perl</literal>, Fedora Core: <literal>perl-Net-SSLGlue</literal>, openSUSE:
1387 <literal>perl-Net-SSLGlue</literal></para></listitem>
1389 <listitem><para>SSL-Verschlüsselung: Modul <literal>Net::SMTP::SSL</literal> (Debian-Paketname
1390 <literal>libnet-smtp-ssl-perl</literal>, Fedora Core: <literal>perl-Net-SMTP-SSL</literal>, openSUSE:
1391 <literal>perl-Net-SMTP-SSL</literal></para></listitem>
1396 <sect1 id="Drucken-mit-kivitendo">
1397 <title>Drucken mit kivitendo</title>
1399 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. Um drucken zu können, braucht der Server ein geeignetes
1400 LaTeX System. Am einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter Debianoiden Betriebssystemen installiert man
1401 die Pakete mit:</para>
1403 <para><programlisting>aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1404 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1406 <para>TODO: RPM-Pakete.</para>
1408 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1410 <listitem><para>Standard</para></listitem>
1411 <listitem><para>f-tex</para></listitem>
1412 <listitem><para>RB</para></listitem>
1415 <sect2 id="Vorlagenverzeichnis-anlegen" xreflabel="Vorlagenverzeichnis anlegen">
1416 <title>Vorlagenverzeichnis anlegen</title>
1417 <para>Im Administrationsbereich lässt sich bei einem Benutzer/Mandanten einer dieser Vorlagensätze als Basis für die zu
1418 druckenden Dokumente auswählen. Rufen Sie dazu die <guimenu>Benutzerverwaltung</guimenu> auf.</para>
1420 <para>Wählen Sie dort einen Benutzer aus oder legen Sie einen neuen an. In der Benutzerbearbeiten-Maske müssen Sie zwei Dinge
1424 <listitem><para><option>Name</option>: Der Verzeichnisname für den neuen Vorlagensatz. Dieser kann im Rahmen der üblichen
1425 Bedingungen für Verzeichnisnamen frei gewählt werden.</para></listitem>
1426 <listitem><para><option>Vorlagen auswählen</option>: Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll
1427 (<filename>Standard</filename>, <filename>f-tex</filename> oder <filename>RB</filename>.)</para></listitem>
1430 <para>Der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Benutzern verwendet werden.</para>
1432 <para>Die Abhängigkeiten kann man prüfen mit:</para>
1434 <programlisting>/scripts/installation_check.pl -l</programlisting>
1437 <sect2 id="Vorlagen-Standard">
1438 <title>Standard</title>
1440 <para>Der Standard-Vorlagensatz von Kivitendo. Wie unter <ulink url="http://demo.kivitendo.org">http://demo.kivitendo.org</ulink> zu
1446 <title>f-tex</title>
1448 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt.</para>
1450 <sect3 id="f-tex-Feature-Übersicht">
1451 <title>Feature-Übersicht</title>
1453 <listitem><para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage für alle briefartigen Dokumente verwendet. Also
1454 Angebot, Rechnung, Performarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc..</para></listitem>
1456 <listitem><para>Leichte Anpassung an das Firmen-Layout durch verwendung eines Hintergrund-PDF. Dieses kann leicht mit dem
1457 eigenen Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp, Adobe*)</para></listitem>
1459 <listitem><para>Hintergrund-PDF umschaltbar auf "nur erste Seite" (Standard) oder "alle Seiten" (Option
1460 "<option>bgPdfFirstPageOnly</option>" in Datei <filename>letter.lco</filename>)</para></listitem>
1462 <listitem><para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1463 versendeten Dokumenten eingebunden (Option "<option>bgPdfEmailOnly</option>" in Datei
1464 <filename>letter.lco</filename>).</para></listitem>
1466 <listitem><para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch, Wiederholung von Kopfzeilen, Zwischensummen
1467 etc. (danke an Kai-Martin Knaak für die Vorarbeit)</para></listitem>
1469 <listitem><para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom Land des eigenen Unternehmens abweicht (also die
1470 Rechnung das Land verlässt).</para></listitem>
1472 <listitem><para>Multisprachfähig leicht um weitere Sprachen zu erweitern, alle Übersetzungen in der Datei
1473 <filename>translatinos.tex</filename>.</para></listitem>
1475 <listitem><para>Auflistung von Bruttopreisen für Endverbraucher.</para></listitem>
1479 <sect3 id="f-tex-Installation">
1480 <title>Die Installation</title>
1482 <listitem><para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref linkend="Vorlagenverzeichnis-anlegen"/>. Das
1483 Vorlagensystem funktioniert jetzt schon, hat allerdings noch einen Beispiel-Briefkopf.</para></listitem>
1485 <listitem><para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach <filename>./letter_head.pdf</filename>.</para></listitem>
1486 <listitem><para>Editiere den Bereich "<option>settings</option>" in der datei <filename>letter.lco</filename>.</para></listitem>
1489 <para>oder etwas Detaillierter:</para>
1492 Es wird eine Datei <filename>sample.lco</filename> erstellt und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
1493 ist dies die Datei die für die Firmenspezifischen Anpassungen gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig
1494 ist, wird in dieser Datei auf ein Hintergrundpdf verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen
1495 vorzunehmen und <filename>sample.lco</filename> unverändert zu lassen. Die die Anpassung über eine
1496 <filename>*.lco</filename>-Datei die letztlich auf <filename>letter.lco</filename> verlinkt ist ist aber auch möglich.
1500 Es wird eine Datei <filename>sample_head.pdf</filename> mit ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
1501 verlinkt. Damit gibt es schon mal eine Funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei
1502 <filename>sample_haed.pdf</filename> an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
1503 Template Verzeichniss ablegen und statt <filename>sample_head.pdf</filename> nach <filename>letter_head.pdf</filename>
1508 letzlich muss <filename>letter_head.pdf</filename> auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
1509 enthält. Bei Updates oder nach erneutem
1513 Es wird eine Datei <filename>mydata.tex.example</filename> ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
1514 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das Land verwendet. Die Datei muss also nicht angefasst
1515 werden. Die Anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig).
1518 Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc. sollten über die Hintergrund-PDF-Datei oder die
1519 <filename>*.lco</filename>-Datei erfolgen.
1523 <sect3 id="f-tex-Funktionsübersicht">
1524 <title>f-tex Funktionsübersicht</title>
1526 Das Konzept von kivitendo sieht vor, für jedes Dokument (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine LaTeX-Vorlage
1527 vorzuhalten, dies ist sehr Wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
1528 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
1529 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche LaTeX-Vorlage verwendet, welche über Codeweichen die
1530 Besonderheiten der jeweiligen Dokumente Berücksichtigt.
1534 <listitem><para>Tabellen mit oder ohne Preis</para></listitem>
1535 <listitem><para>Sprache der Tabellenüberschriften etc.</para></listitem>
1536 <listitem><para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus Angebotsnummer)</para></listitem>
1537 <listitem><para>Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus Gewerblicher
1538 Kunde)</para></listitem>
1541 <para>Nachteil:</para>
1544 LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
1545 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann natürlich
1546 auch innerhalb der Tabellendarstellung gut persönliche Anpassungen vornehmen. Aber man kann sich hier bei Veränderungen sehr
1547 schnell häftig in den Fuss schiessen.
1550 <para>Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund PDF auf Basis der
1551 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen, und sich an der Form der dargestellten Tabellen wie sie
1552 ausgeliefert werden, erfreuen.
1555 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine kontinuierliche Schritte gehen.</para>
1559 <sect3 id="f-tex-Bruttopreise">
1560 <title>Bruttopreise für Endverbraucher</title>
1562 <para>Der auszuweisende Bruttopreis wird innerhalb der LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen "alle
1563 Preise Brutto" auszuwählen, aber:</para>
1566 <para>hierfür müssen die Preise auch in Brutto in der Datenbank stehen (ja - das lässt sich über die Preisgruppen und die
1567 Zuordung einer Default-Preisgruppe handhaben)</para>
1570 <para>man darf beim Anlegen des Vorgangs nicht vergessen Dieses Häkchen zu setzen. (das ist in der Praxis wenn man sowohl
1571 Endverbraucher- wie Gewerbekunden beliefert der eigentliche Knackpunkt)</para>
1576 Es gibt mit f-tex eine weitere Alternative. Die Information ob Brutto oder Nettorechnung wird mit den Zahlarten
1577 verknüpft. Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben werden sollen, enden mit "_E" (für
1578 Endverbraucher). Falls identische Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt man diese einfach doppelt
1579 an (einmal mit der Namensendung "_E"). Gewinn:</para>
1582 <listitem><para>Die Entscheidung, ob Netopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste Verbunden.</para></listitem>
1583 <listitem><para>Die Default-Zahlart kann im Kundendatensatz hinterlegt werden, und man muss nicht mehr daran denken, "alle Preise
1584 Netto" auszuwählen.</para></listitem>
1585 <listitem><para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken reviediert werden,
1586 ohne dass sich der Auftragswert ändert.</para></listitem>
1590 <sect3 id="f-tex-lieferadressen">
1591 <title>Lieferadressen</title>
1593 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen im Adressfeld zum Einsatz. Wenn die
1594 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende Adressvariable eingesetzt. Wenn also die Lieferadresse in
1595 Straße, Hausnummer und Ort abweicht, müssen auch nur diese Felder in der Lieferadresse ausgefüllt werden. Für den Firmenname wird
1596 der Wert der Hauptadresse angezeigt.
1601 <sect2 id="Vorlagen-RB">
1604 <para>Vollständiger Dokumentensatz mit alternativem Design</para>
1608 <sect2 id="allgemeine-hinweise-zu-latex">
1609 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
1610 <para>In den allermeisten Installationen sollte drucken jetzt schon
1611 funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
1612 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
1613 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1618 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1619 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1620 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1624 <para>! Package inputenc Error: Unicode char \u8:... set up for
1625 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1626 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1627 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1628 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1629 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1633 <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
1634 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1635 Prüfen Sie den Namen in der Konfiguration (Standard:
1636 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1637 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1640 <para>Wenn sich das Problem nicht auf Grund der ausgabe im Webbrowser verifizieren lässt:</para>
1643 <para> editiere [kivitendo-home]/config/kivitendo.conf und ändere "keep_tmp_files" auf 1</para>
1644 <para><programlisting>keep_temp_files = 1;</programlisting></para>
1647 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
1650 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
1653 <para>wechsele in das users Verzeichnis von kivitendo</para>
1654 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
1657 <para>LaTeX Suchpfad anpassen:</para>
1658 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
1661 <para>Finde herraus welche Datei kivitendo beim letzten Durchlauf erstellt hat</para>
1662 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
1663 <para>Es sollte die letzte Datei ganz unten sein</para>
1666 <para>für besseren Hinweis auf Fehler texdatei nochmals übersetzen</para>
1667 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
1668 <para>in der *.tex datei nach dem Fehler suchen.</para>
1674 <sect1 id="OpenDocument-Vorlagen">
1675 <title>OpenDocument-Vorlagen</title>
1677 <para>kivitendo unterstützt die Verwendung von Vorlagen im
1678 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1679 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1680 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1681 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1682 <filename>config/kivitendo.conf</filename> die Variable
1683 <literal>opendocument</literal> im Abschnitt
1684 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1685 Dieses ist die Standardeinstellung.</para>
1687 <para>Weiterhin muss in der Datei
1688 <filename>config/kivitendo.conf</filename> die Variable
1689 <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf
1690 die Zeichenkodierung gesetzt werden, die auch bei der Speicherung der
1691 Daten in der Datenbank verwendet wird. Diese ist in den meisten Fällen
1694 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1695 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1696 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1697 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1698 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1699 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1701 <para>Nach der Installation müssen in der Datei
1702 <filename>config/kivitendo.conf</filename> zwei weitere Variablen
1703 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1704 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1705 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1706 enthalten. Beide stehen im Abschnitt
1707 <literal>applications</literal>.</para>
1709 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
1710 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1711 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1712 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1713 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1714 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1715 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1716 werden muss. Der Nachteil ist, dass diese Methode Python und die
1717 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1720 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1721 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1722 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1723 Dokumentenvorlage enthalten sein und
1724 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1725 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1726 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1727 ebenfalls enthalten sein muss.</para>
1729 <para>Als letztes muss herausgefunden werden, welchen Namen
1730 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1731 gibt. Unter Debian ist dies momentan
1732 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1733 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1734 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1735 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1736 folgender Befehl auszuführen:</para>
1738 <para><literal>mv users/.openoffice.org2
1739 users/.openoffice</literal></para>
1741 <para>Dieses Verzeichnis, wie auch das komplette
1742 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1743 sein. Dieses wurde bereits erledigt (siehe <xref
1744 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1745 erneut überprüft werden, wenn die Konvertierung nach PDF
1749 <sect1 id="config.eur">
1750 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1753 <sect2 id="config.eur.introduction"
1754 xreflabel="Einführung in die Konfiguration zur EUR">
1755 <title>Einführung</title>
1757 <para>kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1758 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals noch <filename>config/lx_office.conf</filename>)
1759 befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden.</para>
1761 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1762 die Mandantendatenbank verschoben und dabei auch gleich in drei
1763 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1764 steuern lässt.</para>
1767 <sect2 id="config.eur.parameters"
1768 xreflabel="Konfigurationsparameter für EUR">
1769 <title>Konfigurationsparameter</title>
1771 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1772 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1776 <term><varname>profit_determination</varname></term>
1779 <para>Dieser Parameter legt die Berechnungsmethode für die
1780 Gewinnermittlung fest. Er enthält entweder
1781 <literal>balance</literal> für
1782 Betriebsvermögensvergleich/Bilanzierung oder
1783 <literal>income</literal> für die
1784 Einnahmen-Überschuss-Rechnung.</para>
1789 <term><varname>accounting_method</varname></term>
1792 <para>Dieser Parameter steuert die Buchungs- und
1793 Berechnungsmethoden für die Versteuerungsart. Er enthält
1794 entweder <literal>accrual</literal> für die Soll-Versteuerung
1795 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1800 <term><varname>inventory_system</varname></term>
1803 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1804 enthält entweder <literal>perpetual</literal> für die
1805 Bestandsmethode oder <literal>periodic</literal> für die
1806 Aufwandsmethode.</para>
1811 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1812 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1813 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1814 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1815 Bestandsmethode.</para>
1817 <para>Die Konfiguration "<varname>eur</varname>" unter
1818 <varname>[system]</varname> in der <link
1819 linkend="config.config-file">Konfigurationsdatei</link>
1820 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
1821 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1824 <sect2 id="config.eur.setting-parameters">
1825 <title>Festlegen der Parameter</title>
1827 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1828 der Admininstration können diese Optionen nun unabhängig voneinander
1829 eingestellt werden.</para>
1831 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1832 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1835 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1836 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
1837 angezeigt. Unter <guimenu>System</guimenu>
1838 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> können
1839 die Einstellungen auch geändert werden. Dabei ist zu beachten,
1840 dass eine Änderung vorhandene Daten so belässt und damit
1841 evtl. die Ergebnisse verfälscht. Dies gilt vor Allem für die
1842 Warenbuchungsmethode (siehe auch
1843 <link linkend="config.eur.inventory-system-perpetual">
1844 Bemerkungen zu Bestandsmethode</link>).</para>
1847 <sect2 id="config.eur.inventory-system-perpetual">
1848 <title>Bemerkungen zu Bestandsmethode</title>
1850 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1851 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
1852 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1853 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1854 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1855 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1856 Einkaufsrechnungen berechnet wird.</para>
1858 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1859 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1860 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1864 <sect2 id="config.eur.knonw-issues">
1865 <title>Bekannte Probleme</title>
1867 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1868 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1869 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1870 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1871 die Konfigurationsvariable
1872 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1875 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1876 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1880 <sect1 id="config.skr04-update-3804">
1881 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1883 <sect2 id="config.skr04-update-3804.introduction">
1884 <title>Einführung</title>
1886 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1887 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1888 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1889 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1890 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1891 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1892 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1893 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1894 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1895 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1896 Screenshots dargestellt.</para>
1898 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1899 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1900 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1901 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1904 <sect2 id="config.skr04-update-3804.create-chart">
1905 <title>Konto 3804 manuell anlegen</title>
1907 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
1908 anzulegen und zu konfigurieren. Zuerst wird in
1909 <guimenu>System</guimenu> ->
1910 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
1911 erfassen</guimenuitem> das Konto angelegt.</para>
1914 <screeninfo>Konto 3804 erfassen</screeninfo>
1918 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
1924 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
1925 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
1926 wie im folgenden Screenshot angezeigt anpassen.
1930 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
1934 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
1940 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
1941 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
1945 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
1949 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
1955 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
1956 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
1957 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
1958 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
1962 <screeninfo>Konto 4315 anpassen</screeninfo>
1966 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
1972 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
1973 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
1977 <screeninfo>Steuerliste vergleichen</screeninfo>
1981 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
1988 <sect1 id="config.client">
1989 <title>Einstellungen pro Mandant</title>
1991 <para>Einige Einstellungen können von einem Benutzer mit dem
1992 <link linkend="Zusammenhänge">Recht</link> "Administration
1993 (Für die Verwaltung der aktuellen Instanz aus einem Userlogin heraus)"
1994 gemacht werden. Diese Einstellungen sind dann für die aktuellen
1995 Mandanten-Datenbank gültig. Die Einstellungen sind
1996 unter <guimenu>System</guimenu>
1997 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
1999 <para>Bitte beachten Sie die Hinweise zu den einzelnen
2000 Einstellungen. Einige Einstellungen sollten nicht ohne Weiteres
2001 im laufenden Betrieb geändert werden (siehe
2002 auch <link linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
2003 Bestandsmethode</link>).</para>
2005 <para>Die Einstellungen <literal>show_bestbefore</literal>
2006 und <literal>payments_changeable</literal> aus dem
2007 Abschnitt <literal>features</literal> und die Einstellungen im
2008 Abschnitt <literal>datev_check</literal> (sofern schon vorhanden)
2009 der <link linkend="config.config-file">kivitendo-Konfigurationsdatei</link>
2010 werden bei einem Datenbankupdate einer älteren Version automatisch
2011 übernommen. Diese Einträge können danach aus der Konfigurationsdatei
2012 entfernt werden.</para>
2015 <sect1 id="kivitendo-ERP-verwenden">
2016 <title>kivitendo ERP verwenden</title>
2018 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
2019 folgender URL erreichbar:</para>
2022 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
2024 <para>Die Administrationsseite erreichen Sie unter:</para>
2027 url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
2031 <chapter id="features" xreflabel="Features und Funktionen">
2032 <title>Features und Funktionen</title>
2034 <sect1 id="features.periodic-invoices"
2035 xreflabel="Wiedekehrende Rechnungen">
2036 <title>Wiederkehrende Rechnungen</title>
2038 <sect2 id="features.periodic-invoices.introduction"
2039 xreflabel="Einführung in wiederkehrende Rechnungen">
2040 <title>Einführung</title>
2042 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
2043 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
2044 Die konfigurierten Aufträge werden später automatisch in Rechnungen
2045 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
2046 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
2047 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
2048 wiederzufinden sind.</para>
2051 <sect2 id="features.periodic-invoices.configuration"
2052 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
2053 <title>Konfiguration</title>
2055 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
2056 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
2057 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
2058 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
2059 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
2062 <para>Folgende Parameter kann man konfigurieren:</para>
2069 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
2070 erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
2071 neuen Monats).</para>
2073 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
2074 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
2075 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
2076 nächsten Periodenwechsel für alle Perioden, seit der letzten
2077 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
2078 verhindern, muss man vorher das Startdatum neu setzen.</para>
2080 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
2081 erstellt. Man kann sich diese Aufträge aber gesondert in den
2082 Berichten anzeigen lassen.</para>
2087 <term>Periodizität</term>
2090 <para>Ob monatlich, quartalsweise oder jährlich auf neue
2091 Rechnungen überprüft werden soll. Für jede Periode seit dem
2092 Startdatum wird überprüft, ob für die Periode (beginnend immer
2093 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
2094 wurde. Unter Umständen können bei einem Startdatum in der
2095 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
2100 <term>Buchen auf</term>
2103 <para>Das Forderungskonto, in der Regel "Forderungen aus
2104 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
2105 Buchungsgruppen der betreffenden Waren.</para>
2110 <term>Startdatum</term>
2113 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
2119 <term>Enddatum</term>
2122 <para>ab wann keine Rechnungen mehr erstellt werden
2128 <term>Automatische Verlängerung um x Monate</term>
2131 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
2132 eingetragenen Enddatums weiterhin erstellt werden, so kann man
2133 hier die Anzahl der Monate eingeben, um die das Enddatum
2134 automatisch nach hinten geschoben wird.</para>
2139 <term>Drucken</term>
2142 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
2143 Rechnungen auch gleich ausdrucken lassen.</para>
2148 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
2149 Informationen zu den erstellten Rechnungen verschickt werden.
2150 Konfiguriert wird dies in der <link
2151 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
2152 <filename>config/kivitendo.conf</filename> im Abschnitt
2153 <varname>[periodic_invoices]</varname>.</para>
2156 <sect2 id="features.periodic-invoices.reports">
2157 <title>Auflisten</title>
2159 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
2160 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
2161 Rechnungen inaktiv", mit denen man sich einen Überglick über die
2162 wiederkehrenden Rechnungen verschaffen kann.</para>
2165 <sect2 id="features.periodic-invoices.task-server">
2166 <title>Erzeugung der eigentlichen Rechnungen</title>
2168 <para>Die zeitliche und periodische Überprüfung, ob eine
2169 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
2170 durch den <link linkend="config.task-server">Taskserver</link>, einen
2171 externen Dienst, der automatisch beim Start des Servers gestartet
2172 werden sollte.</para>
2175 <sect2 id="features.periodic-invoices.create-for-current-month">
2176 <title>Erste Rechnung für aktuellen Monat erstellen</title>
2178 <para>Will man im laufenden Monat eine monatlich wiederkehrende
2179 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
2180 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
2181 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
2182 generiert hat. Alternativ setzt man das Startdatum auf den
2183 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
2184 manuell über den Workflow.</para>
2188 <sect1 id="dokumentenvorlagen-und-variablen">
2189 <title>Dokumentenvorlagen und verfügbare Variablen</title>
2191 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
2192 <title>Einführung</title>
2194 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
2195 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
2196 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
2197 <function><%variablenname%></function> verwendet wird. Für
2198 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
2200 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
2202 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
2203 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
2204 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
2205 alle Vorlagenarten.</para>
2207 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
2208 verfügbar als hier aufgelistet werden. Die meisten davon können
2209 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
2210 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
2211 diese wie folgt erhalten werden:</para>
2215 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
2216 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
2220 <para>In <filename>Form.pm</filename> die Funktion
2221 <function>parse_template</function> suchen und hier die Zeile
2222 <command>print(STDERR Dumper($self));</command> einfügen.</para>
2226 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
2227 ein PDF für eine Rechnung erzeugen.</para>
2231 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
2232 der Variablen <varname>$self</varname> in der Form <varname>'key'
2233 => 'value',</varname>. Alle <varname>key</varname>s sind
2239 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
2240 <title>Variablen ausgeben</title>
2242 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
2243 Tags geschrieben werden, also z.B.
2244 <varname><%variablenname%></varname>.</para>
2246 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
2247 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
2248 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
2249 werden die folgenden Flags unterstützt:</para>
2253 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
2254 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
2255 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
2256 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
2260 <para><option>NOESCAPE</option> unterdrückt das Escapen von
2261 Sonderzeichen für die Vorlagensprache. Wenn also in einer
2262 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
2263 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
2264 ist dieses Flag sinnvoll.</para>
2268 <para>Beispiel:</para>
2270 <programlisting><%quototal NOFORMAT%></programlisting>
2273 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
2274 <title>Verwendung in Druckbefehlen</title>
2276 <para>In der Admininstration können Drucker definiert werden. Auch im
2277 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
2278 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
2279 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
2280 <function>`...`</function> nicht zu unerwünschtem Verhalten
2283 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
2284 für das die Telefonnummer eines Ansprechpartners als Teil der
2285 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
2286 z.B. wie folgt aussehen:</para>
2288 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
2291 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
2292 xreflabel="Anfang und Ende der Tags verändern">
2293 <title>Anfang und Ende der Tags verändern</title>
2295 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
2296 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
2297 Prozentzeichen und dem Größerzeichen endet, beispielsweise
2298 <function><%customer%></function>. Da diese Form aber z.B. in
2299 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
2300 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
2301 Stil umgestellt werden.</para>
2303 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
2304 Format gültigen Kommentarzeichen anfangen, dann
2305 <function>config:</function> enthalten, die entsprechende Option
2306 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
2307 enden. Beispiel für LaTeX:</para>
2309 <programlisting>% config: tag-style=($ $)</programlisting>
2311 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
2312 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
2313 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
2315 <programlisting><!-- config: tag-style=($ $) --></programlisting>
2318 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
2319 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
2321 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
2322 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
2323 "<filename>.ext</filename>" geeignet zu ersetzen:
2324 "<filename>.tex</filename>" für LaTeX-Vorlagen und
2325 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
2329 <term><filename>bin_list.ext</filename></term>
2332 <para>Lagerliste</para>
2337 <term><filename>check.ext</filename></term>
2345 <term><filename>invoice.ext</filename></term>
2348 <para>Rechnung</para>
2353 <term><filename>packing_list.ext</filename></term>
2356 <para>Packliste</para>
2361 <term><filename>pick_list.ext</filename></term>
2364 <para>Sammelliste</para>
2369 <term><filename>purchase_delivery_order.ext</filename></term>
2372 <para>Lieferschein (Einkauf)</para>
2377 <term><filename>purcharse_order.ext</filename></term>
2380 <para>Bestellung an Lieferanten</para>
2385 <term><filename>request_quotation.ext</filename></term>
2388 <para>Anfrage an Lieferanten</para>
2393 <term><filename>sales_delivery_order.ext</filename></term>
2396 <para>Lieferschein (Verkauf)</para>
2401 <term><filename>sales_order.ext</filename></term>
2404 <para>Bestellung</para>
2409 <term><filename>sales_quotation.ext</filename></term>
2412 <para>Angebot an Kunden</para>
2417 <term><filename>zahlungserinnerung.ext</filename></term>
2420 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2425 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2428 <para>Rechnung über Mahngebühren (Dateiname im Programm
2429 konfigurierbar)</para>
2435 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2436 <title>Sprache, Drucker und E-Mail</title>
2438 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2439 eingearbeitet. So wird aus der Vorlage
2440 <filename>sales_order.ext</filename> bei Sprache
2441 <function>de</function> und Druckerkürzel <function>lpr2</function>
2442 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2443 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2444 bekommen dann noch das Kürzel <filename>_email</filename>, der
2445 vollständige Vorlagenname wäre dann
2446 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2447 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2448 werden. Diese wird verwendet, wenn keine der anderen Varianten
2449 gefunden wird.</para>
2451 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2452 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2453 verschickt wird, ist:</para>
2457 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2461 <para><filename>sales_order_de_lpr2.tex</filename></para>
2465 <para><filename>sales_order.tex</filename></para>
2469 <para><filename>default.tex</filename></para>
2473 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2474 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2476 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2479 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2480 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2483 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2484 xreflabel="Metainformationen zur angeforderten Vorlage">
2485 <title>Metainformationen zur angeforderten Vorlage</title>
2487 <para>Diese Variablen liefern Informationen darüber welche Variante
2488 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2489 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2490 Formulare einbinden möchten.</para>
2494 <term><varname>template_meta.formname</varname></term>
2497 <para>Basisname der Vorlage. Identisch mit der <link
2498 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2499 zu den Dateinamen</link> ohne die Erweiterung. Ein
2500 Verkaufsauftrag enthält hier
2501 <constant>sales_order</constant>.</para>
2506 <term><varname>template_meta.language.description</varname></term>
2509 <para>Beschreibung der verwendeten Sprache</para>
2514 <term><varname>template_meta.language.template_code</varname></term>
2517 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2518 Kürzel das im Dateinamen verwendetet wird.</para>
2523 <term><varname>template_meta.language.output_numberformat</varname></term>
2526 <para>Zahlenformat der verwendeten Sprache in der Form
2527 "<constant>1.000,00</constant>". Experimentell! Nur
2528 interessant für Vorlagen die mit unformatierten Werten
2534 <term><varname>template_meta.language.output_dateformat</varname></term>
2537 <para>Datumsformat der verwendeten Sprache in der Form
2538 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2539 interessant für Vorlagen die mit unformatierten Werten
2545 <term><varname>template_meta.format</varname></term>
2548 <para>Das angeforderte Format. Kann im Moment die Werte
2549 <constant>pdf</constant>, <constant>postscript</constant>,
2550 <constant>html</constant>, <constant>opendocument</constant>,
2551 <constant>opendocument_pdf</constant> und
2552 <constant>excel</constant> enthalten.</para>
2557 <term><varname>template_meta.extension</varname></term>
2560 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2561 <constant>format</constant> entschieden.</para>
2566 <term><varname>template_meta.media</varname></term>
2569 <para>Ausgabemedium. Kann zur Zeit die Werte
2570 <constant>screen</constant> für Bildschirm,
2571 <constant>email</constant> für E-Mmail (triggert das
2572 <constant>_email</constant> Kürzel im Dateinamen),
2573 <constant>printer</constant> für Drucker, und
2574 <constant>queue</constant> für Warteschlange enthalten.</para>
2579 <term><varname>template_meta.printer.description</varname></term>
2582 <para>Beschreibung des ausgewählten Druckers</para>
2587 <term><varname>template_meta.printer.template_code</varname></term>
2590 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2591 dem Kürzel das im Dateinamen verwendetet wird.</para>
2596 <term><varname>template_meta.tmpfile</varname></term>
2599 <para>Datei-Prefix für temporäre Dateien.</para>
2605 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2606 <title>Stammdaten von Kunden und Lieferanten</title>
2610 <term><varname>account_number</varname></term>
2613 <para>Kontonummer</para>
2618 <term><varname>bank</varname></term>
2621 <para>Name der Bank</para>
2626 <term><varname>bank_code</varname></term>
2629 <para>Bankleitzahl</para>
2634 <term><varname>bic</varname></term>
2637 <para>Bank-Identifikations-Code (Bank Identifier Code,
2643 <term><varname>business</varname></term>
2646 <para>Kunden-/Lieferantentyp</para>
2651 <term><varname>city</varname></term>
2659 <term><varname>contact</varname></term>
2662 <para>Kontakt</para>
2667 <term><varname>country</varname></term>
2675 <term><varname>cp_email</varname></term>
2678 <para>Email des Ansprechpartners</para>
2683 <term><varname>cp_givenname</varname></term>
2686 <para>Vorname des Ansprechpartners</para>
2691 <term><varname>cp_greeting</varname></term>
2694 <para>Anrede des Ansprechpartners</para>
2699 <term><varname>cp_name</varname></term>
2702 <para>Name des Ansprechpartners</para>
2707 <term><varname>cp_phone1</varname></term>
2710 <para>Telefonnummer 1 des Ansprechpartners</para>
2715 <term><varname>cp_phone2</varname></term>
2718 <para>Telefonnummer 2 des Ansprechpartners</para>
2723 <term><varname>cp_title</varname></term>
2726 <para>Titel des Ansprechpartners</para>
2731 <term><varname>creditlimit</varname></term>
2734 <para>Kreditlimit</para>
2739 <term><varname>customeremail</varname></term>
2742 <para>Email des Kunden; nur für Kunden</para>
2747 <term><varname>customerfax</varname></term>
2750 <para>Faxnummer des Kunden; nur für Kunden</para>
2755 <term><varname>customernotes</varname></term>
2758 <para>Bemerkungen beim Kunden; nur für Kunden</para>
2763 <term><varname>customernumber</varname></term>
2766 <para>Kundennummer; nur für Kunden</para>
2771 <term><varname>customerphone</varname></term>
2774 <para>Telefonnummer des Kunden; nur für Kunden</para>
2779 <term><varname>discount</varname></term>
2787 <term><varname>email</varname></term>
2790 <para>Emailadresse</para>
2795 <term><varname>fax</varname></term>
2798 <para>Faxnummer</para>
2803 <term><varname>homepage</varname></term>
2806 <para>Homepage</para>
2811 <term><varname>iban</varname></term>
2814 <para>Internationale Kontonummer (International Bank Account
2815 Number, IBAN)</para>
2820 <term><varname>language</varname></term>
2823 <para>Sprache</para>
2828 <term><varname>name</varname></term>
2831 <para>Firmenname</para>
2836 <term><varname>payment_description</varname></term>
2839 <para>Name der Zahlart</para>
2844 <term><varname>payment_terms</varname></term>
2847 <para>Zahlungskonditionen</para>
2852 <term><varname>phone</varname></term>
2855 <para>Telefonnummer</para>
2860 <term><varname>shiptocity</varname></term>
2863 <para>Stadt (Lieferadresse) <link
2864 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2869 <term><varname>shiptocontact</varname></term>
2872 <para>Kontakt (Lieferadresse) <link
2873 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2878 <term><varname>shiptocountry</varname></term>
2881 <para>Land (Lieferadresse) <link
2882 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2887 <term><varname>shiptodepartment1</varname></term>
2890 <para>Abteilung 1 (Lieferadresse) <link
2891 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2896 <term><varname>shiptodepartment2</varname></term>
2899 <para>Abteilung 2 (Lieferadresse) <link
2900 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2905 <term><varname>shiptoemail</varname></term>
2908 <para>Email (Lieferadresse) <link
2909 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2914 <term><varname>shiptofax</varname></term>
2917 <para>Fax (Lieferadresse) <link
2918 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2923 <term><varname>shiptoname</varname></term>
2926 <para>Firmenname (Lieferadresse) <link
2927 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2932 <term><varname>shiptophone</varname></term>
2935 <para>Telefonnummer (Lieferadresse) <link
2936 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2941 <term><varname>shiptostreet</varname></term>
2944 <para>Straße und Hausnummer (Lieferadresse) <link
2945 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2950 <term><varname>shiptozipcode</varname></term>
2953 <para>Postleitzahl (Lieferadresse) <link
2954 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2959 <term><varname>street</varname></term>
2962 <para>Straße und Hausnummer</para>
2967 <term><varname>taxnumber</varname></term>
2970 <para>Steuernummer</para>
2975 <term><varname>ustid</varname></term>
2978 <para>Umsatzsteuer-Identifikationsnummer</para>
2983 <term><varname>vendoremail</varname></term>
2986 <para>Email des Lieferanten; nur für Lieferanten</para>
2991 <term><varname>vendorfax</varname></term>
2994 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
2999 <term><varname>vendornotes</varname></term>
3002 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
3007 <term><varname>vendornumber</varname></term>
3010 <para>Lieferantennummer; nur für Lieferanten</para>
3015 <term><varname>vendorphone</varname></term>
3018 <para>Telefonnummer des Lieferanten; nur für
3024 <term><varname>zipcode</varname></term>
3027 <para>Postleitzahl</para>
3032 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
3033 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
3034 Stammdaten nicht eingetragen, so haben die Variablen
3035 <varname>shipto*</varname> den gleichen Wert wie die die
3036 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
3037 einige <varname>shipto*</varname>-Variablen so nicht in den
3038 Stammdaten wiederfinden sondern schlicht Kopien der
3039 Lieferdatenvariablen sind (z.B.
3040 <varname>shiptocontact</varname>).</para>
3044 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
3045 <title>Informationen über den Bearbeiter</title>
3049 <term><varname>employee_address</varname></term>
3052 <para>Adressfeld</para>
3057 <term><varname>employee_businessnumber</varname></term>
3060 <para>Firmennummer</para>
3065 <term><varname>employee_company</varname></term>
3068 <para>Firmenname</para>
3073 <term><varname>employee_co_ustid</varname></term>
3076 <para>Usatzsteuer-Identifikationsnummer</para>
3081 <term><varname>employee_duns</varname></term>
3084 <para>DUNS-Nummer</para>
3089 <term><varname>employee_email</varname></term>
3097 <term><varname>employee_fax</varname></term>
3105 <term><varname>employee_name</varname></term>
3108 <para>voller Name</para>
3113 <term><varname>employee_signature</varname></term>
3116 <para>Signatur</para>
3121 <term><varname>employee_taxnumber</varname></term>
3124 <para>Steuernummer</para>
3129 <term><varname>employee_tel</varname></term>
3132 <para>Telefonnummer</para>
3138 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
3139 <title>Informationen über den Bearbeiter</title>
3143 <term><varname>salesman_address</varname></term>
3146 <para>Adressfeld</para>
3151 <term><varname>salesman_businessnumber</varname></term>
3154 <para>Firmennummer</para>
3159 <term><varname>salesman_company</varname></term>
3162 <para>Firmenname</para>
3167 <term><varname>salesman_co_ustid</varname></term>
3170 <para>Usatzsteuer-Identifikationsnummer</para>
3175 <term><varname>salesman_duns</varname></term>
3178 <para>DUNS-Nummer</para>
3183 <term><varname>salesman_email</varname></term>
3191 <term><varname>salesman_fax</varname></term>
3199 <term><varname>salesman_name</varname></term>
3202 <para>voller Name</para>
3207 <term><varname>salesman_signature</varname></term>
3210 <para>Signatur</para>
3215 <term><varname>salesman_taxnumber</varname></term>
3218 <para>Steuernummer</para>
3223 <term><varname>salesman_tel</varname></term>
3226 <para>Telefonnummer</para>
3232 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
3233 <title>Variablen für die einzelnen Steuern</title>
3237 <term><varname>tax</varname></term>
3245 <term><varname>taxbase</varname></term>
3248 <para>zu versteuernder Betrag</para>
3253 <term><varname>taxdescription</varname></term>
3256 <para>Name der Steuer</para>
3261 <term><varname>taxrate</varname></term>
3264 <para>Steuersatz</para>
3271 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
3272 <title>Variablen in Rechnungen</title>
3274 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
3275 <title>Allgemeine Variablen</title>
3279 <term><varname>creditremaining</varname></term>
3282 <para>Verbleibender Kredit</para>
3287 <term><varname>currency</varname></term>
3290 <para>Währung</para>
3295 <term><varname>cusordnumber</varname></term>
3298 <para>Bestellnummer beim Kunden</para>
3303 <term><varname>deliverydate</varname></term>
3306 <para>Lieferdatum</para>
3311 <term><varname>duedate</varname></term>
3314 <para>Fälligkeitsdatum</para>
3319 <term><varname>globalprojectnumber</varname></term>
3322 <para>Projektnummer des ganzen Beleges</para>
3327 <term><varname>globalprojectdescription</varname></term>
3330 <para>Projekbeschreibung des ganzen Beleges</para>
3335 <term><varname>intnotes</varname></term>
3338 <para>Interne Bemerkungen</para>
3343 <term><varname>invdate</varname></term>
3346 <para>Rechnungsdatum</para>
3351 <term><varname>invnumber</varname></term>
3354 <para>Rechnungsnummer</para>
3359 <term><varname>invtotal</varname></term>
3362 <para>gesamter Rechnungsbetrag</para>
3367 <term><varname>notes</varname></term>
3370 <para>Bemerkungen der Rechnung</para>
3375 <term><varname>orddate</varname></term>
3378 <para>Auftragsdatum</para>
3383 <term><varname>ordnumber</varname></term>
3386 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3387 erstellt wurde</para>
3392 <term><varname>payment_description</varname></term>
3395 <para>Name der Zahlart</para>
3400 <term><varname>payment_terms</varname></term>
3403 <para>Zahlungskonditionen</para>
3408 <term><varname>quodate</varname></term>
3411 <para>Angebotsdatum</para>
3416 <term><varname>quonumber</varname></term>
3419 <para>Angebotsnummer</para>
3424 <term><varname>shippingpoint</varname></term>
3427 <para>Versandort</para>
3432 <term><varname>shipvia</varname></term>
3435 <para>Transportmittel</para>
3440 <term><varname>subtotal</varname></term>
3443 <para>Zwischensumme aller Posten ohne Steuern</para>
3448 <term><varname>total</varname></term>
3451 <para>Restsumme der Rechnung (Summe abzüglich bereits
3452 bezahlter Posten)</para>
3457 <term><varname>transaction_description</varname></term>
3460 <para>Vorgangsbezeichnung</para>
3465 <term><varname>transdate</varname></term>
3468 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3469 erstellt wurde</para>
3475 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3476 <title>Variablen für jeden Posten auf der Rechnung</title>
3480 <term><varname>bin</varname></term>
3483 <para>Stellage</para>
3488 <term><varname>description</varname></term>
3491 <para>Artikelbeschreibung</para>
3496 <term><varname>discount</varname></term>
3499 <para>Rabatt als Betrag</para>
3504 <term><varname>discount_sub</varname></term>
3507 <para>Zwischensumme mit Rabatt</para>
3512 <term><varname>drawing</varname></term>
3515 <para>Zeichnung</para>
3520 <term><varname>ean</varname></term>
3523 <para>EAN-Code</para>
3528 <term><varname>image</varname></term>
3536 <term><varname>linetotal</varname></term>
3539 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3544 <term><varname>longdescription</varname></term>
3547 <para>Langtext</para>
3552 <term><varname>microfiche</varname></term>
3555 <para>Mikrofilm</para>
3560 <term><varname>netprice</varname></term>
3563 <para>Nettopreis</para>
3568 <term><varname>nodiscount_linetotal</varname></term>
3571 <para>Zeilensumme ohne Rabatt</para>
3576 <term><varname>nodiscount_sub</varname></term>
3579 <para>Zwischensumme ohne Rabatt</para>
3584 <term><varname>number</varname></term>
3587 <para>Artikelnummer</para>
3592 <term><varname>ordnumber_oe</varname></term>
3595 <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
3596 aus einem Sammelauftrag erstellt wurde</para>
3601 <term><varname>p_discount</varname></term>
3604 <para>Rabatt in Prozent</para>
3609 <term><varname>partnotes</varname></term>
3612 <para>Die beim Artikel gespeicherten Bemerkungen</para>
3617 <term><varname>partsgroup</varname></term>
3620 <para>Warengruppe</para>
3625 <term><varname>price_factor</varname></term>
3628 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
3634 <term><varname>price_factor_name</varname></term>
3637 <para>Der Name des Preisfaktors, sofern einer eingestellt
3643 <term><varname>projectnumber</varname></term>
3646 <para>Projektnummer</para>
3651 <term><varname>projectdescription</varname></term>
3654 <para>Projektbeschreibung</para>
3659 <term><varname>qty</varname></term>
3667 <term><varname>reqdate</varname></term>
3670 <para>Lieferdatum</para>
3675 <term><varname>runningnumber</varname></term>
3678 <para>Position auf der Rechnung (1, 2, 3...)</para>
3683 <term><varname>sellprice</varname></term>
3686 <para>Verkaufspreis</para>
3691 <term><varname>serialnumber</varname></term>
3694 <para>Seriennummer</para>
3699 <term><varname>tax_rate</varname></term>
3702 <para>Steuersatz</para>
3707 <term><varname>transdate_oe</varname></term>
3710 <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
3711 aus einem Sammelauftrag erstellt wurde</para>
3716 <term><varname>unit</varname></term>
3719 <para>Einheit</para>
3724 <term><varname>weight</varname></term>
3727 <para>Gewicht</para>
3732 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
3733 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
3734 einer <function>foreach</function>-Schleife ausgegeben werden, da
3735 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
3736 können. Die Variablen dafür lauten:</para>
3740 <term><varname>make</varname></term>
3743 <para>Lieferant</para>
3748 <term><varname>model</varname></term>
3751 <para>Lieferantenartikelnummer</para>
3757 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
3758 <title>Variablen für die einzelnen Zahlungseingänge</title>
3762 <term><varname>payment</varname></term>
3770 <term><varname>paymentaccount</varname></term>
3778 <term><varname>paymentdate</varname></term>
3786 <term><varname>paymentmemo</varname></term>
3794 <term><varname>paymentsource</varname></term>
3803 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
3804 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
3806 <para>Die vom Benutzer definierten Variablen für Kunden und
3807 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
3808 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
3809 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
3810 Variablennamen zusammen.</para>
3812 <para>Beispiel: Der Benutzer hat eine Variable namens
3813 <varname>number_of_employees</varname> definiert, die die Anzahl der
3814 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
3815 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
3820 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
3821 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
3823 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
3824 <title>Namen der Vorlagen</title>
3826 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
3827 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
3828 Erstellung einer Rechnung über die Mahngebühren und Zinsen
3829 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
3830 Vorlagenname für diese Mahnstufe mit dem Zusatz
3831 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
3832 für die ausgewählte Sprache und den ausgewählten Drucker
3836 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
3837 <title>Allgemeine Variablen in Mahnungen</title>
3839 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3840 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3841 Kunden stehen als Variablen <varname>name</varname>,
3842 <varname>street</varname>, <varname>zipcode</varname>,
3843 <varname>city</varname>, <varname>country</varname>,
3844 <varname>department_1</varname>, <varname>department_2</varname>,
3845 und <varname>email</varname> zur Verfügung.</para>
3847 <para>Weitere Variablen beinhalten:</para>
3851 <term><varname>dunning_date</varname></term>
3854 <para>Datum der Mahnung</para>
3859 <term><varname>dunning_duedate</varname></term>
3862 <para>Fälligkeitsdatum für diese Mahhnung</para>
3867 <term><varname>dunning_id</varname></term>
3870 <para>Mahnungsnummer</para>
3875 <term><varname>fee</varname></term>
3878 <para>Kummulative Mahngebühren</para>
3883 <term><varname>interest_rate</varname></term>
3886 <para>Zinssatz per anno in Prozent</para>
3891 <term><varname>total_amount</varname></term>
3894 <para>Gesamter noch zu zahlender Betrag als
3895 <function>fee</function> + <function>total_interest</function>
3896 + <function>total_open_amount</function></para>
3901 <term><varname>total_interest</varname></term>
3904 <para>Zinsen per anno über alle Rechnungen</para>
3909 <term><varname>total_open_amount</varname></term>
3912 <para>Summe über alle offene Beträge der Rechnungen</para>
3918 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
3919 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
3923 <term><varname>dn_amount</varname></term>
3926 <para>Rechnungssumme (brutto)</para>
3931 <term><varname>dn_duedate</varname></term>
3934 <para>Originales Fälligkeitsdatum der Rechnung</para>
3939 <term><varname>dn_dunning_date</varname></term>
3942 <para>Datum der Mahnung</para>
3947 <term><varname>dn_dunning_duedate</varname></term>
3950 <para>Fälligkeitsdatum der Mahnung</para>
3955 <term><varname>dn_fee</varname></term>
3958 <para>Kummulative Mahngebühr</para>
3963 <term><varname>dn_interest</varname></term>
3966 <para>Zinsen per anno für diese Rechnung</para>
3971 <term><varname>dn_invnumber</varname></term>
3974 <para>Rechnungsnummer</para>
3979 <term><varname>dn_linetotal</varname></term>
3982 <para>Noch zu zahlender Betrag (ergibt sich aus
3983 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
3984 + <varname>dn_interest</varname>)</para>
3989 <term><varname>dn_netamount</varname></term>
3992 <para>Rechnungssumme (netto)</para>
3997 <term><varname>dn_open_amount</varname></term>
4000 <para>Offener Rechnungsbetrag</para>
4005 <term><varname>dn_ordnumber</varname></term>
4008 <para>Bestellnummer</para>
4013 <term><varname>dn_transdate</varname></term>
4016 <para>Rechnungsdatum</para>
4021 <term><varname>dn_curr</varname></term>
4024 <para>Währung, in der die Rechnung erstellt wurde. (Die
4025 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
4031 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
4032 <title>Variablen in automatisch erzeugten Rechnungen über
4033 Mahngebühren</title>
4035 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4036 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4037 Kunden stehen als Variablen <varname>name</varname>,
4038 <varname>street</varname>, <varname>zipcode</varname>,
4039 <varname>city</varname>, <varname>country</varname>,
4040 <varname>department_1</varname>, <varname>department_2</varname>,
4041 und <varname>email</varname> zur Verfügung.</para>
4043 <para>Weitere Variablen beinhalten:</para>
4047 <term><varname>duedate</varname></term>
4050 <para>Fälligkeitsdatum der Rechnung</para>
4055 <term><varname>dunning_id</varname></term>
4058 <para>Mahnungsnummer</para>
4063 <term><varname>fee</varname></term>
4066 <para>Mahngebühren</para>
4071 <term><varname>interest</varname></term>
4079 <term><varname>invamount</varname></term>
4082 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
4083 <varname>interest</varname>)</para>
4088 <term><varname>invdate</varname></term>
4091 <para>Rechnungsdatum</para>
4096 <term><varname>invnumber</varname></term>
4099 <para>Rechnungsnummer</para>
4106 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
4107 <title>Variablen in anderen Vorlagen</title>
4110 <title>Einführung</title>
4112 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
4113 Rechnung. Allerdings heißen die Variablen, die mit
4114 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
4115 fangen sie mit <varname>quo</varname> für "quotation" an:
4116 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
4117 wiederum fangen sie mit <varname>ord</varname> für "order" an:
4118 <varname>ordnumber</varname> für Bestellnummer etc.</para>
4120 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
4121 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
4122 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
4123 Vorlage keine Bedeutung haben oder noch nicht belegt sein
4126 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
4127 in Rechnungen aufgeführt.</para>
4130 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
4131 <title>Angebote und Preisanfragen</title>
4135 <term><varname>quonumber</varname></term>
4138 <para>Angebots- bzw. Anfragenummer</para>
4143 <term><varname>reqdate</varname></term>
4146 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
4147 Preisanfragen)</para>
4152 <term><varname>transdate</varname></term>
4155 <para>Angebots- bzw. Anfragedatum</para>
4161 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
4162 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
4166 <term><varname>ordnumber</varname></term>
4169 <para>Auftragsnummer</para>
4174 <term><varname>reqdate</varname></term>
4177 <para>Lieferdatum</para>
4182 <term><varname>transdate</varname></term>
4185 <para>Auftragsdatum</para>
4191 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
4192 <title>Lieferscheine (Verkauf und Einkauf)</title>
4196 <term><varname>cusordnumber</varname></term>
4199 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
4200 des Lieferanten (im Einkauf)</para>
4205 <term><varname>donumber</varname></term>
4208 <para>Lieferscheinnummer</para>
4213 <term><varname>transdate</varname></term>
4216 <para>Lieferscheindatum</para>
4221 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
4222 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
4223 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
4224 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
4225 <function>foreach</function>-Schleife ausgegeben werden. Diese
4226 Variablen sind:</para>
4230 <term><varname>si_bin</varname></term>
4233 <para>Lagerplatz</para>
4238 <term><varname>si_chargenumber</varname></term>
4241 <para>Chargennummer</para>
4246 <term><varname>si_bestbefore</varname></term>
4249 <para>Mindesthaltbarkeit</para>
4254 <term><varname>si_number</varname></term>
4257 <para>Artikelnummer</para>
4262 <term><varname>si_qty</varname></term>
4265 <para>Anzahl bzw. Menge</para>
4270 <term><varname>si_runningnumber</varname></term>
4273 <para>Positionsnummer (1, 2, 3 etc)</para>
4278 <term><varname>si_unit</varname></term>
4281 <para>Einheit</para>
4286 <term><varname>si_warehouse</varname></term>
4295 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
4296 <title>Variablen für Sammelrechnung</title>
4300 <term><varname>c0total</varname></term>
4303 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
4309 <term><varname>c30total</varname></term>
4312 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
4313 und < 60 Tage</para>
4318 <term><varname>c60total</varname></term>
4321 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
4322 und < 90 Tage</para>
4327 <term><varname>c90total</varname></term>
4330 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
4336 <term><varname>total</varname></term>
4339 <para>Gesamtbetrag aller Rechnungen</para>
4344 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
4348 <term><varname>invnumber</varname></term>
4351 <para>Rechnungsnummer</para>
4356 <term><varname>invdate</varname></term>
4359 <para>Rechnungsdatum</para>
4364 <term><varname>duedate</varname></term>
4367 <para>Fälligkeitsdatum</para>
4372 <term><varname>amount</varname></term>
4375 <para>Summe der Rechnung</para>
4380 <term><varname>open</varname></term>
4383 <para>Noch offener Betrag der Rechnung</para>
4388 <term><varname>c0</varname></term>
4391 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4397 <term><varname>c30</varname></term>
4400 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4406 <term><varname>c60</varname></term>
4409 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4415 <term><varname>c90</varname></term>
4418 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4426 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4427 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4429 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4430 <title>Einfürhung</title>
4432 <para>Der Parser kennt neben den Variablen einige weitere
4433 Konstrukte, die gesondert behandelt werden. Diese sind wie
4434 Variablennamen in spezieller Weise markiert:
4435 <command><%anweisung%> ... <%end%></command></para>
4437 <para>Anmerkung zum <command><%end%></command>: Der besseren
4438 Verständlichkeit halber kann man nach dem <command>end</command>
4439 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4440 Anweisung (z.B. <command>if</command> oder
4441 <command>foreach</command>) damit abgeschlossen wird.</para>
4443 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4444 <command><%if type == "sales_quotation"%></command>, so könnte
4445 er mit <command><%end%></command> genauso abgeschlossen werden
4446 wie mit <command><%end if%></command> oder auch
4447 <command><%end type == "sales_quotation"%></command>.</para>
4450 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4451 <title>Der if-Block</title>
4453 <programlisting><%if variablenname%>
4455 <%end%></programlisting>
4457 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4458 und dem "end" werden nur ausgegeben, wenn die Variable
4459 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4461 <para>Handelt es sich bei der benannten Variable um ein Array, also um einen Variablennamen, über den man mit
4462 <command><%foreach variablenname%></command> iteriert, so wird mit diesem Konstrukt darauf getestet, ob das Array Elemente
4463 enthält. Somit würde im folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt ihrer Überschrift "Zahlungseingänge"
4464 ausgegeben, wenn tatsächlich welche getätigt wurden:</para>
4466 <programlisting><%if payment%>
4468 <%foreach payment%>
4469 Am <%paymentdate%>: <%payment%> €
4470 <%end foreach%>
4471 <%end if%></programlisting>
4473 <para>Die Bedingung kann auch negiert werden, indem das Wort
4474 <function>not</function> nach dem <filename>if</filename> verwendet
4475 wird. Beispiel:</para>
4477 <programlisting><%if not cp_greeting%>
4479 <%end%></programlisting>
4481 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4482 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4483 einer Variablen mit einer festen Zeichenkette oder einer anderen
4484 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4485 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4486 die rechte Seite des Vergleichsoperators in Anführungszeichen
4487 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4488 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4491 <programlisting><%if var1 == "Wert"%></programlisting>
4493 <para>Testet die Variable <varname>var1</varname> auf
4494 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4495 Mittels <function>!=</function> anstelle von <function>==</function>
4496 würde auf Ungleichheit getestet.</para>
4498 <programlisting><%if var1 == var2%></programlisting>
4500 <para>Testet die Variable <varname>var1</varname> auf
4501 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4502 <function>!=</function> anstelle von <function>==</function> würde
4503 auf Ungleichheit getestet.</para>
4505 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4506 auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
4507 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4508 dieselbe Syntax wie oben nur mit <function>=~</function> und
4509 <function>!~</function> als Vergleichsoperatoren.</para>
4511 <para>Beispiel für einen Test, ob die Variable
4512 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4513 <constant>schwierig</constant> enthält:</para>
4515 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4518 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4519 <title>Der foreach-Block</title>
4521 <programlisting><%foreach variablenname%>
4523 <%end%></programlisting>
4525 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4526 wie das Perl-Array der Variablen <varname>variablenname</varname>
4527 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4528 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4529 benutzt. In jedem Durchlauf werden die <link
4530 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4531 Variablen</link> jeweils auf den Wert für die aktuelle Position
4534 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
4536 <programlisting><%foreach number%>
4537 Position: <%runningnumber%>
4538 Anzahl: <%qty%>
4539 Artikelnummer: <%number%>
4540 Beschreibung: <%description%>
4542 <%end%></programlisting>
4544 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
4545 <function><%foreach%></function>-Block innerhalb einer
4546 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
4547 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
4548 Inhalt zwischen <function><%foreach%></function> und
4549 <function><%end%></function> wiederholt, nicht aber die
4550 komplette Zeile, in der er steht.</para>
4554 <sect2 id="dokumentenvorlagen-und-variablen.markup">
4555 <title>Markup-Code zur Textformatierung innerhalb von
4558 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
4559 anders formatiert haben möchte, so ist dies begrenzt möglich.
4560 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
4561 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
4562 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
4563 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
4564 (HTML oder PDF über LaTeX) umgesetzt.</para>
4566 <para>Die unterstützen Formatierungen sind:</para>
4570 <term><b>Text</b></term>
4573 <para>Text wird in Fettdruck gesetzt.</para>
4578 <term><i>Text</i></term>
4581 <para>Text wird kursiv gesetzt.</para>
4586 <term><u>Text</u></term>
4589 <para>Text wird unterstrichen.</para>
4594 <term><s>Text</s></term>
4597 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
4598 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
4603 <term><bullet></term>
4606 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
4612 <para>Der Befehl <command><bullet></command> funktioniert
4613 momentan auch nur in Latex-Vorlagen.</para>
4617 <sect1 id="excel-templates">
4618 <title>Excel-Vorlagen</title>
4620 <sect2 id="excel-templates.summary">
4621 <title>Zusammenfassung</title>
4623 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
4624 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
4628 <sect2 id="excel-templates.usage">
4629 <title>Bedienung</title>
4631 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
4632 werden. Die Konfigurationsoption heißt <varname>excel_templates =
4633 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
4635 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
4636 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
4637 werden. In den normalen Verkaufsmasken taucht nun
4638 <constant>Excel</constant> als auswählbares Format auf und kann von da
4639 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
4641 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
4642 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
4643 <filename>sales_quotation.xls</filename> gespeichert.</para>
4646 <sect2 id="excel-templates.syntax">
4647 <title>Variablensyntax</title>
4649 <para>Einfache Syntax:
4650 <command><<varname>></command></para>
4652 <para>Dabei sind <constant><<</constant> und
4653 <constant>>></constant> die Delimiter. Da Excel auf festen
4654 Breiten besteht, kann der Tag künstlich verlängert werden, indem
4655 weitere <constant><</constant> oder <constant>></constant>
4656 eingefügt werden. Der Tag muss nicht symmetrisch sein.
4659 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4661 <para>Um die Limitierung der festen Breite zu reduzieren, können
4662 weitere Variablen in einem Block interpoliert werden. Whitespace wird
4663 dazwishen dann erhalten. Beispiel:</para>
4665 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4667 <para>Die Variablen werden interpoliert, und linksbündig mit
4668 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
4669 lang, werden überzählige Zeichen abgeschnitten.</para>
4671 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
4672 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
4674 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4676 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
4677 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
4681 <sect2 id="excel-templates.limitations">
4682 <title>Einschränkungen</title>
4684 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
4685 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
4686 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
4687 Text zu ersetzen.</para>
4689 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
4690 <command><%if%></command> und
4691 <command><%foreach%></command> nicht vorhanden. Der Delimiter
4692 <constant><% %></constant> kommt in den Headerinformationen
4693 evtl. vor. Deshalb wurde auf den sichereren Delimiter
4694 <constant><<</constant> und <constant>>></constant>
4701 <title>Entwicklerdokumentation</title>
4703 <sect1 id="devel.globals" xreflabel="Globale Variablen">
4704 <title>Globale Variablen</title>
4707 <title>Wie sehen globale Variablen in Perl aus?</title>
4709 <para>Globale Variablen liegen in einem speziellen namespace namens
4710 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
4711 globs global und die meisten speziellen Variablen sind...
4714 <para>Daraus ergeben sich folgende Formen:</para>
4718 <term><literal>$main::form</literal></term>
4721 <para>expliziter Namespace "main"</para>
4726 <term><literal>$::form</literal></term>
4729 <para>impliziter Namespace "main"</para>
4734 <term><literal>open FILE, "file.txt"</literal></term>
4737 <para><varname>FILE</varname> ist global</para>
4742 <term><literal>$_</literal></term>
4745 <para>speziell</para>
4750 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
4751 Schlüsselwort wie "<function>global</function>", mit dem man
4752 importieren kann. <function>my</function>, <function>our</function>
4753 und <function>local</function> machen was anderes.</para>
4757 <term><literal>my $form</literal></term>
4760 <para>lexikalische Variable, gültig bis zum Ende des
4766 <term><literal>our $form</literal></term>
4769 <para><varname>$form</varname> referenziert ab hier
4770 <varname>$PACKAGE::form</varname>.</para>
4775 <term><literal>local $form</literal></term>
4778 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
4779 des scopes zurückgesetzt</para>
4786 <title>Warum sind globale Variablen ein Problem?</title>
4788 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
4790 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
4791 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
4792 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
4793 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
4794 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
4795 Datenbankverbindungen, weil die sehr lange zum Initialisieren
4798 <para>Das zweite Problem ist <function>strict</function>. Unter
4799 <function>strict</function> werden alle Variablen die nicht explizit
4800 mit <function>Package</function>, <function>my</function> oder
4801 <function>our</function> angegeben werden als Tippfehler angemarkert,
4802 dies hat, seit der Einführung, u.a. schon so manche langwierige
4803 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
4804 angegeben werden, werden die nicht geprüft, und somit kann sich
4805 schnell ein Tippfehler einschleichen.</para>
4809 <title>Kanonische globale Variablen</title>
4811 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
4812 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
4813 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
4814 umhergereicht werden.</para>
4816 <para>Diese Variablen sind im Moment die folgenden neun:</para>
4820 <para><varname>$::form</varname></para>
4824 <para><varname>%::myconfig</varname></para>
4828 <para><varname>$::locale</varname></para>
4832 <para><varname>$::lxdebug</varname></para>
4836 <para><varname>$::auth</varname></para>
4840 <para><varname>$::lx_office_conf</varname></para>
4844 <para><varname>$::instance_conf</varname></para>
4848 <para><varname>$::dispatcher</varname></para>
4852 <para><varname>$::request</varname></para>
4856 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
4857 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
4858 Eigenschaften (Konventionen):</para>
4861 <title>$::form</title>
4865 <para>Ist ein Objekt der Klasse
4866 "<classname>Form</classname>"</para>
4870 <para>Wird nach jedem Request gelöscht</para>
4874 <para>Muss auch in Tests und Konsolenscripts vorhanden
4879 <para>Enthält am Anfang eines Requests die Requestparameter vom
4884 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
4885 cachen, das wird aber momentan absichtlich zerstört</para>
4889 <para><varname>$::form</varname> wurde unter <productname>SQL
4890 Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
4891 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
4892 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
4893 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
4894 <function>IS->retrieve_customer()</function> in Sicherheit
4897 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
4898 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
4899 3552, Stand version 2.7beta), um dies hinterher wieder auf den
4900 richtigen Wert zu setzen:</para>
4902 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
4903 $::myconfig{numberformat} = $numberformat;
4904 # (...) div Berechnungen
4905 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
4907 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
4908 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
4909 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
4910 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
4911 Es geht ziemlich sicher etwas kaputt.</para>
4913 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
4914 in den <productname>Template::Toolkit</productname> Templates
4915 außerhalb der Controller: der Ausdruck <function>[% var
4916 %]</function> greift auf <varname>$::form->{var}</varname> zu.
4917 Unter Controllern ist der Standard Scope anders, da lautet der
4918 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
4919 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
4920 <function><%var%></function> zeigt auf
4921 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
4922 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
4925 <programlisting>[%- IF business %]
4926 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
4927 [%- END %]</programlisting>
4929 <para>Entweder wird hier dann $::form->{business} ausgewertet
4930 oder aber der Funktion
4931 <function>$form->parse_html_template</function> wird explizit
4932 noch ein zusätzlicher Hash übergeben, der dann auch in den
4933 (Web-)Templates zu Verfügung steht, bspw. so:</para>
4935 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
4937 <para>Innerhalb von Schleifen wird
4938 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
4939 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
4940 welches über alle Positionen eines Lieferscheins in Schleife
4943 <programlisting>for $i (1 .. $form->{rowcount}) {
4945 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
4946 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
4947 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
4953 <title>%::myconfig</title>
4957 <para>Das einzige Hash unter den globalen Variablen</para>
4961 <para>Wird spätestens benötigt wenn auf die Datenbank
4962 zugegriffen wird</para>
4966 <para>Wird bei jedem Request neu erstellt.</para>
4970 <para>Enthält die Userdaten des aktuellen Logins</para>
4974 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
4975 extern serialisiert werden, weil da auch der Datenbankzugriff
4976 für diesen user drinsteht.</para>
4980 <para>Enthält unter anderem Listenbegrenzung vclimit,
4981 Datumsformat dateformat und Nummernformat numberformat</para>
4985 <para>Enthält Datenbankzugriffinformationen</para>
4989 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
4990 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
4991 aktuellen Users entscheiden müssen, befragen
4992 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
4993 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
4994 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
4995 Informationen über den Benutzer die über die
4996 Administrator-Schnittstelle (admin.pl) eingegeben wurden.</para>
5000 <title>$::locale</title>
5004 <para>Objekt der Klasse "Locale"</para>
5008 <para>Wird pro Request erstellt</para>
5012 <para>Muss auch für Tests und Scripte immer verfügbar
5017 <para>Cached intern über Requestgrenzen hinweg benutzte
5022 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
5023 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
5027 <title>$::lxdebug</title>
5031 <para>Objekt der Klasse "LXDebug"</para>
5035 <para>Wird global gecached</para>
5039 <para>Muss immer verfügbar sein, in nahezu allen
5044 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
5045 bereit, wie "<function>enter_sub</function>" und
5046 "<function>leave_sub</function>", mit denen in den alten Modulen ein
5047 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
5048 der man die Wallclockzeit seit Requeststart loggen kann, sowie
5049 "<function>message</function>" und "<function>dump</function>" mit
5050 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
5053 <para>Beispielsweise so:</para>
5055 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
5056 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
5060 <title>$::auth</title>
5064 <para>Objekt der Klasse "SL::Auth"</para>
5068 <para>Wird global gecached</para>
5072 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
5076 <para>Wird nach jedem Request resettet.</para>
5080 <para><varname>$::auth</varname> stellt Funktionen bereit um die
5081 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
5082 vom aktuellen User abhängen wird das Objekt aus
5083 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
5084 Request kurz resettet.</para>
5088 <title>$::lx_office_conf</title>
5092 <para>Objekt der Klasse
5093 "<classname>SL::LxOfficeConf</classname>"</para>
5097 <para>Global gecached</para>
5101 <para>Repräsentation der
5102 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
5106 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
5107 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
5108 das Programm die Konfiguration ändern kann oder sollte.</para>
5110 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
5111 Debug- und Trace-Log-Datei wie folgt konfiguriert und
5114 <programlisting>[debug]
5115 file = /tmp/kivitendo-debug.log</programlisting>
5117 <para>ist der Key <varname>file</varname> im Programm als
5118 <varname>$::lx_office_conf->{debug}{file}</varname>
5122 <para>Zugriff auf die Konfiguration erfolgt im Moment über
5123 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
5128 <title>$::instance_conf</title>
5132 <para>Objekt der Klasse
5133 "<classname>SL::InstanceConfiguration</classname>"</para>
5137 <para>wird pro Request neu erstellt</para>
5141 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
5142 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
5143 ist hier eine Mandantendatenbank. Beispielsweise überprüft
5144 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
5145 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
5149 <title>$::dispatcher</title>
5153 <para>Objekt der Klasse
5154 "<varname>SL::Dispatcher</varname>"</para>
5158 <para>wird pro Serverprozess erstellt.</para>
5162 <para>enthält Informationen über die technische Verbindung zum
5167 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
5168 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
5169 Objekt untergebracht.</para>
5173 <title>$::request</title>
5177 <para>Hashref (evtl später Objekt)</para>
5181 <para>Wird pro Request neu initialisiert.</para>
5185 <para>Keine Unterstruktur garantiert.</para>
5189 <para><varname>$::request</varname> ist ein generischer Platz um
5190 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
5191 at a distance benutzt werden, sondern um lokales memoizing zu
5192 ermöglichen, das garantiert am Ende des Requests zerstört
5195 <para>Vieles von dem, was im moment in <varname>$::form</varname>
5196 liegt, sollte eigentlich hier liegen. Die groben
5197 Differentialkriterien sind:</para>
5201 <para>Kommt es vom User, und soll unverändert wieder an den
5202 User? Dann <varname>$::form</varname>, steht da eh schon</para>
5206 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
5207 Requests gebraucht werden? Dann
5208 <varname>$::request</varname></para>
5212 <para>Muss ich von anderen Teilen des Programms lesend drauf
5213 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
5214 Wrappermethode</para>
5221 <title>Ehemalige globale Variablen</title>
5223 <para>Die folgenden Variablen waren einmal im Programm, und wurden
5227 <title>$::cgi</title>
5231 <para>war nötig, weil cookie Methoden nicht als
5232 Klassenfunktionen funktionieren</para>
5236 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
5237 Klassennamespace gehalten wird und über Requestgrenzen
5242 <para>liegt jetzt unter
5243 <varname>$::request->{cgi}</varname></para>
5249 <title>$::all_units</title>
5253 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
5254 ein paar hundert mal pro Request eine Liste der Einheiten
5255 brauchen, und de als Parameter durch einen Riesenstack von
5256 Funktionen geschleift werden müssten.</para>
5260 <para>Liegt jetzt unter
5261 <varname>$::request->{cache}{all_units}</varname></para>
5266 <function>AM->retrieve_all_units()</function> gesetzt oder
5273 <title>%::called_subs</title>
5277 <para>wurde benutzt um callsub deep recursions
5282 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
5283 möglichen Rekursioenen darstellt, und da nie welche
5288 <para>komplette recursion protection wurde entfernt.</para>
5295 <sect1 id="devel.fcgi">
5296 <title>Entwicklung unter FastCGI</title>
5298 <sect2 id="devel.fcgi.general">
5299 <title>Allgemeines</title>
5301 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
5302 werden, muss der Webserver neu gestartet werden.</para>
5304 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
5305 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
5306 müssen folgende Aspekte beachtet werden.</para>
5309 <sect2 id="devel.fcgi.exiting">
5310 <title>Programmende und Ausnahmen</title>
5312 <para>Betrifft die Funktionen <function>warn</function>,
5313 <function>die</function>, <function>exit</function>,
5314 <function>carp</function> und <function>confess</function>.</para>
5316 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
5317 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
5318 am Laufen zu halten. Man kann mit <function>die</function>,
5319 <function>confess</function> oder <function>carp</function> Fehler
5320 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
5321 eigene <function>$::form-</function>error()> tut im Prinzip das
5322 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
5323 <function>exit</function> hingegen werden nicht abgefangen.
5324 <function>warn</function> wird direkt nach STDERR, also in Server Log
5325 eine Nachricht schreiben (sofern in der Konfiguration nicht die
5326 Warnungen in das kivitendo Log umgeleitet wurden), und
5327 <function>exit</function> wird die Ausführung beenden.</para>
5329 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
5330 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
5331 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
5332 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
5335 <sect2 id="devel.fcgi.globals">
5336 <title>Globale Variablen</title>
5338 <para>Um zu vermeiden, dass Informationen von einem Request in einen
5339 anderen gelangen, müssen alle globalen Variablen vor einem Request
5340 sauber initialisiert werden. Das ist besonders wichtig im
5341 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
5342 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
5345 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
5346 abgetrennten Block, der alle kanonischen globalen Variablen listet und
5347 erklärt. Bitte keine anderen einführen ohne das sauber zu
5348 dokumentieren.</para>
5350 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
5351 man sicher geht, dass man die richtige erwischt.</para>
5354 <sect2 id="devel.fcgi.performance">
5355 <title>Performance und Statistiken</title>
5357 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
5358 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
5359 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
5360 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
5361 sind es je nach Menge der definierten Variablen 1-2s. Ab der
5362 Moose/Rose::DB Version sind es 5-6s.</para>
5364 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
5365 den kritischen Pfaden, unter 0,15 sonst.</para>
5368 <sect2 id="devel.fcgi.known-issues">
5369 <title>Bekannte Probleme</title>
5371 <sect3 id="devel.fcgi.known-issues.encoding">
5372 <title>Encoding Awareness</title>
5374 <para>UTF-8 kodierte Installationen sind sehr anfällig gegen
5375 fehlerhfate Encodings unter FCGI. latin9 Installationen behandeln
5376 falsch kodierte Zeichen eher unwissend, und geben sie einfach
5377 weiter. UTF-8 verweigert bei fehlerhaften Programmpfaden kurzerhand
5378 das Ausliefern. Es wird noch daran gearbeitet, alle Fehler da zu
5384 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
5385 <title>SQL-Upgradedateien</title>
5387 <sect2 id="db-upgrade-files.introduction"
5388 xreflabel="Einführung in die Datenbank-Upgradedateien">
5389 <title>Einführung</title>
5391 <para>Der alte Mechanismus für SQL-Upgradescripte, der auf einer
5392 Versionsnummer beruht und dann in sql/Pg-upgrade nach einem Script für
5393 diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele
5394 Entwicklung im stable- und unstable-Baum betrifft.</para>
5396 <para>Dieser Mechanismus wurde für kivitendo 2.4.1 deutlich erweitert.
5397 Es werden weiterhin alle Scripte aus sql/Pg-upgrade ausgeführt.
5398 Zusätzlich gibt es aber ein zweites Verzeichnis, sql/Pg-upgrade2. In
5399 diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren,
5400 die neben den eigentlich auszuführenden SQL- oder Perl-Befehlen einige
5401 Kontrollinformationen enthält.</para>
5403 <para>Neu sind die Kontrollinformationen, die Abhängigkeiten und
5404 Prioritäten definieren können werden, sodass Datenbankscripte zwar in
5405 einer sicheren Reihenfolge ausgeführt werden (z.B. darf ein "ALTER
5406 TABLE" erst ausgeführt werden, wenn die Tabelle mit "CREATE TABLE"
5407 angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man
5408 keine Versionsnummern mehr braucht.</para>
5410 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
5411 sql/Pg-upgrade2 bereits durchgeführt wurde und führt diese nicht
5412 erneut aus. Dazu dient die Tabelle "schema_info", die bei der
5413 Anmeldung automatisch angelegt wird.</para>
5416 <sect2 id="db-upgrade-files.format"
5417 xreflabel="Format der Upgradedateien">
5418 <title>Format der Kontrollinformationen</title>
5420 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5421 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5422 hat dabei das folgende Format:</para>
5424 <para>Für SQL-Upgradedateien:</para>
5426 <programlisting>-- @key: value</programlisting>
5428 <para>Für Perl-Upgradedateien:</para>
5430 <programlisting># @key: value</programlisting>
5432 <para>Leerzeichen vor "<varname>value</varname>" werden
5435 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5439 <term><varname>tag</varname></term>
5442 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5443 Dieser "tag" kann von anderen Kontrolldateien in ihren
5444 Abhängigkeiten verwendet werden (Schlüsselwort
5445 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5446 in der Datenbank eingetragen wird.</para>
5448 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5449 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5451 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5452 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5453 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5459 <term><varname>charset</varname></term>
5462 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
5463 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5464 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
5465 Abwesenheit des Tags der Zeichensatz
5466 "<literal>ISO-8859-15</literal>" angenommen.</para>
5471 <term><varname>description</varname></term>
5474 <para>Benötigt. Eine Beschreibung, was in diesem Update
5475 passiert. Diese wird dem Benutzer beim eigentlichen
5476 Datenbankupdate angezeigt. Während der Tag in englisch gehalten
5477 sein sollte, sollte die Beschreibung auf Deutsch
5483 <term><varname>depends</varname></term>
5486 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5487 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
5488 dass die in dieser Liste aufgeführten Scripte bereits
5489 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5491 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5492 Script "b" existiert, das von Änderungen in "a" abhängt, und
5493 eine neue Kontrolldatei für "c" erstellt wird, die von
5494 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5495 Tag "b" als Abhängigkeit zu definieren.</para>
5497 <para>Es ist nicht erlaubt, sich selbst referenzierende
5498 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5499 und "c" -> "a").</para>
5504 <term><varname>priority</varname></term>
5507 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5508 der Scripte ausgeführt werden, die die gleichen
5509 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5510 der Wert 1000 benutzt.</para>
5512 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5513 "depends" benutzt werden. kivitendo sortiert die auszuführenden
5514 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5515 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5516 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5517 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5518 Priorität alphabetisch nach dem "tag".</para>
5523 <term><varname>ignore</varname></term>
5526 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
5527 Skript bei der Anmeldung ignoriert und entsprechend nicht
5534 <sect2 id="db-upgrade-files.dbupgrade-tool"
5535 xreflabel="Hilfsscript dbupgrade2_tool.pl">
5536 <title>Hilfsscript dbupgrade2_tool.pl</title>
5538 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
5539 existiert ein Hilfsscript namens
5540 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
5541 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
5542 liest alle Datenbankupgradescripte aus dem Verzeichnis
5543 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
5544 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
5545 von der Kommandozeile überprüft werden können.</para>
5547 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
5548 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
5549 sich aber auch Informationen auf verschiedene Art ausgeben
5554 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
5555 --list</command>"</para>
5557 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
5558 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
5559 würde. Es werden neben der Listenposition der Tag, die
5560 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
5564 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
5565 --tree</command>"</para>
5567 <para>Listet alle Tags in Baumform basierend auf den
5568 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
5569 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
5570 beim übergeordneten Script als Abhängigkeit eingetragen
5574 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
5575 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
5576 --rtree</command>"</para>
5578 <para>Listet alle Tags in Baumform basierend auf den
5579 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
5580 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
5581 die das übergeordnete Script als Abhängigkeit eingetragen
5586 <para>Baumform mit Postscriptausgabe:
5587 "<command>./scripts/dbupgrade2_tool.pl
5588 --graphviz</command>"</para>
5590 <para>Benötigt das Tool "<command>graphviz</command>", um mit
5591 seiner Hilfe die <link
5592 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
5593 Baumform</link> in eine Postscriptdatei namens
5594 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
5595 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
5596 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
5597 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
5602 <para>Scripte, von denen kein anderes Script abhängt:
5603 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
5605 <para>Listet die Tags aller Scripte auf, von denen keine anderen
5606 Scripte abhängen.</para>
5612 <sect1 id="translations-languages" xreflabel="Translations and languages">
5613 <title>Translations and languages</title>
5615 <sect2 id="translations-languages.introduction"
5616 xreflabel="Introduction to translations and languages">
5617 <title>Introduction</title>
5620 <para>Dieser Abschnitt ist in Englisch geschrieben, um
5621 internationalen Übersetzern die Arbeit zu erleichtern.</para>
5624 <para>This section describes how localization packages in kivitendo
5625 are built. Currently the only language fully supported is German, and
5626 since most of the internal messages are held in English the English
5627 version is usable too.</para>
5629 <para>A stub version of French is included but not functunal at this
5633 <sect2 id="translations-languages.file-structure"
5634 xreflabel="File structure">
5635 <title>File structure</title>
5637 <para>The structure of locales in kivitendo is:</para>
5639 <programlisting>kivitendo/locale/<langcode>/</programlisting>
5641 <para>where <langcode> stands for an abbreviation of the
5642 language package. The builtin packages use two letter <ulink
5643 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
5644 but the actual name is not relevant for the program and can easily be
5646 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
5647 tags</ulink> (i.e. "en_GB"). In fact the original language packages
5648 from SQL Ledger are named in this way.</para>
5650 <para>In such a language directory the following files are
5655 <term>LANGUAGE</term>
5658 <para>This file is mandatory.</para>
5660 <para>The <filename>LANGUAGE</filename> file contains the self
5661 descripted name of the language. It should contain a native
5662 representation first, and in parenthesis an english translation
5663 after that. Example:</para>
5665 <programlisting>Deutsch (German)</programlisting>
5670 <term>charset</term>
5673 <para>This file should be present.</para>
5675 <para>The <filename>charset</filename> file describes which
5676 charset a language package is written in and applies to all
5677 other language files in the package. It is possible to write
5678 some language packages without an explicit charset, but it is
5679 still strongly recommended. You'll never know in what
5680 environment your language package will be used, and neither
5681 UTF-8 nor Latin1 are guaranteed.</para>
5683 <para>The whole content of this file is a string that can be
5684 recognized as a valid charset encoding. Example:</para>
5686 <programlisting>UTF-8</programlisting>
5694 <para>This file is mandatory.</para>
5696 <para>The central translation file. It is essentially an inline
5697 Perl script autogenerated by <command>locales.pl</command>. To
5698 generate it, generate the directory and the two files mentioned
5699 above, and execute the following command:</para>
5701 <programlisting>scripts/locales.pl <langcode></programlisting>
5703 <para>Otherwise you can simply copy one of the other languages.
5704 You will be told how many are missing like this:</para>
5706 <programlisting>$ scripts/locales.pl en
5707 English - 0.6% - 2015/2028 missing</programlisting>
5709 <para>A file named "<filename>missing</filename>" will be
5710 generated and can be edited. You can also edit the
5711 "<filename>all</filename>" file directly. Edit everything you
5712 like to fit the target language and execute
5713 <command>locales.pl</command> again. See how the missing words
5719 <term>Num2text</term>
5722 <para>Legacy code from SQL Ledger. It provides a means for
5723 numbers to be converted into natural language, like
5724 <literal>1523 => one thousand five hundred twenty
5725 three</literal>. If you want to provide it, it must be inlinable
5726 Perl code which provides a <function>num2text</function> sub. If
5727 an <function>init</function> sub exists it will be executed
5730 <para>Only used in the check and receipt printing module.</para>
5735 <term>special_chars</term>
5738 <para>kivitendo comes with a lot of interfaces to different
5739 formats, some of which are rather picky with their accepted
5740 charset. The <filename>special_chars</filename> file contains a
5741 listing of chars not suited for different file format and
5742 provides substitutions. It is written in "Simple Ini" style,
5743 containing a block for every file format.</para>
5745 <para>First entry should be the order of substitution for
5746 entries as a whitespace separated list. All entries are
5747 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
5748 and <literal>\\</literal> all work.</para>
5750 <para>After that every entry is a special char that should be
5751 translated when writing text into such a file.</para>
5753 <para>Example:</para>
5755 <programlisting>[Template/XML]
5756 order=& < > \n
5760 \n=<br></programlisting>
5762 <para>Note the importance of the order in this example.
5763 Substituting < and > befor & would lead to $gt; become
5766 <para>For a list of valid formats, see the German
5767 <filename>special_chars</filename> entry. As of this writing the
5768 following are recognized:</para>
5770 <programlisting>HTML
5775 Template/OpenDocument
5776 filenames</programlisting>
5778 <para>The last of which is very machine dependant. Remember that
5779 a lot of characters are forbidden by some filesystems, for
5780 exmaple MS Windows doesn't like ':' in its files where Linux
5781 doesn't mind that. If you want the files created with your
5782 language pack to be portable, find all chars that could cause
5788 <term>missing</term>
5791 <para>This file is not a part of the language package
5794 <para>This is a file generated by
5795 <command>scripts/locales.pl</command> while processing your
5796 locales. It's only to have the missing entries singled out and
5797 does not belong to a language package.</para>
5805 <para>This file is not a part of the language package
5808 <para>Another file generated by
5809 <command>scripts/locales.pl</command>. If for any reason a
5810 translation does not appear anymore and can be deleted, it gets
5811 moved here. The last 50 or so entries deleted are saved here in
5812 case you made a typo, so that you don't have to translate
5813 everything again. If a tranlsation is missing, the lost file is
5814 checked first. If you maintain a language package, you might
5815 want to keep this safe somewhere.</para>
5822 <sect1 id="devel.testsuite">
5823 <title>Die kivitendo-Test-Suite</title>
5825 <sect2 id="devel.testsuite.intro">
5826 <title>Einführung</title>
5828 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul <literal>Test::More</literal>.</para>
5830 <para>Die grundlegenden Fakten sind:</para>
5833 <listitem><para>Alle Tests liegen im Unterverzeichnis <filename>t/</filename>.</para></listitem>
5835 <listitem><para>Ein Script (bzw. ein Test) in <filename>f/</filename> enthält einen oder mehrere Testfälle.</para></listitem>
5837 <listitem><para>Alle Dateinamen von Tests enden auf <literal>.t</literal>. Es sind selbstständig ausführbare Perl-Scripte.</para></listitem>
5839 <listitem><para>Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in <filename>f/</filename>, deren
5840 Dateiname auf <literal>.t</literal> endet.</para></listitem>
5844 <sect2 id="devel.testsuite.prerequisites">
5845 <title>Voraussetzungen</title>
5847 <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>
5850 <listitem><para><literal>Test::Deep</literal> (Debian-Paketname: <literal>libtest-deep-perl</literal>; Fedora Core:
5851 <literal>perl-Test-Deep</literal>; openSUSE: <literal>perl-Test-Deep</literal>)</para></listitem>
5852 <listitem><para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses Modul ist ab Perl 5.10.1 Bestandteil der
5853 Perl-Distribution und kann für frühere Versionen aus dem <ulink url="http://www.cpan.org">CPAN</ulink> bezogen
5854 werden.</para></listitem>
5858 <sect2 id="devel.testsuite.execution">
5860 Existierende Tests ausführen
5863 <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
5864 gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript <filename>t/test.sh</filename>.</para>
5866 <para>Will man die komplette Test-Suite ausführen, so muss man einfach nur <filename>t/test.sh</filename> ohne weitere Parameter aus
5867 dem kivitendo-Basisverzeichnis heraus ausführen.</para>
5869 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an <filename>t/test.sh</filename>. Beispielsweise:</para>
5871 <programlisting>t/test.sh t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
5875 <sect2 id="devel.testsuite.meaning_of_scripts">
5877 Bedeutung der verschiedenen Test-Scripte
5880 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch
5881 während der Entwicklung nützliche Tests sind:</para>
5884 <listitem><para><filename>t/001compile.t</filename> -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab</para></listitem>
5885 <listitem><para><filename>t/002goodperl.t</filename> -- überprüft alle Perl-Dateien auf Anwesenheit von '<literal>use strict</literal>'-Anweisungen</para></listitem>
5886 <listitem><para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von <function>system()</function> und <function>exec()</function> auf Gültigkeit</para></listitem>
5887 <listitem><para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien Tab-Zeichen enthalten</para></listitem>
5888 <listitem><para><filename>t/006spelling.t</filename> -- sucht nach häufigen Rechtschreibfehlern</para></listitem>
5889 <listitem><para><filename>t/011pod.t</filename> -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit</para></listitem>
5892 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module.</para>
5895 <sect2 id="devel.testsuite.create_new">
5897 Neue Test-Scripte erstellen
5900 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende
5901 Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden.</para>
5903 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
5905 Ideen für neue Test-Scripte, die keine konkreten Funktionen testen
5908 <para> Ideen, die abgesehen von Funktions noch nicht umgesetzt wurden:</para>
5911 <listitem><para>Überprüfung auf fehlende symbolische Links</para></listitem>
5912 <listitem><para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten)</para></listitem>
5913 <listitem><para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para></listitem>
5914 <listitem><para>Überprüfung auf Leerzeichen am Ende von Zeilen</para></listitem>
5915 <listitem><para>Test, ob alle zu übersetzenden Strings in <filename>locale/de/all</filename> vorhanden sind</para></listitem>
5916 <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>
5920 <sect3 id="devel.testsuite.directory_and_test_names">
5922 Konvention für Verzeichnis- und Dateinamen
5925 <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>
5928 <listitem><para>Die Dateiendung muss <filename>.t</filename> lauten.</para></listitem>
5930 <listitem><para>Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise
5931 <filename>bad_function_params.t</filename>).</para></listitem>
5933 <listitem><para>Unterverzeichnisse sollten grob nach dem Themenbereich benannt sind, mit dem sich die Scripte darin befassen
5934 (beispielsweise <filename>background_jobs</filename> für Tests rund um Hintergrund-Jobs).</para></listitem>
5936 <listitem><para>Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist
5937 (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben.</para></listitem>
5941 <sect3 id="devel.testsuite.minimal_example">
5943 Minimales Skelett für eigene Scripte
5946 <para>Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden:</para>
5948 <programlisting>use Test::More tests => 0;
5952 use Support::TestSetup;
5954 Support::TestSetup::login();</programlisting>
5956 <para>Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie
5957 <varname>$::auth</varname>, <varname>$::form</varname> oder <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
5958 <filename>config/kivitendo.conf</filename> im Abschnitt <literal>testing.login</literal> ein gültiger Login-Name eingetragen
5959 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
5961 <para>Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile <code>Support::TestSetup::login();</code>
5962 weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.</para>
5967 <sect1 id="devel.style-guide">
5968 <title>Stil-Richtlinien</title>
5970 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
5971 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
5972 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
5973 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
5975 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
5978 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
5979 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
5984 <para>Es werden keine echten Tabs sondern Leerzeichen
5989 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
5991 <programlisting>foreach my $row (@data) {
5993 # do something with $row
5997 $row->{modules} = MODULE->retrieve(
5998 id => $row->{id},
5999 date => $use_now ? localtime() : $row->{time},
6003 $report->add($row);
6008 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
6009 Zeile wie der letzte Befehl. Beispiele:</para>
6011 <programlisting>sub debug {
6017 <programlisting>if ($form->{item_rows} > 0) {
6023 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
6024 der Befehl / die öffnende schließende Klammer, die den Block
6025 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
6026 Beispiele wie bei 3. gelten.</para>
6030 <para>Die Wörter "<function>else</function>",
6031 "<function>elsif</function>", "<function>while</function>" befinden
6032 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
6035 <programlisting>if ($form->{sum} > 1000) {
6037 } elsif ($form->{sum} > 0) {
6045 } until ($a > 0);</programlisting>
6049 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
6050 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
6051 und grep-ähnliche Operatoren. Beispiel:</para>
6053 <programlisting>$main::lxdebug->message("Could not find file.");
6054 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
6058 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
6060 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
6061 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
6062 Blöcke schon. Beispiel:</para>
6064 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
6069 $form->{sum} += $form->{"row_$i"};
6070 $form->{ $form->{index} } += 1;
6072 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
6076 <para>Mehrzeilige Befehle</para>
6080 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
6081 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
6082 werden, in der die ersten Funktionsparameter in der ersten Zeile
6083 stehen. Beispiel:</para>
6085 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
6086 $form->{some_col_value});</programlisting>
6090 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
6091 besten in einer übersichtlichen Tabellenstruktur organisiert
6092 wird. Beispiel:</para>
6094 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
6095 : $form->{oldcount} ? $form->{oldcount} + 1
6096 : $form->{rowcount} - $form->{rowbase};</programlisting>
6102 <para>Kommentare</para>
6106 <para>Kommentare, die alleine in einer Zeile stehen, sollten
6107 soweit wie der Code eingerückt sein.</para>
6111 <para>Seitliche hängende Kommentare sollten einheitlich
6112 formatiert werden.</para>
6116 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
6117 auf Englisch zu verfassen. So wie ich keine Lust habe,
6118 französischen Quelltext zu lesen, sollte auch der kivitendo
6119 Quelltext für nicht-Deutschsprachige lesbar sein.
6122 <programlisting>my $found = 0;
6130 $i = 0 # initialize $i
6132 $i *= $const; # do something crazy
6133 $i = $n; # recover $i</programlisting>
6139 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
6140 Interpolation gewünscht ist. Beispiel:</para>
6142 <programlisting>$form->{sum} = 0;
6143 $form->{"row_$i"} = $form->{"row_$i"} - 5;
6144 $some_hash{42} = 54;</programlisting>
6148 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
6149 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
6150 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
6151 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
6153 <para>Als Beispiel sei die Funktion
6154 <function>print_options</function> aus
6155 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
6159 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
6160 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
6163 <para>Emacs und vim haben beide recht einfache Methoden zur
6164 Entfernung von trailing whitespace. Emacs kennt das Kommande
6165 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
6166 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
6167 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
6172 <para>Es wird kein <command>perltidy</command> verwendet.</para>
6174 <para>In der Vergangenheit wurde versucht,
6175 <command>perltidy</command> zu verwenden, um einen einheitlichen
6176 Stil zu erlangen. Es hat sich aber gezeigt, dass
6177 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
6178 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
6179 den Interessierten sind hier die
6180 <command>perltidy</command>-Optionen, die grob den beschriebenen
6181 Richtlinien entsprechen:</para>
6183 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
6184 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
6185 -lp -vt=1 -vtc=1</programlisting>
6189 <para><varname>STDERR</varname> ist tabu. Unkonditionale
6190 Debugmeldungen auch.</para>
6192 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
6193 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
6194 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
6196 <para>Die <classname>LXDebug</classname>-Methode
6197 "<function>message</function>" nimmt als ersten Paramter außerdem
6198 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
6199 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
6200 und werden in den meisten Fällen auch vom Repository
6201 zurückgewiesen.</para>
6205 <para>Alle neuen Module müssen use strict verwenden.</para>
6207 <para><varname>$form</varname>, <varname>$auth</varname>,
6208 <varname>$locale</varname>, <varname>$lxdebug</varname> und
6209 <varname>%myconfig</varname> werden derzeit aus dem main package
6210 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
6211 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
6216 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
6217 <title>Dokumentation erstellen</title>
6219 <sect2 id="devel.build-doc.introduction">
6220 <title>Einführung</title>
6222 <para>Diese Dokumentation ist in <productname>DocBook</productname>
6223 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
6224 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
6225 Editor nutzt, der spezielle Unterstützung für
6226 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
6227 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
6228 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
6232 <sect2 id="devel.build-doc.required-software">
6233 <title>Benötigte Software</title>
6235 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
6236 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
6237 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
6238 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
6239 <command>scripts/build_doc.sh</command>.</para>
6241 <para>Das Script benötigt zur Konvertierung verschiedene
6242 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
6248 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
6249 in einer halbwegs aktuellen Version</para>
6253 <para>Das Java-Build-System <ulink
6254 url="http://ant.apache.org/">Apache Ant</ulink></para>
6258 <para>Das Dokumentations-System Dobudish für
6259 <productname>DocBook</productname> 4.5, eine Zusammenstellung
6260 diverser Stylesheets und Grafiken zur Konvertierung von
6261 <productname>DocBook</productname> XML in andere Formate. Das
6262 Paket, das benötigt wird, ist zum Zeitpunkt der
6263 Dokumentationserstellung
6264 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
6265 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
6270 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
6271 sind auf allen gängigen Plattformen verfügbar. Beispiel für
6272 Debian/Ubuntu:</para>
6274 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
6276 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
6277 <filename>doc/build</filename> entpackt werden. Beispiel unter der
6278 Annahme, das <productname>Dobudish</productname> in
6279 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
6281 <programlisting>cd doc/build
6282 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
6285 <sect2 id="devel.build-doc.build">
6286 <title>PDFs und HTML-Seiten erstellen</title>
6288 <para>Die eigentliche Konvertierung erfolgt nach Installation der
6289 benötigten Software mit einem einfachen Aufruf direkt aus dem
6290 kivitendo-Installationsverzeichnis heraus:</para>
6292 <programlisting>./scripts/build_doc.sh</programlisting>
6295 <sect2 id="devel.build-doc.repository">
6296 <title>Einchecken in das Git-Repository</title>
6298 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
6299 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
6300 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
6301 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
6303 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
6304 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob