1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <book id="kivitendo-documentation" lang="de">
5 <title>kivitendo 3.2.0: Installation, Konfiguration, Entwicklung</title>
7 <chapter id="Aktuelle-Hinweise">
8 <title>Aktuelle Hinweise</title>
10 <para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>
14 <para>im kivitendo-Forum: <ulink
15 url="https://forum.kivitendo.org:32443">https://forum.kivitendo.org:32443</ulink></para>
18 <para>in der doc/UPGRADE Datei im doc-Verzeichnis der Installation</para>
21 <para>Im Schulungs- und Dienstleistungsangebot der entsprechenden kivitendo-Partner: <ulink
22 url="http://www.kivitendo.de/partner.html">http://www.kivitendo.de/partner.html</ulink></para>
28 <title>Installation und Grundkonfiguration</title>
30 <sect1 id="Installation-Übersicht">
31 <title>Übersicht</title>
34 Die Installation von kivitendo umfasst mehrere Schritte. Die folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
35 Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit minimalen Features möglichst schnell zum Laufen zu kriegen.
39 <listitem><para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo benötigt gewisse Ressourcen und benutzt weitere
40 Programme. Das Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert diese. Auch die Liste der benötigten Perl-Module
41 befindet sich hier.</para></listitem>
43 <listitem><para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst die "<xref
44 linkend="Manuelle-Installation-des-Programmpaketes"/>" sowie grundlegende Einstellungen, die der "<xref
45 linkend="config.config-file"/>" erläutert.</para></listitem>
47 <listitem><para><emphasis>Konfiguration externer Programme</emphasis>: hierzu gehören die Datenbank ("<xref
48 linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der Webserver ("<xref
49 linkend="Apache-Konfiguration"/>"). </para></listitem>
51 <listitem><para><emphasis>Benutzerinformationen speichern können</emphasis>: man benötigt mindestens eine Datenbank, in der
52 Informationen zur Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man das als Administrator macht, verrät "<xref
53 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para></listitem>
55 <listitem><para><emphasis>Benutzer, Gruppen und Datenbanken anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
56 linkend="Benutzer--und-Gruppenverwaltung"/>".</para></listitem>
58 <listitem><para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann kann es losgehen: "<xref
59 linkend="kivitendo-ERP-verwenden"/>"</para></listitem>
63 Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen
68 <sect1 id="Benötigte-Software-und-Pakete">
69 <title>Benötigte Software und Pakete</title>
71 <sect2 id="Betriebssystem">
72 <title>Betriebssystem</title>
74 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
75 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
76 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
77 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
78 ohne große Probleme auf den derzeit aktuellen verbreiteten
79 Distributionen läuft.</para>
81 <para>Anfang 2014 sind das folgende Systeme, von denen bekannt ist,
82 dass kivitendo auf ihnen läuft:</para>
90 <para>6.0 "Squeeze" (hier muss allerdings das Modul FCGI in der Version >= 0.72 compiled werden, und <literal>Rose::DB::Object</literal> ist zu alt)</para>
93 <para>7.0 "Wheezy"</para>
99 <para>Ubuntu 12.04 LTS "Precise Pangolin", 12.10 "Quantal Quetzal", 13.04 "Precise Pangolin" und 14.04 "Trusty Tahr" LTS Alpha</para>
103 <para>openSUSE 12.2, 12.3 und 13.1</para>
107 <para>SuSE Linux Enterprice Server 11</para>
111 <para>Fedora 16 bis 19</para>
116 <sect2 id="Pakete" xreflabel="Pakete">
117 <title>Benötigte Perl-Pakete installieren</title>
119 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
120 Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.4)
123 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht Bestandteil einer Standard-Perl-Installation sind. Um zu
124 überprüfen, ob die erforderlichen Pakete installiert und aktuell genug sind, wird ein Script mitgeliefert, das wie folgt aufgerufen
127 <programlisting>./scripts/installation_check.pl</programlisting>
129 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
132 <listitem><para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para></listitem>
134 <listitem><para><literal>Archive::Zip</literal></para></listitem>
136 <listitem><para><literal>Config::Std</literal></para></listitem>
138 <listitem><para><literal>DateTime</literal></para></listitem>
140 <listitem><para><literal>DBI</literal></para></listitem>
142 <listitem><para><literal>DBD::Pg</literal></para></listitem>
144 <listitem><para><literal>Email::Address</literal></para></listitem>
146 <listitem><para><literal>Email::MIME</literal></para></listitem>
148 <listitem><para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71 inklusive; siehe <xref linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para></listitem>
150 <listitem><para><literal>File::Copy::Recursive</literal></para></listitem>
152 <listitem><para><literal>JSON</literal></para></listitem>
154 <listitem><para><literal>List::MoreUtils</literal></para></listitem>
156 <listitem><para><literal>Net::SMTP::SSL</literal> (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "<xref
157 linkend="config.sending-email.smtp"/>")</para></listitem>
159 <listitem><para><literal>Net::SSLGlue</literal> (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "<xref
160 linkend="config.sending-email.smtp"/>")</para></listitem>
162 <listitem><para><literal>Params::Validate</literal></para></listitem>
164 <listitem><para><literal>PDF::API2</literal></para></listitem>
166 <listitem><para><literal>Rose::Object</literal></para></listitem>
168 <listitem><para><literal>Rose::DB</literal></para></listitem>
170 <listitem><para><literal>Rose::DB::Object</literal> Version 0.788 oder neuer</para></listitem>
172 <listitem><para><literal>Template</literal></para></listitem>
174 <listitem><para><literal>Text::CSV_XS</literal></para></listitem>
176 <listitem><para><literal>Text::Iconv</literal></para></listitem>
178 <listitem><para><literal>URI</literal></para></listitem>
180 <listitem><para><literal>XML::Writer</literal></para></listitem>
182 <listitem><para><literal>YAML</literal></para></listitem>
185 <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen: <literal>GD</literal>, <literal>HTML::Restrict</literal>, <literal>Image::Info</literal></para>
186 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen: <literal>File::Copy::Recursive</literal>.</para>
188 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen: <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
189 <literal>Net::SSLGlue</literal>.</para>
191 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
192 hinzugekommen, <literal>URI</literal> und
193 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
196 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
197 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
198 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
199 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
201 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
202 hinzugekommen.</para>
204 <para><literal>Email::Address</literal> und
205 <literal>List::MoreUtils</literal> sind schon länger feste
206 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
207 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
208 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
209 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
213 <title>Debian und Ubuntu</title>
215 <para>Für Debian und Ubuntu stehen die meisten der benötigten Perl-Pakete als Debian-Pakete zur Verfügung. Sie können mit folgendem Befehl installiert werden:</para>
217 <programlisting>apt-get install apache2 libarchive-zip-perl libclone-perl \
218 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
219 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
220 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
221 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
222 librose-db-perl librose-object-perl libsort-naturally-perl \
223 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
224 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
225 libimage-info-perl libgd-gd2-perl \
226 libfile-copy-recursive-perl postgresql</programlisting>
228 <para>Für das Paket HTML::Restrict gibt es kein Debian-Paket, dies muß per CPAN installiert werden. Der entsprechende Befehl wird beim Aufruf von installation_check.pl angezeigt.</para>
232 <title>Fedora Core</title>
234 <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 installiert werden:</para>
236 <programlisting>yum install httpd perl-Archive-Zip perl-Clone perl-DBD-Pg \
237 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
238 perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
239 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
240 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
241 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
242 perl-XML-Writer perl-YAML perl-parent postgresql-server</programlisting>
244 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
246 <programlisting>yum install perl-CPAN
247 cpan Config::Std</programlisting>
252 <title>openSUSE</title>
254 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
255 installiert werden:</para>
257 <programlisting>zypper install apache2 perl-Archive-Zip perl-Clone \
258 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
259 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
260 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
261 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
262 perl-URI perl-XML-Writer perl-YAML postgresql-server</programlisting>
264 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
266 <programlisting>yum install perl-CPAN
267 cpan Rose::Db::Object</programlisting>
273 <sect1 id="Manuelle-Installation-des-Programmpaketes"
274 xreflabel="Manuelle Installation des Programmpaketes">
275 <title>Manuelle Installation des Programmpaketes</title>
276 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github gehostet und kann
277 <ulink url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink> heruntergeladen werden.</para>
278 <para>Die kivitendo ERP Installationsdatei (<filename>kivitendo-erp-3.2.0.tgz</filename>) wird im Dokumentenverzeichnis des Webservers
279 (z.B. <filename>/var/www/html/</filename>, <filename>/srv/www/htdocs</filename> oder <filename>/var/www/</filename>) entpackt:</para>
281 <programlisting>cd /var/www
282 tar xvzf kivitendo-erp-3.2.0.tgz</programlisting>
284 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
286 <programlisting>cd kivitendo-erp</programlisting>
288 <para>Alternativ können Sie auch einen Alias in der
289 Webserverkonfiguration benutzen, um auf das tatsächliche
290 Installationsverzeichnis zu verweisen.</para>
292 <para>Bei einer Neuinstallation von Version 3.1.0 oder Version 3.2.0 muß das WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
294 <programlisting>mkdir webdav</programlisting>
296 <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
297 beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
298 Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
299 core <constant>apache</constant> oder bei OpenSUSE <constant>wwwrun</constant>).</para>
301 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
302 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
304 <programlisting>chown -R www-data users spool webdav</programlisting>
306 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
307 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>
309 <programlisting>chown www-data templates users</programlisting>
312 <sect1 id="config.config-file">
313 <title>kivitendo-Konfigurationsdatei</title>
315 <sect2 id="config.config-file.introduction"
316 xreflabel="Einführung in die Konfigurationsdatei">
317 <title>Einführung</title>
319 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei,
320 die benötigt wird: <filename>config/kivitendo.conf</filename> (kurz:
321 "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
322 von kivitendo bzw. der Migration von älteren Versionen angelegt
325 <para>Als Vorlage dient die Datei
326 <filename>config/kivitendo.conf.default</filename> (kurz: "die
327 Default-Datei"):</para>
329 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
331 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
332 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
333 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
334 Abschnitte und Werte enthalten, die von denen der Default-Datei
339 Vor der Umbenennung in kivitendo hieß diese Datei noch <filename>config/lx_office.conf</filename>. Aus Gründen der Kompatibilität
340 wird diese Datei eingelesen, sofern die Datei <filename>config/kivitendo.conf</filename> nicht existiert.
344 <para>Diese Hauptkonfigurationsdatei ist dann eine
345 installationsspezifische Datei, d.h. sie enthält bspw. lokale
346 Passwörter und wird auch nicht im Versionsmanagement (git)
349 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
350 Mandaten, bzw. Datenbanken gleich.</para>
353 <sect2 id="config.config-file.sections-parameters">
354 <title>Abschnitte und Parameter</title>
356 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
357 entsprechend kommentiert sind:</para>
360 <listitem><para><literal>authentication</literal> (siehe Abschnitt "<xref
361 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>" in diesem Kapitel)</para></listitem>
363 <listitem><para><literal>authentication/database</literal></para></listitem>
365 <listitem><para><literal>authentication/ldap</literal></para></listitem>
367 <listitem><para><literal>system</literal></para></listitem>
369 <listitem><para><literal>paths</literal></para></listitem>
371 <listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>
373 <listitem><para><literal>applications</literal></para></listitem>
375 <listitem><para><literal>environment</literal></para></listitem>
378 <listitem><para><literal>print_templates</literal></para></listitem>
380 <listitem><para><literal>task_server</literal></para></listitem>
382 <listitem><para><literal>periodic_invoices</literal></para></listitem>
384 <listitem><para><literal>self_tests</literal></para></listitem>
386 <listitem><para><literal>console</literal></para></listitem>
388 <listitem><para><literal>testing</literal></para></listitem>
390 <listitem><para><literal>testing/database</literal></para></listitem>
392 <listitem><para><literal>debug</literal></para></listitem>
395 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
396 einzustellen oder zu kontrollieren sind, sind:</para>
398 <programlisting>[authentication]
399 admin_password = geheim
401 [authentication/database]
406 password =</programlisting>
408 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
409 <varname>[periodic_invoices]</varname> den Login eines Benutzers
410 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
411 mit Informationen über die erstellten Rechnungen bekommt.</para>
413 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten Ausführung bestimmter Aufgaben mit, den <link
414 linkend="config.task-server">Taskserver</link>. Er wird u.a. für Features wie die <link
415 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link> benötigt, erledigt aber auch andere erforderliche Aufgaben
416 und muss daher in Betrieb genommen werden. Der Taskserver benötigt zwei Konfigurationseinstellungen, die unter
417 <varname>[task_server]</varname> anzugeben sind: ein Mandant (entweder der Mandantenname oder eine Datenbank-ID, Variable
418 <varname>client</varname>), aus dem die Datenbankkonfiguration entnommen wird, sowie ein Login (Variable <varname>login</varname>)
419 eines Benutzers, der für gewisse Dinge wie die Rechnungserstellung als Verkäufer eingetragen wird.</para>
421 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
422 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
425 <sect2 id="config.config-file.prior-versions">
426 <title>Versionen vor 2.6.3</title>
428 <para>In älteren kivitendo Versionen gab es im Verzeichnis
429 <filename>config</filename> die Dateien
430 <filename>authentication.pl</filename> und
431 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
432 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
433 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
434 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
436 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
437 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
438 manuell übertragen und die alten Konfigurationsdateien anschließend
439 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
440 entsprechende Fehlermeldung an.</para>
444 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
445 <title>Anpassung der PostgreSQL-Konfiguration</title>
447 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
449 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
450 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
452 <para>kivitendo setzt zwingend voraus, dass die Datenbank Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen Serverinstallationen
453 braucht man hier meist nicht einzugreifen.</para>
455 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so
456 braucht man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
458 <programlisting>su postgres
460 exit </programlisting>
462 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
463 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
464 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
467 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
469 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
470 Versionsnummer angepasst werden.</para>
472 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
474 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
475 <literal>\l</literal> geprüft werden.</para>
478 <sect2 id="Änderungen-an-Konfigurationsdateien">
479 <title>Änderungen an Konfigurationsdateien</title>
481 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
482 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
483 <filename>/var/lib/pgsql/data/</filename> oder
484 <filename>/etc/postgresql/</filename>, muss sichergestellt werden,
485 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
486 Parameter <varname>listen_address</varname> gesteuert. Laufen
487 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
488 <literal>localhost</literal> verwendet werden. Andernfalls müssen
489 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
490 was mit dem Wert <literal>*</literal> geschieht.</para>
492 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
493 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
494 sein sollte, müssen die Berichtigungen für den Zugriff geändert
495 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
496 nögiten Verbindungen immer zuzulassen, für eine lokal laufenden
497 Datenbank zum Beispiel:</para>
499 <programlisting>local all kivitendo password
500 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
503 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
504 <title>Erweiterung für servergespeicherte Prozeduren</title>
506 <para>In der Datenbank <literal>template1</literal> muss die
507 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
508 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
509 <programlisting>su - postgres
510 psql template1</programlisting>
512 führen Sie die folgenden Kommandos aus:</para>
514 <programlisting>create language 'plpgsql';
518 <sect2 id="Datenbankbenutzer-anlegen">
519 <title>Datenbankbenutzer anlegen</title>
521 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
522 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
523 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
526 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit nein
527 beantworten, genauso ist die Berechtigung neue User (Roles) zu
528 generieren nicht nötig.</para>
529 <programlisting>su - postgres
530 createuser -d -P kivitendo
531 exit</programlisting>
533 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
534 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.
535 den hier gewählten Benutzernamen.</para>
539 <sect1 id="Apache-Konfiguration">
540 <title>Webserver-Konfiguration</title>
543 <title>Grundkonfiguration mittels CGI</title>
546 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
547 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
548 <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
551 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
552 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
553 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
554 anderen Datei hinzu, die beim Starten des Webservers eingelesen
557 <programlisting>AddHandler cgi-script .pl
558 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
560 <Directory /var/www/kivitendo-erp>
561 Options ExecCGI Includes FollowSymlinks
564 <Directory /var/www/kivitendo-erp/users>
567 </Directory></programlisting>
569 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
570 das kivitendo-Archiv entpacket haben.</para>
573 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
574 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
577 <para>Auf einigen Webservern werden manchmal die Grafiken und
578 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
579 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
581 <programlisting>EnableSendfile Off</programlisting>
584 <sect2 id="Apache-Konfiguration.FCGI"
585 xreflabel="Konfiguration für FastCGI/FCGI">
586 <title>Konfiguration für FastCGI/FCGI</title>
588 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
589 <title>Was ist FastCGI?</title>
591 <para>Direkt aus <ulink
592 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
595 <para><citation> FastCGI ist ein Standard für die Einbindung
596 externer Software zur Generierung dynamischer Webseiten in einem
597 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
598 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
599 umgehen. </citation></para>
602 <sect3 id="Apache-Konfiguration.FCGI.Warum">
603 <title>Warum FastCGI?</title>
605 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
606 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
607 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
608 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
609 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
610 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
611 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
612 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
613 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
614 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
615 deutlich länger dauert als früher, und dass davon 90% für das Laden
616 der Module verwendet wird.</para>
618 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
619 wird nur die eigentliche Programmlogik ausgeführt.</para>
622 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
623 <title>Getestete Kombinationen aus Webservern und Plugin</title>
625 <para>Folgende Kombinationen sind getestet:</para>
629 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
633 <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
637 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
638 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
639 mod_fastcgi nicht mehr explizit eingegangen.</para>
641 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
645 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern
646 bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrere Installation gibt, muss zwingend Version 0.68 oder
647 aber Version 0.72 und neuer eingesetzt werden.</para>
649 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie sich die Vorgängerversion wie folgt
652 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
656 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
657 <title>Konfiguration des Webservers</title>
659 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
660 laufen zu lassen, empfliehlt es sich die Installation ersteinmal
661 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
662 debuggen die beim ersten aufsetzen auftreten können. Sollte die
663 Installation schon funktionieren, lesen Sie weiter.</para>
665 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
666 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
668 <programlisting>a2enmod fcgid</programlisting>
670 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
671 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
672 und <function>Directory</function>-Direktiven. Dabei wird zwischen
673 dem Installationspfad von kivitendo im Dateisystem
674 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
675 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
676 ("<filename>/url/for/kivitendo-erp</filename>").</para>
678 <para>Folgender Konfigurationsschnipsel funktioniert mit
681 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
682 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
684 <Directory /path/to/kivitendo-erp>
686 Options ExecCGI Includes FollowSymlinks
691 <DirectoryMatch /path/to/kivitendo-erp/users>
694 </DirectoryMatch></programlisting>
696 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
697 die maximale Größe eines Requests. Diese sollte wie folgt
698 hochgesetzt werden:</para>
700 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
702 <para>Das ganze sollte dann so aussehen:</para>
704 <programlisting>AddHandler fcgid-script .fpl
705 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
706 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
707 FcgidMaxRequestLen 10485760
709 <Directory /path/to/kivitendo-erp>
711 Options ExecCGI Includes FollowSymlinks
716 <DirectoryMatch /path/to/kivitendo-erp/users>
719 </DirectoryMatch></programlisting>
721 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
722 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
723 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
724 gibt es hier kleine Performance-Einbußen.</para>
726 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
727 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
728 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
730 <programlisting># Zugriff über CGI
731 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
733 # Zugriff mit mod_fcgid:
734 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
735 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
737 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
738 die normale Version erreichbar, und unter
739 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
740 FastCGI-Version.</para>
745 <sect1 id="config.task-server">
746 <title>Der Task-Server</title>
748 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und
749 diese zu festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess wird u.a. für die Erzeugung der wiederkehrenden
750 Rechnungen und weitere essenzielle Aufgaben benutzt.</para>
752 <sect2 id="Konfiguration-des-Task-Servers">
753 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
755 <para>Die Konfiguration erfolgt über den Abschnitt
756 <literal>[task_server]</literal> in der Datei
757 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
758 Optionen sind:</para>
762 <term><varname>client</varname></term>
765 <para>Name oder Datenbank-ID eines vorhandenen kivitendo-Mandanten, der benutzt wird, um die zu verwendende
766 Datenbankverbindung auszulesen. Der Mandant muss in der Administration angelegt werden. Diese Option muss angegeben
769 <para>Diese Option kam mit Release v3.x.0 hinzu und muss daher in Konfigurationen, die von älteren Versionen aktualisiert
770 wurden, ergänzt werden.</para>
775 <term><varname>login</varname></term>
778 <para>gültiger kivitendo-Benutzername, der z.B. als Verkäufer beim Erzeugen wiederkehrender Rechnungen benötigt wird. Der
779 Benutzer muss in der Administration angelegt werden. Diese Option muss angegeben werden.</para>
784 <term><varname>run_as</varname></term>
787 <para>Wird der Server vom Systembenutzer <literal>root</literal>
788 gestartet, so wechselt er auf den mit <literal>run_as</literal>
789 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
790 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
792 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
793 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
794 unter dem auch der Webserver läuft.</para>
799 <term><varname>debug</varname></term>
802 <para>Schaltet Debug-Informationen an und aus.</para>
808 <sect2 id="Einbinden-in-den-Boot-Prozess">
809 <title>Automatisches Starten des Task-Servers beim Booten</title>
811 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
812 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
813 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
815 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
816 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
817 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
818 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
819 anstelle eines symbolischen Links verwendet werden können.</para>
822 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, ältere Fedora Core)</title>
824 <para>Kopieren Sie die Datei
825 <filename>scripts/boot/system-v/kivitendo-server</filename>
826 nach <filename>/etc/init.d/kivitendo-server</filename>. Passen
827 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
828 <literal>DAEMON=....</literal>). Binden Sie das Script in den
829 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
833 <para>Debian-basierende Systeme:</para>
835 <programlisting>update-rc.d kivitendo-task-server defaults
836 # Nur bei Debian Squeeze und neuer:
837 insserv kivitendo-task-server</programlisting>
841 <para>Ältere OpenSUSE und ältere Fedora Core:</para>
843 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
847 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
850 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
854 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
856 <para>Kopieren Sie die Datei
857 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
858 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
859 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
860 <literal>exec ....</literal>).</para>
862 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
865 <programlisting>service kivitendo-task-server start</programlisting>
869 <title>systemd-basierende Systeme (z.B. neure OpenSUSE, neuere Fedora Core)</title>
871 <para>Verlinken Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
872 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
873 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>). Binden Sie das Script in den Boot-Prozess ein.
876 <para>Alle hierzu benötigten Befehle sehen so aus:</para>
878 <programlisting>cd /var/www/kivitendo-erp/scripts/boot/systemd
879 ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
881 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
884 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
888 <sect2 id="Prozesskontrolle">
889 <title>Wie der Task-Server gestartet und beendet wird</title>
891 <para>Der Task-Server wird wie folgt kontrolliert:</para>
893 <programlisting>./scripts/task_server.pl Befehl</programlisting>
895 <para><literal>Befehl</literal> ist dabei eine der folgenden
900 <para><literal>start</literal> startet eine neue Instanz des
901 Task-Servers. Die Prozess-ID wird innerhalb des
902 <filename>users</filename>-Verzeichnisses abgelegt.</para>
906 <para><literal>stop</literal> beendet einen laufenden
911 <para><literal>restart</literal> beendet und startet ihn
916 <para><literal>status</literal> berichtet, ob der Task-Server
921 <para>Der Task-Server wechselt beim Starten automatisch in das
922 kivitendo-Installationsverzeichnis.</para>
924 <para>Dieselben Optionen können auch für die SystemV-basierenden
925 Runlevel-Scripte benutzt werden (siehe oben).</para>
927 <sect2 id="Prozesskontrolle2">
928 <title>Task-Server mit mehreren Mandanten</title>
930 <para>Beim Task-Server werden der zu verwendende Mandant und Login-Name des Benutzers, unter dem der Task-Server laufen soll, in die
931 Konfigurationsdatei geschrieben. Hat man mehrere Mandanten, muss man auch mehrere Konfigurationsdateien anlegen.</para>
933 <para>Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf, wo in der Kategorie <varname>[task_server]</varname> die
934 gewünschten Werte für <varname>client</varname> und <varname>login</varname> eingetragen werden.</para>
936 <para>Der alternative Task-Server wird dann mit folgendem Befehl
939 <programlisting>./scripts/task_server.pl -c config/DATEINAME.conf</programlisting>
943 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
944 <title>Benutzerauthentifizierung und Administratorpasswort</title>
946 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
947 über die Verwaltung von Gruppen und weitere Einstellungen</para>
949 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
950 <title>Grundlagen zur Benutzerauthentifizierung</title>
952 <para>kivitendo verwaltet die Benutzerinformationen in einer
953 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
954 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
955 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
956 können, müssen aber nicht unterschiedlich sein.</para>
958 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
959 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
960 abgelegt werden.</para>
962 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
963 entweder gegen die Authentifizierungsdatenbank oder gegen einen
964 LDAP-Server überprüft werden.</para>
966 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
967 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
968 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
969 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
970 einer Version vor v2.6.0 angelegt werden. Eine
971 Beispielkonfigurationsdatei
972 <filename>config/kivitendo.conf.default</filename> existiert, die als
973 Vorlage benutzt werden kann.</para>
976 <sect2 id="Administratorpasswort">
977 <title>Administratorpasswort</title>
979 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
980 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
981 nur dort und nicht mehr im Administrationsinterface selber geändert
982 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
983 Abschnitt <varname>[authentication]</varname>.</para>
986 <sect2 id="Authentifizierungsdatenbank">
987 <title>Authentifizierungsdatenbank</title>
989 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
990 Parametern in <varname>[authentication/database]</varname>
991 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
995 <term><literal>host</literal></term>
998 <para>Der Rechnername oder die IP-Adresse des
999 Datenbankservers</para>
1004 <term><literal>port</literal></term>
1007 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1012 <term><literal>db</literal></term>
1015 <para>Der Name der Authentifizierungsdatenbank</para>
1020 <term><literal>user</literal></term>
1023 <para>Der Benutzername, mit dem sich kivitendo beim
1024 Datenbankserver anmeldet (z.B.
1025 "<literal>postgres</literal>")</para>
1030 <term><literal>password</literal></term>
1033 <para>Das Passwort für den Datenbankbenutzer</para>
1038 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1039 automatisch anlegen (mehr dazu siehe unten).</para>
1042 <sect2 id="Passwortüberprüfung">
1043 <title>Passwortüberprüfung</title>
1045 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1046 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1047 Active-Directory-Server. Welche davon benutzt wird, regelt der
1048 Parameter <varname>module</varname> im Abschnitt
1049 <varname>[authentication]</varname>.</para>
1051 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1052 gespeichert werden, so muss der Parameter <varname>module</varname>
1053 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1054 der Administrator als auch die Benutzer selber ihre Psaswörter in
1055 kivitendo ändern.</para>
1057 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1058 benutzt werden, so muss der Parameter <varname>module</varname> auf
1059 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1060 zusätzliche Informationen über den LDAP-Server im Abschnitt
1061 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1065 <term><literal>host</literal></term>
1068 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1069 Active-Directory-Servers. Diese Angabe ist zwingend
1070 erforderlich.</para>
1075 <term><literal>port</literal></term>
1078 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1083 <term><literal>tls</literal></term>
1086 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1087 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1088 ‘<literal>0</literal>’ belassen</para>
1093 <term><literal>attribute</literal></term>
1096 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1097 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1098 meist ‘<literal>sAMAccountName</literal>’, für andere
1099 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1100 zwingend erforderlich.</para>
1105 <term><literal>base_dn</literal></term>
1108 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1109 Diese Angabe ist zwingend erforderlich.</para>
1114 <term><literal>filter</literal></term>
1117 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1118 <literal><%login%></literal>, so wird dieses durch den vom
1119 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1120 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1121 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1126 <term><literal>bind_dn</literal> und
1127 <literal>bind_password</literal></term>
1130 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1131 durchsucht werden kann (z.B. ist dies bei
1132 Active-Directory-Servern der Fall), so kann diese hier angegeben
1133 werden. Für Active-Directory-Server kann als
1134 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1135 z.B. ‘<literal>cn=Martin
1136 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1137 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1138 also ‘<literal>Martin Mustermann</literal>’.</para>
1144 <sect2 id="Name-des-Session-Cookies">
1145 <title>Name des Session-Cookies</title>
1147 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1148 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1149 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1150 Parameter <varname>cookie_name</varname> im Abschnitt
1151 <varname>[authentication]</varname>gesetzt.</para>
1153 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1154 Server existiert.</para>
1157 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1158 <title>Anlegen der Authentifizierungsdatenbank</title>
1160 <para>Nachdem alle Einstellungen in
1161 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1162 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1163 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1164 der folgenden URL erreichbar sein sollte:</para>
1167 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1171 <sect1 id="Benutzer--und-Gruppenverwaltung">
1172 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1174 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und Datenbanken angelegt werden. Dieses geschieht im
1175 Administrationsmenü, das Sie unter folgender URL finden:</para>
1178 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1180 <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
1181 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1183 <sect2 id="Zusammenhänge">
1184 <title>Zusammenhänge</title>
1186 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung in einer oder zwei Datenbanken gespeichert werden.</para>
1188 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat
1189 Zugriff auf welche Mandanten, und welche Gruppe verfügt über welche Rechte. Diese Informationen werden in der
1190 Authentifizierungsdatenbank gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter in der Konfigurationsdatei
1191 <filename>config/kivitendo.conf</filename> gespeichert werden.</para>
1193 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten, Waren) und Belege
1194 (Angebote, Lieferscheine, Rechnungen). Diese werden in einer Mandantendatenbank gespeichert. Die
1195 Verbindungsinformationen einer solchen Mandantendatenbank werden im Administrationsbereich konfiguriert, indem man einen Mandanten
1196 anlegt und dort die Parameter einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1198 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich, die Authentifizierungsdatenbank und eine der
1199 Mandantendatenbanken in ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit mehr als einem Mandanten, wird
1200 empfohlen, für die Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die nicht gleichzeitig für einen Mandanten
1201 verwendet wird.</para>
1204 <sect2 id="Mandanten-Benutzer-Gruppen">
1205 <title>Mandanten, Benutzer und Gruppen</title>
1207 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen, die sich frei zueinander zuordnen lassen.</para>
1209 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1210 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1211 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank. Diese sollte über die <link
1212 linkend="Datenbanken-anlegen">Datenbankverwaltung</link> geschehen.</para>
1214 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten soll. Sie erhält einen Loginnamen sowie ein
1215 Passwort. Weiterhin legt der Administrator fest, an welchen Mandanten sich ein Benutzer anmelden kann, was beim Login verifiziert
1218 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür
1219 vom Administrator gewisse Rechte zugeordnet. Weiterhin legt der Administrator fest, für welche Mandanten eine Gruppe gilt, und
1220 welche Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer dann an einem Mandanten an, so erhält er alle Rechte von
1221 allen denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in denen der Benutzer zum Anderen Mitglied ist, </para>
1223 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und Benutzer angelegt werden, kann im Prinzip beliebig gewählt
1224 werden. Die folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1226 <orderedlist numeration="arabic">
1228 <para>Datenbank anlegen</para>
1232 <para>Gruppen anlegen</para>
1236 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1240 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1245 <sect2 id="Datenbanken-anlegen">
1246 <title>Datenbanken anlegen</title>
1248 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1249 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1250 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1253 <sect2 id="Gruppen-anlegen">
1254 <title>Gruppen anlegen</title>
1256 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1257 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1258 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1259 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1261 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank gespeichert, gelten aber nicht automatisch für alle
1262 Mandanten. Der Administrator legt vielmehr fest, für welche Mandanten eine Gruppe gültig ist. Dies kann entweder beim Bearbeiten der
1263 Gruppe geschehen ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn man einen Mandanten bearbeitet ("für diesen
1264 Mandanten sind die Gruppen A, B und C gültig").</para>
1266 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder dieser Gruppe festgelegt werden ("in dieser Gruppe sind die
1267 Benutzer X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten eines Benutzers geschehen ("dieser Benutzer ist
1268 Mitglied in den Gruppen A, B und C").</para>
1271 <sect2 id="Benutzer-anlegen">
1272 <title>Benutzer anlegen</title>
1274 <para>Beim Anlegen von Benutzern werden für viele Parameter Standardeinstellungen vorgenommen, die den Gepflogenheiten des deutschen
1275 Raumes entsprechen.</para>
1277 <para>Zwingend anzugeben ist der Loginname. Wenn die Passwortauthentifizierung über die Datenbank eingestellt ist, so kann hier auch
1278 das Benutzerpasswort gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1281 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier auch konfiguriert werden, auf welche Mandanten der Benutzer
1282 Zugriff hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können sowohl beim Benutzer vorgenommen werden ("dieser
1283 Benutzer hat Zugriff auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen X, Y und Z") als auch beim Mandanten ("auf
1284 diesen Mandanten haben Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe sind Benutzer A, B und C
1285 Mitglieder").</para>
1288 <sect2 id="Mandanten-anlegen">
1289 <title>Mandanten anlegen</title>
1291 <para>Ein Mandant besteht aus Administrationssicht primär aus einem eindeutigen Namen. Weiterhin wird hier hinterlegt, welche
1292 Datenbank als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten einer der eben angelegten Datenbanken eingetragen
1295 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch konfiguriert werden, welche Benutzer Zugriff auf den
1296 Mandanten haben bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen können sowohl beim Mandanten vorgenommen werden
1297 ("auf diesen Mandanten haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die Gruppen X, Y und Z gültig") als auch
1298 beim Benutzer ("dieser Benutzer hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese Gruppe ist für Mandanten A, B und
1302 <sect1 id="Drucker--Systemverwaltung">
1303 <title>Drucker- und Systemverwaltung</title>
1304 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte Druckeradministration und System.</para>
1305 <sect2 id="Druckeradministration">
1306 <title>Druckeradministration</title>
1307 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig viele "Druckbefehle" im System verwalten. Diese Befehle werden mandantenweise
1308 zugeordnet. Unter Druckerbeschreibung wird der Namen des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs angezeigt wird.</para>
1309 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl, der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P meinDrucker' oder ein
1310 kompletter Pfad zu einem Skript (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh).
1311 Wird ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich ergänzt, ist
1312 bspw. das Kürzel 'epson_drucker' definiert, so wird beim Ausdruck eines Angebots folgende Vorlage geparst: sales_quotation_epson_drucker.tex.</para>
1315 <title>System sperren / entsperren</title>
1317 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation sperren/entsperren'. Setz man diese Sperre so ist der Zugang zu der gesamten kivitendo Installation gesperrt.</para>
1318 <para>Falls die Sperre gesetzt ist, erscheint anstelle der Anmeldemaske die Information: 'kivitendo ist momentan zwecks Wartungsarbeiten nicht zugänglich.'.
1320 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo automatisch 'sperrt', falls es bei einem Versionsupdate zu einem Datenbankfehler kam. Somit kann hier nicht aus Versehen
1321 mit einem inkonsistenten Datenbestand weitergearbeitet werden.</para>
1325 <sect1 id="config.sending-email" xreflabel="E-Mail-Versand aus kivitendo heraus">
1326 <title>E-Mail-Versand aus kivitendo heraus</title>
1328 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden, z.B. um ein Angebot direkt an einen Kunden zu
1329 verschicken. Damit dies funktioniert, muss eingestellt werden, über welchen Server die E-Mails verschickt werden sollen. kivitendo
1330 unterstützt dabei zwei Mechanismen: Versand über einen lokalen E-Mail-Server (z.B. mit <productname>Postfix</productname> oder
1331 <productname>Exim</productname>, was auch die standardmäßig aktive Methode ist) sowie Versand über einen SMTP-Server (z.B. der des
1332 eigenen Internet-Providers).</para>
1334 <para>Welche Methode und welcher Server verwendet werden, wird über die Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1335 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1337 <sect2 id="config.sending-email.sendmail" xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1338 <title>Versand über lokalen E-Mail-Server</title>
1340 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie
1341 z.B. <productname>Postfix</productname>, <productname>Exim</productname> oder <productname>Sendmail</productname> läuft.</para>
1343 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1344 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1346 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet wird, dient der Parameter '<literal>sendmail =
1347 ...</literal>'. Der Standardwert verweist auf das Programm <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1348 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1350 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen dieses sprengen. Hierfür sei auf die Dokumentation des
1351 E-Mail-Servers verwiesen.</para>
1354 <sect2 id="config.sending-email.smtp" xreflabel="E-Mail-Versand über einen SMTP-Server">
1355 <title>Versand über einen SMTP-Server</title>
1357 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server vorhanden oder zwar einer vorhanden, dieser aber nicht
1358 konfiguriert ist.</para>
1360 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1361 Parameter dienen dabei der weiteren Konfiguration:</para>
1365 <term><varname>hostname</varname></term>
1367 <listitem><para>Name oder IP-Adresse des SMTP-Servers. Standardwert: '<literal>localhost</literal>'</para></listitem>
1371 <term><varname>port</varname></term>
1373 <listitem><para>Portnummer. Der Standardwert hängt von der verwendeten Verschlüsselungsmethode ab. Gilt '<literal>security =
1374 none</literal>' oder '<literal>security = tls</literal>', so ist 25 die Standardportnummer. Für '<literal>security =
1375 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht geändert werden.</para></listitem>
1379 <term><varname>security</varname></term>
1381 <listitem><para>Wahl der zu verwendenden Verschlüsselung der Verbindung mit dem Server. Standardwert ist
1382 '<literal>none</literal>', wodurch keine Verschlüsselung verwendet wird. Mit '<literal>tls</literal>' wird TLS-Verschlüsselung
1383 eingeschaltet, und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL eingeschaltet. Achtung: Für
1384 '<literal>tls</literal>' und '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt (siehe unten).</para></listitem>
1388 <term><varname>login</varname> und <varname>password</varname></term>
1390 <listitem><para>Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername
1391 und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von
1392 Verschlüsselung aktiviert werden.</para></listitem>
1396 <para>Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind:</para>
1399 <listitem><para>TLS-Verschlüsselung: Modul <literal>Net::SSLGlue</literal> (Debian-Paketname
1400 <literal>libnet-sslglue-perl</literal>, Fedora Core: <literal>perl-Net-SSLGlue</literal>, openSUSE:
1401 <literal>perl-Net-SSLGlue</literal></para></listitem>
1403 <listitem><para>SSL-Verschlüsselung: Modul <literal>Net::SMTP::SSL</literal> (Debian-Paketname
1404 <literal>libnet-smtp-ssl-perl</literal>, Fedora Core: <literal>perl-Net-SMTP-SSL</literal>, openSUSE:
1405 <literal>perl-Net-SMTP-SSL</literal></para></listitem>
1410 <sect1 id="Drucken-mit-kivitendo">
1411 <title>Drucken mit kivitendo</title>
1413 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. Um drucken zu können, braucht der Server ein geeignetes
1414 LaTeX System. Am einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter debianoiden Betriebssystemen installiert man
1415 die Pakete mit:</para>
1417 <para><programlisting>aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1418 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1420 <para>TODO: RPM-Pakete.</para>
1422 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1424 <listitem><para>Standard</para></listitem>
1425 <listitem><para>f-tex</para></listitem>
1426 <listitem><para>RB</para></listitem>
1429 <sect2 id="Vorlagenverzeichnis-anlegen" xreflabel="Vorlagenverzeichnis anlegen">
1430 <title>Vorlagenverzeichnis anlegen</title>
1431 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1433 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1435 <para>Der Angemmeldete Benutzer muss in einer Gruppe sein, die über das
1436 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch <xref linkend="Gruppen-anlegen"/>.
1438 <para>Im Userbereich lässt sich unter:
1439 "<guimenu>System</guimenu> ->
1440 <guisubmenu>Mandantenverwaltung</guisubmenu> -> <guimenuitem>Verschiedenes</guimenuitem>" die Option
1441 "Neue Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1444 <listitem><para><option>Vorlagen auswählen</option>: Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll
1445 (<filename>Standard</filename>, <filename>f-tex</filename> oder <filename>RB</filename>.)</para></listitem>
1446 <listitem><para><option>Neuer Name</option>: Der Verzeichnisname für den neuen Vorlagensatz. Dieser kann im Rahmen der üblichen
1447 Bedingungen für Verzeichnisnamen frei gewählt werden.</para></listitem>
1450 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist für den aktuellen Mandanten ausgewählt.
1451 Der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1452 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch vorgenommen werden. Den Ordner findet man im Dateisystem unter
1453 <filename>./templates/[Neuer Name]</filename></para>
1457 <sect2 id="Vorlagen-Standard">
1458 <title>Standard</title>
1460 <para>Der Standard-Vorlagensatz von Kivitendo. Wie unter <ulink url="http://demo.kivitendo.org">http://demo.kivitendo.org</ulink> zu
1466 <title>f-tex</title>
1468 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt.</para>
1470 <sect3 id="f-tex-Feature-Übersicht">
1471 <title>Feature-Übersicht</title>
1473 <listitem><para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage für alle briefartigen Dokumente verwendet. Also
1474 Angebot, Rechnung, Proformarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc..</para></listitem>
1476 <listitem><para>Leichte Anpassung an das Firmen-Layout durch verwendung eines Hintergrund-PDF. Dieses kann leicht mit dem
1477 eigenen Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp, Adobe*)</para></listitem>
1479 <listitem><para>Hintergrund-PDF umschaltbar auf "nur erste Seite" (Standard) oder "alle Seiten" (Option
1480 "<option>bgPdfFirstPageOnly</option>" in Datei <filename>letter.lco</filename>)</para></listitem>
1482 <listitem><para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1483 versendeten Dokumenten eingebunden (Option "<option>bgPdfEmailOnly</option>" in Datei
1484 <filename>letter.lco</filename>).</para></listitem>
1486 <listitem><para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch, Wiederholung von Kopfzeilen, Zwischensummen
1487 etc. (danke an Kai-Martin Knaak für die Vorarbeit)</para></listitem>
1489 <listitem><para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom Land des eigenen Unternehmens abweicht (also die
1490 Rechnung das Land verlässt).</para></listitem>
1492 <listitem><para>Multisprachfähig leicht um weitere Sprachen zu erweitern, alle Übersetzungen in der Datei
1493 <filename>translatinos.tex</filename>.</para></listitem>
1495 <listitem><para>Auflistung von Bruttopreisen für Endverbraucher.</para></listitem>
1499 <sect3 id="f-tex-Installation">
1500 <title>Die Installation</title>
1502 <listitem><para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref linkend="Vorlagenverzeichnis-anlegen"/>. Das
1503 Vorlagensystem funktioniert jetzt schon, hat allerdings noch einen Beispiel-Briefkopf.</para></listitem>
1505 <listitem><para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach <filename>./letter_head.pdf</filename>.</para></listitem>
1506 <listitem><para>Editiere den Bereich "<option>settings</option>" in der datei <filename>letter.lco</filename>.</para></listitem>
1509 <para>oder etwas detaillierter:</para>
1512 Es wird eine Datei <filename>sample.lco</filename> erstellt und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
1513 ist dies die Datei die für die firmenspezifischen Anpassungen gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig
1514 ist, wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen
1515 vorzunehmen und <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung über eine
1516 <filename>*.lco</filename>-Datei, die letztlich auf <filename>letter.lco</filename> verlinkt ist ist aber auch möglich.
1520 Es wird eine Datei <filename>sample_head.pdf</filename> mit ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
1521 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei
1522 <filename>sample_head.pdf</filename> an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
1523 Template Verzeichniss ablegen und statt <filename>sample_head.pdf</filename> nach <filename>letter_head.pdf</filename>
1528 Letzlich muss <filename>letter_head.pdf</filename> auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
1533 Es wird eine Datei <filename>mydata.tex.example</filename> ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
1534 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das Land verwendet. Die Datei muss also nicht angefasst
1535 werden. Die anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig).
1538 Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc. sollten über die Hintergrund-PDF-Datei oder die
1539 <filename>*.lco</filename>-Datei erfolgen.
1543 <sect3 id="f-tex-Funktionsübersicht">
1544 <title>f-tex Funktionsübersicht</title>
1546 Das Konzept von kivitendo sieht vor, für jedes Dokument (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine LaTeX-Vorlage
1547 vorzuhalten, dies ist sehr wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
1548 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
1549 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche LaTeX-Vorlage verwendet, welche über Codeweichen die
1550 Besonderheiten der jeweiligen Dokumente berücksichtigt:
1554 <listitem><para>Tabellen mit oder ohne Preis</para></listitem>
1555 <listitem><para>Sprache der Tabellenüberschriften etc.</para></listitem>
1556 <listitem><para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus Angebotsnummer)</para></listitem>
1557 <listitem><para>Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus gewerblicher
1558 Kunde)</para></listitem>
1561 <para>Nachteil:</para>
1564 LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
1565 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann natürlich
1566 auch innerhalb der Tabellendarstellung gut persönliche Anpassungen vornehmen. Aber man kann sich hier bei Veränderungen sehr
1567 schnell heftig in den Fuss schiessen.
1570 <para>Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
1571 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen, und sich an der Form der dargestellten Tabellen, wie sie
1572 ausgeliefert werden, erfreuen.
1575 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine, kontinuierliche Schritte gehen.</para>
1579 <sect3 id="f-tex-Bruttopreise">
1580 <title>Bruttopreise für Endverbraucher</title>
1582 <para>Der auszuweisende Bruttopreis wird innerhalb der LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen "alle
1583 Preise Brutto" auszuwählen, aber:</para>
1586 <para>hierfür müssen die Preise auch in Brutto in der Datenbank stehen (ja - das lässt sich über die Preisgruppen und die
1587 Zuordung einer Default-Preisgruppe handhaben)</para>
1590 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
1591 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche Knackpunkt)</para>
1596 Es gibt mit f-tex eine weitere Alternative. Die Information ob Brutto oder Nettorechnung wird mit den Zahlarten
1597 verknüpft. Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben werden sollen, enden mit "_E" (für
1598 Endverbraucher). Falls identische Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt man diese einfach doppelt
1599 an (einmal mit der Namensendung "_E"). Gewinn:</para>
1602 <listitem><para>Die Entscheidung, ob Netopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste verbunden.</para></listitem>
1603 <listitem><para>Die Default-Zahlart kann im Kundendatensatz hinterlegt werden, und man muss nicht mehr daran denken, "alle Preise
1604 Netto" auszuwählen.</para></listitem>
1605 <listitem><para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken revidiert werden,
1606 ohne dass sich der Auftragswert ändert.</para></listitem>
1610 <sect3 id="f-tex-lieferadressen">
1611 <title>Lieferadressen</title>
1613 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen im Adressfeld zum Einsatz. Wenn die
1614 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende Adressvariable eingesetzt. Wenn also die Lieferadresse in
1615 Straße, Hausnummer und Ort abweicht, müssen auch nur diese Felder in der Lieferadresse ausgefüllt werden. Für den Firmenname wird
1616 der Wert der Hauptadresse angezeigt.
1621 <sect2 id="Vorlagen-RB">
1622 <title>Der Druckvorlagensatz RB</title>
1624 <para>Hierbei handelt es sich um einen vollständigen Dokumentensatz mit alternativem Design.</para>
1625 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
1626 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1627 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die eigenen Firmendaten finden sich in der Datei Readme.tex im Vorlagenverzeichnis.</para>
1631 <sect2 id="allgemeine-hinweise-zu-latex">
1632 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
1633 <para>In den allermeisten Installationen sollte das Drucken jetzt schon
1634 funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
1635 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeile,
1636 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1641 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1642 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1643 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1647 <para>! Package inputenc Error: Unicode char \u8:... set up for
1648 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1649 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1650 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1651 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1652 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1656 <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
1657 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1658 Prüfen Sie den Namen in der Konfiguration (Standard:
1659 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1660 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1663 <para>Wenn sich das Problem nicht auf Grund der ausgabe im Webbrowser verifizieren lässt:</para>
1666 <para> editiere [kivitendo-home]/config/kivitendo.conf und ändere "keep_temp_files" auf 1</para>
1667 <para><programlisting>keep_temp_files = 1;</programlisting></para>
1670 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
1673 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
1676 <para>wechsele in das users Verzeichnis von kivitendo</para>
1677 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
1680 <para>LaTeX Suchpfad anpassen:</para>
1681 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
1684 <para>Finde herraus welche Datei kivitendo beim letzten Durchlauf erstellt hat</para>
1685 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
1686 <para>Es sollte die letzte Datei ganz unten sein</para>
1689 <para>für besseren Hinweis auf Fehler texdatei nochmals übersetzen</para>
1690 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
1691 <para>in der *.tex datei nach dem Fehler suchen.</para>
1697 <sect1 id="OpenDocument-Vorlagen">
1698 <title>OpenDocument-Vorlagen</title>
1700 <para>kivitendo unterstützt die Verwendung von Vorlagen im
1701 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1702 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1703 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1704 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1705 <filename>config/kivitendo.conf</filename> die Variable
1706 <literal>opendocument</literal> im Abschnitt
1707 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1708 Dieses ist die Standardeinstellung.</para>
1710 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1711 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1712 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1713 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1714 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1715 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1717 <para>Nach der Installation müssen in der Datei
1718 <filename>config/kivitendo.conf</filename> zwei weitere Variablen
1719 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1720 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1721 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1722 enthalten. Beide stehen im Abschnitt
1723 <literal>applications</literal>.</para>
1725 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
1726 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1727 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1728 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1729 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1730 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1731 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1732 werden muss. Der Nachteil ist, dass diese Methode Python und die
1733 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1738 Für die Verbindung zu OpenOffice wird normalerweise der Python-Interpreter <filename>/usr/bin/python</filename> benutzt. Sollte
1739 dies nicht der richtige sein, so kann man mit zwei Konfigurationsvariablen entscheiden, welcher Python-Interpreter genutzt
1740 wird. Mit der Option <literal>python_uno</literal> aus dem Abschnitt <literal>applications</literal> wird der Interpreter selber
1741 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert <literal>/usr/bin/python</literal>.
1745 Zusätzlich ist es möglich, Pfade anzugeben, in denen Python neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
1746 z.B. falls sich diese in einem gesonderten OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
1747 <literal>python_uno_path</literal> und befindet sich im Abschnitt <literal>environment</literal>. Sie ist standardmäßig
1748 leer. Werden hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte voneinander getrennt werden. Der Inhalt wird an den
1749 Python-Interpreter über die Umgebungsvariable <literal>PYTHONPATH</literal> übergeben.
1753 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1754 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1755 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1756 Dokumentenvorlage enthalten sein und
1757 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1758 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1759 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1760 ebenfalls enthalten sein muss.</para>
1762 <para>Als letztes muss herausgefunden werden, welchen Namen
1763 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1764 gibt. Unter Debian ist dies momentan
1765 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1766 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1767 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1768 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1769 folgender Befehl auszuführen:</para>
1771 <para><literal>mv users/.openoffice.org2
1772 users/.openoffice</literal></para>
1774 <para>Dieses Verzeichnis, wie auch das komplette
1775 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1776 sein. Dieses wurde bereits erledigt (siehe <xref
1777 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1778 erneut überprüft werden, wenn die Konvertierung nach PDF
1782 <sect1 id="config.eur">
1783 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1786 <sect2 id="config.eur.introduction"
1787 xreflabel="Einführung in die Konfiguration zur EUR">
1788 <title>Einführung</title>
1790 <para>kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1791 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals noch <filename>config/lx_office.conf</filename>)
1792 befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden.</para>
1794 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1795 die Mandantendatenbank verschoben und dabei auch gleich in drei
1796 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1797 steuern lässt.</para>
1800 <sect2 id="config.eur.parameters"
1801 xreflabel="Konfigurationsparameter für EUR">
1802 <title>Konfigurationsparameter</title>
1804 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1805 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1809 <term><varname>profit_determination</varname></term>
1812 <para>Dieser Parameter legt die Berechnungsmethode für die
1813 Gewinnermittlung fest. Er enthält entweder
1814 <literal>balance</literal> für
1815 Betriebsvermögensvergleich/Bilanzierung oder
1816 <literal>income</literal> für die
1817 Einnahmen-Überschuss-Rechnung.</para>
1822 <term><varname>accounting_method</varname></term>
1825 <para>Dieser Parameter steuert die Buchungs- und
1826 Berechnungsmethoden für die Versteuerungsart. Er enthält
1827 entweder <literal>accrual</literal> für die Soll-Versteuerung
1828 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1833 <term><varname>inventory_system</varname></term>
1836 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1837 enthält entweder <literal>perpetual</literal> für die
1838 Bestandsmethode oder <literal>periodic</literal> für die
1839 Aufwandsmethode.</para>
1844 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1845 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1846 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1847 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1848 Bestandsmethode.</para>
1850 <para>Die Konfiguration "<varname>eur</varname>" unter
1851 <varname>[system]</varname> in der <link
1852 linkend="config.config-file">Konfigurationsdatei</link>
1853 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
1854 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1857 <sect2 id="config.eur.setting-parameters">
1858 <title>Festlegen der Parameter</title>
1860 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1861 der Admininstration können diese Optionen nun unabhängig voneinander
1862 eingestellt werden.</para>
1864 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1865 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1868 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1869 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
1870 angezeigt. Unter <guimenu>System</guimenu>
1871 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> können
1872 die Einstellungen auch geändert werden. Dabei ist zu beachten,
1873 dass eine Änderung vorhandene Daten so belässt und damit
1874 evtl. die Ergebnisse verfälscht. Dies gilt vor Allem für die
1875 Warenbuchungsmethode (siehe auch
1876 <link linkend="config.eur.inventory-system-perpetual">
1877 Bemerkungen zu Bestandsmethode</link>).</para>
1880 <sect2 id="config.eur.inventory-system-perpetual">
1881 <title>Bemerkungen zu Bestandsmethode</title>
1883 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1884 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
1885 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1886 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1887 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1888 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1889 Einkaufsrechnungen berechnet wird.</para>
1891 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1892 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1893 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1897 <sect2 id="config.eur.knonw-issues">
1898 <title>Bekannte Probleme</title>
1900 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1901 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1902 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1903 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1904 die Konfigurationsvariable
1905 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1908 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1909 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1913 <sect1 id="config.skr04-update-3804">
1914 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1916 <sect2 id="config.skr04-update-3804.introduction">
1917 <title>Einführung</title>
1919 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1920 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1921 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1922 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1923 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1924 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1925 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1926 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1927 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1928 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1929 Screenshots dargestellt.</para>
1931 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1932 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1933 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1934 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1937 <sect2 id="config.skr04-update-3804.create-chart">
1938 <title>Konto 3804 manuell anlegen</title>
1940 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
1941 anzulegen und zu konfigurieren. Zuerst wird in
1942 <guimenu>System</guimenu> ->
1943 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
1944 erfassen</guimenuitem> das Konto angelegt.</para>
1947 <screeninfo>Konto 3804 erfassen</screeninfo>
1951 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
1957 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
1958 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
1959 wie im folgenden Screenshot angezeigt anpassen.
1963 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
1967 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
1973 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
1974 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
1978 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
1982 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
1988 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
1989 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
1990 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
1991 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
1995 <screeninfo>Konto 4315 anpassen</screeninfo>
1999 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
2005 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
2006 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
2010 <screeninfo>Steuerliste vergleichen</screeninfo>
2014 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
2021 <title>Verhalten des Bilanzberichts</title>
2023 Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als Grundlage für das
2024 Startdatum benutzt. Schließt man die Bücher allerdings monatsweise führt dies
2025 zu falschen Werten.</para>
2026 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau einstellen indem man:</para>
2029 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu vorher)</para>
2032 <para>immer den Jahresanfang nimmt (1.1. relativ zum Stichtag)</para>
2035 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
2036 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen gibt</para>
2037 <para>- oder mit "alle Buchungen" als Alternative"</para>
2040 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen gibt </para>
2043 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
2046 Folgende Hinweise zu den Optionen:
2047 Das "Bücher schließen Datum" ist sinnvoll, wenn man nur komplette Jahre
2048 schließt. Bei Wirtschaftsjahr = Kalendarjahr entspricht dies aber auch
2050 "Alle Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
2052 Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B. sinnvoll, wenn man
2053 am sich Anfang des zweiten Buchungsjahres befindet, und noch keinen
2054 Jahreswechsel und auch noch keine EB-Buchungen hat.
2055 Bei den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1. Tag
2056 des Wirtschaftsjahres gebucht werden.
2057 Zur Sicherheit wird das Startdatum im Bilanzbericht jetzt zusätzlich zum
2058 Stichtag mit angezeigt. Das hilft auch bei der Kontrolle für den
2059 Abgleich mit der GuV.
2061 <sect1 id="config.client">
2062 <title>Einstellungen pro Mandant</title>
2064 <para>Einige Einstellungen können von einem Benutzer mit dem
2065 <link linkend="Zusammenhänge">Recht</link> "Administration
2066 (Für die Verwaltung der aktuellen Instanz aus einem Userlogin heraus)"
2067 gemacht werden. Diese Einstellungen sind dann für die aktuellen
2068 Mandanten-Datenbank gültig. Die Einstellungen sind
2069 unter <guimenu>System</guimenu>
2070 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
2072 <para>Bitte beachten Sie die Hinweise zu den einzelnen
2073 Einstellungen. Einige Einstellungen sollten nicht ohne Weiteres
2074 im laufenden Betrieb geändert werden (siehe
2075 auch <link linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
2076 Bestandsmethode</link>).</para>
2078 <para>Die Einstellungen <literal>show_bestbefore</literal>
2079 und <literal>payments_changeable</literal> aus dem
2080 Abschnitt <literal>features</literal> und die Einstellungen im
2081 Abschnitt <literal>datev_check</literal> (sofern schon vorhanden)
2082 der <link linkend="config.config-file">kivitendo-Konfigurationsdatei</link>
2083 werden bei einem Datenbankupdate einer älteren Version automatisch
2084 übernommen. Diese Einträge können danach aus der Konfigurationsdatei
2085 entfernt werden.</para>
2088 <sect1 id="kivitendo-ERP-verwenden">
2089 <title>kivitendo ERP verwenden</title>
2091 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
2092 folgender URL erreichbar:</para>
2095 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
2097 <para>Die Administrationsseite erreichen Sie unter:</para>
2100 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
2104 <chapter id="features" xreflabel="Features und Funktionen">
2105 <title>Features und Funktionen</title>
2107 <sect1 id="features.periodic-invoices"
2108 xreflabel="Wiedekehrende Rechnungen">
2109 <title>Wiederkehrende Rechnungen</title>
2111 <sect2 id="features.periodic-invoices.introduction"
2112 xreflabel="Einführung in wiederkehrende Rechnungen">
2113 <title>Einführung</title>
2115 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
2116 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
2117 Die konfigurierten Aufträge werden später automatisch in Rechnungen
2118 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
2119 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
2120 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
2121 wiederzufinden sind.</para>
2124 <sect2 id="features.periodic-invoices.configuration"
2125 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
2126 <title>Konfiguration</title>
2128 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
2129 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
2130 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
2131 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
2132 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
2135 <para>Folgende Parameter kann man konfigurieren:</para>
2142 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
2143 erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
2144 neuen Monats).</para>
2146 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
2147 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
2148 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
2149 nächsten Periodenwechsel für alle Perioden, seit der letzten
2150 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
2151 verhindern, muss man vorher das Startdatum neu setzen.</para>
2153 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
2154 erstellt. Man kann sich diese Aufträge aber gesondert in den
2155 Berichten anzeigen lassen.</para>
2160 <term>Periodizität</term>
2163 <para>Ob monatlich, quartalsweise oder jährlich auf neue
2164 Rechnungen überprüft werden soll. Für jede Periode seit dem
2165 Startdatum wird überprüft, ob für die Periode (beginnend immer
2166 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
2167 wurde. Unter Umständen können bei einem Startdatum in der
2168 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
2173 <term>Buchen auf</term>
2176 <para>Das Forderungskonto, in der Regel "Forderungen aus
2177 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
2178 Buchungsgruppen der betreffenden Waren.</para>
2183 <term>Startdatum</term>
2186 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
2192 <term>Enddatum</term>
2195 <para>ab wann keine Rechnungen mehr erstellt werden
2201 <term>Automatische Verlängerung um x Monate</term>
2204 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
2205 eingetragenen Enddatums weiterhin erstellt werden, so kann man
2206 hier die Anzahl der Monate eingeben, um die das Enddatum
2207 automatisch nach hinten geschoben wird.</para>
2212 <term>Drucken</term>
2215 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
2216 Rechnungen auch gleich ausdrucken lassen.</para>
2221 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
2222 Informationen zu den erstellten Rechnungen verschickt werden.
2223 Konfiguriert wird dies in der <link
2224 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
2225 <filename>config/kivitendo.conf</filename> im Abschnitt
2226 <varname>[periodic_invoices]</varname>.</para>
2229 <sect2 id="features.periodic-invoices.variables">
2230 <title>Spezielle Variablen</title>
2233 Um die erzeugten Rechnungen individualisieren zu können, werden beim Umwandeln des Auftrags in eine Rechnung einige speziell
2234 formatierte Variablen durch für die jeweils aktuelle Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B. den
2235 Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei die Syntax <literal><%variablenname%></literal>.
2239 Sofern es sich um eine Datumsvariable handelt, kann das Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
2240 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus: <literal><%variablenname
2241 FORMAT=Formatinformation%></literal>. Die zur verfügung stehenden Formatinformationen werden unten genauer beschrieben.
2245 Diese Variablen werden in den folgenden Elementen des Auftrags ersetzt:
2249 <listitem><para>Bemerkungen</para></listitem>
2250 <listitem><para>Interne Bemerkungen</para></listitem>
2251 <listitem><para>Vorgangsbezeichnung</para></listitem>
2252 <listitem><para>In den Beschreibungs- und Langtextfeldern aller Positionen</para></listitem>
2255 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
2259 <term><varname><%current_quarter%></varname>, <varname><%previous_quarter%></varname>, <varname><%next_quarter%></varname></term>
2263 Aktuelles, vorheriges und nächstes Quartal als Zahl zwischen <literal>1</literal> und <literal>4</literal>.
2269 <term><varname><%current_month%></varname>, <varname><%previous_month%></varname>, <varname><%next_month%></varname></term>
2273 Aktueller, vorheriger und nächster Monat als Zahl zwischen <literal>1</literal> und <literal>12</literal>.
2279 <term><varname><%current_month_long%></varname>, <varname><%previous_month_long%></varname>, <varname><%next_month_long%></varname></term>
2283 Aktueller, vorheriger und nächster Monat als Name (<literal>Januar</literal>, <literal>Februar</literal> etc.).
2289 <term><varname><%current_year%></varname>, <varname><%previous_year%></varname>, <varname><%next_year%></varname></term>
2293 Aktuelles, vorheriges und nächstes Jahr als vierstellige Jahreszahl (<literal>2013</literal> etc.).
2299 <term><varname><%period_start_date%></varname>, <varname><%period_end_date%></varname></term>
2303 Formatiertes Datum des ersten und letzten Tages im Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im ersten
2304 Quartal von 2013 wären dies der <literal>01.01.2013</literal> und <literal>31.03.2013</literal>).
2311 Die invidiuellen Formatinformationen bestehen aus Paaren von Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
2312 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal> durch das viertstellige Jahr ersetzt. Alle möglichen
2319 <term><varname>%a</varname></term>
2322 <para>Der abgekürzte Wochentagsname.</para>
2327 <term><varname>%A</varname></term>
2330 <para>Der ausgeschriebene Wochentagsname.</para>
2335 <term><varname>%b</varname></term>
2338 <para>Der abgekürzte Monatsname.</para>
2343 <term><varname>%B</varname></term>
2346 <para>Der ausgeschriebene Monatsname.</para>
2351 <term><varname>%C</varname></term>
2354 <para>Das Jahrhundert (Jahr/100) als eine zweistellige Zahl.</para>
2359 <term><varname>%d</varname></term>
2362 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
2367 <term><varname>%D</varname></term>
2370 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
2375 <term><varname>%e</varname></term>
2378 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings werden führende Nullen durch Leerzeichen ersetzt.</para>
2383 <term><varname>%F</varname></term>
2386 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
2391 <term><varname>%j</varname></term>
2394 <para>Der Tag im Jahr als Zahl zwischen 001 und 366 inklusive.</para>
2399 <term><varname>%m</varname></term>
2402 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
2407 <term><varname>%u</varname></term>
2410 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei die 1 dem Montag entspricht.</para>
2415 <term><varname>%U</varname></term>
2418 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive, wobei der erste Sonntag im Jahr das Startdatum von Woche 01 ist.</para>
2423 <term><varname>%V</varname></term>
2426 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53 inklusive, wobei Woche 01 die erste Woche, von der mindestens vier Tage im Jahr liegen; Montag ist erster Tag der Woche.</para>
2431 <term><varname>%w</varname></term>
2434 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei die 0 dem Sonntag entspricht.</para>
2439 <term><varname>%W</varname></term>
2442 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive, wobei der erste Montag im Jahr das Startdatum von Woche 01 ist.</para>
2447 <term><varname>%y</varname></term>
2450 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99 inklusive.</para>
2455 <term><varname>%Y</varname></term>
2458 <para>Das Jahr als vierstellige Zahl.</para>
2463 <term><varname>%%</varname></term>
2466 <para>Das Prozentzeichen selber.</para>
2472 Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode
2473 dauert: <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%> bis <%period_end_date FORMAT=%m/%Y%></literal>
2477 <sect2 id="features.periodic-invoices.reports">
2478 <title>Auflisten</title>
2480 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
2481 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
2482 Rechnungen inaktiv", mit denen man sich einen Überglick über die
2483 wiederkehrenden Rechnungen verschaffen kann.</para>
2486 <sect2 id="features.periodic-invoices.task-server">
2487 <title>Erzeugung der eigentlichen Rechnungen</title>
2489 <para>Die zeitliche und periodische Überprüfung, ob eine
2490 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
2491 durch den <link linkend="config.task-server">Taskserver</link>, einen
2492 externen Dienst, der automatisch beim Start des Servers gestartet
2493 werden sollte.</para>
2496 <sect2 id="features.periodic-invoices.create-for-current-month">
2497 <title>Erste Rechnung für aktuellen Monat erstellen</title>
2499 <para>Will man im laufenden Monat eine monatlich wiederkehrende
2500 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
2501 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
2502 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
2503 generiert hat. Alternativ setzt man das Startdatum auf den
2504 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
2505 manuell über den Workflow.</para>
2508 <sect1 id="dokumentenvorlagen-und-variablen">
2509 <title>Dokumentenvorlagen und verfügbare Variablen</title>
2511 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
2512 <title>Einführung</title>
2514 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
2515 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
2516 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
2517 <function><%variablenname%></function> verwendet wird. Für
2518 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
2520 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
2522 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
2523 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
2524 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
2525 alle Vorlagenarten.</para>
2527 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
2528 verfügbar als hier aufgelistet werden. Die meisten davon können
2529 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
2530 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
2531 diese wie folgt erhalten werden:</para>
2535 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
2536 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
2540 <para>In <filename>Form.pm</filename> die Funktion
2541 <function>parse_template</function> suchen und hier die Zeile
2542 <command>print(STDERR Dumper($self));</command> einfügen.</para>
2546 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
2547 ein PDF für eine Rechnung erzeugen.</para>
2551 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
2552 der Variablen <varname>$self</varname> in der Form <varname>'key'
2553 => 'value',</varname>. Alle <varname>key</varname>s sind
2559 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
2560 <title>Variablen ausgeben</title>
2562 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
2563 Tags geschrieben werden, also z.B.
2564 <varname><%variablenname%></varname>.</para>
2566 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
2567 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
2568 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
2569 werden die folgenden Flags unterstützt:</para>
2573 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
2574 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
2575 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
2576 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
2580 <para><option>NOESCAPE</option> unterdrückt das Escapen von
2581 Sonderzeichen für die Vorlagensprache. Wenn also in einer
2582 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
2583 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
2584 ist dieses Flag sinnvoll.</para>
2588 <para>Beispiel:</para>
2590 <programlisting><%quototal NOFORMAT%></programlisting>
2593 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
2594 <title>Verwendung in Druckbefehlen</title>
2596 <para>In der Admininstration können Drucker definiert werden. Auch im
2597 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
2598 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
2599 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
2600 <function>`...`</function> nicht zu unerwünschtem Verhalten
2603 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
2604 für das die Telefonnummer eines Ansprechpartners als Teil der
2605 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
2606 z.B. wie folgt aussehen:</para>
2608 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
2611 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
2612 xreflabel="Anfang und Ende der Tags verändern">
2613 <title>Anfang und Ende der Tags verändern</title>
2615 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
2616 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
2617 Prozentzeichen und dem Größerzeichen endet, beispielsweise
2618 <function><%customer%></function>. Da diese Form aber z.B. in
2619 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
2620 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
2621 Stil umgestellt werden.</para>
2623 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
2624 Format gültigen Kommentarzeichen anfangen, dann
2625 <function>config:</function> enthalten, die entsprechende Option
2626 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
2627 enden. Beispiel für LaTeX:</para>
2629 <programlisting>% config: tag-style=($ $)</programlisting>
2631 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
2632 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
2633 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
2635 <programlisting><!-- config: tag-style=($ $) --></programlisting>
2638 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
2639 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
2641 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
2642 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
2643 "<filename>.ext</filename>" geeignet zu ersetzen:
2644 "<filename>.tex</filename>" für LaTeX-Vorlagen und
2645 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
2649 <term><filename>bin_list.ext</filename></term>
2652 <para>Lagerliste</para>
2657 <term><filename>check.ext</filename></term>
2665 <term><filename>invoice.ext</filename></term>
2668 <para>Rechnung</para>
2673 <term><filename>packing_list.ext</filename></term>
2676 <para>Packliste</para>
2681 <term><filename>pick_list.ext</filename></term>
2684 <para>Sammelliste</para>
2689 <term><filename>purchase_delivery_order.ext</filename></term>
2692 <para>Lieferschein (Einkauf)</para>
2697 <term><filename>purcharse_order.ext</filename></term>
2700 <para>Bestellung an Lieferanten</para>
2705 <term><filename>request_quotation.ext</filename></term>
2708 <para>Anfrage an Lieferanten</para>
2713 <term><filename>sales_delivery_order.ext</filename></term>
2716 <para>Lieferschein (Verkauf)</para>
2721 <term><filename>sales_order.ext</filename></term>
2724 <para>Bestellung</para>
2729 <term><filename>sales_quotation.ext</filename></term>
2732 <para>Angebot an Kunden</para>
2737 <term><filename>zahlungserinnerung.ext</filename></term>
2740 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2745 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2748 <para>Rechnung über Mahngebühren (Dateiname im Programm
2749 konfigurierbar)</para>
2755 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2756 <title>Sprache, Drucker und E-Mail</title>
2758 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2759 eingearbeitet. So wird aus der Vorlage
2760 <filename>sales_order.ext</filename> bei Sprache
2761 <function>de</function> und Druckerkürzel <function>lpr2</function>
2762 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2763 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2764 bekommen dann noch das Kürzel <filename>_email</filename>, der
2765 vollständige Vorlagenname wäre dann
2766 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2767 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2768 werden. Diese wird verwendet, wenn keine der anderen Varianten
2769 gefunden wird.</para>
2771 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2772 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2773 verschickt wird, ist:</para>
2777 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2781 <para><filename>sales_order_de_lpr2.tex</filename></para>
2785 <para><filename>sales_order.tex</filename></para>
2789 <para><filename>default.tex</filename></para>
2793 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2794 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2796 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2799 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2800 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2803 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2804 xreflabel="Metainformationen zur angeforderten Vorlage">
2805 <title>Metainformationen zur angeforderten Vorlage</title>
2807 <para>Diese Variablen liefern Informationen darüber welche Variante
2808 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2809 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2810 Formulare einbinden möchten.</para>
2814 <term><varname>template_meta.formname</varname></term>
2817 <para>Basisname der Vorlage. Identisch mit der <link
2818 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2819 zu den Dateinamen</link> ohne die Erweiterung. Ein
2820 Verkaufsauftrag enthält hier
2821 <constant>sales_order</constant>.</para>
2826 <term><varname>template_meta.language.description</varname></term>
2829 <para>Beschreibung der verwendeten Sprache</para>
2834 <term><varname>template_meta.language.template_code</varname></term>
2837 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2838 Kürzel das im Dateinamen verwendetet wird.</para>
2843 <term><varname>template_meta.language.output_numberformat</varname></term>
2846 <para>Zahlenformat der verwendeten Sprache in der Form
2847 "<constant>1.000,00</constant>". Experimentell! Nur
2848 interessant für Vorlagen die mit unformatierten Werten
2854 <term><varname>template_meta.language.output_dateformat</varname></term>
2857 <para>Datumsformat der verwendeten Sprache in der Form
2858 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2859 interessant für Vorlagen die mit unformatierten Werten
2865 <term><varname>template_meta.format</varname></term>
2868 <para>Das angeforderte Format. Kann im Moment die Werte
2869 <constant>pdf</constant>, <constant>postscript</constant>,
2870 <constant>html</constant>, <constant>opendocument</constant>,
2871 <constant>opendocument_pdf</constant> und
2872 <constant>excel</constant> enthalten.</para>
2877 <term><varname>template_meta.extension</varname></term>
2880 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2881 <constant>format</constant> entschieden.</para>
2886 <term><varname>template_meta.media</varname></term>
2889 <para>Ausgabemedium. Kann zur Zeit die Werte
2890 <constant>screen</constant> für Bildschirm,
2891 <constant>email</constant> für E-Mmail (triggert das
2892 <constant>_email</constant> Kürzel im Dateinamen),
2893 <constant>printer</constant> für Drucker, und
2894 <constant>queue</constant> für Warteschlange enthalten.</para>
2899 <term><varname>template_meta.printer.description</varname></term>
2902 <para>Beschreibung des ausgewählten Druckers</para>
2907 <term><varname>template_meta.printer.template_code</varname></term>
2910 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2911 dem Kürzel das im Dateinamen verwendetet wird.</para>
2916 <term><varname>template_meta.tmpfile</varname></term>
2919 <para>Datei-Prefix für temporäre Dateien.</para>
2925 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2926 <title>Stammdaten von Kunden und Lieferanten</title>
2930 <term><varname>account_number</varname></term>
2933 <para>Kontonummer</para>
2938 <term><varname>bank</varname></term>
2941 <para>Name der Bank</para>
2946 <term><varname>bank_code</varname></term>
2949 <para>Bankleitzahl</para>
2954 <term><varname>bic</varname></term>
2957 <para>Bank-Identifikations-Code (Bank Identifier Code,
2963 <term><varname>business</varname></term>
2966 <para>Kunden-/Lieferantentyp</para>
2971 <term><varname>city</varname></term>
2979 <term><varname>contact</varname></term>
2982 <para>Kontakt</para>
2987 <term><varname>country</varname></term>
2995 <term><varname>c_vendor_id</varname></term>
2998 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
3003 <term><varname>v_customer_id</varname></term>
3006 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
3011 <term><varname>cp_email</varname></term>
3014 <para>Email des Ansprechpartners</para>
3019 <term><varname>cp_givenname</varname></term>
3022 <para>Vorname des Ansprechpartners</para>
3027 <term><varname>cp_greeting</varname></term>
3030 <para>Anrede des Ansprechpartners</para>
3035 <term><varname>cp_name</varname></term>
3038 <para>Name des Ansprechpartners</para>
3043 <term><varname>cp_phone1</varname></term>
3046 <para>Telefonnummer 1 des Ansprechpartners</para>
3051 <term><varname>cp_phone2</varname></term>
3054 <para>Telefonnummer 2 des Ansprechpartners</para>
3059 <term><varname>cp_title</varname></term>
3062 <para>Titel des Ansprechpartners</para>
3067 <term><varname>creditlimit</varname></term>
3070 <para>Kreditlimit</para>
3075 <term><varname>customeremail</varname></term>
3078 <para>Email des Kunden; nur für Kunden</para>
3083 <term><varname>customerfax</varname></term>
3086 <para>Faxnummer des Kunden; nur für Kunden</para>
3091 <term><varname>customernotes</varname></term>
3094 <para>Bemerkungen beim Kunden; nur für Kunden</para>
3099 <term><varname>customernumber</varname></term>
3102 <para>Kundennummer; nur für Kunden</para>
3107 <term><varname>customerphone</varname></term>
3110 <para>Telefonnummer des Kunden; nur für Kunden</para>
3115 <term><varname>discount</varname></term>
3123 <term><varname>email</varname></term>
3126 <para>Emailadresse</para>
3131 <term><varname>fax</varname></term>
3134 <para>Faxnummer</para>
3139 <term><varname>homepage</varname></term>
3142 <para>Homepage</para>
3147 <term><varname>iban</varname></term>
3150 <para>Internationale Kontonummer (International Bank Account
3151 Number, IBAN)</para>
3156 <term><varname>language</varname></term>
3159 <para>Sprache</para>
3164 <term><varname>name</varname></term>
3167 <para>Firmenname</para>
3172 <term><varname>payment_description</varname></term>
3175 <para>Name der Zahlart</para>
3180 <term><varname>payment_terms</varname></term>
3183 <para>Zahlungskonditionen</para>
3188 <term><varname>phone</varname></term>
3191 <para>Telefonnummer</para>
3196 <term><varname>shiptocity</varname></term>
3199 <para>Stadt (Lieferadresse) <link
3200 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3205 <term><varname>shiptocontact</varname></term>
3208 <para>Kontakt (Lieferadresse) <link
3209 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3214 <term><varname>shiptocountry</varname></term>
3217 <para>Land (Lieferadresse) <link
3218 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3223 <term><varname>shiptodepartment1</varname></term>
3226 <para>Abteilung 1 (Lieferadresse) <link
3227 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3232 <term><varname>shiptodepartment2</varname></term>
3235 <para>Abteilung 2 (Lieferadresse) <link
3236 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3241 <term><varname>shiptoemail</varname></term>
3244 <para>Email (Lieferadresse) <link
3245 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3250 <term><varname>shiptofax</varname></term>
3253 <para>Fax (Lieferadresse) <link
3254 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3259 <term><varname>shiptoname</varname></term>
3262 <para>Firmenname (Lieferadresse) <link
3263 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3268 <term><varname>shiptophone</varname></term>
3271 <para>Telefonnummer (Lieferadresse) <link
3272 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3277 <term><varname>shiptostreet</varname></term>
3280 <para>Straße und Hausnummer (Lieferadresse) <link
3281 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3286 <term><varname>shiptozipcode</varname></term>
3289 <para>Postleitzahl (Lieferadresse) <link
3290 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3295 <term><varname>street</varname></term>
3298 <para>Straße und Hausnummer</para>
3303 <term><varname>taxnumber</varname></term>
3306 <para>Steuernummer</para>
3311 <term><varname>ustid</varname></term>
3314 <para>Umsatzsteuer-Identifikationsnummer</para>
3319 <term><varname>vendoremail</varname></term>
3322 <para>Email des Lieferanten; nur für Lieferanten</para>
3327 <term><varname>vendorfax</varname></term>
3330 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
3335 <term><varname>vendornotes</varname></term>
3338 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
3343 <term><varname>vendornumber</varname></term>
3346 <para>Lieferantennummer; nur für Lieferanten</para>
3351 <term><varname>vendorphone</varname></term>
3354 <para>Telefonnummer des Lieferanten; nur für
3360 <term><varname>zipcode</varname></term>
3363 <para>Postleitzahl</para>
3368 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
3369 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
3370 Stammdaten nicht eingetragen, so haben die Variablen
3371 <varname>shipto*</varname> den gleichen Wert wie die die
3372 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
3373 einige <varname>shipto*</varname>-Variablen so nicht in den
3374 Stammdaten wiederfinden sondern schlicht Kopien der
3375 Lieferdatenvariablen sind (z.B.
3376 <varname>shiptocontact</varname>).</para>
3380 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
3381 <title>Informationen über den Bearbeiter</title>
3385 <term><varname>employee_address</varname></term>
3388 <para>Adressfeld</para>
3393 <term><varname>employee_businessnumber</varname></term>
3396 <para>Firmennummer</para>
3401 <term><varname>employee_company</varname></term>
3404 <para>Firmenname</para>
3409 <term><varname>employee_co_ustid</varname></term>
3412 <para>Usatzsteuer-Identifikationsnummer</para>
3417 <term><varname>employee_duns</varname></term>
3420 <para>DUNS-Nummer</para>
3425 <term><varname>employee_email</varname></term>
3433 <term><varname>employee_fax</varname></term>
3441 <term><varname>employee_name</varname></term>
3444 <para>voller Name</para>
3449 <term><varname>employee_signature</varname></term>
3452 <para>Signatur</para>
3457 <term><varname>employee_taxnumber</varname></term>
3460 <para>Steuernummer</para>
3465 <term><varname>employee_tel</varname></term>
3468 <para>Telefonnummer</para>
3474 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
3475 <title>Informationen über den Verkäufer</title>
3479 <term><varname>salesman_address</varname></term>
3482 <para>Adressfeld</para>
3487 <term><varname>salesman_businessnumber</varname></term>
3490 <para>Firmennummer</para>
3495 <term><varname>salesman_company</varname></term>
3498 <para>Firmenname</para>
3503 <term><varname>salesman_co_ustid</varname></term>
3506 <para>Usatzsteuer-Identifikationsnummer</para>
3511 <term><varname>salesman_duns</varname></term>
3514 <para>DUNS-Nummer</para>
3519 <term><varname>salesman_email</varname></term>
3527 <term><varname>salesman_fax</varname></term>
3535 <term><varname>salesman_name</varname></term>
3538 <para>voller Name</para>
3543 <term><varname>salesman_signature</varname></term>
3546 <para>Signatur</para>
3551 <term><varname>salesman_taxnumber</varname></term>
3554 <para>Steuernummer</para>
3559 <term><varname>salesman_tel</varname></term>
3562 <para>Telefonnummer</para>
3568 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
3569 <title>Variablen für die einzelnen Steuern</title>
3573 <term><varname>tax</varname></term>
3581 <term><varname>taxbase</varname></term>
3584 <para>zu versteuernder Betrag</para>
3589 <term><varname>taxdescription</varname></term>
3592 <para>Name der Steuer</para>
3597 <term><varname>taxrate</varname></term>
3600 <para>Steuersatz</para>
3606 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
3607 <title>Variablen für Lieferbedingungen</title>
3611 <term><varname>delivery_term</varname></term>
3612 <listitem><para>Datenbank-Objekt der Lieferbedingung</para></listitem>
3615 <term><varname>delivery_term.description</varname></term>
3616 <listitem><para>Beschreibung der Lieferbedingung</para></listitem>
3619 <term><varname>delivery_term.description_long</varname></term>
3620 <listitem><para>Langtext bzw. übersetzter Langtext der Lieferbedingung</para></listitem>
3626 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
3627 <title>Variablen in Rechnungen</title>
3629 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
3630 <title>Allgemeine Variablen</title>
3634 <term><varname>creditremaining</varname></term>
3637 <para>Verbleibender Kredit</para>
3642 <term><varname>currency</varname></term>
3645 <para>Währung</para>
3650 <term><varname>cusordnumber</varname></term>
3653 <para>Bestellnummer beim Kunden</para>
3658 <term><varname>deliverydate</varname></term>
3661 <para>Lieferdatum</para>
3666 <term><varname>duedate</varname></term>
3669 <para>Fälligkeitsdatum</para>
3674 <term><varname>globalprojectnumber</varname></term>
3677 <para>Projektnummer des ganzen Beleges</para>
3682 <term><varname>globalprojectdescription</varname></term>
3685 <para>Projekbeschreibung des ganzen Beleges</para>
3690 <term><varname>intnotes</varname></term>
3693 <para>Interne Bemerkungen</para>
3698 <term><varname>invdate</varname></term>
3701 <para>Rechnungsdatum</para>
3706 <term><varname>invnumber</varname></term>
3709 <para>Rechnungsnummer</para>
3714 <term><varname>invtotal</varname></term>
3717 <para>gesamter Rechnungsbetrag</para>
3722 <term><varname>notes</varname></term>
3725 <para>Bemerkungen der Rechnung</para>
3730 <term><varname>orddate</varname></term>
3733 <para>Auftragsdatum</para>
3738 <term><varname>ordnumber</varname></term>
3741 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3742 erstellt wurde</para>
3747 <term><varname>payment_description</varname></term>
3750 <para>Name der Zahlart</para>
3755 <term><varname>payment_terms</varname></term>
3758 <para>Zahlungskonditionen</para>
3763 <term><varname>quodate</varname></term>
3766 <para>Angebotsdatum</para>
3771 <term><varname>quonumber</varname></term>
3774 <para>Angebotsnummer</para>
3779 <term><varname>shippingpoint</varname></term>
3782 <para>Versandort</para>
3787 <term><varname>shipvia</varname></term>
3790 <para>Transportmittel</para>
3795 <term><varname>subtotal</varname></term>
3798 <para>Zwischensumme aller Posten ohne Steuern</para>
3803 <term><varname>total</varname></term>
3806 <para>Restsumme der Rechnung (Summe abzüglich bereits
3807 bezahlter Posten)</para>
3812 <term><varname>transaction_description</varname></term>
3815 <para>Vorgangsbezeichnung</para>
3820 <term><varname>transdate</varname></term>
3823 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3824 erstellt wurde</para>
3830 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3831 <title>Variablen für jeden Posten auf der Rechnung</title>
3835 <term><varname>bin</varname></term>
3838 <para>Stellage</para>
3843 <term><varname>description</varname></term>
3846 <para>Artikelbeschreibung</para>
3851 <term><varname>discount</varname></term>
3854 <para>Rabatt als Betrag</para>
3859 <term><varname>discount_sub</varname></term>
3862 <para>Zwischensumme mit Rabatt</para>
3867 <term><varname>drawing</varname></term>
3870 <para>Zeichnung</para>
3875 <term><varname>ean</varname></term>
3878 <para>EAN-Code</para>
3883 <term><varname>image</varname></term>
3891 <term><varname>linetotal</varname></term>
3894 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3899 <term><varname>longdescription</varname></term>
3902 <para>Langtext</para>
3907 <term><varname>microfiche</varname></term>
3910 <para>Mikrofilm</para>
3915 <term><varname>netprice</varname></term>
3918 <para>Alternative zu <varname>sellprice</varname>, aber <varname>netprice</varname> entspricht dem effektiven Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor. <varname>netprice</varname> wird rückgerechnet aus Zeilensumme / Menge. Diese Variable ist nützlich, wenn man den gewährten Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge * Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll. <varname>netprice</varname> hat nichts mit Netto/Brutto im Sinne von Steuern zu tun.</para>
3923 <term><varname>nodiscount_linetotal</varname></term>
3926 <para>Zeilensumme ohne Rabatt</para>
3931 <term><varname>nodiscount_sub</varname></term>
3934 <para>Zwischensumme ohne Rabatt</para>
3939 <term><varname>number</varname></term>
3942 <para>Artikelnummer</para>
3947 <term><varname>ordnumber_oe</varname></term>
3950 <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
3951 aus einem Sammelauftrag erstellt wurde</para>
3956 <term><varname>donumber_do</varname></term>
3959 <para>Lieferscheinnummer desjenigen Lieferscheins, aus dem die Position stammt, sofern die Rechnung aus einem oder
3960 mehreren Lieferscheinen erstellt wurde</para>
3965 <term><varname>p_discount</varname></term>
3968 <para>Rabatt in Prozent</para>
3973 <term><varname>partnotes</varname></term>
3976 <para>Die beim Artikel gespeicherten Bemerkungen</para>
3981 <term><varname>partsgroup</varname></term>
3984 <para>Warengruppe</para>
3989 <term><varname>price_factor</varname></term>
3992 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
3998 <term><varname>price_factor_name</varname></term>
4001 <para>Der Name des Preisfaktors, sofern einer eingestellt
4007 <term><varname>projectnumber</varname></term>
4010 <para>Projektnummer</para>
4015 <term><varname>projectdescription</varname></term>
4018 <para>Projektbeschreibung</para>
4023 <term><varname>qty</varname></term>
4031 <term><varname>reqdate</varname></term>
4034 <para>Lieferdatum</para>
4039 <term><varname>runningnumber</varname></term>
4042 <para>Position auf der Rechnung (1, 2, 3...)</para>
4047 <term><varname>sellprice</varname></term>
4050 <para>Verkaufspreis</para>
4055 <term><varname>serialnumber</varname></term>
4058 <para>Seriennummer</para>
4063 <term><varname>tax_rate</varname></term>
4066 <para>Steuersatz</para>
4071 <term><varname>transdate_oe</varname></term>
4074 <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
4075 aus einem Sammelauftrag erstellt wurde</para>
4080 <term><varname>unit</varname></term>
4083 <para>Einheit</para>
4088 <term><varname>weight</varname></term>
4091 <para>Gewicht</para>
4096 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
4097 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
4098 einer <function>foreach</function>-Schleife ausgegeben werden, da
4099 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
4100 können. Die Variablen dafür lauten:</para>
4104 <term><varname>make</varname></term>
4107 <para>Lieferant</para>
4112 <term><varname>model</varname></term>
4115 <para>Lieferantenartikelnummer</para>
4121 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
4122 <title>Variablen für die einzelnen Zahlungseingänge</title>
4126 <term><varname>payment</varname></term>
4134 <term><varname>paymentaccount</varname></term>
4142 <term><varname>paymentdate</varname></term>
4150 <term><varname>paymentmemo</varname></term>
4158 <term><varname>paymentsource</varname></term>
4167 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
4168 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
4170 <para>Die vom Benutzer definierten Variablen für Kunden und
4171 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
4172 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
4173 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
4174 Variablennamen zusammen.</para>
4176 <para>Beispiel: Der Benutzer hat eine Variable namens
4177 <varname>number_of_employees</varname> definiert, die die Anzahl der
4178 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
4179 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
4184 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
4185 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
4187 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
4188 <title>Namen der Vorlagen</title>
4190 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
4191 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
4192 Erstellung einer Rechnung über die Mahngebühren und Zinsen
4193 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
4194 Vorlagenname für diese Mahnstufe mit dem Zusatz
4195 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
4196 für die ausgewählte Sprache und den ausgewählten Drucker
4200 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
4201 <title>Allgemeine Variablen in Mahnungen</title>
4203 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4204 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4205 Kunden stehen als Variablen <varname>name</varname>,
4206 <varname>street</varname>, <varname>zipcode</varname>,
4207 <varname>city</varname>, <varname>country</varname>,
4208 <varname>department_1</varname>, <varname>department_2</varname>,
4209 und <varname>email</varname> zur Verfügung.</para>
4211 <para>Weitere Variablen beinhalten:</para>
4215 <term><varname>dunning_date</varname></term>
4218 <para>Datum der Mahnung</para>
4223 <term><varname>dunning_duedate</varname></term>
4226 <para>Fälligkeitsdatum für diese Mahhnung</para>
4231 <term><varname>dunning_id</varname></term>
4234 <para>Mahnungsnummer</para>
4239 <term><varname>fee</varname></term>
4242 <para>Kummulative Mahngebühren</para>
4247 <term><varname>interest_rate</varname></term>
4250 <para>Zinssatz per anno in Prozent</para>
4255 <term><varname>total_amount</varname></term>
4258 <para>Gesamter noch zu zahlender Betrag als
4259 <function>fee</function> + <function>total_interest</function>
4260 + <function>total_open_amount</function></para>
4265 <term><varname>total_interest</varname></term>
4268 <para>Zinsen per anno über alle Rechnungen</para>
4273 <term><varname>total_open_amount</varname></term>
4276 <para>Summe über alle offene Beträge der Rechnungen</para>
4282 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
4283 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
4287 <term><varname>dn_amount</varname></term>
4290 <para>Rechnungssumme (brutto)</para>
4295 <term><varname>dn_duedate</varname></term>
4298 <para>Originales Fälligkeitsdatum der Rechnung</para>
4303 <term><varname>dn_dunning_date</varname></term>
4306 <para>Datum der Mahnung</para>
4311 <term><varname>dn_dunning_duedate</varname></term>
4314 <para>Fälligkeitsdatum der Mahnung</para>
4319 <term><varname>dn_fee</varname></term>
4322 <para>Kummulative Mahngebühr</para>
4327 <term><varname>dn_interest</varname></term>
4330 <para>Zinsen per anno für diese Rechnung</para>
4335 <term><varname>dn_invnumber</varname></term>
4338 <para>Rechnungsnummer</para>
4343 <term><varname>dn_linetotal</varname></term>
4346 <para>Noch zu zahlender Betrag (ergibt sich aus
4347 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
4348 + <varname>dn_interest</varname>)</para>
4353 <term><varname>dn_netamount</varname></term>
4356 <para>Rechnungssumme (netto)</para>
4361 <term><varname>dn_open_amount</varname></term>
4364 <para>Offener Rechnungsbetrag</para>
4369 <term><varname>dn_ordnumber</varname></term>
4372 <para>Bestellnummer</para>
4377 <term><varname>dn_transdate</varname></term>
4380 <para>Rechnungsdatum</para>
4385 <term><varname>dn_curr</varname></term>
4388 <para>Währung, in der die Rechnung erstellt wurde. (Die
4389 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
4395 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
4396 <title>Variablen in automatisch erzeugten Rechnungen über
4397 Mahngebühren</title>
4399 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4400 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4401 Kunden stehen als Variablen <varname>name</varname>,
4402 <varname>street</varname>, <varname>zipcode</varname>,
4403 <varname>city</varname>, <varname>country</varname>,
4404 <varname>department_1</varname>, <varname>department_2</varname>,
4405 und <varname>email</varname> zur Verfügung.</para>
4407 <para>Weitere Variablen beinhalten:</para>
4411 <term><varname>duedate</varname></term>
4414 <para>Fälligkeitsdatum der Rechnung</para>
4419 <term><varname>dunning_id</varname></term>
4422 <para>Mahnungsnummer</para>
4427 <term><varname>fee</varname></term>
4430 <para>Mahngebühren</para>
4435 <term><varname>interest</varname></term>
4443 <term><varname>invamount</varname></term>
4446 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
4447 <varname>interest</varname>)</para>
4452 <term><varname>invdate</varname></term>
4455 <para>Rechnungsdatum</para>
4460 <term><varname>invnumber</varname></term>
4463 <para>Rechnungsnummer</para>
4470 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
4471 <title>Variablen in anderen Vorlagen</title>
4474 <title>Einführung</title>
4476 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
4477 Rechnung. Allerdings heißen die Variablen, die mit
4478 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
4479 fangen sie mit <varname>quo</varname> für "quotation" an:
4480 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
4481 wiederum fangen sie mit <varname>ord</varname> für "order" an:
4482 <varname>ordnumber</varname> für Bestellnummer etc.</para>
4484 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
4485 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
4486 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
4487 Vorlage keine Bedeutung haben oder noch nicht belegt sein
4490 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
4491 in Rechnungen aufgeführt.</para>
4494 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
4495 <title>Angebote und Preisanfragen</title>
4499 <term><varname>quonumber</varname></term>
4502 <para>Angebots- bzw. Anfragenummer</para>
4507 <term><varname>reqdate</varname></term>
4510 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
4511 Preisanfragen)</para>
4516 <term><varname>transdate</varname></term>
4519 <para>Angebots- bzw. Anfragedatum</para>
4525 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
4526 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
4530 <term><varname>ordnumber</varname></term>
4533 <para>Auftragsnummer</para>
4538 <term><varname>reqdate</varname></term>
4541 <para>Lieferdatum</para>
4546 <term><varname>transdate</varname></term>
4549 <para>Auftragsdatum</para>
4555 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
4556 <title>Lieferscheine (Verkauf und Einkauf)</title>
4560 <term><varname>cusordnumber</varname></term>
4563 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
4564 des Lieferanten (im Einkauf)</para>
4569 <term><varname>donumber</varname></term>
4572 <para>Lieferscheinnummer</para>
4577 <term><varname>transdate</varname></term>
4580 <para>Lieferscheindatum</para>
4585 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
4586 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
4587 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
4588 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
4589 <function>foreach</function>-Schleife ausgegeben werden. Diese
4590 Variablen sind:</para>
4594 <term><varname>si_bin</varname></term>
4597 <para>Lagerplatz</para>
4602 <term><varname>si_chargenumber</varname></term>
4605 <para>Chargennummer</para>
4610 <term><varname>si_bestbefore</varname></term>
4613 <para>Mindesthaltbarkeit</para>
4618 <term><varname>si_number</varname></term>
4621 <para>Artikelnummer</para>
4626 <term><varname>si_qty</varname></term>
4629 <para>Anzahl bzw. Menge</para>
4634 <term><varname>si_runningnumber</varname></term>
4637 <para>Positionsnummer (1, 2, 3 etc)</para>
4642 <term><varname>si_unit</varname></term>
4645 <para>Einheit</para>
4650 <term><varname>si_warehouse</varname></term>
4659 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
4660 <title>Variablen für Sammelrechnung</title>
4664 <term><varname>c0total</varname></term>
4667 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
4673 <term><varname>c30total</varname></term>
4676 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
4677 und < 60 Tage</para>
4682 <term><varname>c60total</varname></term>
4685 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
4686 und < 90 Tage</para>
4691 <term><varname>c90total</varname></term>
4694 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
4700 <term><varname>total</varname></term>
4703 <para>Gesamtbetrag aller Rechnungen</para>
4708 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
4712 <term><varname>invnumber</varname></term>
4715 <para>Rechnungsnummer</para>
4720 <term><varname>invdate</varname></term>
4723 <para>Rechnungsdatum</para>
4728 <term><varname>duedate</varname></term>
4731 <para>Fälligkeitsdatum</para>
4736 <term><varname>amount</varname></term>
4739 <para>Summe der Rechnung</para>
4744 <term><varname>open</varname></term>
4747 <para>Noch offener Betrag der Rechnung</para>
4752 <term><varname>c0</varname></term>
4755 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4761 <term><varname>c30</varname></term>
4764 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4770 <term><varname>c60</varname></term>
4773 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4779 <term><varname>c90</varname></term>
4782 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4790 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4791 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4793 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4794 <title>Einfürhung</title>
4796 <para>Der Parser kennt neben den Variablen einige weitere
4797 Konstrukte, die gesondert behandelt werden. Diese sind wie
4798 Variablennamen in spezieller Weise markiert:
4799 <command><%anweisung%> ... <%end%></command></para>
4801 <para>Anmerkung zum <command><%end%></command>: Der besseren
4802 Verständlichkeit halber kann man nach dem <command>end</command>
4803 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4804 Anweisung (z.B. <command>if</command> oder
4805 <command>foreach</command>) damit abgeschlossen wird.</para>
4807 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4808 <command><%if type == "sales_quotation"%></command>, so könnte
4809 er mit <command><%end%></command> genauso abgeschlossen werden
4810 wie mit <command><%end if%></command> oder auch
4811 <command><%end type == "sales_quotation"%></command>.</para>
4814 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4815 <title>Der if-Block</title>
4817 <programlisting><%if variablenname%>
4819 <%end%></programlisting>
4821 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4822 und dem "end" werden nur ausgegeben, wenn die Variable
4823 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4825 <para>Handelt es sich bei der benannten Variable um ein Array, also um einen Variablennamen, über den man mit
4826 <command><%foreach variablenname%></command> iteriert, so wird mit diesem Konstrukt darauf getestet, ob das Array Elemente
4827 enthält. Somit würde im folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt ihrer Überschrift "Zahlungseingänge"
4828 ausgegeben, wenn tatsächlich welche getätigt wurden:</para>
4830 <programlisting><%if payment%>
4832 <%foreach payment%>
4833 Am <%paymentdate%>: <%payment%> €
4834 <%end foreach%>
4835 <%end if%></programlisting>
4837 <para>Die Bedingung kann auch negiert werden, indem das Wort
4838 <function>not</function> nach dem <filename>if</filename> verwendet
4839 wird. Beispiel:</para>
4841 <programlisting><%if not cp_greeting%>
4843 <%end%></programlisting>
4845 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4846 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4847 einer Variablen mit einer festen Zeichenkette oder einer anderen
4848 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4849 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4850 die rechte Seite des Vergleichsoperators in Anführungszeichen
4851 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4852 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4855 <programlisting><%if var1 == "Wert"%></programlisting>
4857 <para>Testet die Variable <varname>var1</varname> auf
4858 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4859 Mittels <function>!=</function> anstelle von <function>==</function>
4860 würde auf Ungleichheit getestet.</para>
4862 <programlisting><%if var1 == var2%></programlisting>
4864 <para>Testet die Variable <varname>var1</varname> auf
4865 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4866 <function>!=</function> anstelle von <function>==</function> würde
4867 auf Ungleichheit getestet.</para>
4869 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4870 auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
4871 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4872 dieselbe Syntax wie oben nur mit <function>=~</function> und
4873 <function>!~</function> als Vergleichsoperatoren.</para>
4875 <para>Beispiel für einen Test, ob die Variable
4876 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4877 <constant>schwierig</constant> enthält:</para>
4879 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4882 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4883 <title>Der foreach-Block</title>
4885 <programlisting><%foreach variablenname%>
4887 <%end%></programlisting>
4889 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4890 wie das Perl-Array der Variablen <varname>variablenname</varname>
4891 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4892 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4893 benutzt. In jedem Durchlauf werden die <link
4894 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4895 Variablen</link> jeweils auf den Wert für die aktuelle Position
4898 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
4900 <programlisting><%foreach number%>
4901 Position: <%runningnumber%>
4902 Anzahl: <%qty%>
4903 Artikelnummer: <%number%>
4904 Beschreibung: <%description%>
4906 <%end%></programlisting>
4908 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
4909 <function><%foreach%></function>-Block innerhalb einer
4910 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
4911 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
4912 Inhalt zwischen <function><%foreach%></function> und
4913 <function><%end%></function> wiederholt, nicht aber die
4914 komplette Zeile, in der er steht.</para>
4918 <sect2 id="dokumentenvorlagen-und-variablen.markup">
4919 <title>Markup-Code zur Textformatierung innerhalb von
4922 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
4923 anders formatiert haben möchte, so ist dies begrenzt möglich.
4924 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
4925 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
4926 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
4927 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
4928 (HTML oder PDF über LaTeX) umgesetzt.</para>
4930 <para>Die unterstützen Formatierungen sind:</para>
4934 <term><b>Text</b></term>
4937 <para>Text wird in Fettdruck gesetzt.</para>
4942 <term><i>Text</i></term>
4945 <para>Text wird kursiv gesetzt.</para>
4950 <term><u>Text</u></term>
4953 <para>Text wird unterstrichen.</para>
4958 <term><s>Text</s></term>
4961 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
4962 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
4967 <term><bullet></term>
4970 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
4976 <para>Der Befehl <command><bullet></command> funktioniert
4977 momentan auch nur in Latex-Vorlagen.</para>
4981 <sect1 id="excel-templates">
4982 <title>Excel-Vorlagen</title>
4984 <sect2 id="excel-templates.summary">
4985 <title>Zusammenfassung</title>
4987 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
4988 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
4992 <sect2 id="excel-templates.usage">
4993 <title>Bedienung</title>
4995 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
4996 werden. Die Konfigurationsoption heißt <varname>excel_templates =
4997 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
4999 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
5000 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
5001 werden. In den normalen Verkaufsmasken taucht nun
5002 <constant>Excel</constant> als auswählbares Format auf und kann von da
5003 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
5005 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
5006 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
5007 <filename>sales_quotation.xls</filename> gespeichert.</para>
5010 <sect2 id="excel-templates.syntax">
5011 <title>Variablensyntax</title>
5013 <para>Einfache Syntax:
5014 <command><<varname>></command></para>
5016 <para>Dabei sind <constant><<</constant> und
5017 <constant>>></constant> die Delimiter. Da Excel auf festen
5018 Breiten besteht, kann der Tag künstlich verlängert werden, indem
5019 weitere <constant><</constant> oder <constant>></constant>
5020 eingefügt werden. Der Tag muss nicht symmetrisch sein.
5023 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
5025 <para>Um die Limitierung der festen Breite zu reduzieren, können
5026 weitere Variablen in einem Block interpoliert werden. Whitespace wird
5027 dazwishen dann erhalten. Beispiel:</para>
5029 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
5031 <para>Die Variablen werden interpoliert, und linksbündig mit
5032 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
5033 lang, werden überzählige Zeichen abgeschnitten.</para>
5035 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
5036 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
5038 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
5040 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
5041 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
5045 <sect2 id="excel-templates.limitations">
5046 <title>Einschränkungen</title>
5048 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
5049 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
5050 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
5051 Text zu ersetzen.</para>
5053 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
5054 <command><%if%></command> und
5055 <command><%foreach%></command> nicht vorhanden. Der Delimiter
5056 <constant><% %></constant> kommt in den Headerinformationen
5057 evtl. vor. Deshalb wurde auf den sichereren Delimiter
5058 <constant><<</constant> und <constant>>></constant>
5062 <sect1 id="features.warehouse">
5063 <title>Mandantenkonfiguration Lager</title>
5064 Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt:
5065 Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die Möglichkeit hier über den
5066 Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. Ferner kann
5067 jede Position eines Lieferscheins ein-, bzw. ausgelagert werden (Einkauf-, bzw. Verkauf).
5068 Es können beliebig viele Lager mit beliebig vielen Lagerplätzen abgebildet werden.
5069 Die Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder Einzelposition und
5070 das Auswählen dieser Position zu einem Lager mit Lagerplatz.
5071 Dieses Verfahren lässt sich schrittweise vereinfachen, je nachdem wie die Einstellungen in
5072 der Mandatenkonfiguration gesetzt werden.
5075 <para><option>Auslagern über Standardlagerplatz</option> Hier wird ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz)
5076 in dem Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über den Standardlagerplatz (konfigurierbar pro Ware) durchführt.
5080 <para><option>Auslagern ohne Bestandsprüfung</option>Das obige Auslagern schlägt fehl, wenn die entsprechende Menge für
5081 die Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit dieser Option
5082 erlauben. Hierfür muss ein entsprechender Lagerplatz (Fehlbestand, o.ä.) konfiguriert sein.</para>
5085 Zusätzliche Funktionshinweise:
5087 <listitem><para><option>Standard-Lagerplatz</option>Ist dieser konfiguriert, wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
5088 Stammdaten-> Waren / Dienstleistung / Erzeugnis verwendet.
5091 <listitem><para><option>Standard-Lagerplatz verwenden, falls keiner in Stammdaten definiert</option>Wird beim 'Auslagern über Standardlagerplatz'
5092 keine Standardlagerplatz zu der Ware gefunden, so wird mit dieser Option einfach der Standardlagerplatz verwendet.
5100 <title>Entwicklerdokumentation</title>
5102 <sect1 id="devel.globals" xreflabel="Globale Variablen">
5103 <title>Globale Variablen</title>
5106 <title>Wie sehen globale Variablen in Perl aus?</title>
5108 <para>Globale Variablen liegen in einem speziellen namespace namens
5109 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
5110 globs global und die meisten speziellen Variablen sind...
5113 <para>Daraus ergeben sich folgende Formen:</para>
5117 <term><literal>$main::form</literal></term>
5120 <para>expliziter Namespace "main"</para>
5125 <term><literal>$::form</literal></term>
5128 <para>impliziter Namespace "main"</para>
5133 <term><literal>open FILE, "file.txt"</literal></term>
5136 <para><varname>FILE</varname> ist global</para>
5141 <term><literal>$_</literal></term>
5144 <para>speziell</para>
5149 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
5150 Schlüsselwort wie "<function>global</function>", mit dem man
5151 importieren kann. <function>my</function>, <function>our</function>
5152 und <function>local</function> machen was anderes.</para>
5156 <term><literal>my $form</literal></term>
5159 <para>lexikalische Variable, gültig bis zum Ende des
5165 <term><literal>our $form</literal></term>
5168 <para><varname>$form</varname> referenziert ab hier
5169 <varname>$PACKAGE::form</varname>.</para>
5174 <term><literal>local $form</literal></term>
5177 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
5178 des scopes zurückgesetzt</para>
5185 <title>Warum sind globale Variablen ein Problem?</title>
5187 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
5189 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
5190 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
5191 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
5192 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
5193 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
5194 Datenbankverbindungen, weil die sehr lange zum Initialisieren
5197 <para>Das zweite Problem ist <function>strict</function>. Unter
5198 <function>strict</function> werden alle Variablen die nicht explizit
5199 mit <function>Package</function>, <function>my</function> oder
5200 <function>our</function> angegeben werden als Tippfehler angemarkert,
5201 dies hat, seit der Einführung, u.a. schon so manche langwierige
5202 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
5203 angegeben werden, werden die nicht geprüft, und somit kann sich
5204 schnell ein Tippfehler einschleichen.</para>
5208 <title>Kanonische globale Variablen</title>
5210 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
5211 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
5212 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
5213 umhergereicht werden.</para>
5215 <para>Diese Variablen sind im Moment die folgenden neun:</para>
5219 <para><varname>$::form</varname></para>
5223 <para><varname>%::myconfig</varname></para>
5227 <para><varname>$::locale</varname></para>
5231 <para><varname>$::lxdebug</varname></para>
5235 <para><varname>$::auth</varname></para>
5239 <para><varname>$::lx_office_conf</varname></para>
5243 <para><varname>$::instance_conf</varname></para>
5247 <para><varname>$::dispatcher</varname></para>
5251 <para><varname>$::request</varname></para>
5255 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
5256 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
5257 Eigenschaften (Konventionen):</para>
5260 <title>$::form</title>
5264 <para>Ist ein Objekt der Klasse
5265 "<classname>Form</classname>"</para>
5269 <para>Wird nach jedem Request gelöscht</para>
5273 <para>Muss auch in Tests und Konsolenscripts vorhanden
5278 <para>Enthält am Anfang eines Requests die Requestparameter vom
5283 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
5284 cachen, das wird aber momentan absichtlich zerstört</para>
5288 <para><varname>$::form</varname> wurde unter <productname>SQL
5289 Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
5290 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
5291 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
5292 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
5293 <function>IS->retrieve_customer()</function> in Sicherheit
5296 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
5297 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
5298 3552, Stand version 2.7beta), um dies hinterher wieder auf den
5299 richtigen Wert zu setzen:</para>
5301 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
5302 $::myconfig{numberformat} = $numberformat;
5303 # (...) div Berechnungen
5304 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
5306 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
5307 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
5308 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
5309 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
5310 Es geht ziemlich sicher etwas kaputt.</para>
5312 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
5313 in den <productname>Template::Toolkit</productname> Templates
5314 außerhalb der Controller: der Ausdruck <function>[% var
5315 %]</function> greift auf <varname>$::form->{var}</varname> zu.
5316 Unter Controllern ist der Standard Scope anders, da lautet der
5317 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
5318 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
5319 <function><%var%></function> zeigt auf
5320 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
5321 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
5324 <programlisting>[%- IF business %]
5325 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
5326 [%- END %]</programlisting>
5328 <para>Entweder wird hier dann $::form->{business} ausgewertet
5329 oder aber der Funktion
5330 <function>$form->parse_html_template</function> wird explizit
5331 noch ein zusätzlicher Hash übergeben, der dann auch in den
5332 (Web-)Templates zu Verfügung steht, bspw. so:</para>
5334 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
5336 <para>Innerhalb von Schleifen wird
5337 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
5338 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
5339 welches über alle Positionen eines Lieferscheins in Schleife
5342 <programlisting>for $i (1 .. $form->{rowcount}) {
5344 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
5345 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
5346 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
5352 <title>%::myconfig</title>
5356 <para>Das einzige Hash unter den globalen Variablen</para>
5360 <para>Wird spätestens benötigt wenn auf die Datenbank
5361 zugegriffen wird</para>
5365 <para>Wird bei jedem Request neu erstellt.</para>
5369 <para>Enthält die Userdaten des aktuellen Logins</para>
5373 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
5374 extern serialisiert werden, weil da auch der Datenbankzugriff
5375 für diesen user drinsteht.</para>
5379 <para>Enthält unter anderem Listenbegrenzung vclimit,
5380 Datumsformat dateformat und Nummernformat numberformat</para>
5384 <para>Enthält Datenbankzugriffinformationen</para>
5388 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
5389 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
5390 aktuellen Users entscheiden müssen, befragen
5391 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
5392 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
5393 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
5394 Informationen über den Benutzer die über die
5395 Administrator-Schnittstelle eingegeben wurden.</para>
5399 <title>$::locale</title>
5403 <para>Objekt der Klasse "Locale"</para>
5407 <para>Wird pro Request erstellt</para>
5411 <para>Muss auch für Tests und Scripte immer verfügbar
5416 <para>Cached intern über Requestgrenzen hinweg benutzte
5421 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
5422 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
5426 <title>$::lxdebug</title>
5430 <para>Objekt der Klasse "LXDebug"</para>
5434 <para>Wird global gecached</para>
5438 <para>Muss immer verfügbar sein, in nahezu allen
5443 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
5444 bereit, wie "<function>enter_sub</function>" und
5445 "<function>leave_sub</function>", mit denen in den alten Modulen ein
5446 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
5447 der man die Wallclockzeit seit Requeststart loggen kann, sowie
5448 "<function>message</function>" und "<function>dump</function>" mit
5449 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
5452 <para>Beispielsweise so:</para>
5454 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
5455 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
5459 <title>$::auth</title>
5463 <para>Objekt der Klasse "SL::Auth"</para>
5467 <para>Wird global gecached</para>
5471 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
5475 <para>Wird nach jedem Request resettet.</para>
5479 <para><varname>$::auth</varname> stellt Funktionen bereit um die
5480 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
5481 vom aktuellen User abhängen wird das Objekt aus
5482 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
5483 Request kurz resettet.</para>
5485 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten. Dessen Einstellungen können über
5486 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert ist ein Hash mit den Werten aus der Tabelle
5487 <literal>auth.clients</literal>.</para>
5491 <title>$::lx_office_conf</title>
5495 <para>Objekt der Klasse
5496 "<classname>SL::LxOfficeConf</classname>"</para>
5500 <para>Global gecached</para>
5504 <para>Repräsentation der
5505 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
5509 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
5510 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
5511 das Programm die Konfiguration ändern kann oder sollte.</para>
5513 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
5514 Debug- und Trace-Log-Datei wie folgt konfiguriert und
5517 <programlisting>[debug]
5518 file_name = /tmp/kivitendo-debug.log</programlisting>
5520 <para>ist der Key <varname>file</varname> im Programm als
5521 <varname>$::lx_office_conf->{debug}{file}</varname>
5525 <para>Zugriff auf die Konfiguration erfolgt im Moment über
5526 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
5531 <title>$::instance_conf</title>
5535 <para>Objekt der Klasse
5536 "<classname>SL::InstanceConfiguration</classname>"</para>
5540 <para>wird pro Request neu erstellt</para>
5544 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
5545 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
5546 ist hier eine Mandantendatenbank. Beispielsweise überprüft
5547 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
5548 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
5552 <title>$::dispatcher</title>
5556 <para>Objekt der Klasse
5557 "<varname>SL::Dispatcher</varname>"</para>
5561 <para>wird pro Serverprozess erstellt.</para>
5565 <para>enthält Informationen über die technische Verbindung zum
5570 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
5571 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
5572 Objekt untergebracht.</para>
5576 <title>$::request</title>
5580 <para>Hashref (evtl später Objekt)</para>
5584 <para>Wird pro Request neu initialisiert.</para>
5588 <para>Keine Unterstruktur garantiert.</para>
5592 <para><varname>$::request</varname> ist ein generischer Platz um
5593 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
5594 at a distance benutzt werden, sondern um lokales memoizing zu
5595 ermöglichen, das garantiert am Ende des Requests zerstört
5598 <para>Vieles von dem, was im moment in <varname>$::form</varname>
5599 liegt, sollte eigentlich hier liegen. Die groben
5600 Differentialkriterien sind:</para>
5604 <para>Kommt es vom User, und soll unverändert wieder an den
5605 User? Dann <varname>$::form</varname>, steht da eh schon</para>
5609 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
5610 Requests gebraucht werden? Dann
5611 <varname>$::request</varname></para>
5615 <para>Muss ich von anderen Teilen des Programms lesend drauf
5616 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
5617 Wrappermethode</para>
5624 <title>Ehemalige globale Variablen</title>
5626 <para>Die folgenden Variablen waren einmal im Programm, und wurden
5630 <title>$::cgi</title>
5634 <para>war nötig, weil cookie Methoden nicht als
5635 Klassenfunktionen funktionieren</para>
5639 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
5640 Klassennamespace gehalten wird und über Requestgrenzen
5645 <para>liegt jetzt unter
5646 <varname>$::request->{cgi}</varname></para>
5652 <title>$::all_units</title>
5656 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
5657 ein paar hundert mal pro Request eine Liste der Einheiten
5658 brauchen, und de als Parameter durch einen Riesenstack von
5659 Funktionen geschleift werden müssten.</para>
5663 <para>Liegt jetzt unter
5664 <varname>$::request->{cache}{all_units}</varname></para>
5669 <function>AM->retrieve_all_units()</function> gesetzt oder
5676 <title>%::called_subs</title>
5680 <para>wurde benutzt um callsub deep recursions
5685 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
5686 möglichen Rekursioenen darstellt, und da nie welche
5691 <para>komplette recursion protection wurde entfernt.</para>
5698 <sect1 id="devel.fcgi">
5699 <title>Entwicklung unter FastCGI</title>
5701 <sect2 id="devel.fcgi.general">
5702 <title>Allgemeines</title>
5704 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
5705 werden, muss der Webserver neu gestartet werden.</para>
5707 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
5708 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
5709 müssen folgende Aspekte beachtet werden.</para>
5712 <sect2 id="devel.fcgi.exiting">
5713 <title>Programmende und Ausnahmen</title>
5715 <para>Betrifft die Funktionen <function>warn</function>,
5716 <function>die</function>, <function>exit</function>,
5717 <function>carp</function> und <function>confess</function>.</para>
5719 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
5720 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
5721 am Laufen zu halten. Man kann mit <function>die</function>,
5722 <function>confess</function> oder <function>carp</function> Fehler
5723 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
5724 eigene <function>$::form-</function>error()> tut im Prinzip das
5725 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
5726 <function>exit</function> hingegen werden nicht abgefangen.
5727 <function>warn</function> wird direkt nach STDERR, also in Server Log
5728 eine Nachricht schreiben (sofern in der Konfiguration nicht die
5729 Warnungen in das kivitendo Log umgeleitet wurden), und
5730 <function>exit</function> wird die Ausführung beenden.</para>
5732 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
5733 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
5734 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
5735 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
5738 <sect2 id="devel.fcgi.globals">
5739 <title>Globale Variablen</title>
5741 <para>Um zu vermeiden, dass Informationen von einem Request in einen
5742 anderen gelangen, müssen alle globalen Variablen vor einem Request
5743 sauber initialisiert werden. Das ist besonders wichtig im
5744 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
5745 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
5748 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
5749 abgetrennten Block, der alle kanonischen globalen Variablen listet und
5750 erklärt. Bitte keine anderen einführen ohne das sauber zu
5751 dokumentieren.</para>
5753 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
5754 man sicher geht, dass man die richtige erwischt.</para>
5757 <sect2 id="devel.fcgi.performance">
5758 <title>Performance und Statistiken</title>
5760 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
5761 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
5762 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
5763 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
5764 sind es je nach Menge der definierten Variablen 1-2s. Ab der
5765 Moose/Rose::DB Version sind es 5-6s.</para>
5767 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
5768 den kritischen Pfaden, unter 0,15 sonst.</para>
5772 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
5773 <title>SQL-Upgradedateien</title>
5775 <sect2 id="db-upgrade-files.introduction"
5776 xreflabel="Einführung in die Datenbank-Upgradedateien">
5777 <title>Einführung</title>
5779 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte gesteuert, die sich im Verzeichnis <filename>sql/Pg-upgrade2</filename>
5780 befinden. In diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren, die neben den eigentlich auszuführenden SQL- oder
5781 Perl-Befehlen einige Kontrollinformationen enthält.</para>
5783 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten, sodass Datenbankscripte zwar in einer sicheren Reihenfolge
5784 ausgeführt werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt werden, wenn die Tabelle mit <literal>CREATE
5785 TABLE</literal> angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man keine Versionsnummern braucht.</para>
5787 <para>kivitendo merkt sich dabei, welches der Upgradescripte in <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
5788 führt diese nicht erneut aus. Dazu dient die Tabelle "<literal>schema_info</literal>", die bei der Anmeldung automatisch angelegt
5792 <sect2 id="db-upgrade-files.format"
5793 xreflabel="Format der Upgradedateien">
5794 <title>Format der Kontrollinformationen</title>
5796 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5797 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5798 hat dabei das folgende Format:</para>
5800 <para>Für SQL-Upgradedateien:</para>
5802 <programlisting>-- @key: value</programlisting>
5804 <para>Für Perl-Upgradedateien:</para>
5806 <programlisting># @key: value</programlisting>
5808 <para>Leerzeichen vor "<varname>value</varname>" werden
5811 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5815 <term><varname>tag</varname></term>
5818 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5819 Dieser "tag" kann von anderen Kontrolldateien in ihren
5820 Abhängigkeiten verwendet werden (Schlüsselwort
5821 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5822 in der Datenbank eingetragen wird.</para>
5824 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5825 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5827 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5828 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5829 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5835 <term><varname>charset</varname></term>
5838 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5839 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
5840 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte hingegen müssen immer in UTF-8 encodiert sein und sollten
5841 demnach auch ein "<literal>use utf8;</literal>" enthalten.</para>
5846 <term><varname>description</varname></term>
5849 <para>Benötigt. Eine Beschreibung, was in diesem Update
5850 passiert. Diese wird dem Benutzer beim eigentlichen
5851 Datenbankupdate angezeigt. Während der Tag in englisch gehalten
5852 sein sollte, sollte die Beschreibung auf Deutsch
5858 <term><varname>depends</varname></term>
5861 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5862 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
5863 dass die in dieser Liste aufgeführten Scripte bereits
5864 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5866 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5867 Script "b" existiert, das von Änderungen in "a" abhängt, und
5868 eine neue Kontrolldatei für "c" erstellt wird, die von
5869 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5870 Tag "b" als Abhängigkeit zu definieren.</para>
5872 <para>Es ist nicht erlaubt, sich selbst referenzierende
5873 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5874 und "c" -> "a").</para>
5879 <term><varname>priority</varname></term>
5882 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5883 der Scripte ausgeführt werden, die die gleichen
5884 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5885 der Wert 1000 benutzt.</para>
5887 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5888 "depends" benutzt werden. kivitendo sortiert die auszuführenden
5889 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5890 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5891 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5892 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5893 Priorität alphabetisch nach dem "tag".</para>
5898 <term><varname>ignore</varname></term>
5901 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
5902 Skript bei der Anmeldung ignoriert und entsprechend nicht
5909 <sect2 id="db-upgrade-files.format-perl-files" xreflabel="Format von Perl-Upgradedateien">
5910 <title>Format von in Perl geschriebenen Datenbankupgradescripten</title>
5912 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so ausgeführt sondern müssen sich an gewisse Konventionen
5913 halten. Dafür bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
5915 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse dar, die vom Elternobjekt
5916 "<literal>SL::DBUpgrade2::Base</literal>" erben und eine Funktion namens "<literal>run</literal>" zur Verfügung stellen muss. Das
5917 Script wird ausgeführt, indem eine Instanz dieser Klasse erzeugt und darauf die erwähnte "<literal>run</literal>" aufgerufen
5920 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert für "<literal>@tag</literal>" ableitet. Dabei werden alle
5921 Zeichen, die in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche ersetzt. Insgesamt sieht der Paketname wie folgt
5922 aus: "<literal>SL::DBUpgrade2::tag</literal>".</para>
5924 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
5925 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
5927 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie folgt aus:</para>
5929 <programlisting># @tag: beispiel-upgrade-file42
5930 # @description: Ein schönes Beispielscript
5931 # @depends: release_3_1_0
5932 package SL::DBUpgrade2::beispiel_upgrade_file42;
5937 use parent qw(SL::DBUpgrade2::Base);
5942 # hier Aktionen ausführen
5951 <sect2 id="db-upgrade-files.dbupgrade-tool"
5952 xreflabel="Hilfsscript dbupgrade2_tool.pl">
5953 <title>Hilfsscript dbupgrade2_tool.pl</title>
5955 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
5956 existiert ein Hilfsscript namens
5957 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
5958 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
5959 liest alle Datenbankupgradescripte aus dem Verzeichnis
5960 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
5961 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
5962 von der Kommandozeile überprüft werden können.</para>
5964 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
5965 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
5966 sich aber auch Informationen auf verschiedene Art ausgeben
5971 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
5972 --list</command>"</para>
5974 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
5975 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
5976 würde. Es werden neben der Listenposition der Tag, die
5977 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
5981 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
5982 --tree</command>"</para>
5984 <para>Listet alle Tags in Baumform basierend auf den
5985 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
5986 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
5987 beim übergeordneten Script als Abhängigkeit eingetragen
5991 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
5992 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
5993 --rtree</command>"</para>
5995 <para>Listet alle Tags in Baumform basierend auf den
5996 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
5997 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
5998 die das übergeordnete Script als Abhängigkeit eingetragen
6003 <para>Baumform mit Postscriptausgabe:
6004 "<command>./scripts/dbupgrade2_tool.pl
6005 --graphviz</command>"</para>
6007 <para>Benötigt das Tool "<command>graphviz</command>", um mit
6008 seiner Hilfe die <link
6009 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
6010 Baumform</link> in eine Postscriptdatei namens
6011 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
6012 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
6013 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
6014 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
6019 <para>Scripte, von denen kein anderes Script abhängt:
6020 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
6022 <para>Listet die Tags aller Scripte auf, von denen keine anderen
6023 Scripte abhängen.</para>
6029 <sect1 id="translations-languages" xreflabel="Translations and languages">
6030 <title>Translations and languages</title>
6032 <sect2 id="translations-languages.introduction"
6033 xreflabel="Introduction to translations and languages">
6034 <title>Introduction</title>
6037 <para>Dieser Abschnitt ist in Englisch geschrieben, um
6038 internationalen Übersetzern die Arbeit zu erleichtern.</para>
6041 <para>This section describes how localization packages in kivitendo
6042 are built. Currently the only language fully supported is German, and
6043 since most of the internal messages are held in English the English
6044 version is usable too.</para>
6046 <para>A stub version of French is included but not functunal at this
6050 <sect2 id="translations-languages.character-set"
6051 xreflabel="Character set">
6052 <title>Character set</title>
6054 <para>All files included in a language pack must use UTF-8 as their encoding.</para>
6057 <sect2 id="translations-languages.file-structure"
6058 xreflabel="File structure">
6059 <title>File structure</title>
6061 <para>The structure of locales in kivitendo is:</para>
6063 <programlisting>kivitendo/locale/<langcode>/</programlisting>
6065 <para>where <langcode> stands for an abbreviation of the
6066 language package. The builtin packages use two letter <ulink
6067 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
6068 but the actual name is not relevant for the program and can easily be
6070 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
6071 tags</ulink> (i.e. "en_GB"). In fact the original language packages
6072 from SQL Ledger are named in this way.</para>
6074 <para>In such a language directory the following files are
6079 <term>LANGUAGE</term>
6082 <para>This file is mandatory.</para>
6084 <para>The <filename>LANGUAGE</filename> file contains the self
6085 descripted name of the language. It should contain a native
6086 representation first, and in parenthesis an english translation
6087 after that. Example:</para>
6089 <programlisting>Deutsch (German)</programlisting>
6097 <para>This file is mandatory.</para>
6099 <para>The central translation file. It is essentially an inline
6100 Perl script autogenerated by <command>locales.pl</command>. To
6101 generate it, generate the directory and the two files mentioned
6102 above, and execute the following command:</para>
6104 <programlisting>scripts/locales.pl <langcode></programlisting>
6106 <para>Otherwise you can simply copy one of the other languages.
6107 You will be told how many are missing like this:</para>
6109 <programlisting>$ scripts/locales.pl en
6110 English - 0.6% - 2015/2028 missing</programlisting>
6112 <para>A file named "<filename>missing</filename>" will be
6113 generated and can be edited. You can also edit the
6114 "<filename>all</filename>" file directly. Edit everything you
6115 like to fit the target language and execute
6116 <command>locales.pl</command> again. See how the missing words
6122 <term>Num2text</term>
6125 <para>Legacy code from SQL Ledger. It provides a means for
6126 numbers to be converted into natural language, like
6127 <literal>1523 => one thousand five hundred twenty
6128 three</literal>. If you want to provide it, it must be inlinable
6129 Perl code which provides a <function>num2text</function> sub. If
6130 an <function>init</function> sub exists it will be executed
6133 <para>Only used in the check and receipt printing module.</para>
6138 <term>special_chars</term>
6141 <para>kivitendo comes with a lot of interfaces to different
6142 formats, some of which are rather picky with their accepted
6143 charset. The <filename>special_chars</filename> file contains a
6144 listing of chars not suited for different file format and
6145 provides substitutions. It is written in "Simple Ini" style,
6146 containing a block for every file format.</para>
6148 <para>First entry should be the order of substitution for
6149 entries as a whitespace separated list. All entries are
6150 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
6151 and <literal>\\</literal> all work.</para>
6153 <para>After that every entry is a special char that should be
6154 translated when writing text into such a file.</para>
6156 <para>Example:</para>
6158 <programlisting>[Template/XML]
6159 order=& < > \n
6163 \n=<br></programlisting>
6165 <para>Note the importance of the order in this example.
6166 Substituting < and > befor & would lead to $gt; become
6169 <para>For a list of valid formats, see the German
6170 <filename>special_chars</filename> entry. As of this writing the
6171 following are recognized:</para>
6173 <programlisting>HTML
6178 Template/OpenDocument
6179 filenames</programlisting>
6181 <para>The last of which is very machine dependant. Remember that
6182 a lot of characters are forbidden by some filesystems, for
6183 exmaple MS Windows doesn't like ':' in its files where Linux
6184 doesn't mind that. If you want the files created with your
6185 language pack to be portable, find all chars that could cause
6191 <term>missing</term>
6194 <para>This file is not a part of the language package
6197 <para>This is a file generated by
6198 <command>scripts/locales.pl</command> while processing your
6199 locales. It's only to have the missing entries singled out and
6200 does not belong to a language package.</para>
6208 <para>This file is not a part of the language package
6211 <para>Another file generated by
6212 <command>scripts/locales.pl</command>. If for any reason a
6213 translation does not appear anymore and can be deleted, it gets
6214 moved here. The last 50 or so entries deleted are saved here in
6215 case you made a typo, so that you don't have to translate
6216 everything again. If a tranlsation is missing, the lost file is
6217 checked first. If you maintain a language package, you might
6218 want to keep this safe somewhere.</para>
6225 <sect1 id="devel.testsuite">
6226 <title>Die kivitendo-Test-Suite</title>
6228 <sect2 id="devel.testsuite.intro">
6229 <title>Einführung</title>
6231 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul <literal>Test::More</literal>.</para>
6233 <para>Die grundlegenden Fakten sind:</para>
6236 <listitem><para>Alle Tests liegen im Unterverzeichnis <filename>t/</filename>.</para></listitem>
6238 <listitem><para>Ein Script (bzw. ein Test) in <filename>t/</filename> enthält einen oder mehrere Testfälle.</para></listitem>
6240 <listitem><para>Alle Dateinamen von Tests enden auf <literal>.t</literal>. Es sind selbstständig ausführbare Perl-Scripte.</para></listitem>
6242 <listitem><para>Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in <filename>t/</filename>, deren
6243 Dateiname auf <literal>.t</literal> endet.</para></listitem>
6247 <sect2 id="devel.testsuite.prerequisites">
6248 <title>Voraussetzungen</title>
6250 <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>
6253 <listitem><para><literal>Test::Deep</literal> (Debian-Paketname: <literal>libtest-deep-perl</literal>; Fedora Core:
6254 <literal>perl-Test-Deep</literal>; openSUSE: <literal>perl-Test-Deep</literal>)</para></listitem>
6255 <listitem><para><literal>Test::Exception</literal> (Debian-Paketname: <literal>libtest-exception-perl</literal>; Fedora Core:
6256 <literal>perl-Test-Exception</literal>; openSUSE: <literal>perl-Test-Exception</literal>)</para></listitem>
6257 <listitem><para><literal>Test::Output</literal> (Debian-Paketname: <literal>libtest-output-perl</literal>; Fedora Core:
6258 <literal>perl-Test-Output</literal>; openSUSE: <literal>perl-Test-Output</literal>)</para></listitem>
6259 <listitem><para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses Modul ist ab Perl 5.10.1 Bestandteil der
6260 Perl-Distribution und kann für frühere Versionen aus dem <ulink url="http://www.cpan.org">CPAN</ulink> bezogen
6261 werden.</para></listitem>
6262 <listitem><para><literal>LWP::Simple</literal> aus dem Paket <literal>libwww-perl</literal> (Debian-Panetname:
6263 <literal>libwww-perl</literal>; Fedora Core: <literal>perl-libwww-perl</literal>; openSUSE:
6264 <literal>perl-libwww-perl</literal>)</para></listitem>
6265 <listitem><para><literal>URI::Find</literal> (Debian-Panetname: <literal>liburi-find-perl</literal>; Fedora Core:
6266 <literal>perl-URI-Find</literal>; openSUSE: <literal>perl-URI-Find</literal>)</para></listitem>
6269 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
6270 müssen in der Konfigurationsdatei im Abschnit <literal>testing/database</literal> Datenbankverbindungsparameter angegeben
6271 werden. Der hier angegebene Benutzer muss weiterhin das Recht haben, Datenbanken anzulegen und zu löschen.</para>
6274 <sect2 id="devel.testsuite.execution">
6276 Existierende Tests ausführen
6279 <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
6280 gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript <filename>t/test.pl</filename>.</para>
6282 <para>Will man die komplette Test-Suite ausführen, so muss man einfach nur <filename>t/test.pl</filename> ohne weitere Parameter aus
6283 dem kivitendo-Basisverzeichnis heraus ausführen.</para>
6285 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an <filename>t/test.pl</filename>. Beispielsweise:</para>
6287 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
6291 <sect2 id="devel.testsuite.meaning_of_scripts">
6293 Bedeutung der verschiedenen Test-Scripte
6296 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch
6297 während der Entwicklung nützliche Tests sind:</para>
6300 <listitem><para><filename>t/001compile.t</filename> -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab</para></listitem>
6301 <listitem><para><filename>t/002goodperl.t</filename> -- überprüft alle Perl-Dateien auf Anwesenheit von '<literal>use strict</literal>'-Anweisungen</para></listitem>
6302 <listitem><para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von <function>system()</function> und <function>exec()</function> auf Gültigkeit</para></listitem>
6303 <listitem><para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien Tab-Zeichen enthalten</para></listitem>
6304 <listitem><para><filename>t/006spelling.t</filename> -- sucht nach häufigen Rechtschreibfehlern</para></listitem>
6305 <listitem><para><filename>t/011pod.t</filename> -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit</para></listitem>
6308 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module.</para>
6311 <sect2 id="devel.testsuite.create_new">
6313 Neue Test-Scripte erstellen
6316 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende
6317 Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden.</para>
6319 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
6321 Ideen für neue Test-Scripte, die keine konkreten Funktionen testen
6324 <para> Ideen, die abgesehen von Funktionen noch nicht umgesetzt wurden:</para>
6327 <listitem><para>Überprüfung auf fehlende symbolische Links</para></listitem>
6328 <listitem><para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten)</para></listitem>
6329 <listitem><para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para></listitem>
6330 <listitem><para>Überprüfung auf Leerzeichen am Ende von Zeilen</para></listitem>
6331 <listitem><para>Test, ob alle zu übersetzenden Strings in <filename>locale/de/all</filename> vorhanden sind</para></listitem>
6332 <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>
6336 <sect3 id="devel.testsuite.directory_and_test_names">
6338 Konvention für Verzeichnis- und Dateinamen
6341 <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>
6344 <listitem><para>Die Dateiendung muss <filename>.t</filename> lauten.</para></listitem>
6346 <listitem><para>Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise
6347 <filename>bad_function_params.t</filename>).</para></listitem>
6349 <listitem><para>Unterverzeichnisse sollten grob nach dem Themenbereich benannt sein, mit dem sich die Scripte darin befassen
6350 (beispielsweise <filename>background_jobs</filename> für Tests rund um Hintergrund-Jobs).</para></listitem>
6352 <listitem><para>Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist
6353 (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben.</para></listitem>
6357 <sect3 id="devel.testsuite.minimal_example">
6359 Minimales Skelett für eigene Scripte
6362 <para>Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden:</para>
6364 <programlisting>use Test::More tests => 0;
6368 use Support::TestSetup;
6370 Support::TestSetup::login();</programlisting>
6372 <para>Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie
6373 <varname>$::auth</varname>, <varname>$::form</varname> oder <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
6374 <filename>config/kivitendo.conf</filename> im Abschnitt <literal>testing.login</literal> ein gültiger Login-Name eingetragen
6375 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
6377 <para>Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile <code>Support::TestSetup::login();</code>
6378 weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.</para>
6383 <sect1 id="devel.style-guide">
6384 <title>Stil-Richtlinien</title>
6386 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
6387 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
6388 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
6389 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
6391 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
6394 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
6395 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
6400 <para>Es werden keine echten Tabs sondern Leerzeichen
6405 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
6407 <programlisting>foreach my $row (@data) {
6409 # do something with $row
6413 $row->{modules} = MODULE->retrieve(
6414 id => $row->{id},
6415 date => $use_now ? localtime() : $row->{time},
6419 $report->add($row);
6424 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
6425 Zeile wie der letzte Befehl. Beispiele:</para>
6427 <programlisting>sub debug {
6433 <programlisting>if ($form->{item_rows} > 0) {
6439 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
6440 der Befehl / die öffnende schließende Klammer, die den Block
6441 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
6442 Beispiele wie bei 3. gelten.</para>
6446 <para>Die Wörter "<function>else</function>",
6447 "<function>elsif</function>", "<function>while</function>" befinden
6448 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
6451 <programlisting>if ($form->{sum} > 1000) {
6453 } elsif ($form->{sum} > 0) {
6461 } until ($a > 0);</programlisting>
6465 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
6466 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
6467 und grep-ähnliche Operatoren. Beispiel:</para>
6469 <programlisting>$main::lxdebug->message("Could not find file.");
6470 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
6474 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
6476 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
6477 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
6478 Blöcke schon. Beispiel:</para>
6480 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
6485 $form->{sum} += $form->{"row_$i"};
6486 $form->{ $form->{index} } += 1;
6488 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
6492 <para>Mehrzeilige Befehle</para>
6496 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
6497 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
6498 werden, in der die ersten Funktionsparameter in der ersten Zeile
6499 stehen. Beispiel:</para>
6501 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
6502 $form->{some_col_value});</programlisting>
6506 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
6507 besten in einer übersichtlichen Tabellenstruktur organisiert
6508 wird. Beispiel:</para>
6510 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
6511 : $form->{oldcount} ? $form->{oldcount} + 1
6512 : $form->{rowcount} - $form->{rowbase};</programlisting>
6518 <para>Kommentare</para>
6522 <para>Kommentare, die alleine in einer Zeile stehen, sollten
6523 soweit wie der Code eingerückt sein.</para>
6527 <para>Seitliche hängende Kommentare sollten einheitlich
6528 formatiert werden.</para>
6532 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
6533 auf Englisch zu verfassen. So wie ich keine Lust habe,
6534 französischen Quelltext zu lesen, sollte auch der kivitendo
6535 Quelltext für nicht-Deutschsprachige lesbar sein.
6538 <programlisting>my $found = 0;
6546 $i = 0 # initialize $i
6548 $i *= $const; # do something crazy
6549 $i = $n; # recover $i</programlisting>
6555 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
6556 Interpolation gewünscht ist. Beispiel:</para>
6558 <programlisting>$form->{sum} = 0;
6559 $form->{"row_$i"} = $form->{"row_$i"} - 5;
6560 $some_hash{42} = 54;</programlisting>
6564 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
6565 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
6566 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
6567 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
6569 <para>Als Beispiel sei die Funktion
6570 <function>print_options</function> aus
6571 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
6575 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
6576 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
6579 <para>Emacs und vim haben beide recht einfache Methoden zur
6580 Entfernung von trailing whitespace. Emacs kennt das Kommande
6581 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
6582 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
6583 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
6588 <para>Es wird kein <command>perltidy</command> verwendet.</para>
6590 <para>In der Vergangenheit wurde versucht,
6591 <command>perltidy</command> zu verwenden, um einen einheitlichen
6592 Stil zu erlangen. Es hat sich aber gezeigt, dass
6593 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
6594 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
6595 den Interessierten sind hier die
6596 <command>perltidy</command>-Optionen, die grob den beschriebenen
6597 Richtlinien entsprechen:</para>
6599 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
6600 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
6601 -lp -vt=1 -vtc=1</programlisting>
6605 <para><varname>STDERR</varname> ist tabu. Unkonditionale
6606 Debugmeldungen auch.</para>
6608 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
6609 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
6610 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
6612 <para>Die <classname>LXDebug</classname>-Methode
6613 "<function>message</function>" nimmt als ersten Paramter außerdem
6614 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
6615 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
6616 und werden in den meisten Fällen auch vom Repository
6617 zurückgewiesen.</para>
6621 <para>Alle neuen Module müssen use strict verwenden.</para>
6623 <para><varname>$form</varname>, <varname>$auth</varname>,
6624 <varname>$locale</varname>, <varname>$lxdebug</varname> und
6625 <varname>%myconfig</varname> werden derzeit aus dem main package
6626 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
6627 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
6632 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
6633 <title>Dokumentation erstellen</title>
6635 <sect2 id="devel.build-doc.introduction">
6636 <title>Einführung</title>
6638 <para>Diese Dokumentation ist in <productname>DocBook</productname>
6639 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
6640 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
6641 Editor nutzt, der spezielle Unterstützung für
6642 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
6643 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
6644 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
6648 <sect2 id="devel.build-doc.required-software">
6649 <title>Benötigte Software</title>
6651 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
6652 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
6653 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
6654 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
6655 <command>scripts/build_doc.sh</command>.</para>
6657 <para>Das Script benötigt zur Konvertierung verschiedene
6658 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
6664 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
6665 in einer halbwegs aktuellen Version</para>
6669 <para>Das Java-Build-System <ulink
6670 url="http://ant.apache.org/">Apache Ant</ulink></para>
6674 <para>Das Dokumentations-System Dobudish für
6675 <productname>DocBook</productname> 4.5, eine Zusammenstellung
6676 diverser Stylesheets und Grafiken zur Konvertierung von
6677 <productname>DocBook</productname> XML in andere Formate. Das
6678 Paket, das benötigt wird, ist zum Zeitpunkt der
6679 Dokumentationserstellung
6680 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
6681 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
6686 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
6687 sind auf allen gängigen Plattformen verfügbar. Beispiel für
6688 Debian/Ubuntu:</para>
6690 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
6692 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
6693 <filename>doc/build</filename> entpackt werden. Beispiel unter der
6694 Annahme, das <productname>Dobudish</productname> in
6695 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
6697 <programlisting>cd doc/build
6698 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
6701 <sect2 id="devel.build-doc.build">
6702 <title>PDFs und HTML-Seiten erstellen</title>
6704 <para>Die eigentliche Konvertierung erfolgt nach Installation der
6705 benötigten Software mit einem einfachen Aufruf direkt aus dem
6706 kivitendo-Installationsverzeichnis heraus:</para>
6708 <programlisting>./scripts/build_doc.sh</programlisting>
6711 <sect2 id="devel.build-doc.repository">
6712 <title>Einchecken in das Git-Repository</title>
6714 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
6715 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
6716 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
6717 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
6719 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
6720 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob