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.3.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. Unter Ubuntu funktioniert das mit:</para>
229 <programlisting>apt-get install build-essential
230 cpan HTML::Restrict</programlisting>
234 <title>Fedora Core</title>
236 <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>
238 <programlisting>yum install httpd perl-Archive-Zip perl-Clone perl-DBD-Pg \
239 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
240 perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
241 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
242 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
243 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
244 perl-XML-Writer perl-YAML perl-parent postgresql-server</programlisting>
246 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
248 <programlisting>yum install perl-CPAN
249 cpan Config::Std</programlisting>
254 <title>openSUSE</title>
256 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
257 installiert werden:</para>
259 <programlisting>zypper install apache2 perl-Archive-Zip perl-Clone \
260 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
261 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
262 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
263 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
264 perl-URI perl-XML-Writer perl-YAML postgresql-server</programlisting>
266 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
268 <programlisting>yum install perl-CPAN
269 cpan Rose::Db::Object</programlisting>
275 <sect1 id="Manuelle-Installation-des-Programmpaketes"
276 xreflabel="Manuelle Installation des Programmpaketes">
277 <title>Manuelle Installation des Programmpaketes</title>
278 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github gehostet und kann
279 <ulink url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink> heruntergeladen werden.</para>
280 <para>Die kivitendo ERP Installationsdatei (<filename>kivitendo-erp-3.3.0.tgz</filename>) wird im Dokumentenverzeichnis des Webservers
281 (z.B. <filename>/var/www/html/</filename>, <filename>/srv/www/htdocs</filename> oder <filename>/var/www/</filename>) entpackt:</para>
283 <programlisting>cd /var/www
284 tar xvzf kivitendo-erp-3.3.0.tgz</programlisting>
286 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
288 <programlisting>cd kivitendo-erp</programlisting>
290 <para>Alternativ können Sie auch einen Alias in der
291 Webserverkonfiguration benutzen, um auf das tatsächliche
292 Installationsverzeichnis zu verweisen.</para>
294 <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
296 <programlisting>mkdir webdav</programlisting>
298 <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
299 beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
300 Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
301 core <constant>apache</constant> oder bei OpenSUSE <constant>wwwrun</constant>).</para>
303 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
304 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
306 <programlisting>chown -R www-data users spool webdav</programlisting>
308 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
309 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>
311 <programlisting>chown www-data templates users</programlisting>
314 <sect1 id="config.config-file">
315 <title>kivitendo-Konfigurationsdatei</title>
317 <sect2 id="config.config-file.introduction"
318 xreflabel="Einführung in die Konfigurationsdatei">
319 <title>Einführung</title>
321 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei,
322 die benötigt wird: <filename>config/kivitendo.conf</filename> (kurz:
323 "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
324 von kivitendo bzw. der Migration von älteren Versionen angelegt
327 <para>Als Vorlage dient die Datei
328 <filename>config/kivitendo.conf.default</filename> (kurz: "die
329 Default-Datei"):</para>
331 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
333 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
334 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
335 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
336 Abschnitte und Werte enthalten, die von denen der Default-Datei
341 Vor der Umbenennung in kivitendo hieß diese Datei noch <filename>config/lx_office.conf</filename>. Aus Gründen der Kompatibilität
342 wird diese Datei eingelesen, sofern die Datei <filename>config/kivitendo.conf</filename> nicht existiert.
346 <para>Diese Hauptkonfigurationsdatei ist dann eine
347 installationsspezifische Datei, d.h. sie enthält bspw. lokale
348 Passwörter und wird auch nicht im Versionsmanagement (git)
351 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
352 Mandaten, bzw. Datenbanken gleich.</para>
355 <sect2 id="config.config-file.sections-parameters">
356 <title>Abschnitte und Parameter</title>
358 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
359 entsprechend kommentiert sind:</para>
362 <listitem><para><literal>authentication</literal> (siehe Abschnitt "<xref
363 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>" in diesem Kapitel)</para></listitem>
365 <listitem><para><literal>authentication/database</literal></para></listitem>
367 <listitem><para><literal>authentication/ldap</literal></para></listitem>
369 <listitem><para><literal>system</literal></para></listitem>
371 <listitem><para><literal>paths</literal></para></listitem>
373 <listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>
375 <listitem><para><literal>applications</literal></para></listitem>
377 <listitem><para><literal>environment</literal></para></listitem>
380 <listitem><para><literal>print_templates</literal></para></listitem>
382 <listitem><para><literal>task_server</literal></para></listitem>
384 <listitem><para><literal>periodic_invoices</literal></para></listitem>
386 <listitem><para><literal>self_tests</literal></para></listitem>
388 <listitem><para><literal>console</literal></para></listitem>
390 <listitem><para><literal>testing</literal></para></listitem>
392 <listitem><para><literal>testing/database</literal></para></listitem>
394 <listitem><para><literal>debug</literal></para></listitem>
397 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
398 einzustellen oder zu kontrollieren sind, sind:</para>
400 <programlisting>[authentication]
401 admin_password = geheim
403 [authentication/database]
408 password =</programlisting>
410 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
411 <varname>[periodic_invoices]</varname> den Login eines Benutzers
412 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
413 mit Informationen über die erstellten Rechnungen bekommt.</para>
415 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten Ausführung bestimmter Aufgaben mit, den <link
416 linkend="config.task-server">Taskserver</link>. Er wird u.a. für Features wie die <link
417 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link> benötigt, erledigt aber auch andere erforderliche Aufgaben
418 und muss daher in Betrieb genommen werden. Der Taskserver benötigt zwei Konfigurationseinstellungen, die unter
419 <varname>[task_server]</varname> anzugeben sind: ein Mandant (entweder der Mandantenname oder eine Datenbank-ID, Variable
420 <varname>client</varname>), aus dem die Datenbankkonfiguration entnommen wird, sowie ein Login (Variable <varname>login</varname>)
421 eines Benutzers, der für gewisse Dinge wie die Rechnungserstellung als Verkäufer eingetragen wird.</para>
423 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
424 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
427 <sect2 id="config.config-file.prior-versions">
428 <title>Versionen vor 2.6.3</title>
430 <para>In älteren kivitendo Versionen gab es im Verzeichnis
431 <filename>config</filename> die Dateien
432 <filename>authentication.pl</filename> und
433 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
434 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
435 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
436 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
438 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
439 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
440 manuell übertragen und die alten Konfigurationsdateien anschließend
441 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
442 entsprechende Fehlermeldung an.</para>
446 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
447 <title>Anpassung der PostgreSQL-Konfiguration</title>
449 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
451 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
452 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
454 <para>kivitendo setzt zwingend voraus, dass die Datenbank Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen Serverinstallationen
455 braucht man hier meist nicht einzugreifen.</para>
457 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so
458 braucht man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
460 <programlisting>su postgres
462 exit </programlisting>
464 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
465 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
466 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
469 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
471 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
472 Versionsnummer angepasst werden.</para>
474 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
476 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
477 <literal>\l</literal> geprüft werden.</para>
480 <sect2 id="Änderungen-an-Konfigurationsdateien">
481 <title>Änderungen an Konfigurationsdateien</title>
483 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
484 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
485 <filename>/var/lib/pgsql/data/</filename> oder
486 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
487 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
488 Parameter <varname>listen_address</varname> gesteuert. Laufen
489 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
490 <literal>localhost</literal> verwendet werden. Andernfalls müssen
491 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
492 was mit dem Wert <literal>*</literal> geschieht.</para>
494 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
495 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
496 sein sollte, müssen die Berechtigungen für den Zugriff geändert
497 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
498 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
499 Datenbank zum Beispiel:</para>
501 <programlisting>local all kivitendo password
502 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
505 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
506 <title>Erweiterung für servergespeicherte Prozeduren</title>
508 <para>In der Datenbank <literal>template1</literal> muss die
509 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
510 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
511 <programlisting>su - postgres
512 psql template1</programlisting>
514 führen Sie die folgenden Kommandos aus:</para>
516 <programlisting>create language 'plpgsql';
520 <sect2 id="Datenbankbenutzer-anlegen">
521 <title>Datenbankbenutzer anlegen</title>
523 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
524 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
525 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
528 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit nein
529 beantworten, genauso ist die Berechtigung neue User (Roles) zu
530 generieren nicht nötig.</para>
531 <programlisting>su - postgres
532 createuser -d -P kivitendo
533 exit</programlisting>
535 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
536 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.
537 den hier gewählten Benutzernamen.</para>
541 <sect1 id="Apache-Konfiguration">
542 <title>Webserver-Konfiguration</title>
545 <title>Grundkonfiguration mittels CGI</title>
548 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
549 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
550 <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
553 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
554 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
555 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
556 anderen Datei hinzu, die beim Starten des Webservers eingelesen
559 <programlisting>AddHandler cgi-script .pl
560 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
562 <Directory /var/www/kivitendo-erp>
563 Options ExecCGI Includes FollowSymlinks
566 <Directory /var/www/kivitendo-erp/users>
569 </Directory></programlisting>
571 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
572 das kivitendo-Archiv entpacket haben.</para>
575 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
576 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
579 <para>Auf einigen Webservern werden manchmal die Grafiken und
580 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
581 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
583 <programlisting>EnableSendfile Off</programlisting>
586 <sect2 id="Apache-Konfiguration.FCGI"
587 xreflabel="Konfiguration für FastCGI/FCGI">
588 <title>Konfiguration für FastCGI/FCGI</title>
590 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
591 <title>Was ist FastCGI?</title>
593 <para>Direkt aus <ulink
594 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
597 <para><citation> FastCGI ist ein Standard für die Einbindung
598 externer Software zur Generierung dynamischer Webseiten in einem
599 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
600 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
601 umgehen. </citation></para>
604 <sect3 id="Apache-Konfiguration.FCGI.Warum">
605 <title>Warum FastCGI?</title>
607 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
608 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
609 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
610 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
611 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
612 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
613 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
614 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
615 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
616 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
617 deutlich länger dauert als früher, und dass davon 90% für das Laden
618 der Module verwendet wird.</para>
620 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
621 wird nur die eigentliche Programmlogik ausgeführt.</para>
624 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
625 <title>Getestete Kombinationen aus Webservern und Plugin</title>
627 <para>Folgende Kombinationen sind getestet:</para>
631 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
635 <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
639 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
643 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
644 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
645 mod_fastcgi nicht mehr explizit eingegangen.</para>
647 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
651 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern
652 bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer Installation gibt, muss zwingend Version 0.68 oder
653 aber Version 0.72 und neuer eingesetzt werden.</para>
655 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie sich die Vorgängerversion wie folgt
658 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
662 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
663 <title>Konfiguration des Webservers</title>
665 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
666 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
667 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
668 debuggen die beim ersten aufsetzen auftreten können. Sollte die
669 Installation schon funktionieren, lesen Sie weiter.</para>
671 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
672 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
674 <programlisting>a2enmod fcgid</programlisting>
676 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
677 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
678 und <function>Directory</function>-Direktiven. Dabei wird zwischen
679 dem Installationspfad von kivitendo im Dateisystem
680 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
681 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
682 ("<filename>/url/for/kivitendo-erp</filename>").</para>
684 <para>Folgender Konfigurationsschnipsel funktioniert mit
687 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
688 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
690 <Directory /path/to/kivitendo-erp>
692 Options ExecCGI Includes FollowSymlinks
697 <DirectoryMatch /path/to/kivitendo-erp/users>
700 </DirectoryMatch></programlisting>
703 <para>Im Vergleich zu Apache 2.2 hat sich in Apache 2.4 die Syntax der Directorydirektiven verändert. Statt</para>
706 Allow from All </programlisting>
707 <para> muß man jetzt Folgendes einstellen:</para>
708 <programlisting>Require all granted</programlisting>
711 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
712 die maximale Größe eines Requests. Diese sollte wie folgt
713 hochgesetzt werden:</para>
715 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
718 <para>Das Ganze sollte dann so aussehen:</para>
720 <programlisting>AddHandler fcgid-script .fpl
721 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
722 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
723 FcgidMaxRequestLen 10485760
725 <Directory /path/to/kivitendo-erp>
727 Options ExecCGI Includes FollowSymlinks
732 <DirectoryMatch /path/to/kivitendo-erp/users>
735 </DirectoryMatch></programlisting>
737 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
738 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
739 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
740 gibt es hier kleine Performance-Einbußen.</para>
742 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
743 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
744 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
746 <programlisting># Zugriff über CGI
747 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
749 # Zugriff mit mod_fcgid:
750 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
751 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
753 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
754 die normale Version erreichbar, und unter
755 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
756 FastCGI-Version.</para>
761 <sect1 id="config.task-server">
762 <title>Der Task-Server</title>
764 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und
765 diese zu festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess wird u.a. für die Erzeugung der wiederkehrenden
766 Rechnungen und weitere essenzielle Aufgaben benutzt.</para>
768 <sect2 id="Konfiguration-des-Task-Servers">
769 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
771 <para>Die Konfiguration erfolgt über den Abschnitt
772 <literal>[task_server]</literal> in der Datei
773 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
774 Optionen sind:</para>
778 <term><varname>client</varname></term>
781 <para>Name oder Datenbank-ID eines vorhandenen kivitendo-Mandanten, der benutzt wird, um die zu verwendende
782 Datenbankverbindung auszulesen. Der Mandant muss in der Administration angelegt werden. Diese Option muss angegeben
785 <para>Diese Option kam mit Release v3.x.0 hinzu und muss daher in Konfigurationen, die von älteren Versionen aktualisiert
786 wurden, ergänzt werden.</para>
791 <term><varname>login</varname></term>
794 <para>gültiger kivitendo-Benutzername, der z.B. als Verkäufer beim Erzeugen wiederkehrender Rechnungen benötigt wird. Der
795 Benutzer muss in der Administration angelegt werden. Diese Option muss angegeben werden.</para>
800 <term><varname>run_as</varname></term>
803 <para>Wird der Server vom Systembenutzer <literal>root</literal>
804 gestartet, so wechselt er auf den mit <literal>run_as</literal>
805 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
806 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
808 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
809 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
810 unter dem auch der Webserver läuft.</para>
815 <term><varname>debug</varname></term>
818 <para>Schaltet Debug-Informationen an und aus.</para>
824 <sect2 id="Einbinden-in-den-Boot-Prozess">
825 <title>Automatisches Starten des Task-Servers beim Booten</title>
827 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
828 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
829 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
831 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
832 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
833 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
834 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
835 anstelle eines symbolischen Links verwendet werden können.</para>
838 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, ältere Fedora Core)</title>
840 <para>Kopieren Sie die Datei
841 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
842 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
843 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
844 <literal>DAEMON=....</literal>). Binden Sie das Script in den
845 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
849 <para>Debian-basierende Systeme:</para>
851 <programlisting>update-rc.d kivitendo-task-server defaults
852 # Nur bei Debian Squeeze und neuer:
853 insserv kivitendo-task-server</programlisting>
857 <para>Ältere OpenSUSE und ältere Fedora Core:</para>
859 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
863 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
866 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
870 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
872 <para>Kopieren Sie die Datei
873 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
874 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
875 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
876 <literal>exec ....</literal>).</para>
878 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
881 <programlisting>service kivitendo-task-server start</programlisting>
885 <title>systemd-basierende Systeme (z.B. neure OpenSUSE, neuere Fedora Core)</title>
887 <para>Verlinken Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
888 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
889 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>). Binden Sie das Script in den Boot-Prozess ein.
892 <para>Alle hierzu benötigten Befehle sehen so aus:</para>
894 <programlisting>cd /var/www/kivitendo-erp/scripts/boot/systemd
895 ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
897 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
900 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
904 <sect2 id="Prozesskontrolle">
905 <title>Wie der Task-Server gestartet und beendet wird</title>
907 <para>Der Task-Server wird wie folgt kontrolliert:</para>
909 <programlisting>./scripts/task_server.pl Befehl</programlisting>
911 <para><literal>Befehl</literal> ist dabei eine der folgenden
916 <para><literal>start</literal> startet eine neue Instanz des
917 Task-Servers. Die Prozess-ID wird innerhalb des
918 <filename>users</filename>-Verzeichnisses abgelegt.</para>
922 <para><literal>stop</literal> beendet einen laufenden
927 <para><literal>restart</literal> beendet und startet ihn
932 <para><literal>status</literal> berichtet, ob der Task-Server
937 <para>Der Task-Server wechselt beim Starten automatisch in das
938 kivitendo-Installationsverzeichnis.</para>
940 <para>Dieselben Optionen können auch für die SystemV-basierenden
941 Runlevel-Scripte benutzt werden (siehe oben).</para>
943 <sect2 id="Prozesskontrolle2">
944 <title>Task-Server mit mehreren Mandanten</title>
946 <para>Beim Task-Server werden der zu verwendende Mandant und Login-Name des Benutzers, unter dem der Task-Server laufen soll, in die
947 Konfigurationsdatei geschrieben. Hat man mehrere Mandanten, muss man auch mehrere Konfigurationsdateien anlegen.</para>
949 <para>Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf, wo in der Kategorie <varname>[task_server]</varname> die
950 gewünschten Werte für <varname>client</varname> und <varname>login</varname> eingetragen werden.</para>
952 <para>Der alternative Task-Server wird dann mit folgendem Befehl
955 <programlisting>./scripts/task_server.pl -c config/DATEINAME.conf</programlisting>
959 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
960 <title>Benutzerauthentifizierung und Administratorpasswort</title>
962 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
963 über die Verwaltung von Gruppen und weitere Einstellungen</para>
965 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
966 <title>Grundlagen zur Benutzerauthentifizierung</title>
968 <para>kivitendo verwaltet die Benutzerinformationen in einer
969 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
970 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
971 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
972 können, müssen aber nicht unterschiedlich sein.</para>
974 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
975 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
976 abgelegt werden.</para>
978 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
979 entweder gegen die Authentifizierungsdatenbank oder gegen einen
980 LDAP-Server überprüft werden.</para>
982 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
983 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
984 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
985 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
986 einer Version vor v2.6.0 angelegt werden. Eine
987 Beispielkonfigurationsdatei
988 <filename>config/kivitendo.conf.default</filename> existiert, die als
989 Vorlage benutzt werden kann.</para>
992 <sect2 id="Administratorpasswort">
993 <title>Administratorpasswort</title>
995 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
996 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
997 nur dort und nicht mehr im Administrationsinterface selber geändert
998 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
999 Abschnitt <varname>[authentication]</varname>.</para>
1002 <sect2 id="Authentifizierungsdatenbank">
1003 <title>Authentifizierungsdatenbank</title>
1005 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1006 Parametern in <varname>[authentication/database]</varname>
1007 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1011 <term><literal>host</literal></term>
1014 <para>Der Rechnername oder die IP-Adresse des
1015 Datenbankservers</para>
1020 <term><literal>port</literal></term>
1023 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1028 <term><literal>db</literal></term>
1031 <para>Der Name der Authentifizierungsdatenbank</para>
1036 <term><literal>user</literal></term>
1039 <para>Der Benutzername, mit dem sich kivitendo beim
1040 Datenbankserver anmeldet (z.B.
1041 "<literal>postgres</literal>")</para>
1046 <term><literal>password</literal></term>
1049 <para>Das Passwort für den Datenbankbenutzer</para>
1054 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1055 automatisch anlegen (mehr dazu siehe unten).</para>
1058 <sect2 id="Passwortüberprüfung">
1059 <title>Passwortüberprüfung</title>
1061 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1062 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1063 Active-Directory-Server. Welche davon benutzt wird, regelt der
1064 Parameter <varname>module</varname> im Abschnitt
1065 <varname>[authentication]</varname>.</para>
1067 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1068 gespeichert werden, so muss der Parameter <varname>module</varname>
1069 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1070 der Administrator als auch die Benutzer selber ihre Psaswörter in
1071 kivitendo ändern.</para>
1073 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1074 benutzt werden, so muss der Parameter <varname>module</varname> auf
1075 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1076 zusätzliche Informationen über den LDAP-Server im Abschnitt
1077 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1081 <term><literal>host</literal></term>
1084 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1085 Active-Directory-Servers. Diese Angabe ist zwingend
1086 erforderlich.</para>
1091 <term><literal>port</literal></term>
1094 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1099 <term><literal>tls</literal></term>
1102 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1103 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1104 ‘<literal>0</literal>’ belassen</para>
1109 <term><literal>attribute</literal></term>
1112 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1113 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1114 meist ‘<literal>sAMAccountName</literal>’, für andere
1115 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1116 zwingend erforderlich.</para>
1121 <term><literal>base_dn</literal></term>
1124 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1125 Diese Angabe ist zwingend erforderlich.</para>
1130 <term><literal>filter</literal></term>
1133 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1134 <literal><%login%></literal>, so wird dieses durch den vom
1135 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1136 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1137 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1142 <term><literal>bind_dn</literal> und
1143 <literal>bind_password</literal></term>
1146 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1147 durchsucht werden kann (z.B. ist dies bei
1148 Active-Directory-Servern der Fall), so kann diese hier angegeben
1149 werden. Für Active-Directory-Server kann als
1150 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1151 z.B. ‘<literal>cn=Martin
1152 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1153 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1154 also ‘<literal>Martin Mustermann</literal>’.</para>
1160 <sect2 id="Name-des-Session-Cookies">
1161 <title>Name des Session-Cookies</title>
1163 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1164 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1165 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1166 Parameter <varname>cookie_name</varname> im Abschnitt
1167 <varname>[authentication]</varname>gesetzt.</para>
1169 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1170 Server existiert.</para>
1173 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1174 <title>Anlegen der Authentifizierungsdatenbank</title>
1176 <para>Nachdem alle Einstellungen in
1177 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1178 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1179 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1180 der folgenden URL erreichbar sein sollte:</para>
1183 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1187 <sect1 id="Benutzer--und-Gruppenverwaltung">
1188 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1190 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und Datenbanken angelegt werden. Dieses geschieht im
1191 Administrationsmenü, das Sie unter folgender URL finden:</para>
1194 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1196 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1197 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1199 <sect2 id="Zusammenhänge">
1200 <title>Zusammenhänge</title>
1202 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung in einer oder zwei Datenbanken gespeichert werden.</para>
1204 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat
1205 Zugriff auf welche Mandanten, und welche Gruppe verfügt über welche Rechte. Diese Informationen werden in der
1206 Authentifizierungsdatenbank gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter in der Konfigurationsdatei
1207 <filename>config/kivitendo.conf</filename> gespeichert werden.</para>
1209 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten, Waren) und Belege
1210 (Angebote, Lieferscheine, Rechnungen). Diese werden in einer Mandantendatenbank gespeichert. Die
1211 Verbindungsinformationen einer solchen Mandantendatenbank werden im Administrationsbereich konfiguriert, indem man einen Mandanten
1212 anlegt und dort die Parameter einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1214 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich, die Authentifizierungsdatenbank und eine der
1215 Mandantendatenbanken in ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit mehr als einem Mandanten, wird
1216 empfohlen, für die Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die nicht gleichzeitig für einen Mandanten
1217 verwendet wird.</para>
1220 <sect2 id="Mandanten-Benutzer-Gruppen">
1221 <title>Mandanten, Benutzer und Gruppen</title>
1223 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen, die sich frei zueinander zuordnen lassen.</para>
1225 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1226 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1227 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank. Diese sollte über die <link
1228 linkend="Datenbanken-anlegen">Datenbankverwaltung</link> geschehen.</para>
1230 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten soll. Sie erhält einen Loginnamen sowie ein
1231 Passwort. Weiterhin legt der Administrator fest, an welchen Mandanten sich ein Benutzer anmelden kann, was beim Login verifiziert
1234 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür
1235 vom Administrator gewisse Rechte zugeordnet. Weiterhin legt der Administrator fest, für welche Mandanten eine Gruppe gilt, und
1236 welche Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer dann an einem Mandanten an, so erhält er alle Rechte von
1237 allen denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in denen der Benutzer zum Anderen Mitglied ist, </para>
1239 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und Benutzer angelegt werden, kann im Prinzip beliebig gewählt
1240 werden. Die folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1242 <orderedlist numeration="arabic">
1244 <para>Datenbank anlegen</para>
1248 <para>Gruppen anlegen</para>
1252 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1256 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1261 <sect2 id="Datenbanken-anlegen">
1262 <title>Datenbanken anlegen</title>
1264 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1265 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1266 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1269 <sect2 id="Gruppen-anlegen">
1270 <title>Gruppen anlegen</title>
1272 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1273 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1274 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1275 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1277 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank gespeichert, gelten aber nicht automatisch für alle
1278 Mandanten. Der Administrator legt vielmehr fest, für welche Mandanten eine Gruppe gültig ist. Dies kann entweder beim Bearbeiten der
1279 Gruppe geschehen ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn man einen Mandanten bearbeitet ("für diesen
1280 Mandanten sind die Gruppen A, B und C gültig").</para>
1282 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder dieser Gruppe festgelegt werden ("in dieser Gruppe sind die
1283 Benutzer X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten eines Benutzers geschehen ("dieser Benutzer ist
1284 Mitglied in den Gruppen A, B und C").</para>
1287 <sect2 id="Benutzer-anlegen">
1288 <title>Benutzer anlegen</title>
1290 <para>Beim Anlegen von Benutzern werden für viele Parameter Standardeinstellungen vorgenommen, die den Gepflogenheiten des deutschen
1291 Raumes entsprechen.</para>
1293 <para>Zwingend anzugeben ist der Loginname. Wenn die Passwortauthentifizierung über die Datenbank eingestellt ist, so kann hier auch
1294 das Benutzerpasswort gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1297 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier auch konfiguriert werden, auf welche Mandanten der Benutzer
1298 Zugriff hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können sowohl beim Benutzer vorgenommen werden ("dieser
1299 Benutzer hat Zugriff auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen X, Y und Z") als auch beim Mandanten ("auf
1300 diesen Mandanten haben Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe sind Benutzer A, B und C
1301 Mitglieder").</para>
1304 <sect2 id="Mandanten-anlegen">
1305 <title>Mandanten anlegen</title>
1307 <para>Ein Mandant besteht aus Administrationssicht primär aus einem eindeutigen Namen. Weiterhin wird hier hinterlegt, welche
1308 Datenbank als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten einer der eben angelegten Datenbanken eingetragen
1311 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch konfiguriert werden, welche Benutzer Zugriff auf den
1312 Mandanten haben bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen können sowohl beim Mandanten vorgenommen werden
1313 ("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
1314 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
1318 <sect1 id="Drucker--Systemverwaltung">
1319 <title>Drucker- und Systemverwaltung</title>
1320 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte Druckeradministration und System.</para>
1321 <sect2 id="Druckeradministration">
1322 <title>Druckeradministration</title>
1323 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig viele "Druckbefehle" im System verwalten. Diese Befehle werden mandantenweise
1324 zugeordnet. Unter Druckerbeschreibung wird der Namen des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs angezeigt wird.</para>
1325 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl, der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P meinDrucker' oder ein
1326 kompletter Pfad zu einem Skript (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh).
1327 Wird ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich ergänzt, ist
1328 bspw. das Kürzel 'epson_drucker' definiert, so wird beim Ausdruck eines Angebots folgende Vorlage geparst: sales_quotation_epson_drucker.tex.</para>
1331 <title>System sperren / entsperren</title>
1333 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der gesamten kivitendo Installation gesperrt.</para>
1334 <para>Falls die Sperre gesetzt ist, erscheint anstelle der Anmeldemaske die Information: 'kivitendo ist momentan zwecks Wartungsarbeiten nicht zugänglich.'.
1336 <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
1337 mit einem inkonsistenten Datenbestand weitergearbeitet werden.</para>
1341 <sect1 id="config.sending-email" xreflabel="E-Mail-Versand aus kivitendo heraus">
1342 <title>E-Mail-Versand aus kivitendo heraus</title>
1344 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden, z.B. um ein Angebot direkt an einen Kunden zu
1345 verschicken. Damit dies funktioniert, muss eingestellt werden, über welchen Server die E-Mails verschickt werden sollen. kivitendo
1346 unterstützt dabei zwei Mechanismen: Versand über einen lokalen E-Mail-Server (z.B. mit <productname>Postfix</productname> oder
1347 <productname>Exim</productname>, was auch die standardmäßig aktive Methode ist) sowie Versand über einen SMTP-Server (z.B. der des
1348 eigenen Internet-Providers).</para>
1350 <para>Welche Methode und welcher Server verwendet werden, wird über die Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1351 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1353 <sect2 id="config.sending-email.sendmail" xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1354 <title>Versand über lokalen E-Mail-Server</title>
1356 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie
1357 z.B. <productname>Postfix</productname>, <productname>Exim</productname> oder <productname>Sendmail</productname> läuft.</para>
1359 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1360 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1362 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet wird, dient der Parameter '<literal>sendmail =
1363 ...</literal>'. Der Standardwert verweist auf das Programm <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1364 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1366 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen dieses sprengen. Hierfür sei auf die Dokumentation des
1367 E-Mail-Servers verwiesen.</para>
1370 <sect2 id="config.sending-email.smtp" xreflabel="E-Mail-Versand über einen SMTP-Server">
1371 <title>Versand über einen SMTP-Server</title>
1373 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server vorhanden oder zwar einer vorhanden, dieser aber nicht
1374 konfiguriert ist.</para>
1376 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1377 Parameter dienen dabei der weiteren Konfiguration:</para>
1381 <term><varname>hostname</varname></term>
1383 <listitem><para>Name oder IP-Adresse des SMTP-Servers. Standardwert: '<literal>localhost</literal>'</para></listitem>
1387 <term><varname>port</varname></term>
1389 <listitem><para>Portnummer. Der Standardwert hängt von der verwendeten Verschlüsselungsmethode ab. Gilt '<literal>security =
1390 none</literal>' oder '<literal>security = tls</literal>', so ist 25 die Standardportnummer. Für '<literal>security =
1391 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht geändert werden.</para></listitem>
1395 <term><varname>security</varname></term>
1397 <listitem><para>Wahl der zu verwendenden Verschlüsselung der Verbindung mit dem Server. Standardwert ist
1398 '<literal>none</literal>', wodurch keine Verschlüsselung verwendet wird. Mit '<literal>tls</literal>' wird TLS-Verschlüsselung
1399 eingeschaltet, und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL eingeschaltet. Achtung: Für
1400 '<literal>tls</literal>' und '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt (siehe unten).</para></listitem>
1404 <term><varname>login</varname> und <varname>password</varname></term>
1406 <listitem><para>Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername
1407 und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von
1408 Verschlüsselung aktiviert werden.</para></listitem>
1412 <para>Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind:</para>
1415 <listitem><para>TLS-Verschlüsselung: Modul <literal>Net::SSLGlue</literal> (Debian-Paketname
1416 <literal>libnet-sslglue-perl</literal>, Fedora Core: <literal>perl-Net-SSLGlue</literal>, openSUSE:
1417 <literal>perl-Net-SSLGlue</literal></para></listitem>
1419 <listitem><para>SSL-Verschlüsselung: Modul <literal>Net::SMTP::SSL</literal> (Debian-Paketname
1420 <literal>libnet-smtp-ssl-perl</literal>, Fedora Core: <literal>perl-Net-SMTP-SSL</literal>, openSUSE:
1421 <literal>perl-Net-SMTP-SSL</literal></para></listitem>
1426 <sect1 id="Drucken-mit-kivitendo">
1427 <title>Drucken mit kivitendo</title>
1429 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. Um drucken zu können, braucht der Server ein geeignetes
1430 LaTeX System. Am einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter debianoiden Betriebssystemen installiert man
1431 die Pakete mit:</para>
1433 <para><programlisting>aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1434 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1436 <para>TODO: RPM-Pakete.</para>
1438 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1440 <listitem><para>Standard</para></listitem>
1441 <listitem><para>f-tex</para></listitem>
1442 <listitem><para>RB</para></listitem>
1445 <sect2 id="Vorlagenverzeichnis-anlegen" xreflabel="Vorlagenverzeichnis anlegen">
1446 <title>Vorlagenverzeichnis anlegen</title>
1447 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1449 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1451 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
1452 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch <xref linkend="Gruppen-anlegen"/>.
1454 <para>Im Userbereich lässt sich unter:
1455 "<guimenu>System</guimenu> ->
1456 <guisubmenu>Mandantenverwaltung</guisubmenu> -> <guimenuitem>Verschiedenes</guimenuitem>" die Option
1457 "Neue Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1460 <listitem><para><option>Vorlagen auswählen</option>: Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll
1461 (<filename>Standard</filename>, <filename>f-tex</filename> oder <filename>RB</filename>.)</para></listitem>
1462 <listitem><para><option>Neuer Name</option>: Der Verzeichnisname für den neuen Vorlagensatz. Dieser kann im Rahmen der üblichen
1463 Bedingungen für Verzeichnisnamen frei gewählt werden.</para></listitem>
1466 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist für den aktuellen Mandanten ausgewählt.
1467 Der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1468 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch vorgenommen werden. Den Ordner findet man im Dateisystem unter
1469 <filename>./templates/[Neuer Name]</filename></para>
1473 <sect2 id="Vorlagen-Standard">
1474 <title>Standard</title>
1476 <para>Der Standard-Vorlagensatz von kivitendo. Wie unter <ulink url="https://www.kivitendo.de">https://www.kivitendo.de</ulink> zu
1482 <title>f-tex</title>
1484 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt.</para>
1486 <sect3 id="f-tex-Feature-Übersicht">
1487 <title>Feature-Übersicht</title>
1489 <listitem><para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage für alle briefartigen Dokumente verwendet. Also
1490 Angebot, Rechnung, Proformarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc.</para></listitem>
1492 <listitem><para>Leichte Anpassung an das Firmen-Layout durch Verwendung eines Hintergrund-PDFs. Dieses kann leicht mit dem
1493 eigenen Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp, Adobe*)</para></listitem>
1495 <listitem><para>Hintergrund-PDF umschaltbar auf "nur erste Seite" (Standard) oder "alle Seiten" (Option
1496 "<option>bgPdfFirstPageOnly</option>" in Datei <filename>letter.lco</filename>)</para></listitem>
1498 <listitem><para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1499 versendeten Dokumenten eingebunden (Option "<option>bgPdfEmailOnly</option>" in Datei
1500 <filename>letter.lco</filename>).</para></listitem>
1502 <listitem><para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch, Wiederholung von Kopfzeilen, Zwischensummen
1503 etc. (danke an Kai-Martin Knaak für die Vorarbeit)</para></listitem>
1505 <listitem><para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom Land des eigenen Unternehmens abweicht (also die
1506 Rechnung das Land verlässt).</para></listitem>
1508 <listitem><para>Multisprachfähig leicht um weitere Sprachen zu erweitern, alle Übersetzungen in der Datei
1509 <filename>translatinos.tex</filename>.</para></listitem>
1511 <listitem><para>Auflistung von Bruttopreisen für Endverbraucher.</para></listitem>
1515 <sect3 id="f-tex-Installation">
1516 <title>Die Installation</title>
1518 <listitem><para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref linkend="Vorlagenverzeichnis-anlegen"/>. Das
1519 Vorlagensystem funktioniert jetzt schon, hat allerdings noch einen Beispiel-Briefkopf.</para></listitem>
1521 <listitem><para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach <filename>./letter_head.pdf</filename>.</para></listitem>
1522 <listitem><para>Editiere den Bereich "<option>settings</option>" in der datei <filename>letter.lco</filename>.</para></listitem>
1525 <para>oder etwas detaillierter:</para>
1528 Es wird eine Datei <filename>sample.lco</filename> erstellt und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
1529 ist dies die Datei die für die firmenspezifischen Anpassungen gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig
1530 ist, wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen
1531 vorzunehmen und <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung über eine
1532 <filename>*.lco</filename>-Datei, die letztlich auf <filename>letter.lco</filename> verlinkt ist ist aber auch möglich.
1536 Es wird eine Datei <filename>sample_head.pdf</filename> mit ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
1537 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei
1538 <filename>sample_head.pdf</filename> an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
1539 Template Verzeichniss ablegen und statt <filename>sample_head.pdf</filename> nach <filename>letter_head.pdf</filename>
1544 Letzlich muss <filename>letter_head.pdf</filename> auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
1549 Es wird eine Datei <filename>mydata.tex.example</filename> ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
1550 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das Land verwendet. Die Datei muss also nicht angefasst
1551 werden. Die anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig).
1554 Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc. sollten über die Hintergrund-PDF-Datei oder die
1555 <filename>*.lco</filename>-Datei erfolgen.
1559 <sect3 id="f-tex-Funktionsübersicht">
1560 <title>f-tex Funktionsübersicht</title>
1562 Das Konzept von kivitendo sieht vor, für jedes Dokument (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine LaTeX-Vorlage
1563 vorzuhalten, dies ist sehr wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
1564 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
1565 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche LaTeX-Vorlage verwendet, welche über Codeweichen die
1566 Besonderheiten der jeweiligen Dokumente berücksichtigt:
1570 <listitem><para>Tabellen mit oder ohne Preis</para></listitem>
1571 <listitem><para>Sprache der Tabellenüberschriften etc.</para></listitem>
1572 <listitem><para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus Angebotsnummer)</para></listitem>
1573 <listitem><para>Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus gewerblicher
1574 Kunde)</para></listitem>
1577 <para>Nachteil:</para>
1580 LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
1581 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann natürlich
1582 auch innerhalb der Tabellendarstellung gut persönliche Anpassungen vornehmen. Aber man kann sich hier bei Veränderungen sehr
1583 schnell heftig in den Fuss schiessen.
1586 <para>Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
1587 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen, und sich an der Form der dargestellten Tabellen, wie sie
1588 ausgeliefert werden, erfreuen.
1591 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine, kontinuierliche Schritte gehen.</para>
1595 <sect3 id="f-tex-Bruttopreise">
1596 <title>Bruttopreise für Endverbraucher</title>
1598 <para>Der auszuweisende Bruttopreis wird innerhalb der LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen "alle
1599 Preise Brutto" auszuwählen, aber:</para>
1602 <para>hierfür müssen die Preise auch in Brutto in der Datenbank stehen (ja - das lässt sich über die Preisgruppen und die
1603 Zuordung einer Default-Preisgruppe handhaben)</para>
1606 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
1607 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche Knackpunkt)</para>
1612 Es gibt mit f-tex eine weitere Alternative. Die Information ob Brutto oder Nettorechnung wird mit den Zahlarten
1613 verknüpft. Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben werden sollen, enden mit "_E" (für
1614 Endverbraucher). Falls identische Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt man diese einfach doppelt
1615 an (einmal mit der Namensendung "_E"). Gewinn:</para>
1618 <listitem><para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste verbunden.</para></listitem>
1619 <listitem><para>Die Default-Zahlart kann im Kundendatensatz hinterlegt werden, und man muss nicht mehr daran denken, "alle Preise
1620 Netto" auszuwählen.</para></listitem>
1621 <listitem><para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken revidiert werden,
1622 ohne dass sich der Auftragswert ändert.</para></listitem>
1626 <sect3 id="f-tex-lieferadressen">
1627 <title>Lieferadressen</title>
1629 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen im Adressfeld zum Einsatz. Wenn die
1630 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende Adressvariable eingesetzt. Wenn also die Lieferadresse in
1631 Straße, Hausnummer und Ort abweicht, müssen auch nur diese Felder in der Lieferadresse ausgefüllt werden. Für den Firmenname wird
1632 der Wert der Hauptadresse angezeigt.
1637 <sect2 id="Vorlagen-RB">
1638 <title>Der Druckvorlagensatz RB</title>
1640 <para>Hierbei handelt es sich um einen vollständigen \LaTeX Dokumentensatz mit alternativem Design. Die odt oder html-Varianten sind nicht gepflegt.</para>
1641 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
1642 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1643 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die eigenen Firmendaten finden sich in der Datei Readme.tex im Vorlagenverzeichnis.</para>
1645 <para>Eine kurze Übersicht der Features:</para>
1647 <listitem><para>Mehrsprachenfähig, mit Deutscher und Englischer Übersetzung</para></listitem>
1648 <listitem><para>Zentrale Konfigurationsdateien, die für alle Belege benutzt werden, z.B. für Kopf- und Fußzeilen, und Infos wie Bankdaten</para></listitem>
1649 <listitem><para>mehrere vordefinierte Varianten für Logos/Hintergrundbilder</para></listitem>
1650 <listitem><para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder "Außerhalb EU"</para></listitem>
1655 <sect2 id="allgemeine-hinweise-zu-latex">
1656 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
1657 <para>In den allermeisten Installationen sollte das Drucken jetzt schon
1658 funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
1659 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeile,
1660 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1665 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1666 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1667 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1671 <para>! Package inputenc Error: Unicode char \u8:... set up for
1672 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1673 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1674 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1675 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1676 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1680 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des Templates,
1681 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1682 Prüfen Sie den Namen in der Konfiguration (Standard:
1683 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1684 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1687 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser verifizieren lässt:</para>
1690 <para> editiere [kivitendo-home]/config/kivitendo.conf und ändere "keep_temp_files" auf 1</para>
1691 <para><programlisting>keep_temp_files = 1;</programlisting></para>
1694 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
1697 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
1700 <para>wechsel in das users Verzeichnis von kivitendo</para>
1701 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
1704 <para>LaTeX Suchpfad anpassen:</para>
1705 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
1708 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf erstellt hat</para>
1709 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
1710 <para>Es sollte die letzte Datei ganz unten sein</para>
1713 <para>für besseren Hinweis auf Fehler texdatei nochmals übersetzen</para>
1714 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
1715 <para>in der *.tex datei nach dem Fehler suchen.</para>
1721 <sect1 id="OpenDocument-Vorlagen">
1722 <title>OpenDocument-Vorlagen</title>
1724 <para>kivitendo unterstützt die Verwendung von Vorlagen im
1725 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1726 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1727 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1728 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1729 <filename>config/kivitendo.conf</filename> die Variable
1730 <literal>opendocument</literal> im Abschnitt
1731 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1732 Dieses ist die Standardeinstellung.</para>
1734 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1735 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1736 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1737 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1738 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1739 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1741 <para>Nach der Installation müssen in der Datei
1742 <filename>config/kivitendo.conf</filename> zwei weitere Variablen
1743 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1744 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1745 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1746 enthalten. Beide stehen im Abschnitt
1747 <literal>applications</literal>.</para>
1749 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
1750 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1751 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1752 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1753 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1754 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1755 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1756 werden muss. Der Nachteil ist, dass diese Methode Python und die
1757 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1762 Für die Verbindung zu OpenOffice wird normalerweise der Python-Interpreter <filename>/usr/bin/python</filename> benutzt. Sollte
1763 dies nicht der richtige sein, so kann man mit zwei Konfigurationsvariablen entscheiden, welcher Python-Interpreter genutzt
1764 wird. Mit der Option <literal>python_uno</literal> aus dem Abschnitt <literal>applications</literal> wird der Interpreter selber
1765 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert <literal>/usr/bin/python</literal>.
1769 Zusätzlich ist es möglich, Pfade anzugeben, in denen Python neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
1770 z.B. falls sich diese in einem gesonderten OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
1771 <literal>python_uno_path</literal> und befindet sich im Abschnitt <literal>environment</literal>. Sie ist standardmäßig
1772 leer. Werden hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte voneinander getrennt werden. Der Inhalt wird an den
1773 Python-Interpreter über die Umgebungsvariable <literal>PYTHONPATH</literal> übergeben.
1777 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1778 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1779 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1780 Dokumentenvorlage enthalten sein und
1781 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1782 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1783 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1784 ebenfalls enthalten sein muss.</para>
1786 <para>Als letztes muss herausgefunden werden, welchen Namen
1787 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1788 gibt. Unter Debian ist dies momentan
1789 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1790 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1791 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1792 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1793 folgender Befehl auszuführen:</para>
1795 <para><literal>mv users/.openoffice.org2
1796 users/.openoffice</literal></para>
1798 <para>Dieses Verzeichnis, wie auch das komplette
1799 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1800 sein. Dieses wurde bereits erledigt (siehe <xref
1801 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1802 erneut überprüft werden, wenn die Konvertierung nach PDF
1806 <sect1 id="config.eur">
1807 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1810 <sect2 id="config.eur.introduction"
1811 xreflabel="Einführung in die Konfiguration zur EUR">
1812 <title>Einführung</title>
1814 <para>kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1815 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals noch <filename>config/lx_office.conf</filename>)
1816 befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden.</para>
1818 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1819 die Mandantendatenbank verschoben und dabei auch gleich in drei
1820 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1821 steuern lässt.</para>
1824 <sect2 id="config.eur.parameters"
1825 xreflabel="Konfigurationsparameter für EUR">
1826 <title>Konfigurationsparameter</title>
1828 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1829 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1833 <term><varname>profit_determination</varname></term>
1836 <para>Dieser Parameter legt die Berechnungsmethode für die
1837 Gewinnermittlung fest. Er enthält entweder
1838 <literal>balance</literal> für
1839 Betriebsvermögensvergleich/Bilanzierung oder
1840 <literal>income</literal> für die
1841 Einnahmen-Überschuss-Rechnung.</para>
1846 <term><varname>accounting_method</varname></term>
1849 <para>Dieser Parameter steuert die Buchungs- und
1850 Berechnungsmethoden für die Versteuerungsart. Er enthält
1851 entweder <literal>accrual</literal> für die Soll-Versteuerung
1852 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1857 <term><varname>inventory_system</varname></term>
1860 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1861 enthält entweder <literal>perpetual</literal> für die
1862 Bestandsmethode oder <literal>periodic</literal> für die
1863 Aufwandsmethode.</para>
1868 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1869 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1870 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1871 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1872 Bestandsmethode.</para>
1874 <para>Die Konfiguration "<varname>eur</varname>" unter
1875 <varname>[system]</varname> in der <link
1876 linkend="config.config-file">Konfigurationsdatei</link>
1877 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
1878 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1881 <sect2 id="config.eur.setting-parameters">
1882 <title>Festlegen der Parameter</title>
1884 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1885 der Admininstration können diese Optionen nun unabhängig voneinander
1886 eingestellt werden.</para>
1888 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1889 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1892 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1893 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
1894 angezeigt. Unter <guimenu>System</guimenu>
1895 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> können
1896 die Einstellungen auch geändert werden. Dabei ist zu beachten,
1897 dass eine Änderung vorhandene Daten so belässt und damit
1898 evtl. die Ergebnisse verfälscht. Dies gilt vor Allem für die
1899 Warenbuchungsmethode (siehe auch
1900 <link linkend="config.eur.inventory-system-perpetual">
1901 Bemerkungen zur Bestandsmethode</link>).</para>
1904 <sect2 id="config.eur.inventory-system-perpetual">
1905 <title>Bemerkungen zur Bestandsmethode</title>
1907 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1908 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
1909 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1910 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1911 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1912 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1913 Einkaufsrechnungen berechnet wird.</para>
1915 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1916 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1917 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1921 <sect2 id="config.eur.knonw-issues">
1922 <title>Bekannte Probleme</title>
1924 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1925 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1926 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1927 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1928 die Konfigurationsvariable
1929 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1932 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1933 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1937 <sect1 id="config.skr04-update-3804">
1938 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1940 <sect2 id="config.skr04-update-3804.introduction">
1941 <title>Einführung</title>
1943 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1944 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1945 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1946 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1947 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1948 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1949 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1950 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1951 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1952 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1953 Screenshots dargestellt.</para>
1955 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1956 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1957 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1958 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1961 <sect2 id="config.skr04-update-3804.create-chart">
1962 <title>Konto 3804 manuell anlegen</title>
1964 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
1965 anzulegen und zu konfigurieren. Zuerst wird in
1966 <guimenu>System</guimenu> ->
1967 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
1968 erfassen</guimenuitem> das Konto angelegt.</para>
1971 <screeninfo>Konto 3804 erfassen</screeninfo>
1975 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
1981 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
1982 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
1983 wie im folgenden Screenshot angezeigt anpassen.
1987 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
1991 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
1997 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
1998 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
2002 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
2006 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
2012 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
2013 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
2014 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
2015 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
2019 <screeninfo>Konto 4315 anpassen</screeninfo>
2023 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
2029 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
2030 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
2034 <screeninfo>Steuerliste vergleichen</screeninfo>
2038 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
2045 <title>Verhalten des Bilanzberichts</title>
2047 Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als Grundlage für das
2048 Startdatum benutzt. Schließt man die Bücher allerdings monatsweise führt dies
2049 zu falschen Werten.</para>
2050 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau einstellen indem man:</para>
2053 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu vorher)</para>
2056 <para>immer den Jahresanfang nimmt (1.1. relativ zum Stichtag)</para>
2059 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
2060 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen gibt</para>
2061 <para>- oder mit "alle Buchungen" als Alternative"</para>
2064 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen gibt </para>
2067 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
2071 Folgende Hinweise zu den Optionen:
2072 Das "Bücher schließen Datum" ist sinnvoll, wenn man nur komplette Jahre
2073 schließt. Bei Wirtschaftsjahr = Kalendarjahr entspricht dies aber auch
2075 "Alle Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
2077 Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B. sinnvoll, wenn man
2078 am sich Anfang des zweiten Buchungsjahres befindet, und noch keinen
2079 Jahreswechsel und auch noch keine EB-Buchungen hat.
2080 Bei den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1. Tag
2081 des Wirtschaftsjahres gebucht werden.
2082 Zur Sicherheit wird das Startdatum im Bilanzbericht jetzt zusätzlich zum
2083 Stichtag mit angezeigt. Das hilft auch bei der Kontrolle für den
2084 Abgleich mit der GuV.
2087 <sect1 id="config.client">
2088 <title>Einstellungen pro Mandant</title>
2090 <para>Einige Einstellungen können von einem Benutzer mit dem
2091 <link linkend="Zusammenhänge">Recht</link> "Administration
2092 (Für die Verwaltung der aktuellen Instanz aus einem Userlogin heraus)"
2093 gemacht werden. Diese Einstellungen sind dann für die aktuellen
2094 Mandanten-Datenbank gültig. Die Einstellungen sind
2095 unter <guimenu>System</guimenu>
2096 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
2098 <para>Bitte beachten Sie die Hinweise zu den einzelnen
2099 Einstellungen. Einige Einstellungen sollten nicht ohne Weiteres
2100 im laufenden Betrieb geändert werden (siehe
2101 auch <link linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
2102 Bestandsmethode</link>).</para>
2104 <para>Die Einstellungen <literal>show_bestbefore</literal>
2105 und <literal>payments_changeable</literal> aus dem
2106 Abschnitt <literal>features</literal> und die Einstellungen im
2107 Abschnitt <literal>datev_check</literal> (sofern schon vorhanden)
2108 der <link linkend="config.config-file">kivitendo-Konfigurationsdatei</link>
2109 werden bei einem Datenbankupdate einer älteren Version automatisch
2110 übernommen. Diese Einträge können danach aus der Konfigurationsdatei
2111 entfernt werden.</para>
2114 <sect1 id="kivitendo-ERP-verwenden">
2115 <title>kivitendo ERP verwenden</title>
2117 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
2118 folgender URL erreichbar:</para>
2121 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
2123 <para>Die Administrationsseite erreichen Sie unter:</para>
2126 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
2130 <chapter id="features" xreflabel="Features und Funktionen">
2131 <title>Features und Funktionen</title>
2133 <sect1 id="features.periodic-invoices"
2134 xreflabel="Wiederkehrende Rechnungen">
2135 <title>Wiederkehrende Rechnungen</title>
2137 <sect2 id="features.periodic-invoices.introduction"
2138 xreflabel="Einführung in wiederkehrende Rechnungen">
2139 <title>Einführung</title>
2141 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
2142 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
2143 Die konfigurierten Aufträge werden später automatisch in Rechnungen
2144 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
2145 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
2146 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
2147 wiederzufinden sind.</para>
2150 <sect2 id="features.periodic-invoices.configuration"
2151 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
2152 <title>Konfiguration</title>
2154 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
2155 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
2156 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
2157 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
2158 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
2161 <para>Folgende Parameter kann man konfigurieren:</para>
2168 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
2169 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang eines
2170 neuen Monats).</para>
2172 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
2173 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
2174 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
2175 nächsten Periodenwechsel für alle Perioden, seit der letzten
2176 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
2177 verhindern, muss man vorher das Startdatum neu setzen.</para>
2179 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
2180 erstellt. Man kann sich diese Aufträge aber gesondert in den
2181 Berichten anzeigen lassen.</para>
2186 <term>Periodizität</term>
2189 <para>Ob monatlich, quartalsweise oder jährlich auf neue
2190 Rechnungen überprüft werden soll. Für jede Periode seit dem
2191 Startdatum wird überprüft, ob für die Periode (beginnend immer
2192 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
2193 wurde. Unter Umständen können bei einem Startdatum in der
2194 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
2199 <term>Buchen auf</term>
2202 <para>Das Forderungskonto, in der Regel "Forderungen aus
2203 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
2204 Buchungsgruppen der betreffenden Waren.</para>
2209 <term>Startdatum</term>
2212 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
2218 <term>Enddatum</term>
2221 <para>ab wann keine Rechnungen mehr erstellt werden
2227 <term>Automatische Verlängerung um x Monate</term>
2230 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
2231 eingetragenen Enddatums weiterhin erstellt werden, so kann man
2232 hier die Anzahl der Monate eingeben, um die das Enddatum
2233 automatisch nach hinten geschoben wird.</para>
2238 <term>Drucken</term>
2241 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
2242 Rechnungen auch gleich ausdrucken lassen.</para>
2247 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
2248 Informationen zu den erstellten Rechnungen verschickt werden.
2249 Konfiguriert wird dies in der <link
2250 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
2251 <filename>config/kivitendo.conf</filename> im Abschnitt
2252 <varname>[periodic_invoices]</varname>.</para>
2255 <sect2 id="features.periodic-invoices.variables">
2256 <title>Spezielle Variablen</title>
2259 Um die erzeugten Rechnungen individualisieren zu können, werden beim Umwandeln des Auftrags in eine Rechnung einige speziell
2260 formatierte Variablen durch für die jeweils aktuelle Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B. den
2261 Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei die Syntax <literal><%variablenname%></literal>.
2265 Sofern es sich um eine Datumsvariable handelt, kann das Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
2266 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus: <literal><%variablenname
2267 FORMAT=Formatinformation%></literal>. Die zur verfügung stehenden Formatinformationen werden unten genauer beschrieben.
2271 Diese Variablen werden in den folgenden Elementen des Auftrags ersetzt:
2275 <listitem><para>Bemerkungen</para></listitem>
2276 <listitem><para>Interne Bemerkungen</para></listitem>
2277 <listitem><para>Vorgangsbezeichnung</para></listitem>
2278 <listitem><para>In den Beschreibungs- und Langtextfeldern aller Positionen</para></listitem>
2281 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
2285 <term><varname><%current_quarter%></varname>, <varname><%previous_quarter%></varname>, <varname><%next_quarter%></varname></term>
2289 Aktuelles, vorheriges und nächstes Quartal als Zahl zwischen <literal>1</literal> und <literal>4</literal>.
2295 <term><varname><%current_month%></varname>, <varname><%previous_month%></varname>, <varname><%next_month%></varname></term>
2299 Aktueller, vorheriger und nächster Monat als Zahl zwischen <literal>1</literal> und <literal>12</literal>.
2305 <term><varname><%current_month_long%></varname>, <varname><%previous_month_long%></varname>, <varname><%next_month_long%></varname></term>
2309 Aktueller, vorheriger und nächster Monat als Name (<literal>Januar</literal>, <literal>Februar</literal> etc.).
2315 <term><varname><%current_year%></varname>, <varname><%previous_year%></varname>, <varname><%next_year%></varname></term>
2319 Aktuelles, vorheriges und nächstes Jahr als vierstellige Jahreszahl (<literal>2013</literal> etc.).
2325 <term><varname><%period_start_date%></varname>, <varname><%period_end_date%></varname></term>
2329 Formatiertes Datum des ersten und letzten Tages im Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im ersten
2330 Quartal von 2013 wären dies der <literal>01.01.2013</literal> und <literal>31.03.2013</literal>).
2337 Die invidiuellen Formatinformationen bestehen aus Paaren von Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
2338 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal> durch das viertstellige Jahr ersetzt. Alle möglichen
2345 <term><varname>%a</varname></term>
2348 <para>Der abgekürzte Wochentagsname.</para>
2353 <term><varname>%A</varname></term>
2356 <para>Der ausgeschriebene Wochentagsname.</para>
2361 <term><varname>%b</varname></term>
2364 <para>Der abgekürzte Monatsname.</para>
2369 <term><varname>%B</varname></term>
2372 <para>Der ausgeschriebene Monatsname.</para>
2377 <term><varname>%C</varname></term>
2380 <para>Das Jahrhundert (Jahr/100) als eine zweistellige Zahl.</para>
2385 <term><varname>%d</varname></term>
2388 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
2393 <term><varname>%D</varname></term>
2396 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
2401 <term><varname>%e</varname></term>
2404 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings werden führende Nullen durch Leerzeichen ersetzt.</para>
2409 <term><varname>%F</varname></term>
2412 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
2417 <term><varname>%j</varname></term>
2420 <para>Der Tag im Jahr als Zahl zwischen 001 und 366 inklusive.</para>
2425 <term><varname>%m</varname></term>
2428 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
2433 <term><varname>%u</varname></term>
2436 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei die 1 dem Montag entspricht.</para>
2441 <term><varname>%U</varname></term>
2444 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive, wobei der erste Sonntag im Jahr das Startdatum von Woche 01 ist.</para>
2449 <term><varname>%V</varname></term>
2452 <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>
2457 <term><varname>%w</varname></term>
2460 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei die 0 dem Sonntag entspricht.</para>
2465 <term><varname>%W</varname></term>
2468 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive, wobei der erste Montag im Jahr das Startdatum von Woche 01 ist.</para>
2473 <term><varname>%y</varname></term>
2476 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99 inklusive.</para>
2481 <term><varname>%Y</varname></term>
2484 <para>Das Jahr als vierstellige Zahl.</para>
2489 <term><varname>%%</varname></term>
2492 <para>Das Prozentzeichen selber.</para>
2498 Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode
2499 dauert: <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%> bis <%period_end_date FORMAT=%m/%Y%></literal>
2503 <sect2 id="features.periodic-invoices.reports">
2504 <title>Auflisten</title>
2506 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
2507 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
2508 Rechnungen inaktiv", mit denen man sich einen Überglick über die
2509 wiederkehrenden Rechnungen verschaffen kann.</para>
2512 <sect2 id="features.periodic-invoices.task-server">
2513 <title>Erzeugung der eigentlichen Rechnungen</title>
2515 <para>Die zeitliche und periodische Überprüfung, ob eine
2516 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
2517 durch den <link linkend="config.task-server">Taskserver</link>, einen
2518 externen Dienst, der automatisch beim Start des Servers gestartet
2519 werden sollte.</para>
2522 <sect2 id="features.periodic-invoices.create-for-current-month">
2523 <title>Erste Rechnung für aktuellen Monat erstellen</title>
2525 <para>Will man im laufenden Monat eine monatlich wiederkehrende
2526 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
2527 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
2528 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
2529 generiert hat. Alternativ setzt man das Startdatum auf den
2530 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
2531 manuell über den Workflow.</para>
2534 <sect1 id="features.bank"
2535 xreflabel="bankerweiterung">
2536 <title>Bankerweiterung</title>
2538 <sect2 id="features.bank.introduction"
2539 xreflabel="Einführung in die Bankerweiterung">
2540 <title>Einführung</title>
2542 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch im Wiki und soll von dort später hierhin übernommen werden:</para>
2545 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
2548 <sect1 id="dokumentenvorlagen-und-variablen">
2549 <title>Dokumentenvorlagen und verfügbare Variablen</title>
2551 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
2552 <title>Einführung</title>
2554 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
2555 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
2556 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
2557 <function><%variablenname%></function> verwendet wird. Für
2558 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
2560 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
2562 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
2563 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
2564 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
2565 alle Vorlagenarten.</para>
2567 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
2568 verfügbar als hier aufgelistet werden. Die meisten davon können
2569 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
2570 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
2571 diese wie folgt erhalten werden:</para>
2575 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
2576 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
2580 <para>In <filename>Form.pm</filename> die Funktion
2581 <function>parse_template</function> suchen und hier die Zeile
2582 <command>print(STDERR Dumper($self));</command> einfügen.</para>
2586 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
2587 ein PDF für eine Rechnung erzeugen.</para>
2591 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
2592 der Variablen <varname>$self</varname> in der Form <varname>'key'
2593 => 'value',</varname>. Alle <varname>key</varname>s sind
2599 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
2600 <title>Variablen ausgeben</title>
2602 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
2603 Tags geschrieben werden, also z.B.
2604 <varname><%variablenname%></varname>.</para>
2606 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
2607 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
2608 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
2609 werden die folgenden Flags unterstützt:</para>
2613 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
2614 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
2615 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
2616 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
2620 <para><option>NOESCAPE</option> unterdrückt das Escapen von
2621 Sonderzeichen für die Vorlagensprache. Wenn also in einer
2622 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
2623 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
2624 ist dieses Flag sinnvoll.</para>
2628 <para>Beispiel:</para>
2630 <programlisting><%quototal NOFORMAT%></programlisting>
2633 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
2634 <title>Verwendung in Druckbefehlen</title>
2636 <para>In der Admininstration können Drucker definiert werden. Auch im
2637 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
2638 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
2639 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
2640 <function>`...`</function> nicht zu unerwünschtem Verhalten
2643 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
2644 für das die Telefonnummer eines Ansprechpartners als Teil der
2645 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
2646 z.B. wie folgt aussehen:</para>
2648 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
2651 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
2652 xreflabel="Anfang und Ende der Tags verändern">
2653 <title>Anfang und Ende der Tags verändern</title>
2655 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
2656 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
2657 Prozentzeichen und dem Größerzeichen endet, beispielsweise
2658 <function><%customer%></function>. Da diese Form aber z.B. in
2659 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
2660 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
2661 Stil umgestellt werden.</para>
2663 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
2664 Format gültigen Kommentarzeichen anfangen, dann
2665 <function>config:</function> enthalten, die entsprechende Option
2666 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
2667 enden. Beispiel für LaTeX:</para>
2669 <programlisting>% config: tag-style=($ $)</programlisting>
2671 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
2672 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
2673 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
2675 <programlisting><!-- config: tag-style=($ $) --></programlisting>
2678 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
2679 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
2681 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
2682 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
2683 "<filename>.ext</filename>" geeignet zu ersetzen:
2684 "<filename>.tex</filename>" für LaTeX-Vorlagen und
2685 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
2689 <term><filename>bin_list.ext</filename></term>
2692 <para>Lagerliste</para>
2697 <term><filename>check.ext</filename></term>
2705 <term><filename>invoice.ext</filename></term>
2708 <para>Rechnung</para>
2713 <term><filename>packing_list.ext</filename></term>
2716 <para>Packliste</para>
2721 <term><filename>pick_list.ext</filename></term>
2724 <para>Sammelliste</para>
2729 <term><filename>purchase_delivery_order.ext</filename></term>
2732 <para>Lieferschein (Einkauf)</para>
2737 <term><filename>purcharse_order.ext</filename></term>
2740 <para>Bestellung an Lieferanten</para>
2745 <term><filename>request_quotation.ext</filename></term>
2748 <para>Anfrage an Lieferanten</para>
2753 <term><filename>sales_delivery_order.ext</filename></term>
2756 <para>Lieferschein (Verkauf)</para>
2761 <term><filename>sales_order.ext</filename></term>
2764 <para>Bestellung</para>
2769 <term><filename>sales_quotation.ext</filename></term>
2772 <para>Angebot an Kunden</para>
2777 <term><filename>zahlungserinnerung.ext</filename></term>
2780 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2785 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2788 <para>Rechnung über Mahngebühren (Dateiname im Programm
2789 konfigurierbar)</para>
2795 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2796 <title>Sprache, Drucker und E-Mail</title>
2798 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2799 eingearbeitet. So wird aus der Vorlage
2800 <filename>sales_order.ext</filename> bei Sprache
2801 <function>de</function> und Druckerkürzel <function>lpr2</function>
2802 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2803 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2804 bekommen dann noch das Kürzel <filename>_email</filename>, der
2805 vollständige Vorlagenname wäre dann
2806 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2807 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2808 werden. Diese wird verwendet, wenn keine der anderen Varianten
2809 gefunden wird.</para>
2811 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2812 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2813 verschickt wird, ist:</para>
2817 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2821 <para><filename>sales_order_de_lpr2.tex</filename></para>
2825 <para><filename>sales_order.tex</filename></para>
2829 <para><filename>default.tex</filename></para>
2833 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2834 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2836 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2839 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2840 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2843 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2844 xreflabel="Metainformationen zur angeforderten Vorlage">
2845 <title>Metainformationen zur angeforderten Vorlage</title>
2847 <para>Diese Variablen liefern Informationen darüber welche Variante
2848 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2849 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2850 Formulare einbinden möchten.</para>
2854 <term><varname>template_meta.formname</varname></term>
2857 <para>Basisname der Vorlage. Identisch mit der <link
2858 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2859 zu den Dateinamen</link> ohne die Erweiterung. Ein
2860 Verkaufsauftrag enthält hier
2861 <constant>sales_order</constant>.</para>
2866 <term><varname>template_meta.language.description</varname></term>
2869 <para>Beschreibung der verwendeten Sprache</para>
2874 <term><varname>template_meta.language.template_code</varname></term>
2877 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2878 Kürzel das im Dateinamen verwendetet wird.</para>
2883 <term><varname>template_meta.language.output_numberformat</varname></term>
2886 <para>Zahlenformat der verwendeten Sprache in der Form
2887 "<constant>1.000,00</constant>". Experimentell! Nur
2888 interessant für Vorlagen die mit unformatierten Werten
2894 <term><varname>template_meta.language.output_dateformat</varname></term>
2897 <para>Datumsformat der verwendeten Sprache in der Form
2898 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2899 interessant für Vorlagen die mit unformatierten Werten
2905 <term><varname>template_meta.format</varname></term>
2908 <para>Das angeforderte Format. Kann im Moment die Werte
2909 <constant>pdf</constant>, <constant>postscript</constant>,
2910 <constant>html</constant>, <constant>opendocument</constant>,
2911 <constant>opendocument_pdf</constant> und
2912 <constant>excel</constant> enthalten.</para>
2917 <term><varname>template_meta.extension</varname></term>
2920 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2921 <constant>format</constant> entschieden.</para>
2926 <term><varname>template_meta.media</varname></term>
2929 <para>Ausgabemedium. Kann zur Zeit die Werte
2930 <constant>screen</constant> für Bildschirm,
2931 <constant>email</constant> für E-Mail (triggert das
2932 <constant>_email</constant> Kürzel im Dateinamen),
2933 <constant>printer</constant> für Drucker, und
2934 <constant>queue</constant> für Warteschlange enthalten.</para>
2939 <term><varname>template_meta.printer.description</varname></term>
2942 <para>Beschreibung des ausgewählten Druckers</para>
2947 <term><varname>template_meta.printer.template_code</varname></term>
2950 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2951 dem Kürzel das im Dateinamen verwendetet wird.</para>
2956 <term><varname>template_meta.tmpfile</varname></term>
2959 <para>Datei-Prefix für temporäre Dateien.</para>
2965 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2966 <title>Stammdaten von Kunden und Lieferanten</title>
2970 <term><varname>account_number</varname></term>
2973 <para>Kontonummer</para>
2978 <term><varname>bank</varname></term>
2981 <para>Name der Bank</para>
2986 <term><varname>bank_code</varname></term>
2989 <para>Bankleitzahl</para>
2994 <term><varname>bic</varname></term>
2997 <para>Bank-Identifikations-Code (Bank Identifier Code,
3003 <term><varname>business</varname></term>
3006 <para>Kunden-/Lieferantentyp</para>
3011 <term><varname>city</varname></term>
3019 <term><varname>contact</varname></term>
3022 <para>Kontakt</para>
3027 <term><varname>country</varname></term>
3035 <term><varname>c_vendor_id</varname></term>
3038 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
3043 <term><varname>v_customer_id</varname></term>
3046 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
3051 <term><varname>cp_email</varname></term>
3054 <para>Email des Ansprechpartners</para>
3059 <term><varname>cp_givenname</varname></term>
3062 <para>Vorname des Ansprechpartners</para>
3067 <term><varname>cp_greeting</varname></term>
3070 <para>Anrede des Ansprechpartners</para>
3075 <term><varname>cp_name</varname></term>
3078 <para>Name des Ansprechpartners</para>
3083 <term><varname>cp_phone1</varname></term>
3086 <para>Telefonnummer 1 des Ansprechpartners</para>
3091 <term><varname>cp_phone2</varname></term>
3094 <para>Telefonnummer 2 des Ansprechpartners</para>
3099 <term><varname>cp_title</varname></term>
3102 <para>Titel des Ansprechpartners</para>
3107 <term><varname>creditlimit</varname></term>
3110 <para>Kreditlimit</para>
3115 <term><varname>customeremail</varname></term>
3118 <para>Email des Kunden; nur für Kunden</para>
3123 <term><varname>customerfax</varname></term>
3126 <para>Faxnummer des Kunden; nur für Kunden</para>
3131 <term><varname>customernotes</varname></term>
3134 <para>Bemerkungen beim Kunden; nur für Kunden</para>
3139 <term><varname>customernumber</varname></term>
3142 <para>Kundennummer; nur für Kunden</para>
3147 <term><varname>customerphone</varname></term>
3150 <para>Telefonnummer des Kunden; nur für Kunden</para>
3155 <term><varname>discount</varname></term>
3163 <term><varname>email</varname></term>
3166 <para>Emailadresse</para>
3171 <term><varname>fax</varname></term>
3174 <para>Faxnummer</para>
3179 <term><varname>greeting</varname></term>
3187 <term><varname>homepage</varname></term>
3190 <para>Homepage</para>
3195 <term><varname>iban</varname></term>
3198 <para>Internationale Kontonummer (International Bank Account
3199 Number, IBAN)</para>
3204 <term><varname>language</varname></term>
3207 <para>Sprache</para>
3212 <term><varname>name</varname></term>
3215 <para>Firmenname</para>
3220 <term><varname>payment_description</varname></term>
3223 <para>Name der Zahlart</para>
3228 <term><varname>payment_terms</varname></term>
3231 <para>Zahlungskonditionen</para>
3236 <term><varname>phone</varname></term>
3239 <para>Telefonnummer</para>
3244 <term><varname>shiptocity</varname></term>
3247 <para>Stadt (Lieferadresse) <link
3248 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3253 <term><varname>shiptocontact</varname></term>
3256 <para>Kontakt (Lieferadresse) <link
3257 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3262 <term><varname>shiptocountry</varname></term>
3265 <para>Land (Lieferadresse) <link
3266 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3271 <term><varname>shiptodepartment1</varname></term>
3274 <para>Abteilung 1 (Lieferadresse) <link
3275 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3280 <term><varname>shiptodepartment2</varname></term>
3283 <para>Abteilung 2 (Lieferadresse) <link
3284 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3289 <term><varname>shiptoemail</varname></term>
3292 <para>Email (Lieferadresse) <link
3293 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3298 <term><varname>shiptofax</varname></term>
3301 <para>Fax (Lieferadresse) <link
3302 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3307 <term><varname>shiptoname</varname></term>
3310 <para>Firmenname (Lieferadresse) <link
3311 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3316 <term><varname>shiptophone</varname></term>
3319 <para>Telefonnummer (Lieferadresse) <link
3320 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3325 <term><varname>shiptostreet</varname></term>
3328 <para>Straße und Hausnummer (Lieferadresse) <link
3329 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3334 <term><varname>shiptozipcode</varname></term>
3337 <para>Postleitzahl (Lieferadresse) <link
3338 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3343 <term><varname>street</varname></term>
3346 <para>Straße und Hausnummer</para>
3351 <term><varname>taxnumber</varname></term>
3354 <para>Steuernummer</para>
3359 <term><varname>ustid</varname></term>
3362 <para>Umsatzsteuer-Identifikationsnummer</para>
3367 <term><varname>vendoremail</varname></term>
3370 <para>Email des Lieferanten; nur für Lieferanten</para>
3375 <term><varname>vendorfax</varname></term>
3378 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
3383 <term><varname>vendornotes</varname></term>
3386 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
3391 <term><varname>vendornumber</varname></term>
3394 <para>Lieferantennummer; nur für Lieferanten</para>
3399 <term><varname>vendorphone</varname></term>
3402 <para>Telefonnummer des Lieferanten; nur für
3408 <term><varname>zipcode</varname></term>
3411 <para>Postleitzahl</para>
3416 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
3417 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
3418 Stammdaten nicht eingetragen, so haben die Variablen
3419 <varname>shipto*</varname> den gleichen Wert wie die die
3420 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
3421 einige <varname>shipto*</varname>-Variablen so nicht in den
3422 Stammdaten wiederfinden sondern schlicht Kopien der
3423 Lieferdatenvariablen sind (z.B.
3424 <varname>shiptocontact</varname>).</para>
3428 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
3429 <title>Informationen über den Bearbeiter</title>
3433 <term><varname>employee_address</varname></term>
3436 <para>Adressfeld</para>
3441 <term><varname>employee_businessnumber</varname></term>
3444 <para>Firmennummer</para>
3449 <term><varname>employee_company</varname></term>
3452 <para>Firmenname</para>
3457 <term><varname>employee_co_ustid</varname></term>
3460 <para>Usatzsteuer-Identifikationsnummer</para>
3465 <term><varname>employee_duns</varname></term>
3468 <para>DUNS-Nummer</para>
3473 <term><varname>employee_email</varname></term>
3481 <term><varname>employee_fax</varname></term>
3489 <term><varname>employee_name</varname></term>
3492 <para>voller Name</para>
3497 <term><varname>employee_signature</varname></term>
3500 <para>Signatur</para>
3505 <term><varname>employee_taxnumber</varname></term>
3508 <para>Steuernummer</para>
3513 <term><varname>employee_tel</varname></term>
3516 <para>Telefonnummer</para>
3522 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
3523 <title>Informationen über den Verkäufer</title>
3527 <term><varname>salesman_address</varname></term>
3530 <para>Adressfeld</para>
3535 <term><varname>salesman_businessnumber</varname></term>
3538 <para>Firmennummer</para>
3543 <term><varname>salesman_company</varname></term>
3546 <para>Firmenname</para>
3551 <term><varname>salesman_co_ustid</varname></term>
3554 <para>Usatzsteuer-Identifikationsnummer</para>
3559 <term><varname>salesman_duns</varname></term>
3562 <para>DUNS-Nummer</para>
3567 <term><varname>salesman_email</varname></term>
3575 <term><varname>salesman_fax</varname></term>
3583 <term><varname>salesman_name</varname></term>
3586 <para>voller Name</para>
3591 <term><varname>salesman_signature</varname></term>
3594 <para>Signatur</para>
3599 <term><varname>salesman_taxnumber</varname></term>
3602 <para>Steuernummer</para>
3607 <term><varname>salesman_tel</varname></term>
3610 <para>Telefonnummer</para>
3616 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
3617 <title>Variablen für die einzelnen Steuern</title>
3621 <term><varname>tax</varname></term>
3629 <term><varname>taxbase</varname></term>
3632 <para>zu versteuernder Betrag</para>
3637 <term><varname>taxdescription</varname></term>
3640 <para>Name der Steuer</para>
3645 <term><varname>taxrate</varname></term>
3648 <para>Steuersatz</para>
3654 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
3655 <title>Variablen für Lieferbedingungen</title>
3659 <term><varname>delivery_term</varname></term>
3660 <listitem><para>Datenbank-Objekt der Lieferbedingung</para></listitem>
3663 <term><varname>delivery_term.description</varname></term>
3664 <listitem><para>Beschreibung der Lieferbedingung</para></listitem>
3667 <term><varname>delivery_term.description_long</varname></term>
3668 <listitem><para>Langtext bzw. übersetzter Langtext der Lieferbedingung</para></listitem>
3674 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
3675 <title>Variablen in Rechnungen</title>
3677 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
3678 <title>Allgemeine Variablen</title>
3682 <term><varname>creditremaining</varname></term>
3685 <para>Verbleibender Kredit</para>
3690 <term><varname>currency</varname></term>
3693 <para>Währung</para>
3698 <term><varname>cusordnumber</varname></term>
3701 <para>Bestellnummer beim Kunden</para>
3706 <term><varname>deliverydate</varname></term>
3709 <para>Lieferdatum</para>
3714 <term><varname>duedate</varname></term>
3717 <para>Fälligkeitsdatum</para>
3722 <term><varname>globalprojectnumber</varname></term>
3725 <para>Projektnummer des ganzen Beleges</para>
3730 <term><varname>globalprojectdescription</varname></term>
3733 <para>Projekbeschreibung des ganzen Beleges</para>
3738 <term><varname>intnotes</varname></term>
3741 <para>Interne Bemerkungen</para>
3746 <term><varname>invdate</varname></term>
3749 <para>Rechnungsdatum</para>
3754 <term><varname>invnumber</varname></term>
3757 <para>Rechnungsnummer</para>
3762 <term><varname>invtotal</varname></term>
3765 <para>gesamter Rechnungsbetrag</para>
3770 <term><varname>notes</varname></term>
3773 <para>Bemerkungen der Rechnung</para>
3778 <term><varname>orddate</varname></term>
3781 <para>Auftragsdatum</para>
3786 <term><varname>ordnumber</varname></term>
3789 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3790 erstellt wurde</para>
3795 <term><varname>payment_description</varname></term>
3798 <para>Name der Zahlart</para>
3803 <term><varname>payment_terms</varname></term>
3806 <para>Zahlungskonditionen</para>
3811 <term><varname>quodate</varname></term>
3814 <para>Angebotsdatum</para>
3819 <term><varname>quonumber</varname></term>
3822 <para>Angebotsnummer</para>
3827 <term><varname>shippingpoint</varname></term>
3830 <para>Versandort</para>
3835 <term><varname>shipvia</varname></term>
3838 <para>Transportmittel</para>
3843 <term><varname>subtotal</varname></term>
3846 <para>Zwischensumme aller Posten ohne Steuern</para>
3851 <term><varname>total</varname></term>
3854 <para>Restsumme der Rechnung (Summe abzüglich bereits
3855 bezahlter Posten)</para>
3860 <term><varname>transaction_description</varname></term>
3863 <para>Vorgangsbezeichnung</para>
3868 <term><varname>transdate</varname></term>
3871 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3872 erstellt wurde</para>
3878 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3879 <title>Variablen für jeden Posten auf der Rechnung</title>
3883 <term><varname>bin</varname></term>
3886 <para>Stellage</para>
3891 <term><varname>description</varname></term>
3894 <para>Artikelbeschreibung</para>
3899 <term><varname>cusordnumber_oe</varname></term>
3902 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der Posten ursprünglich stammt (nur Verkauf)</para>
3907 <term><varname>discount</varname></term>
3910 <para>Rabatt als Betrag</para>
3915 <term><varname>discount_sub</varname></term>
3918 <para>Zwischensumme mit Rabatt</para>
3923 <term><varname>donumber_do</varname></term>
3926 <para>Lieferscheinnummer des Lieferscheins, aus dem die Position ursprünglich stammt, wenn die Rechnung im Rahmen des Workflows aus einem Lieferschein erstellt wurde.</para>
3931 <term><varname>drawing</varname></term>
3934 <para>Zeichnung</para>
3939 <term><varname>ean</varname></term>
3942 <para>EAN-Code</para>
3947 <term><varname>image</varname></term>
3955 <term><varname>linetotal</varname></term>
3958 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3963 <term><varname>longdescription</varname></term>
3966 <para>Langtext</para>
3971 <term><varname>microfiche</varname></term>
3974 <para>Mikrofilm</para>
3979 <term><varname>netprice</varname></term>
3982 <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>
3987 <term><varname>nodiscount_linetotal</varname></term>
3990 <para>Zeilensumme ohne Rabatt</para>
3995 <term><varname>nodiscount_sub</varname></term>
3998 <para>Zwischensumme ohne Rabatt</para>
4003 <term><varname>number</varname></term>
4006 <para>Artikelnummer</para>
4011 <term><varname>ordnumber_oe</varname></term>
4014 <para>Auftragsnummer des Originalauftrags, aus dem der Posten ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In letzterem Fall wird die unsprüngliche Auftragsnummer angezeigt.</para>
4019 <term><varname>p_discount</varname></term>
4022 <para>Rabatt in Prozent</para>
4027 <term><varname>partnotes</varname></term>
4030 <para>Die beim Artikel gespeicherten Bemerkungen</para>
4035 <term><varname>partsgroup</varname></term>
4038 <para>Warengruppe</para>
4043 <term><varname>price_factor</varname></term>
4046 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
4052 <term><varname>price_factor_name</varname></term>
4055 <para>Der Name des Preisfaktors, sofern einer eingestellt
4061 <term><varname>projectnumber</varname></term>
4064 <para>Projektnummer</para>
4069 <term><varname>projectdescription</varname></term>
4072 <para>Projektbeschreibung</para>
4077 <term><varname>qty</varname></term>
4085 <term><varname>reqdate</varname></term>
4088 <para>Lieferdatum</para>
4093 <term><varname>runningnumber</varname></term>
4096 <para>Position auf der Rechnung (1, 2, 3...)</para>
4101 <term><varname>sellprice</varname></term>
4104 <para>Verkaufspreis</para>
4109 <term><varname>serialnumber</varname></term>
4112 <para>Seriennummer</para>
4117 <term><varname>tax_rate</varname></term>
4120 <para>Steuersatz</para>
4125 <term><varname>transdate_do</varname></term>
4128 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des Workflows aus einem Lieferschein stammte.</para>
4133 <term><varname>transdate_oe</varname></term>
4136 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des Workflows aus einem Auftrag erstellt wurde. Wenn es Sammelaufträge gab wird das Datum des ursprünglichen Auftrags genommen.</para>
4141 <term><varname>transdate_quo</varname></term>
4144 <para>Datum des Angebots, wenn die Position im Rahmen des Workflows aus einem Angebot stammte.</para>
4149 <term><varname>unit</varname></term>
4152 <para>Einheit</para>
4157 <term><varname>weight</varname></term>
4160 <para>Gewicht</para>
4165 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
4166 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
4167 einer <function>foreach</function>-Schleife ausgegeben werden, da
4168 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
4169 können. Die Variablen dafür lauten:</para>
4173 <term><varname>make</varname></term>
4176 <para>Lieferant</para>
4181 <term><varname>model</varname></term>
4184 <para>Lieferantenartikelnummer</para>
4190 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
4191 <title>Variablen für die einzelnen Zahlungseingänge</title>
4195 <term><varname>payment</varname></term>
4203 <term><varname>paymentaccount</varname></term>
4211 <term><varname>paymentdate</varname></term>
4219 <term><varname>paymentmemo</varname></term>
4227 <term><varname>paymentsource</varname></term>
4236 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
4237 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
4239 <para>Die vom Benutzer definierten Variablen für Kunden und
4240 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
4241 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
4242 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
4243 Variablennamen zusammen.</para>
4245 <para>Beispiel: Der Benutzer hat eine Variable namens
4246 <varname>number_of_employees</varname> definiert, die die Anzahl der
4247 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
4248 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
4253 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
4254 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
4256 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
4257 <title>Namen der Vorlagen</title>
4259 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
4260 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
4261 Erstellung einer Rechnung über die Mahngebühren und Zinsen
4262 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
4263 Vorlagenname für diese Mahnstufe mit dem Zusatz
4264 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
4265 für die ausgewählte Sprache und den ausgewählten Drucker
4269 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
4270 <title>Allgemeine Variablen in Mahnungen</title>
4272 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4273 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4274 Kunden stehen als Variablen <varname>name</varname>,
4275 <varname>street</varname>, <varname>zipcode</varname>,
4276 <varname>city</varname>, <varname>country</varname>,
4277 <varname>department_1</varname>, <varname>department_2</varname>,
4278 und <varname>email</varname> zur Verfügung.</para>
4280 <para>Weitere Variablen beinhalten:</para>
4284 <term><varname>dunning_date</varname></term>
4287 <para>Datum der Mahnung</para>
4292 <term><varname>dunning_duedate</varname></term>
4295 <para>Fälligkeitsdatum für diese Mahhnung</para>
4300 <term><varname>dunning_id</varname></term>
4303 <para>Mahnungsnummer</para>
4308 <term><varname>fee</varname></term>
4311 <para>Kummulative Mahngebühren</para>
4316 <term><varname>interest_rate</varname></term>
4319 <para>Zinssatz per anno in Prozent</para>
4324 <term><varname>total_amount</varname></term>
4327 <para>Gesamter noch zu zahlender Betrag als
4328 <function>fee</function> + <function>total_interest</function>
4329 + <function>total_open_amount</function></para>
4334 <term><varname>total_interest</varname></term>
4337 <para>Zinsen per anno über alle Rechnungen</para>
4342 <term><varname>total_open_amount</varname></term>
4345 <para>Summe über alle offene Beträge der Rechnungen</para>
4351 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
4352 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
4356 <term><varname>dn_amount</varname></term>
4359 <para>Rechnungssumme (brutto)</para>
4364 <term><varname>dn_duedate</varname></term>
4367 <para>Originales Fälligkeitsdatum der Rechnung</para>
4372 <term><varname>dn_dunning_date</varname></term>
4375 <para>Datum der Mahnung</para>
4380 <term><varname>dn_dunning_duedate</varname></term>
4383 <para>Fälligkeitsdatum der Mahnung</para>
4388 <term><varname>dn_fee</varname></term>
4391 <para>Kummulative Mahngebühr</para>
4396 <term><varname>dn_interest</varname></term>
4399 <para>Zinsen per anno für diese Rechnung</para>
4404 <term><varname>dn_invnumber</varname></term>
4407 <para>Rechnungsnummer</para>
4412 <term><varname>dn_linetotal</varname></term>
4415 <para>Noch zu zahlender Betrag (ergibt sich aus
4416 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
4417 + <varname>dn_interest</varname>)</para>
4422 <term><varname>dn_netamount</varname></term>
4425 <para>Rechnungssumme (netto)</para>
4430 <term><varname>dn_open_amount</varname></term>
4433 <para>Offener Rechnungsbetrag</para>
4438 <term><varname>dn_ordnumber</varname></term>
4441 <para>Bestellnummer</para>
4446 <term><varname>dn_transdate</varname></term>
4449 <para>Rechnungsdatum</para>
4454 <term><varname>dn_curr</varname></term>
4457 <para>Währung, in der die Rechnung erstellt wurde. (Die
4458 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
4464 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
4465 <title>Variablen in automatisch erzeugten Rechnungen über
4466 Mahngebühren</title>
4468 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4469 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4470 Kunden stehen als Variablen <varname>name</varname>,
4471 <varname>street</varname>, <varname>zipcode</varname>,
4472 <varname>city</varname>, <varname>country</varname>,
4473 <varname>department_1</varname>, <varname>department_2</varname>,
4474 und <varname>email</varname> zur Verfügung.</para>
4476 <para>Weitere Variablen beinhalten:</para>
4480 <term><varname>duedate</varname></term>
4483 <para>Fälligkeitsdatum der Rechnung</para>
4488 <term><varname>dunning_id</varname></term>
4491 <para>Mahnungsnummer</para>
4496 <term><varname>fee</varname></term>
4499 <para>Mahngebühren</para>
4504 <term><varname>interest</varname></term>
4512 <term><varname>invamount</varname></term>
4515 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
4516 <varname>interest</varname>)</para>
4521 <term><varname>invdate</varname></term>
4524 <para>Rechnungsdatum</para>
4529 <term><varname>invnumber</varname></term>
4532 <para>Rechnungsnummer</para>
4539 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
4540 <title>Variablen in anderen Vorlagen</title>
4543 <title>Einführung</title>
4545 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
4546 Rechnung. Allerdings heißen die Variablen, die mit
4547 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
4548 fangen sie mit <varname>quo</varname> für "quotation" an:
4549 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
4550 wiederum fangen sie mit <varname>ord</varname> für "order" an:
4551 <varname>ordnumber</varname> für Bestellnummer etc.</para>
4553 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
4554 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
4555 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
4556 Vorlage keine Bedeutung haben oder noch nicht belegt sein
4559 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
4560 in Rechnungen aufgeführt.</para>
4563 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
4564 <title>Angebote und Preisanfragen</title>
4568 <term><varname>quonumber</varname></term>
4571 <para>Angebots- bzw. Anfragenummer</para>
4576 <term><varname>reqdate</varname></term>
4579 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
4580 Preisanfragen)</para>
4585 <term><varname>transdate</varname></term>
4588 <para>Angebots- bzw. Anfragedatum</para>
4594 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
4595 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
4599 <term><varname>ordnumber</varname></term>
4602 <para>Auftragsnummer</para>
4607 <term><varname>reqdate</varname></term>
4610 <para>Lieferdatum</para>
4615 <term><varname>transdate</varname></term>
4618 <para>Auftragsdatum</para>
4624 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
4625 <title>Lieferscheine (Verkauf und Einkauf)</title>
4629 <term><varname>cusordnumber</varname></term>
4632 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
4633 des Lieferanten (im Einkauf)</para>
4638 <term><varname>donumber</varname></term>
4641 <para>Lieferscheinnummer</para>
4646 <term><varname>transdate</varname></term>
4649 <para>Lieferscheindatum</para>
4654 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
4655 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
4656 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
4657 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
4658 <function>foreach</function>-Schleife ausgegeben werden. Diese
4659 Variablen sind:</para>
4663 <term><varname>si_bin</varname></term>
4666 <para>Lagerplatz</para>
4671 <term><varname>si_chargenumber</varname></term>
4674 <para>Chargennummer</para>
4679 <term><varname>si_bestbefore</varname></term>
4682 <para>Mindesthaltbarkeit</para>
4687 <term><varname>si_number</varname></term>
4690 <para>Artikelnummer</para>
4695 <term><varname>si_qty</varname></term>
4698 <para>Anzahl bzw. Menge</para>
4703 <term><varname>si_runningnumber</varname></term>
4706 <para>Positionsnummer (1, 2, 3 etc)</para>
4711 <term><varname>si_unit</varname></term>
4714 <para>Einheit</para>
4719 <term><varname>si_warehouse</varname></term>
4728 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
4729 <title>Variablen für Sammelrechnung</title>
4733 <term><varname>c0total</varname></term>
4736 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
4742 <term><varname>c30total</varname></term>
4745 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
4746 und < 60 Tage</para>
4751 <term><varname>c60total</varname></term>
4754 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
4755 und < 90 Tage</para>
4760 <term><varname>c90total</varname></term>
4763 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
4769 <term><varname>total</varname></term>
4772 <para>Gesamtbetrag aller Rechnungen</para>
4777 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
4781 <term><varname>invnumber</varname></term>
4784 <para>Rechnungsnummer</para>
4789 <term><varname>invdate</varname></term>
4792 <para>Rechnungsdatum</para>
4797 <term><varname>duedate</varname></term>
4800 <para>Fälligkeitsdatum</para>
4805 <term><varname>amount</varname></term>
4808 <para>Summe der Rechnung</para>
4813 <term><varname>open</varname></term>
4816 <para>Noch offener Betrag der Rechnung</para>
4821 <term><varname>c0</varname></term>
4824 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4830 <term><varname>c30</varname></term>
4833 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4839 <term><varname>c60</varname></term>
4842 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4848 <term><varname>c90</varname></term>
4851 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4859 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4860 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4862 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4863 <title>Einführung</title>
4865 <para>Der Parser kennt neben den Variablen einige weitere
4866 Konstrukte, die gesondert behandelt werden. Diese sind wie
4867 Variablennamen in spezieller Weise markiert:
4868 <command><%anweisung%> ... <%end%></command></para>
4870 <para>Anmerkung zum <command><%end%></command>: Der besseren
4871 Verständlichkeit halber kann man nach dem <command>end</command>
4872 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4873 Anweisung (z.B. <command>if</command> oder
4874 <command>foreach</command>) damit abgeschlossen wird.</para>
4876 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4877 <command><%if type == "sales_quotation"%></command>, so könnte
4878 er mit <command><%end%></command> genauso abgeschlossen werden
4879 wie mit <command><%end if%></command> oder auch
4880 <command><%end type == "sales_quotation"%></command>.</para>
4883 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4884 <title>Der if-Block</title>
4886 <programlisting><%if variablenname%>
4888 <%end%></programlisting>
4890 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4891 und dem "end" werden nur ausgegeben, wenn die Variable
4892 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4894 <para>Handelt es sich bei der benannten Variable um ein Array, also um einen Variablennamen, über den man mit
4895 <command><%foreach variablenname%></command> iteriert, so wird mit diesem Konstrukt darauf getestet, ob das Array Elemente
4896 enthält. Somit würde im folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt ihrer Überschrift "Zahlungseingänge"
4897 ausgegeben, wenn tatsächlich welche getätigt wurden:</para>
4899 <programlisting><%if payment%>
4901 <%foreach payment%>
4902 Am <%paymentdate%>: <%payment%> €
4903 <%end foreach%>
4904 <%end if%></programlisting>
4906 <para>Die Bedingung kann auch negiert werden, indem das Wort
4907 <function>not</function> nach dem <filename>if</filename> verwendet
4908 wird. Beispiel:</para>
4910 <programlisting><%if not cp_greeting%>
4912 <%end%></programlisting>
4914 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4915 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4916 einer Variablen mit einer festen Zeichenkette oder einer anderen
4917 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4918 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4919 die rechte Seite des Vergleichsoperators in Anführungszeichen
4920 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4921 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4924 <programlisting><%if var1 == "Wert"%></programlisting>
4926 <para>Testet die Variable <varname>var1</varname> auf
4927 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4928 Mittels <function>!=</function> anstelle von <function>==</function>
4929 würde auf Ungleichheit getestet.</para>
4931 <programlisting><%if var1 == var2%></programlisting>
4933 <para>Testet die Variable <varname>var1</varname> auf
4934 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4935 <function>!=</function> anstelle von <function>==</function> würde
4936 auf Ungleichheit getestet.</para>
4938 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4939 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
4940 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4941 dieselbe Syntax wie oben nur mit <function>=~</function> und
4942 <function>!~</function> als Vergleichsoperatoren.</para>
4944 <para>Beispiel für einen Test, ob die Variable
4945 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4946 <constant>schwierig</constant> enthält:</para>
4948 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4951 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4952 <title>Der foreach-Block</title>
4954 <programlisting><%foreach variablenname%>
4956 <%end%></programlisting>
4958 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4959 wie das Perl-Array der Variablen <varname>variablenname</varname>
4960 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4961 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4962 benutzt. In jedem Durchlauf werden die <link
4963 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4964 Variablen</link> jeweils auf den Wert für die aktuelle Position
4967 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
4969 <programlisting><%foreach number%>
4970 Position: <%runningnumber%>
4971 Anzahl: <%qty%>
4972 Artikelnummer: <%number%>
4973 Beschreibung: <%description%>
4975 <%end%></programlisting>
4977 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
4978 <function><%foreach%></function>-Block innerhalb einer
4979 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
4980 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
4981 Inhalt zwischen <function><%foreach%></function> und
4982 <function><%end%></function> wiederholt, nicht aber die
4983 komplette Zeile, in der er steht.</para>
4987 <sect2 id="dokumentenvorlagen-und-variablen.markup">
4988 <title>Markup-Code zur Textformatierung innerhalb von
4991 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
4992 anders formatiert haben möchte, so ist dies begrenzt möglich.
4993 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
4994 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
4995 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
4996 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
4997 (HTML oder PDF über LaTeX) umgesetzt.</para>
4999 <para>Die unterstützen Formatierungen sind:</para>
5003 <term><b>Text</b></term>
5006 <para>Text wird in Fettdruck gesetzt.</para>
5011 <term><i>Text</i></term>
5014 <para>Text wird kursiv gesetzt.</para>
5019 <term><u>Text</u></term>
5022 <para>Text wird unterstrichen.</para>
5027 <term><s>Text</s></term>
5030 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
5031 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
5036 <term><bullet></term>
5039 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
5045 <para>Der Befehl <command><bullet></command> funktioniert
5046 momentan auch nur in Latex-Vorlagen.</para>
5050 <sect1 id="excel-templates">
5051 <title>Excel-Vorlagen</title>
5053 <sect2 id="excel-templates.summary">
5054 <title>Zusammenfassung</title>
5056 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
5057 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
5061 <sect2 id="excel-templates.usage">
5062 <title>Bedienung</title>
5064 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
5065 werden. Die Konfigurationsoption heißt <varname>excel_templates =
5066 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
5068 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
5069 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
5070 werden. In den normalen Verkaufsmasken taucht nun
5071 <constant>Excel</constant> als auswählbares Format auf und kann von da
5072 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
5074 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
5075 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
5076 <filename>sales_quotation.xls</filename> gespeichert.</para>
5079 <sect2 id="excel-templates.syntax">
5080 <title>Variablensyntax</title>
5082 <para>Einfache Syntax:
5083 <command><<varname>></command></para>
5085 <para>Dabei sind <constant><<</constant> und
5086 <constant>>></constant> die Delimiter. Da Excel auf festen
5087 Breiten besteht, kann der Tag künstlich verlängert werden, indem
5088 weitere <constant><</constant> oder <constant>></constant>
5089 eingefügt werden. Der Tag muss nicht symmetrisch sein.
5092 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
5094 <para>Um die Limitierung der festen Breite zu reduzieren, können
5095 weitere Variablen in einem Block interpoliert werden. Whitespace wird
5096 dazwishen dann erhalten. Beispiel:</para>
5098 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
5100 <para>Die Variablen werden interpoliert, und linksbündig mit
5101 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
5102 lang, werden überzählige Zeichen abgeschnitten.</para>
5104 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
5105 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
5107 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
5109 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
5110 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
5114 <sect2 id="excel-templates.limitations">
5115 <title>Einschränkungen</title>
5117 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
5118 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
5119 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
5120 Text zu ersetzen.</para>
5122 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
5123 <command><%if%></command> und
5124 <command><%foreach%></command> nicht vorhanden. Der Delimiter
5125 <constant><% %></constant> kommt in den Headerinformationen
5126 evtl. vor. Deshalb wurde auf den sichereren Delimiter
5127 <constant><<</constant> und <constant>>></constant>
5131 <sect1 id="features.warehouse">
5132 <title>Mandantenkonfiguration Lager</title>
5133 Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt:
5134 Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die Möglichkeit hier über den
5135 Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. Ferner kann
5136 jede Position eines Lieferscheins ein-, bzw. ausgelagert werden (Einkauf-, bzw. Verkauf).
5137 Es können beliebig viele Lager mit beliebig vielen Lagerplätzen abgebildet werden.
5138 Die Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder Einzelposition und
5139 das Auswählen dieser Position zu einem Lager mit Lagerplatz.
5140 Dieses Verfahren lässt sich schrittweise vereinfachen, je nachdem wie die Einstellungen in
5141 der Mandatenkonfiguration gesetzt werden.
5144 <para><option>Auslagern über Standardlagerplatz</option> Hier wird ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz)
5145 in dem Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über den Standardlagerplatz (konfigurierbar pro Ware) durchführt.
5149 <para><option>Auslagern ohne Bestandsprüfung</option>Das obige Auslagern schlägt fehl, wenn die entsprechende Menge für
5150 die Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit dieser Option
5151 erlauben. Hierfür muss ein entsprechender Lagerplatz (Fehlbestand, o.ä.) konfiguriert sein.</para>
5154 Zusätzliche Funktionshinweise:
5156 <listitem><para><option>Standard-Lagerplatz</option>Ist dieser konfiguriert, wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
5157 Stammdaten-> Waren / Dienstleistung / Erzeugnis verwendet.
5160 <listitem><para><option>Standard-Lagerplatz verwenden, falls keiner in Stammdaten definiert</option>Wird beim 'Auslagern über Standardlagerplatz'
5161 keine Standardlagerplatz zu der Ware gefunden, so wird mit dieser Option einfach der Standardlagerplatz verwendet.
5169 <title>Entwicklerdokumentation</title>
5171 <sect1 id="devel.globals" xreflabel="Globale Variablen">
5172 <title>Globale Variablen</title>
5175 <title>Wie sehen globale Variablen in Perl aus?</title>
5177 <para>Globale Variablen liegen in einem speziellen namespace namens
5178 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
5179 globs global und die meisten speziellen Variablen sind...
5182 <para>Daraus ergeben sich folgende Formen:</para>
5186 <term><literal>$main::form</literal></term>
5189 <para>expliziter Namespace "main"</para>
5194 <term><literal>$::form</literal></term>
5197 <para>impliziter Namespace "main"</para>
5202 <term><literal>open FILE, "file.txt"</literal></term>
5205 <para><varname>FILE</varname> ist global</para>
5210 <term><literal>$_</literal></term>
5213 <para>speziell</para>
5218 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
5219 Schlüsselwort wie "<function>global</function>", mit dem man
5220 importieren kann. <function>my</function>, <function>our</function>
5221 und <function>local</function> machen was anderes.</para>
5225 <term><literal>my $form</literal></term>
5228 <para>lexikalische Variable, gültig bis zum Ende des
5234 <term><literal>our $form</literal></term>
5237 <para><varname>$form</varname> referenziert ab hier
5238 <varname>$PACKAGE::form</varname>.</para>
5243 <term><literal>local $form</literal></term>
5246 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
5247 des scopes zurückgesetzt</para>
5254 <title>Warum sind globale Variablen ein Problem?</title>
5256 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
5258 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
5259 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
5260 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
5261 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
5262 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
5263 Datenbankverbindungen, weil die sehr lange zum Initialisieren
5266 <para>Das zweite Problem ist <function>strict</function>. Unter
5267 <function>strict</function> werden alle Variablen die nicht explizit
5268 mit <function>Package</function>, <function>my</function> oder
5269 <function>our</function> angegeben werden als Tippfehler angemarkert,
5270 dies hat, seit der Einführung, u.a. schon so manche langwierige
5271 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
5272 angegeben werden, werden die nicht geprüft, und somit kann sich
5273 schnell ein Tippfehler einschleichen.</para>
5277 <title>Kanonische globale Variablen</title>
5279 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
5280 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
5281 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
5282 umhergereicht werden.</para>
5284 <para>Diese Variablen sind im Moment die folgenden neun:</para>
5288 <para><varname>$::form</varname></para>
5292 <para><varname>%::myconfig</varname></para>
5296 <para><varname>$::locale</varname></para>
5300 <para><varname>$::lxdebug</varname></para>
5304 <para><varname>$::auth</varname></para>
5308 <para><varname>$::lx_office_conf</varname></para>
5312 <para><varname>$::instance_conf</varname></para>
5316 <para><varname>$::dispatcher</varname></para>
5320 <para><varname>$::request</varname></para>
5324 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
5325 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
5326 Eigenschaften (Konventionen):</para>
5329 <title>$::form</title>
5333 <para>Ist ein Objekt der Klasse
5334 "<classname>Form</classname>"</para>
5338 <para>Wird nach jedem Request gelöscht</para>
5342 <para>Muss auch in Tests und Konsolenscripts vorhanden
5347 <para>Enthält am Anfang eines Requests die Requestparameter vom
5352 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
5353 cachen, das wird aber momentan absichtlich zerstört</para>
5357 <para><varname>$::form</varname> wurde unter <productname>SQL
5358 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
5359 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
5360 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
5361 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
5362 <function>IS->retrieve_customer()</function> in Sicherheit
5365 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
5366 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
5367 3552, Stand version 2.7beta), um dies hinterher wieder auf den
5368 richtigen Wert zu setzen:</para>
5370 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
5371 $::myconfig{numberformat} = $numberformat;
5372 # (...) div Berechnungen
5373 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
5375 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
5376 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
5377 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
5378 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
5379 Es geht ziemlich sicher etwas kaputt.</para>
5381 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
5382 in den <productname>Template::Toolkit</productname> Templates
5383 außerhalb der Controller: der Ausdruck <function>[% var
5384 %]</function> greift auf <varname>$::form->{var}</varname> zu.
5385 Unter Controllern ist der Standard Scope anders, da lautet der
5386 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
5387 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
5388 <function><%var%></function> zeigt auf
5389 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
5390 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
5393 <programlisting>[%- IF business %]
5394 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
5395 [%- END %]</programlisting>
5397 <para>Entweder wird hier dann $::form->{business} ausgewertet
5398 oder aber der Funktion
5399 <function>$form->parse_html_template</function> wird explizit
5400 noch ein zusätzlicher Hash übergeben, der dann auch in den
5401 (Web-)Templates zu Verfügung steht, bspw. so:</para>
5403 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
5405 <para>Innerhalb von Schleifen wird
5406 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
5407 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
5408 welches über alle Positionen eines Lieferscheins in Schleife
5411 <programlisting>for $i (1 .. $form->{rowcount}) {
5413 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
5414 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
5415 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
5421 <title>%::myconfig</title>
5425 <para>Das einzige Hash unter den globalen Variablen</para>
5429 <para>Wird spätestens benötigt wenn auf die Datenbank
5430 zugegriffen wird</para>
5434 <para>Wird bei jedem Request neu erstellt.</para>
5438 <para>Enthält die Userdaten des aktuellen Logins</para>
5442 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
5443 extern serialisiert werden, weil da auch der Datenbankzugriff
5444 für diesen user drinsteht.</para>
5448 <para>Enthält unter anderem Listenbegrenzung vclimit,
5449 Datumsformat dateformat und Nummernformat numberformat</para>
5453 <para>Enthält Datenbankzugriffinformationen</para>
5457 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
5458 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
5459 aktuellen Users entscheiden müssen, befragen
5460 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
5461 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
5462 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
5463 Informationen über den Benutzer die über die
5464 Administrator-Schnittstelle eingegeben wurden.</para>
5468 <title>$::locale</title>
5472 <para>Objekt der Klasse "Locale"</para>
5476 <para>Wird pro Request erstellt</para>
5480 <para>Muss auch für Tests und Scripte immer verfügbar
5485 <para>Cached intern über Requestgrenzen hinweg benutzte
5490 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
5491 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
5495 <title>$::lxdebug</title>
5499 <para>Objekt der Klasse "LXDebug"</para>
5503 <para>Wird global gecached</para>
5507 <para>Muss immer verfügbar sein, in nahezu allen
5512 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
5513 bereit, wie "<function>enter_sub</function>" und
5514 "<function>leave_sub</function>", mit denen in den alten Modulen ein
5515 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
5516 der man die Wallclockzeit seit Requeststart loggen kann, sowie
5517 "<function>message</function>" und "<function>dump</function>" mit
5518 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
5521 <para>Beispielsweise so:</para>
5523 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
5524 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
5528 <title>$::auth</title>
5532 <para>Objekt der Klasse "SL::Auth"</para>
5536 <para>Wird global gecached</para>
5540 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
5544 <para>Wird nach jedem Request resettet.</para>
5548 <para><varname>$::auth</varname> stellt Funktionen bereit um die
5549 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
5550 vom aktuellen User abhängen wird das Objekt aus
5551 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
5552 Request kurz resettet.</para>
5554 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten. Dessen Einstellungen können über
5555 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert ist ein Hash mit den Werten aus der Tabelle
5556 <literal>auth.clients</literal>.</para>
5560 <title>$::lx_office_conf</title>
5564 <para>Objekt der Klasse
5565 "<classname>SL::LxOfficeConf</classname>"</para>
5569 <para>Global gecached</para>
5573 <para>Repräsentation der
5574 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
5578 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
5579 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
5580 das Programm die Konfiguration ändern kann oder sollte.</para>
5582 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
5583 Debug- und Trace-Log-Datei wie folgt konfiguriert und
5586 <programlisting>[debug]
5587 file_name = /tmp/kivitendo-debug.log</programlisting>
5589 <para>ist der Key <varname>file</varname> im Programm als
5590 <varname>$::lx_office_conf->{debug}{file}</varname>
5594 <para>Zugriff auf die Konfiguration erfolgt im Moment über
5595 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
5600 <title>$::instance_conf</title>
5604 <para>Objekt der Klasse
5605 "<classname>SL::InstanceConfiguration</classname>"</para>
5609 <para>wird pro Request neu erstellt</para>
5613 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
5614 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
5615 ist hier eine Mandantendatenbank. Beispielsweise überprüft
5616 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
5617 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
5621 <title>$::dispatcher</title>
5625 <para>Objekt der Klasse
5626 "<varname>SL::Dispatcher</varname>"</para>
5630 <para>wird pro Serverprozess erstellt.</para>
5634 <para>enthält Informationen über die technische Verbindung zum
5639 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
5640 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
5641 Objekt untergebracht.</para>
5645 <title>$::request</title>
5649 <para>Hashref (evtl später Objekt)</para>
5653 <para>Wird pro Request neu initialisiert.</para>
5657 <para>Keine Unterstruktur garantiert.</para>
5661 <para><varname>$::request</varname> ist ein generischer Platz um
5662 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
5663 at a distance benutzt werden, sondern um lokales memoizing zu
5664 ermöglichen, das garantiert am Ende des Requests zerstört
5667 <para>Vieles von dem, was im moment in <varname>$::form</varname>
5668 liegt, sollte eigentlich hier liegen. Die groben
5669 Differentialkriterien sind:</para>
5673 <para>Kommt es vom User, und soll unverändert wieder an den
5674 User? Dann <varname>$::form</varname>, steht da eh schon</para>
5678 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
5679 Requests gebraucht werden? Dann
5680 <varname>$::request</varname></para>
5684 <para>Muss ich von anderen Teilen des Programms lesend drauf
5685 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
5686 Wrappermethode</para>
5693 <title>Ehemalige globale Variablen</title>
5695 <para>Die folgenden Variablen waren einmal im Programm, und wurden
5699 <title>$::cgi</title>
5703 <para>war nötig, weil cookie Methoden nicht als
5704 Klassenfunktionen funktionieren</para>
5708 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
5709 Klassennamespace gehalten wird und über Requestgrenzen
5714 <para>liegt jetzt unter
5715 <varname>$::request->{cgi}</varname></para>
5721 <title>$::all_units</title>
5725 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
5726 ein paar hundert mal pro Request eine Liste der Einheiten
5727 brauchen, und de als Parameter durch einen Riesenstack von
5728 Funktionen geschleift werden müssten.</para>
5732 <para>Liegt jetzt unter
5733 <varname>$::request->{cache}{all_units}</varname></para>
5738 <function>AM->retrieve_all_units()</function> gesetzt oder
5745 <title>%::called_subs</title>
5749 <para>wurde benutzt um callsub deep recursions
5754 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
5755 möglichen Rekursioenen darstellt, und da nie welche
5760 <para>komplette recursion protection wurde entfernt.</para>
5767 <sect1 id="devel.fcgi">
5768 <title>Entwicklung unter FastCGI</title>
5770 <sect2 id="devel.fcgi.general">
5771 <title>Allgemeines</title>
5773 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
5774 werden, muss der Webserver neu gestartet werden.</para>
5776 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
5777 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
5778 müssen folgende Aspekte beachtet werden.</para>
5781 <sect2 id="devel.fcgi.exiting">
5782 <title>Programmende und Ausnahmen</title>
5784 <para>Betrifft die Funktionen <function>warn</function>,
5785 <function>die</function>, <function>exit</function>,
5786 <function>carp</function> und <function>confess</function>.</para>
5788 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
5789 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
5790 am Laufen zu halten. Man kann mit <function>die</function>,
5791 <function>confess</function> oder <function>carp</function> Fehler
5792 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
5793 eigene <function>$::form-</function>error()> tut im Prinzip das
5794 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
5795 <function>exit</function> hingegen werden nicht abgefangen.
5796 <function>warn</function> wird direkt nach STDERR, also in Server Log
5797 eine Nachricht schreiben (sofern in der Konfiguration nicht die
5798 Warnungen in das kivitendo Log umgeleitet wurden), und
5799 <function>exit</function> wird die Ausführung beenden.</para>
5801 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
5802 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
5803 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
5804 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
5807 <sect2 id="devel.fcgi.globals">
5808 <title>Globale Variablen</title>
5810 <para>Um zu vermeiden, dass Informationen von einem Request in einen
5811 anderen gelangen, müssen alle globalen Variablen vor einem Request
5812 sauber initialisiert werden. Das ist besonders wichtig im
5813 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
5814 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
5817 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
5818 abgetrennten Block, der alle kanonischen globalen Variablen listet und
5819 erklärt. Bitte keine anderen einführen ohne das sauber zu
5820 dokumentieren.</para>
5822 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
5823 man sicher geht, dass man die richtige erwischt.</para>
5826 <sect2 id="devel.fcgi.performance">
5827 <title>Performance und Statistiken</title>
5829 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
5830 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
5831 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
5832 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
5833 sind es je nach Menge der definierten Variablen 1-2s. Ab der
5834 Moose/Rose::DB Version sind es 5-6s.</para>
5836 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
5837 den kritischen Pfaden, unter 0,15 sonst.</para>
5841 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
5842 <title>SQL-Upgradedateien</title>
5844 <sect2 id="db-upgrade-files.introduction"
5845 xreflabel="Einführung in die Datenbank-Upgradedateien">
5846 <title>Einführung</title>
5848 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte gesteuert, die sich im Verzeichnis <filename>sql/Pg-upgrade2</filename>
5849 befinden. In diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren, die neben den eigentlich auszuführenden SQL- oder
5850 Perl-Befehlen einige Kontrollinformationen enthält.</para>
5852 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten, sodass Datenbankscripte zwar in einer sicheren Reihenfolge
5853 ausgeführt werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt werden, wenn die Tabelle mit <literal>CREATE
5854 TABLE</literal> angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man keine Versionsnummern braucht.</para>
5856 <para>kivitendo merkt sich dabei, welches der Upgradescripte in <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
5857 führt diese nicht erneut aus. Dazu dient die Tabelle "<literal>schema_info</literal>", die bei der Anmeldung automatisch angelegt
5861 <sect2 id="db-upgrade-files.format"
5862 xreflabel="Format der Upgradedateien">
5863 <title>Format der Kontrollinformationen</title>
5865 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5866 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5867 hat dabei das folgende Format:</para>
5869 <para>Für SQL-Upgradedateien:</para>
5871 <programlisting>-- @key: value</programlisting>
5873 <para>Für Perl-Upgradedateien:</para>
5875 <programlisting># @key: value</programlisting>
5877 <para>Leerzeichen vor "<varname>value</varname>" werden
5880 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5884 <term><varname>tag</varname></term>
5887 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5888 Dieser "tag" kann von anderen Kontrolldateien in ihren
5889 Abhängigkeiten verwendet werden (Schlüsselwort
5890 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5891 in der Datenbank eingetragen wird.</para>
5893 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5894 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5896 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5897 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5898 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5904 <term><varname>charset</varname></term>
5907 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5908 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
5909 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte hingegen müssen immer in UTF-8 encodiert sein und sollten
5910 demnach auch ein "<literal>use utf8;</literal>" enthalten.</para>
5915 <term><varname>description</varname></term>
5918 <para>Benötigt. Eine Beschreibung, was in diesem Update
5919 passiert. Diese wird dem Benutzer beim eigentlichen
5920 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
5921 sein sollte, sollte die Beschreibung auf Deutsch
5927 <term><varname>depends</varname></term>
5930 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5931 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
5932 dass die in dieser Liste aufgeführten Scripte bereits
5933 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5935 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5936 Script "b" existiert, das von Änderungen in "a" abhängt, und
5937 eine neue Kontrolldatei für "c" erstellt wird, die von
5938 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5939 Tag "b" als Abhängigkeit zu definieren.</para>
5941 <para>Es ist nicht erlaubt, sich selbst referenzierende
5942 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5943 und "c" -> "a").</para>
5948 <term><varname>priority</varname></term>
5951 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5952 der Scripte ausgeführt werden, die die gleichen
5953 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5954 der Wert 1000 benutzt.</para>
5956 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5957 "depends" benutzt werden. kivitendo sortiert die auszuführenden
5958 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5959 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5960 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5961 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5962 Priorität alphabetisch nach dem "tag".</para>
5967 <term><varname>ignore</varname></term>
5970 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
5971 Skript bei der Anmeldung ignoriert und entsprechend nicht
5978 <sect2 id="db-upgrade-files.format-perl-files" xreflabel="Format von Perl-Upgradedateien">
5979 <title>Format von in Perl geschriebenen Datenbankupgradescripten</title>
5981 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so ausgeführt sondern müssen sich an gewisse Konventionen
5982 halten. Dafür bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
5984 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse dar, die vom Elternobjekt
5985 "<literal>SL::DBUpgrade2::Base</literal>" erben und eine Funktion namens "<literal>run</literal>" zur Verfügung stellen muss. Das
5986 Script wird ausgeführt, indem eine Instanz dieser Klasse erzeugt und darauf die erwähnte "<literal>run</literal>" aufgerufen
5989 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert für "<literal>@tag</literal>" ableitet. Dabei werden alle
5990 Zeichen, die in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche ersetzt. Insgesamt sieht der Paketname wie folgt
5991 aus: "<literal>SL::DBUpgrade2::tag</literal>".</para>
5993 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
5994 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
5996 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie folgt aus:</para>
5998 <programlisting># @tag: beispiel-upgrade-file42
5999 # @description: Ein schönes Beispielscript
6000 # @depends: release_3_1_0
6001 package SL::DBUpgrade2::beispiel_upgrade_file42;
6006 use parent qw(SL::DBUpgrade2::Base);
6011 # hier Aktionen ausführen
6020 <sect2 id="db-upgrade-files.dbupgrade-tool"
6021 xreflabel="Hilfsscript dbupgrade2_tool.pl">
6022 <title>Hilfsscript dbupgrade2_tool.pl</title>
6024 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
6025 existiert ein Hilfsscript namens
6026 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
6027 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
6028 liest alle Datenbankupgradescripte aus dem Verzeichnis
6029 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
6030 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
6031 von der Kommandozeile überprüft werden können.</para>
6033 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
6034 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
6035 sich aber auch Informationen auf verschiedene Art ausgeben
6040 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
6041 --list</command>"</para>
6043 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
6044 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
6045 würde. Es werden neben der Listenposition der Tag, die
6046 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
6050 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
6051 --tree</command>"</para>
6053 <para>Listet alle Tags in Baumform basierend auf den
6054 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
6055 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
6056 beim übergeordneten Script als Abhängigkeit eingetragen
6060 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
6061 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
6062 --rtree</command>"</para>
6064 <para>Listet alle Tags in Baumform basierend auf den
6065 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
6066 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
6067 die das übergeordnete Script als Abhängigkeit eingetragen
6072 <para>Baumform mit Postscriptausgabe:
6073 "<command>./scripts/dbupgrade2_tool.pl
6074 --graphviz</command>"</para>
6076 <para>Benötigt das Tool "<command>graphviz</command>", um mit
6077 seiner Hilfe die <link
6078 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
6079 Baumform</link> in eine Postscriptdatei namens
6080 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
6081 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
6082 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
6083 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
6088 <para>Scripte, von denen kein anderes Script abhängt:
6089 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
6091 <para>Listet die Tags aller Scripte auf, von denen keine anderen
6092 Scripte abhängen.</para>
6098 <sect1 id="translations-languages" xreflabel="Translations and languages">
6099 <title>Translations and languages</title>
6101 <sect2 id="translations-languages.introduction"
6102 xreflabel="Introduction to translations and languages">
6103 <title>Introduction</title>
6106 <para>Dieser Abschnitt ist in Englisch geschrieben, um
6107 internationalen Übersetzern die Arbeit zu erleichtern.</para>
6110 <para>This section describes how localization packages in kivitendo
6111 are built. Currently the only language fully supported is German, and
6112 since most of the internal messages are held in English the English
6113 version is usable too.</para>
6115 <para>A stub version of French is included but not functunal at this
6119 <sect2 id="translations-languages.character-set"
6120 xreflabel="Character set">
6121 <title>Character set</title>
6123 <para>All files included in a language pack must use UTF-8 as their encoding.</para>
6126 <sect2 id="translations-languages.file-structure"
6127 xreflabel="File structure">
6128 <title>File structure</title>
6130 <para>The structure of locales in kivitendo is:</para>
6132 <programlisting>kivitendo/locale/<langcode>/</programlisting>
6134 <para>where <langcode> stands for an abbreviation of the
6135 language package. The builtin packages use two letter <ulink
6136 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
6137 but the actual name is not relevant for the program and can easily be
6139 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
6140 tags</ulink> (i.e. "en_GB"). In fact the original language packages
6141 from SQL Ledger are named in this way.</para>
6143 <para>In such a language directory the following files are
6148 <term>LANGUAGE</term>
6151 <para>This file is mandatory.</para>
6153 <para>The <filename>LANGUAGE</filename> file contains the self
6154 descripted name of the language. It should contain a native
6155 representation first, and in parenthesis an english translation
6156 after that. Example:</para>
6158 <programlisting>Deutsch (German)</programlisting>
6166 <para>This file is mandatory.</para>
6168 <para>The central translation file. It is essentially an inline
6169 Perl script autogenerated by <command>locales.pl</command>. To
6170 generate it, generate the directory and the two files mentioned
6171 above, and execute the following command:</para>
6173 <programlisting>scripts/locales.pl <langcode></programlisting>
6175 <para>Otherwise you can simply copy one of the other languages.
6176 You will be told how many are missing like this:</para>
6178 <programlisting>$ scripts/locales.pl en
6179 English - 0.6% - 2015/2028 missing</programlisting>
6181 <para>A file named "<filename>missing</filename>" will be
6182 generated and can be edited. You can also edit the
6183 "<filename>all</filename>" file directly. Edit everything you
6184 like to fit the target language and execute
6185 <command>locales.pl</command> again. See how the missing words
6191 <term>Num2text</term>
6194 <para>Legacy code from SQL Ledger. It provides a means for
6195 numbers to be converted into natural language, like
6196 <literal>1523 => one thousand five hundred twenty
6197 three</literal>. If you want to provide it, it must be inlinable
6198 Perl code which provides a <function>num2text</function> sub. If
6199 an <function>init</function> sub exists it will be executed
6202 <para>Only used in the check and receipt printing module.</para>
6207 <term>special_chars</term>
6210 <para>kivitendo comes with a lot of interfaces to different
6211 formats, some of which are rather picky with their accepted
6212 charset. The <filename>special_chars</filename> file contains a
6213 listing of chars not suited for different file format and
6214 provides substitutions. It is written in "Simple Ini" style,
6215 containing a block for every file format.</para>
6217 <para>First entry should be the order of substitution for
6218 entries as a whitespace separated list. All entries are
6219 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
6220 and <literal>\\</literal> all work.</para>
6222 <para>After that every entry is a special char that should be
6223 translated when writing text into such a file.</para>
6225 <para>Example:</para>
6227 <programlisting>[Template/XML]
6228 order=& < > \n
6232 \n=<br></programlisting>
6234 <para>Note the importance of the order in this example.
6235 Substituting < and > befor & would lead to $gt; become
6238 <para>For a list of valid formats, see the German
6239 <filename>special_chars</filename> entry. As of this writing the
6240 following are recognized:</para>
6242 <programlisting>HTML
6247 Template/OpenDocument
6248 filenames</programlisting>
6250 <para>The last of which is very machine dependant. Remember that
6251 a lot of characters are forbidden by some filesystems, for
6252 exmaple MS Windows doesn't like ':' in its files where Linux
6253 doesn't mind that. If you want the files created with your
6254 language pack to be portable, find all chars that could cause
6260 <term>missing</term>
6263 <para>This file is not a part of the language package
6266 <para>This is a file generated by
6267 <command>scripts/locales.pl</command> while processing your
6268 locales. It's only to have the missing entries singled out and
6269 does not belong to a language package.</para>
6277 <para>This file is not a part of the language package
6280 <para>Another file generated by
6281 <command>scripts/locales.pl</command>. If for any reason a
6282 translation does not appear anymore and can be deleted, it gets
6283 moved here. The last 50 or so entries deleted are saved here in
6284 case you made a typo, so that you don't have to translate
6285 everything again. If a tranlsation is missing, the lost file is
6286 checked first. If you maintain a language package, you might
6287 want to keep this safe somewhere.</para>
6294 <sect1 id="devel.testsuite">
6295 <title>Die kivitendo-Test-Suite</title>
6297 <sect2 id="devel.testsuite.intro">
6298 <title>Einführung</title>
6300 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul <literal>Test::More</literal>.</para>
6302 <para>Die grundlegenden Fakten sind:</para>
6305 <listitem><para>Alle Tests liegen im Unterverzeichnis <filename>t/</filename>.</para></listitem>
6307 <listitem><para>Ein Script (bzw. ein Test) in <filename>t/</filename> enthält einen oder mehrere Testfälle.</para></listitem>
6309 <listitem><para>Alle Dateinamen von Tests enden auf <literal>.t</literal>. Es sind selbstständig ausführbare Perl-Scripte.</para></listitem>
6311 <listitem><para>Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in <filename>t/</filename>, deren
6312 Dateiname auf <literal>.t</literal> endet.</para></listitem>
6316 <sect2 id="devel.testsuite.prerequisites">
6317 <title>Voraussetzungen</title>
6319 <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>
6322 <listitem><para><literal>Test::Deep</literal> (Debian-Paketname: <literal>libtest-deep-perl</literal>; Fedora Core:
6323 <literal>perl-Test-Deep</literal>; openSUSE: <literal>perl-Test-Deep</literal>)</para></listitem>
6324 <listitem><para><literal>Test::Exception</literal> (Debian-Paketname: <literal>libtest-exception-perl</literal>; Fedora Core:
6325 <literal>perl-Test-Exception</literal>; openSUSE: <literal>perl-Test-Exception</literal>)</para></listitem>
6326 <listitem><para><literal>Test::Output</literal> (Debian-Paketname: <literal>libtest-output-perl</literal>; Fedora Core:
6327 <literal>perl-Test-Output</literal>; openSUSE: <literal>perl-Test-Output</literal>)</para></listitem>
6328 <listitem><para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses Modul ist ab Perl 5.10.1 Bestandteil der
6329 Perl-Distribution und kann für frühere Versionen aus dem <ulink url="http://www.cpan.org">CPAN</ulink> bezogen
6330 werden.</para></listitem>
6331 <listitem><para><literal>LWP::Simple</literal> aus dem Paket <literal>libwww-perl</literal> (Debian-Panetname:
6332 <literal>libwww-perl</literal>; Fedora Core: <literal>perl-libwww-perl</literal>; openSUSE:
6333 <literal>perl-libwww-perl</literal>)</para></listitem>
6334 <listitem><para><literal>URI::Find</literal> (Debian-Panetname: <literal>liburi-find-perl</literal>; Fedora Core:
6335 <literal>perl-URI-Find</literal>; openSUSE: <literal>perl-URI-Find</literal>)</para></listitem>
6338 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
6339 müssen in der Konfigurationsdatei im Abschnit <literal>testing/database</literal> Datenbankverbindungsparameter angegeben
6340 werden. Der hier angegebene Benutzer muss weiterhin das Recht haben, Datenbanken anzulegen und zu löschen.</para>
6343 <sect2 id="devel.testsuite.execution">
6345 Existierende Tests ausführen
6348 <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
6349 gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript <filename>t/test.pl</filename>.</para>
6351 <para>Will man die komplette Test-Suite ausführen, so muss man einfach nur <filename>t/test.pl</filename> ohne weitere Parameter aus
6352 dem kivitendo-Basisverzeichnis heraus ausführen.</para>
6354 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an <filename>t/test.pl</filename>. Beispielsweise:</para>
6356 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
6360 <sect2 id="devel.testsuite.meaning_of_scripts">
6362 Bedeutung der verschiedenen Test-Scripte
6365 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch
6366 während der Entwicklung nützliche Tests sind:</para>
6369 <listitem><para><filename>t/001compile.t</filename> -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab</para></listitem>
6370 <listitem><para><filename>t/002goodperl.t</filename> -- überprüft alle Perl-Dateien auf Anwesenheit von '<literal>use strict</literal>'-Anweisungen</para></listitem>
6371 <listitem><para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von <function>system()</function> und <function>exec()</function> auf Gültigkeit</para></listitem>
6372 <listitem><para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien Tab-Zeichen enthalten</para></listitem>
6373 <listitem><para><filename>t/006spelling.t</filename> -- sucht nach häufigen Rechtschreibfehlern</para></listitem>
6374 <listitem><para><filename>t/011pod.t</filename> -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit</para></listitem>
6377 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module.</para>
6380 <sect2 id="devel.testsuite.create_new">
6382 Neue Test-Scripte erstellen
6385 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende
6386 Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden.</para>
6388 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
6390 Ideen für neue Test-Scripte, die keine konkreten Funktionen testen
6393 <para> Ideen, die abgesehen von Funktionen noch nicht umgesetzt wurden:</para>
6396 <listitem><para>Überprüfung auf fehlende symbolische Links</para></listitem>
6397 <listitem><para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten)</para></listitem>
6398 <listitem><para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para></listitem>
6399 <listitem><para>Überprüfung auf Leerzeichen am Ende von Zeilen</para></listitem>
6400 <listitem><para>Test, ob alle zu übersetzenden Strings in <filename>locale/de/all</filename> vorhanden sind</para></listitem>
6401 <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>
6405 <sect3 id="devel.testsuite.directory_and_test_names">
6407 Konvention für Verzeichnis- und Dateinamen
6410 <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>
6413 <listitem><para>Die Dateiendung muss <filename>.t</filename> lauten.</para></listitem>
6415 <listitem><para>Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise
6416 <filename>bad_function_params.t</filename>).</para></listitem>
6418 <listitem><para>Unterverzeichnisse sollten grob nach dem Themenbereich benannt sein, mit dem sich die Scripte darin befassen
6419 (beispielsweise <filename>background_jobs</filename> für Tests rund um Hintergrund-Jobs).</para></listitem>
6421 <listitem><para>Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist
6422 (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben.</para></listitem>
6426 <sect3 id="devel.testsuite.minimal_example">
6428 Minimales Skelett für eigene Scripte
6431 <para>Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden:</para>
6433 <programlisting>use Test::More tests => 0;
6437 use Support::TestSetup;
6439 Support::TestSetup::login();</programlisting>
6441 <para>Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie
6442 <varname>$::auth</varname>, <varname>$::form</varname> oder <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
6443 <filename>config/kivitendo.conf</filename> im Abschnitt <literal>testing.login</literal> ein gültiger Login-Name eingetragen
6444 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
6446 <para>Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile <code>Support::TestSetup::login();</code>
6447 weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.</para>
6452 <sect1 id="devel.style-guide">
6453 <title>Stil-Richtlinien</title>
6455 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
6456 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
6457 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
6458 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
6460 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
6463 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
6464 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
6469 <para>Es werden keine echten Tabs sondern Leerzeichen
6474 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
6476 <programlisting>foreach my $row (@data) {
6478 # do something with $row
6482 $row->{modules} = MODULE->retrieve(
6483 id => $row->{id},
6484 date => $use_now ? localtime() : $row->{time},
6488 $report->add($row);
6493 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
6494 Zeile wie der letzte Befehl. Beispiele:</para>
6496 <programlisting>sub debug {
6502 <programlisting>if ($form->{item_rows} > 0) {
6508 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
6509 der Befehl / die öffnende schließende Klammer, die den Block
6510 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
6511 Beispiele wie bei 3. gelten.</para>
6515 <para>Die Wörter "<function>else</function>",
6516 "<function>elsif</function>", "<function>while</function>" befinden
6517 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
6520 <programlisting>if ($form->{sum} > 1000) {
6522 } elsif ($form->{sum} > 0) {
6530 } until ($a > 0);</programlisting>
6534 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
6535 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
6536 und grep-ähnliche Operatoren. Beispiel:</para>
6538 <programlisting>$main::lxdebug->message("Could not find file.");
6539 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
6543 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
6545 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
6546 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
6547 Blöcke schon. Beispiel:</para>
6549 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
6554 $form->{sum} += $form->{"row_$i"};
6555 $form->{ $form->{index} } += 1;
6557 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
6561 <para>Mehrzeilige Befehle</para>
6565 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
6566 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
6567 werden, in der die ersten Funktionsparameter in der ersten Zeile
6568 stehen. Beispiel:</para>
6570 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
6571 $form->{some_col_value});</programlisting>
6575 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
6576 besten in einer übersichtlichen Tabellenstruktur organisiert
6577 wird. Beispiel:</para>
6579 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
6580 : $form->{oldcount} ? $form->{oldcount} + 1
6581 : $form->{rowcount} - $form->{rowbase};</programlisting>
6587 <para>Kommentare</para>
6591 <para>Kommentare, die alleine in einer Zeile stehen, sollten
6592 soweit wie der Code eingerückt sein.</para>
6596 <para>Seitliche hängende Kommentare sollten einheitlich
6597 formatiert werden.</para>
6601 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
6602 auf Englisch zu verfassen. So wie ich keine Lust habe,
6603 französischen Quelltext zu lesen, sollte auch der kivitendo
6604 Quelltext für nicht-Deutschsprachige lesbar sein.
6607 <programlisting>my $found = 0;
6615 $i = 0 # initialize $i
6617 $i *= $const; # do something crazy
6618 $i = $n; # recover $i</programlisting>
6624 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
6625 Interpolation gewünscht ist. Beispiel:</para>
6627 <programlisting>$form->{sum} = 0;
6628 $form->{"row_$i"} = $form->{"row_$i"} - 5;
6629 $some_hash{42} = 54;</programlisting>
6633 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
6634 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
6635 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
6636 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
6638 <para>Als Beispiel sei die Funktion
6639 <function>print_options</function> aus
6640 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
6644 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
6645 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
6648 <para>Emacs und vim haben beide recht einfache Methoden zur
6649 Entfernung von trailing whitespace. Emacs kennt das Kommande
6650 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
6651 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
6652 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
6657 <para>Es wird kein <command>perltidy</command> verwendet.</para>
6659 <para>In der Vergangenheit wurde versucht,
6660 <command>perltidy</command> zu verwenden, um einen einheitlichen
6661 Stil zu erlangen. Es hat sich aber gezeigt, dass
6662 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
6663 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
6664 den Interessierten sind hier die
6665 <command>perltidy</command>-Optionen, die grob den beschriebenen
6666 Richtlinien entsprechen:</para>
6668 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
6669 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
6670 -lp -vt=1 -vtc=1</programlisting>
6674 <para><varname>STDERR</varname> ist tabu. Unkonditionale
6675 Debugmeldungen auch.</para>
6677 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
6678 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
6679 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
6681 <para>Die <classname>LXDebug</classname>-Methode
6682 "<function>message</function>" nimmt als ersten Paramter außerdem
6683 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
6684 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
6685 und werden in den meisten Fällen auch vom Repository
6686 zurückgewiesen.</para>
6690 <para>Alle neuen Module müssen use strict verwenden.</para>
6692 <para><varname>$form</varname>, <varname>$auth</varname>,
6693 <varname>$locale</varname>, <varname>$lxdebug</varname> und
6694 <varname>%myconfig</varname> werden derzeit aus dem main package
6695 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
6696 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
6701 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
6702 <title>Dokumentation erstellen</title>
6704 <sect2 id="devel.build-doc.introduction">
6705 <title>Einführung</title>
6707 <para>Diese Dokumentation ist in <productname>DocBook</productname>
6708 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
6709 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
6710 Editor nutzt, der spezielle Unterstützung für
6711 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
6712 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
6713 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
6717 <sect2 id="devel.build-doc.required-software">
6718 <title>Benötigte Software</title>
6720 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
6721 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
6722 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
6723 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
6724 <command>scripts/build_doc.sh</command>.</para>
6726 <para>Das Script benötigt zur Konvertierung verschiedene
6727 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
6733 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
6734 in einer halbwegs aktuellen Version</para>
6738 <para>Das Java-Build-System <ulink
6739 url="http://ant.apache.org/">Apache Ant</ulink></para>
6743 <para>Das Dokumentations-System Dobudish für
6744 <productname>DocBook</productname> 4.5, eine Zusammenstellung
6745 diverser Stylesheets und Grafiken zur Konvertierung von
6746 <productname>DocBook</productname> XML in andere Formate. Das
6747 Paket, das benötigt wird, ist zum Zeitpunkt der
6748 Dokumentationserstellung
6749 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
6750 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
6755 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
6756 sind auf allen gängigen Plattformen verfügbar. Beispiel für
6757 Debian/Ubuntu:</para>
6759 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
6761 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
6762 <filename>doc/build</filename> entpackt werden. Beispiel unter der
6763 Annahme, das <productname>Dobudish</productname> in
6764 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
6766 <programlisting>cd doc/build
6767 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
6770 <sect2 id="devel.build-doc.build">
6771 <title>PDFs und HTML-Seiten erstellen</title>
6773 <para>Die eigentliche Konvertierung erfolgt nach Installation der
6774 benötigten Software mit einem einfachen Aufruf direkt aus dem
6775 kivitendo-Installationsverzeichnis heraus:</para>
6777 <programlisting>./scripts/build_doc.sh</programlisting>
6780 <sect2 id="devel.build-doc.repository">
6781 <title>Einchecken in das Git-Repository</title>
6783 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
6784 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
6785 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
6786 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
6788 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
6789 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob