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>RB</para></listitem>
1441 <listitem><para>f-tex</para></listitem>
1442 <listitem><para>rev-odt</para></listitem>
1445 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
1447 <sect2 id="Vorlagenverzeichnis-anlegen" xreflabel="Vorlagenverzeichnis anlegen">
1448 <title>Vorlagenverzeichnis anlegen</title>
1449 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1451 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1453 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
1454 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch <xref linkend="Gruppen-anlegen"/>.
1456 <para>Im Userbereich lässt sich unter:
1457 "<guimenu>System</guimenu> ->
1458 <guisubmenu>Mandantenverwaltung</guisubmenu> -> <guimenuitem>Verschiedenes</guimenuitem>" die Option
1459 "Neue Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1462 <listitem><para><option>Vorlagen auswählen</option>: Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll
1463 (<filename>RB</filename>, <filename>f-tex</filename> oder <filename>odt-rev</filename>.)</para></listitem>
1464 <listitem><para><option>Neuer Name</option>: Der Verzeichnisname für den neuen Vorlagensatz. Dieser kann im Rahmen der üblichen
1465 Bedingungen für Verzeichnisnamen frei gewählt werden.</para></listitem>
1468 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist für den aktuellen Mandanten ausgewählt.
1469 Der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1470 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch vorgenommen werden. Den Ordner findet man im Dateisystem unter
1471 <filename>./templates/[Neuer Name]</filename></para>
1476 <sect2 id="Vorlagen-RB">
1477 <title>Der Druckvorlagensatz RB</title>
1479 <para>Hierbei handelt es sich um einen vollständigen LaTeX Dokumentensatz mit alternativem Design. Die odt oder html-Varianten sind nicht gepflegt.</para>
1480 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
1481 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1482 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die eigenen Firmendaten finden sich in der Datei Readme.tex im Vorlagenverzeichnis.</para>
1484 <para>Eine kurze Übersicht der Features:</para>
1486 <listitem><para>Mehrsprachenfähig, mit Deutscher und Englischer Übersetzung</para></listitem>
1487 <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>
1488 <listitem><para>mehrere vordefinierte Varianten für Logos/Hintergrundbilder</para></listitem>
1489 <listitem><para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder "Außerhalb EU"</para></listitem>
1495 <title>f-tex</title>
1497 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt.</para>
1499 <sect3 id="f-tex-Feature-Übersicht">
1500 <title>Feature-Übersicht</title>
1502 <listitem><para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage für alle briefartigen Dokumente verwendet. Also
1503 Angebot, Rechnung, Proformarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc.</para></listitem>
1505 <listitem><para>Leichte Anpassung an das Firmen-Layout durch Verwendung eines Hintergrund-PDFs. Dieses kann leicht mit dem
1506 eigenen Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp, Adobe*)</para></listitem>
1508 <listitem><para>Hintergrund-PDF umschaltbar auf "nur erste Seite" (Standard) oder "alle Seiten" (Option
1509 "<option>bgPdfFirstPageOnly</option>" in Datei <filename>letter.lco</filename>)</para></listitem>
1511 <listitem><para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1512 versendeten Dokumenten eingebunden (Option "<option>bgPdfEmailOnly</option>" in Datei
1513 <filename>letter.lco</filename>).</para></listitem>
1515 <listitem><para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch, Wiederholung von Kopfzeilen, Zwischensummen
1516 etc. (danke an Kai-Martin Knaak für die Vorarbeit)</para></listitem>
1518 <listitem><para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom Land des eigenen Unternehmens abweicht (also die
1519 Rechnung das Land verlässt).</para></listitem>
1521 <listitem><para>Multisprachfähig leicht um weitere Sprachen zu erweitern, alle Übersetzungen in der Datei
1522 <filename>translatinos.tex</filename>.</para></listitem>
1524 <listitem><para>Auflistung von Bruttopreisen für Endverbraucher.</para></listitem>
1528 <sect3 id="f-tex-Installation">
1529 <title>Die Installation</title>
1531 <listitem><para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref linkend="Vorlagenverzeichnis-anlegen"/>. Das
1532 Vorlagensystem funktioniert jetzt schon, hat allerdings noch einen Beispiel-Briefkopf.</para></listitem>
1534 <listitem><para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach <filename>./letter_head.pdf</filename>.</para></listitem>
1535 <listitem><para>Editiere den Bereich "<option>settings</option>" in der datei <filename>letter.lco</filename>.</para></listitem>
1538 <para>oder etwas detaillierter:</para>
1541 Es wird eine Datei <filename>sample.lco</filename> erstellt und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
1542 ist dies die Datei die für die firmenspezifischen Anpassungen gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig
1543 ist, wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen
1544 vorzunehmen und <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung über eine
1545 <filename>*.lco</filename>-Datei, die letztlich auf <filename>letter.lco</filename> verlinkt ist ist aber auch möglich.
1549 Es wird eine Datei <filename>sample_head.pdf</filename> mit ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
1550 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei
1551 <filename>sample_head.pdf</filename> an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
1552 Template Verzeichniss ablegen und statt <filename>sample_head.pdf</filename> nach <filename>letter_head.pdf</filename>
1557 Letzlich muss <filename>letter_head.pdf</filename> auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
1562 Es wird eine Datei <filename>mydata.tex.example</filename> ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
1563 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das Land verwendet. Die Datei muss also nicht angefasst
1564 werden. Die anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig).
1567 Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc. sollten über die Hintergrund-PDF-Datei oder die
1568 <filename>*.lco</filename>-Datei erfolgen.
1572 <sect3 id="f-tex-Funktionsübersicht">
1573 <title>f-tex Funktionsübersicht</title>
1575 Das Konzept von kivitendo sieht vor, für jedes Dokument (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine LaTeX-Vorlage
1576 vorzuhalten, dies ist sehr wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
1577 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
1578 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche LaTeX-Vorlage verwendet, welche über Codeweichen die
1579 Besonderheiten der jeweiligen Dokumente berücksichtigt:
1583 <listitem><para>Tabellen mit oder ohne Preis</para></listitem>
1584 <listitem><para>Sprache der Tabellenüberschriften etc.</para></listitem>
1585 <listitem><para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus Angebotsnummer)</para></listitem>
1586 <listitem><para>Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus gewerblicher
1587 Kunde)</para></listitem>
1590 <para>Nachteil:</para>
1593 LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
1594 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann natürlich
1595 auch innerhalb der Tabellendarstellung gut persönliche Anpassungen vornehmen. Aber man kann sich hier bei Veränderungen sehr
1596 schnell heftig in den Fuss schiessen.
1599 <para>Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
1600 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen, und sich an der Form der dargestellten Tabellen, wie sie
1601 ausgeliefert werden, erfreuen.
1604 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine, kontinuierliche Schritte gehen.</para>
1608 <sect3 id="f-tex-Bruttopreise">
1609 <title>Bruttopreise für Endverbraucher</title>
1611 <para>Der auszuweisende Bruttopreis wird innerhalb der LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen "alle
1612 Preise Brutto" auszuwählen, aber:</para>
1615 <para>hierfür müssen die Preise auch in Brutto in der Datenbank stehen (ja - das lässt sich über die Preisgruppen und die
1616 Zuordung einer Default-Preisgruppe handhaben)</para>
1619 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
1620 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche Knackpunkt)</para>
1625 Es gibt mit f-tex eine weitere Alternative. Die Information ob Brutto oder Nettorechnung wird mit den Zahlarten
1626 verknüpft. Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben werden sollen, enden mit "_E" (für
1627 Endverbraucher). Falls identische Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt man diese einfach doppelt
1628 an (einmal mit der Namensendung "_E"). Gewinn:</para>
1631 <listitem><para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste verbunden.</para></listitem>
1632 <listitem><para>Die Default-Zahlart kann im Kundendatensatz hinterlegt werden, und man muss nicht mehr daran denken, "alle Preise
1633 Netto" auszuwählen.</para></listitem>
1634 <listitem><para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken revidiert werden,
1635 ohne dass sich der Auftragswert ändert.</para></listitem>
1639 <sect3 id="f-tex-lieferadressen">
1640 <title>Lieferadressen</title>
1642 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen im Adressfeld zum Einsatz. Wenn die
1643 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende Adressvariable eingesetzt. Wenn also die Lieferadresse in
1644 Straße, Hausnummer und Ort abweicht, müssen auch nur diese Felder in der Lieferadresse ausgefüllt werden. Für den Firmenname wird
1645 der Wert der Hauptadresse angezeigt.
1650 <sect2 id="Vorlagen-rev-odt">
1651 <title>Der Druckvorlagensatz rev-odt</title>
1653 <para>Hierbei handelt es sich um einen Dokumentensatz der mit odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
1654 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it, Zürich erstellt
1655 und werden laufend aktualisiert. Ein paar der Formulierungen in den Druckvorlagen entsprechen dem Schweizer Sprachgebrauch, z.B. "Offerte" oder "allfällig".
1659 Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für KundInnen und LieferantInnen,
1660 sowie bei Lieferadressen:
1661 Die in diesem Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das entsprechende
1662 Kürzel, das in Adressen vor die Postleitzahl gesetzt wird.
1663 Das Feld kann auch komplett leer bleiben.
1664 Wer dies anders handhaben möchte, muss die Vorlagen entsprechend anpassen.
1667 odt-Vorlagen können mit LibreOffice oder OpenOffice editiert
1668 und den eigenen Bedürfnissen angepasst werden.
1669 Wichtig beim Editieren von if-Blöcken ist, dass immer der gesamte Block
1670 überschrieben werden muss und nicht nur Teile davon, da dies sonst oft
1671 zu einer odt-Datei führt, die vom Parser nicht korrekt gelesen werden kann.
1674 Zur Zeit gibt es in kivitendo noch keine Möglichkeit, odt-Vorlagen bei Mahnungen
1675 einzusetzen. Entsprechende Vorlagen sind deshalb nicht vorhanden.
1678 Inwieweit es möglich ist, für die in Version 3.2.0 neu eingeführten Pflichtenhefte
1679 odt-Vorlagen zu erstellen, sind wir am abklären.
1680 Wenn dies möglich ist, werden wir in Zukunft auch eine odt-Vorlage für Pflichtenhefte
1681 in diesem Vorlagensatz zur Verfügung stellen.
1684 Fehlermeldungen, Anregungen und Wünsche bitte senden an:
1685 empfang@revamp-it.ch
1690 <sect2 id="allgemeine-hinweise-zu-latex">
1691 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
1692 <para>In den allermeisten Installationen sollte das Drucken jetzt schon
1693 funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
1694 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeile,
1695 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1700 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1701 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1702 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1706 <para>! Package inputenc Error: Unicode char \u8:... set up for
1707 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1708 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1709 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1710 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1711 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1715 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des Templates,
1716 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1717 Prüfen Sie den Namen in der Konfiguration (Standard:
1718 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1719 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1722 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser verifizieren lässt:</para>
1725 <para> editiere [kivitendo-home]/config/kivitendo.conf und ändere "keep_temp_files" auf 1</para>
1726 <para><programlisting>keep_temp_files = 1;</programlisting></para>
1729 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
1732 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
1735 <para>wechsel in das users Verzeichnis von kivitendo</para>
1736 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
1739 <para>LaTeX Suchpfad anpassen:</para>
1740 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
1743 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf erstellt hat</para>
1744 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
1745 <para>Es sollte die letzte Datei ganz unten sein</para>
1748 <para>für besseren Hinweis auf Fehler texdatei nochmals übersetzen</para>
1749 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
1750 <para>in der *.tex datei nach dem Fehler suchen.</para>
1756 <sect1 id="OpenDocument-Vorlagen">
1757 <title>OpenDocument-Vorlagen</title>
1759 <para>kivitendo unterstützt die Verwendung von Vorlagen im
1760 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1761 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1762 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1763 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1764 <filename>config/kivitendo.conf</filename> die Variable
1765 <literal>opendocument</literal> im Abschnitt
1766 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1767 Dieses ist die Standardeinstellung.</para>
1769 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1770 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1771 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1772 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1773 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1774 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1776 <para>Nach der Installation müssen in der Datei
1777 <filename>config/kivitendo.conf</filename> zwei weitere Variablen
1778 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1779 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1780 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1781 enthalten. Beide stehen im Abschnitt
1782 <literal>applications</literal>.</para>
1784 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
1785 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1786 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1787 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1788 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1789 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1790 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1791 werden muss. Der Nachteil ist, dass diese Methode Python und die
1792 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1797 Für die Verbindung zu OpenOffice wird normalerweise der Python-Interpreter <filename>/usr/bin/python</filename> benutzt. Sollte
1798 dies nicht der richtige sein, so kann man mit zwei Konfigurationsvariablen entscheiden, welcher Python-Interpreter genutzt
1799 wird. Mit der Option <literal>python_uno</literal> aus dem Abschnitt <literal>applications</literal> wird der Interpreter selber
1800 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert <literal>/usr/bin/python</literal>.
1804 Zusätzlich ist es möglich, Pfade anzugeben, in denen Python neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
1805 z.B. falls sich diese in einem gesonderten OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
1806 <literal>python_uno_path</literal> und befindet sich im Abschnitt <literal>environment</literal>. Sie ist standardmäßig
1807 leer. Werden hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte voneinander getrennt werden. Der Inhalt wird an den
1808 Python-Interpreter über die Umgebungsvariable <literal>PYTHONPATH</literal> übergeben.
1812 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1813 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1814 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1815 Dokumentenvorlage enthalten sein und
1816 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1817 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1818 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1819 ebenfalls enthalten sein muss.</para>
1821 <para>Als letztes muss herausgefunden werden, welchen Namen
1822 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1823 gibt. Unter Debian ist dies momentan
1824 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1825 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1826 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1827 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1828 folgender Befehl auszuführen:</para>
1830 <para><literal>mv users/.openoffice.org2
1831 users/.openoffice</literal></para>
1833 <para>Dieses Verzeichnis, wie auch das komplette
1834 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1835 sein. Dieses wurde bereits erledigt (siehe <xref
1836 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1837 erneut überprüft werden, wenn die Konvertierung nach PDF
1841 <sect1 id="config.eur">
1842 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1845 <sect2 id="config.eur.introduction"
1846 xreflabel="Einführung in die Konfiguration zur EUR">
1847 <title>Einführung</title>
1849 <para>kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1850 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals noch <filename>config/lx_office.conf</filename>)
1851 befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden.</para>
1853 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1854 die Mandantendatenbank verschoben und dabei auch gleich in drei
1855 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1856 steuern lässt.</para>
1859 <sect2 id="config.eur.parameters"
1860 xreflabel="Konfigurationsparameter für EUR">
1861 <title>Konfigurationsparameter</title>
1863 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1864 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1868 <term><varname>profit_determination</varname></term>
1871 <para>Dieser Parameter legt die Berechnungsmethode für die
1872 Gewinnermittlung fest. Er enthält entweder
1873 <literal>balance</literal> für
1874 Betriebsvermögensvergleich/Bilanzierung oder
1875 <literal>income</literal> für die
1876 Einnahmen-Überschuss-Rechnung.</para>
1881 <term><varname>accounting_method</varname></term>
1884 <para>Dieser Parameter steuert die Buchungs- und
1885 Berechnungsmethoden für die Versteuerungsart. Er enthält
1886 entweder <literal>accrual</literal> für die Soll-Versteuerung
1887 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1892 <term><varname>inventory_system</varname></term>
1895 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1896 enthält entweder <literal>perpetual</literal> für die
1897 Bestandsmethode oder <literal>periodic</literal> für die
1898 Aufwandsmethode.</para>
1903 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1904 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1905 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1906 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1907 Bestandsmethode.</para>
1909 <para>Die Konfiguration "<varname>eur</varname>" unter
1910 <varname>[system]</varname> in der <link
1911 linkend="config.config-file">Konfigurationsdatei</link>
1912 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
1913 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1916 <sect2 id="config.eur.setting-parameters">
1917 <title>Festlegen der Parameter</title>
1919 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1920 der Admininstration können diese Optionen nun unabhängig voneinander
1921 eingestellt werden.</para>
1923 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1924 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1927 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1928 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
1929 angezeigt. Unter <guimenu>System</guimenu>
1930 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> können
1931 die Einstellungen auch geändert werden. Dabei ist zu beachten,
1932 dass eine Änderung vorhandene Daten so belässt und damit
1933 evtl. die Ergebnisse verfälscht. Dies gilt vor Allem für die
1934 Warenbuchungsmethode (siehe auch
1935 <link linkend="config.eur.inventory-system-perpetual">
1936 Bemerkungen zur Bestandsmethode</link>).</para>
1939 <sect2 id="config.eur.inventory-system-perpetual">
1940 <title>Bemerkungen zur Bestandsmethode</title>
1942 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1943 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
1944 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1945 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1946 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1947 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1948 Einkaufsrechnungen berechnet wird.</para>
1950 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1951 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1952 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1956 <sect2 id="config.eur.knonw-issues">
1957 <title>Bekannte Probleme</title>
1959 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1960 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1961 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1962 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1963 die Konfigurationsvariable
1964 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1967 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1968 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1972 <sect1 id="config.skr04-update-3804">
1973 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1975 <sect2 id="config.skr04-update-3804.introduction">
1976 <title>Einführung</title>
1978 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1979 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1980 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1981 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1982 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
1983 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
1984 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
1985 vielleicht schon selbst geholfen hat und mit seinen Änderungen
1986 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
1987 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
1988 Screenshots dargestellt.</para>
1990 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
1991 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
1992 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
1993 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
1996 <sect2 id="config.skr04-update-3804.create-chart">
1997 <title>Konto 3804 manuell anlegen</title>
1999 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
2000 anzulegen und zu konfigurieren. Zuerst wird in
2001 <guimenu>System</guimenu> ->
2002 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
2003 erfassen</guimenuitem> das Konto angelegt.</para>
2006 <screeninfo>Konto 3804 erfassen</screeninfo>
2010 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
2016 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
2017 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
2018 wie im folgenden Screenshot angezeigt anpassen.
2022 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
2026 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
2032 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
2033 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
2037 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
2041 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
2047 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
2048 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
2049 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
2050 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
2054 <screeninfo>Konto 4315 anpassen</screeninfo>
2058 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
2064 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
2065 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
2069 <screeninfo>Steuerliste vergleichen</screeninfo>
2073 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
2080 <title>Verhalten des Bilanzberichts</title>
2082 Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als Grundlage für das
2083 Startdatum benutzt. Schließt man die Bücher allerdings monatsweise führt dies
2084 zu falschen Werten.</para>
2085 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau einstellen indem man:</para>
2088 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu vorher)</para>
2091 <para>immer den Jahresanfang nimmt (1.1. relativ zum Stichtag)</para>
2094 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
2095 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen gibt</para>
2096 <para>- oder mit "alle Buchungen" als Alternative"</para>
2099 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen gibt </para>
2102 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
2106 Folgende Hinweise zu den Optionen:
2107 Das "Bücher schließen Datum" ist sinnvoll, wenn man nur komplette Jahre
2108 schließt. Bei Wirtschaftsjahr = Kalendarjahr entspricht dies aber auch
2110 "Alle Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
2112 Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B. sinnvoll, wenn man
2113 am sich Anfang des zweiten Buchungsjahres befindet, und noch keinen
2114 Jahreswechsel und auch noch keine EB-Buchungen hat.
2115 Bei den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1. Tag
2116 des Wirtschaftsjahres gebucht werden.
2117 Zur Sicherheit wird das Startdatum im Bilanzbericht jetzt zusätzlich zum
2118 Stichtag mit angezeigt. Das hilft auch bei der Kontrolle für den
2119 Abgleich mit der GuV.
2122 <sect1 id="config.client">
2123 <title>Einstellungen pro Mandant</title>
2125 <para>Einige Einstellungen können von einem Benutzer mit dem
2126 <link linkend="Zusammenhänge">Recht</link> "Administration
2127 (Für die Verwaltung der aktuellen Instanz aus einem Userlogin heraus)"
2128 gemacht werden. Diese Einstellungen sind dann für die aktuellen
2129 Mandanten-Datenbank gültig. Die Einstellungen sind
2130 unter <guimenu>System</guimenu>
2131 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
2133 <para>Bitte beachten Sie die Hinweise zu den einzelnen
2134 Einstellungen. Einige Einstellungen sollten nicht ohne Weiteres
2135 im laufenden Betrieb geändert werden (siehe
2136 auch <link linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
2137 Bestandsmethode</link>).</para>
2139 <para>Die Einstellungen <literal>show_bestbefore</literal>
2140 und <literal>payments_changeable</literal> aus dem
2141 Abschnitt <literal>features</literal> und die Einstellungen im
2142 Abschnitt <literal>datev_check</literal> (sofern schon vorhanden)
2143 der <link linkend="config.config-file">kivitendo-Konfigurationsdatei</link>
2144 werden bei einem Datenbankupdate einer älteren Version automatisch
2145 übernommen. Diese Einträge können danach aus der Konfigurationsdatei
2146 entfernt werden.</para>
2149 <sect1 id="kivitendo-ERP-verwenden">
2150 <title>kivitendo ERP verwenden</title>
2152 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
2153 folgender URL erreichbar:</para>
2156 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
2158 <para>Die Administrationsseite erreichen Sie unter:</para>
2161 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
2165 <chapter id="features" xreflabel="Features und Funktionen">
2166 <title>Features und Funktionen</title>
2168 <sect1 id="features.periodic-invoices"
2169 xreflabel="Wiederkehrende Rechnungen">
2170 <title>Wiederkehrende Rechnungen</title>
2172 <sect2 id="features.periodic-invoices.introduction"
2173 xreflabel="Einführung in wiederkehrende Rechnungen">
2174 <title>Einführung</title>
2176 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
2177 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
2178 Die konfigurierten Aufträge werden später automatisch in Rechnungen
2179 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
2180 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
2181 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
2182 wiederzufinden sind.</para>
2185 <sect2 id="features.periodic-invoices.configuration"
2186 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
2187 <title>Konfiguration</title>
2189 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
2190 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
2191 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
2192 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
2193 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
2196 <para>Folgende Parameter kann man konfigurieren:</para>
2203 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
2204 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang eines
2205 neuen Monats).</para>
2207 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
2208 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
2209 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
2210 nächsten Periodenwechsel für alle Perioden, seit der letzten
2211 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
2212 verhindern, muss man vorher das Startdatum neu setzen.</para>
2214 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
2215 erstellt. Man kann sich diese Aufträge aber gesondert in den
2216 Berichten anzeigen lassen.</para>
2221 <term>Periodizität</term>
2224 <para>Ob monatlich, quartalsweise oder jährlich auf neue
2225 Rechnungen überprüft werden soll. Für jede Periode seit dem
2226 Startdatum wird überprüft, ob für die Periode (beginnend immer
2227 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
2228 wurde. Unter Umständen können bei einem Startdatum in der
2229 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
2234 <term>Buchen auf</term>
2237 <para>Das Forderungskonto, in der Regel "Forderungen aus
2238 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
2239 Buchungsgruppen der betreffenden Waren.</para>
2244 <term>Startdatum</term>
2247 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
2253 <term>Enddatum</term>
2256 <para>ab wann keine Rechnungen mehr erstellt werden
2262 <term>Automatische Verlängerung um x Monate</term>
2265 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
2266 eingetragenen Enddatums weiterhin erstellt werden, so kann man
2267 hier die Anzahl der Monate eingeben, um die das Enddatum
2268 automatisch nach hinten geschoben wird.</para>
2273 <term>Drucken</term>
2276 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
2277 Rechnungen auch gleich ausdrucken lassen.</para>
2282 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
2283 Informationen zu den erstellten Rechnungen verschickt werden.
2284 Konfiguriert wird dies in der <link
2285 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
2286 <filename>config/kivitendo.conf</filename> im Abschnitt
2287 <varname>[periodic_invoices]</varname>.</para>
2290 <sect2 id="features.periodic-invoices.variables">
2291 <title>Spezielle Variablen</title>
2294 Um die erzeugten Rechnungen individualisieren zu können, werden beim Umwandeln des Auftrags in eine Rechnung einige speziell
2295 formatierte Variablen durch für die jeweils aktuelle Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B. den
2296 Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei die Syntax <literal><%variablenname%></literal>.
2300 Sofern es sich um eine Datumsvariable handelt, kann das Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
2301 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus: <literal><%variablenname
2302 FORMAT=Formatinformation%></literal>. Die zur verfügung stehenden Formatinformationen werden unten genauer beschrieben.
2306 Diese Variablen werden in den folgenden Elementen des Auftrags ersetzt:
2310 <listitem><para>Bemerkungen</para></listitem>
2311 <listitem><para>Interne Bemerkungen</para></listitem>
2312 <listitem><para>Vorgangsbezeichnung</para></listitem>
2313 <listitem><para>In den Beschreibungs- und Langtextfeldern aller Positionen</para></listitem>
2316 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
2320 <term><varname><%current_quarter%></varname>, <varname><%previous_quarter%></varname>, <varname><%next_quarter%></varname></term>
2324 Aktuelles, vorheriges und nächstes Quartal als Zahl zwischen <literal>1</literal> und <literal>4</literal>.
2330 <term><varname><%current_month%></varname>, <varname><%previous_month%></varname>, <varname><%next_month%></varname></term>
2334 Aktueller, vorheriger und nächster Monat als Zahl zwischen <literal>1</literal> und <literal>12</literal>.
2340 <term><varname><%current_month_long%></varname>, <varname><%previous_month_long%></varname>, <varname><%next_month_long%></varname></term>
2344 Aktueller, vorheriger und nächster Monat als Name (<literal>Januar</literal>, <literal>Februar</literal> etc.).
2350 <term><varname><%current_year%></varname>, <varname><%previous_year%></varname>, <varname><%next_year%></varname></term>
2354 Aktuelles, vorheriges und nächstes Jahr als vierstellige Jahreszahl (<literal>2013</literal> etc.).
2360 <term><varname><%period_start_date%></varname>, <varname><%period_end_date%></varname></term>
2364 Formatiertes Datum des ersten und letzten Tages im Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im ersten
2365 Quartal von 2013 wären dies der <literal>01.01.2013</literal> und <literal>31.03.2013</literal>).
2372 Die invidiuellen Formatinformationen bestehen aus Paaren von Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
2373 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal> durch das viertstellige Jahr ersetzt. Alle möglichen
2380 <term><varname>%a</varname></term>
2383 <para>Der abgekürzte Wochentagsname.</para>
2388 <term><varname>%A</varname></term>
2391 <para>Der ausgeschriebene Wochentagsname.</para>
2396 <term><varname>%b</varname></term>
2399 <para>Der abgekürzte Monatsname.</para>
2404 <term><varname>%B</varname></term>
2407 <para>Der ausgeschriebene Monatsname.</para>
2412 <term><varname>%C</varname></term>
2415 <para>Das Jahrhundert (Jahr/100) als eine zweistellige Zahl.</para>
2420 <term><varname>%d</varname></term>
2423 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
2428 <term><varname>%D</varname></term>
2431 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
2436 <term><varname>%e</varname></term>
2439 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings werden führende Nullen durch Leerzeichen ersetzt.</para>
2444 <term><varname>%F</varname></term>
2447 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
2452 <term><varname>%j</varname></term>
2455 <para>Der Tag im Jahr als Zahl zwischen 001 und 366 inklusive.</para>
2460 <term><varname>%m</varname></term>
2463 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
2468 <term><varname>%u</varname></term>
2471 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei die 1 dem Montag entspricht.</para>
2476 <term><varname>%U</varname></term>
2479 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive, wobei der erste Sonntag im Jahr das Startdatum von Woche 01 ist.</para>
2484 <term><varname>%V</varname></term>
2487 <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>
2492 <term><varname>%w</varname></term>
2495 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei die 0 dem Sonntag entspricht.</para>
2500 <term><varname>%W</varname></term>
2503 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive, wobei der erste Montag im Jahr das Startdatum von Woche 01 ist.</para>
2508 <term><varname>%y</varname></term>
2511 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99 inklusive.</para>
2516 <term><varname>%Y</varname></term>
2519 <para>Das Jahr als vierstellige Zahl.</para>
2524 <term><varname>%%</varname></term>
2527 <para>Das Prozentzeichen selber.</para>
2533 Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode
2534 dauert: <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%> bis <%period_end_date FORMAT=%m/%Y%></literal>
2538 <sect2 id="features.periodic-invoices.reports">
2539 <title>Auflisten</title>
2541 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
2542 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
2543 Rechnungen inaktiv", mit denen man sich einen Überglick über die
2544 wiederkehrenden Rechnungen verschaffen kann.</para>
2547 <sect2 id="features.periodic-invoices.task-server">
2548 <title>Erzeugung der eigentlichen Rechnungen</title>
2550 <para>Die zeitliche und periodische Überprüfung, ob eine
2551 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
2552 durch den <link linkend="config.task-server">Taskserver</link>, einen
2553 externen Dienst, der automatisch beim Start des Servers gestartet
2554 werden sollte.</para>
2557 <sect2 id="features.periodic-invoices.create-for-current-month">
2558 <title>Erste Rechnung für aktuellen Monat erstellen</title>
2560 <para>Will man im laufenden Monat eine monatlich wiederkehrende
2561 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
2562 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
2563 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
2564 generiert hat. Alternativ setzt man das Startdatum auf den
2565 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
2566 manuell über den Workflow.</para>
2569 <sect1 id="features.bank"
2570 xreflabel="bankerweiterung">
2571 <title>Bankerweiterung</title>
2573 <sect2 id="features.bank.introduction"
2574 xreflabel="Einführung in die Bankerweiterung">
2575 <title>Einführung</title>
2577 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch im Wiki und soll von dort später hierhin übernommen werden:</para>
2580 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
2583 <sect1 id="dokumentenvorlagen-und-variablen">
2584 <title>Dokumentenvorlagen und verfügbare Variablen</title>
2586 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
2587 <title>Einführung</title>
2589 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
2590 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
2591 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
2592 <function><%variablenname%></function> verwendet wird. Für
2593 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
2595 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
2597 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
2598 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
2599 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
2600 alle Vorlagenarten.</para>
2602 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
2603 verfügbar als hier aufgelistet werden. Die meisten davon können
2604 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
2605 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
2606 diese wie folgt erhalten werden:</para>
2610 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
2611 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
2615 <para>In <filename>Form.pm</filename> die Funktion
2616 <function>parse_template</function> suchen und hier die Zeile
2617 <command>print(STDERR Dumper($self));</command> einfügen.</para>
2621 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
2622 ein PDF für eine Rechnung erzeugen.</para>
2626 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
2627 der Variablen <varname>$self</varname> in der Form <varname>'key'
2628 => 'value',</varname>. Alle <varname>key</varname>s sind
2634 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
2635 <title>Variablen ausgeben</title>
2637 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
2638 Tags geschrieben werden, also z.B.
2639 <varname><%variablenname%></varname>.</para>
2641 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
2642 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
2643 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
2644 werden die folgenden Flags unterstützt:</para>
2648 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
2649 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
2650 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
2651 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
2655 <para><option>NOESCAPE</option> unterdrückt das Escapen von
2656 Sonderzeichen für die Vorlagensprache. Wenn also in einer
2657 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
2658 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
2659 ist dieses Flag sinnvoll.</para>
2663 <para>Beispiel:</para>
2665 <programlisting><%quototal NOFORMAT%></programlisting>
2668 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
2669 <title>Verwendung in Druckbefehlen</title>
2671 <para>In der Admininstration können Drucker definiert werden. Auch im
2672 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
2673 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
2674 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
2675 <function>`...`</function> nicht zu unerwünschtem Verhalten
2678 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
2679 für das die Telefonnummer eines Ansprechpartners als Teil der
2680 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
2681 z.B. wie folgt aussehen:</para>
2683 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
2686 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
2687 xreflabel="Anfang und Ende der Tags verändern">
2688 <title>Anfang und Ende der Tags verändern</title>
2690 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
2691 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
2692 Prozentzeichen und dem Größerzeichen endet, beispielsweise
2693 <function><%customer%></function>. Da diese Form aber z.B. in
2694 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
2695 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
2696 Stil umgestellt werden.</para>
2698 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
2699 Format gültigen Kommentarzeichen anfangen, dann
2700 <function>config:</function> enthalten, die entsprechende Option
2701 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
2702 enden. Beispiel für LaTeX:</para>
2704 <programlisting>% config: tag-style=($ $)</programlisting>
2706 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
2707 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
2708 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
2710 <programlisting><!-- config: tag-style=($ $) --></programlisting>
2713 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
2714 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
2716 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
2717 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
2718 "<filename>.ext</filename>" geeignet zu ersetzen:
2719 "<filename>.tex</filename>" für LaTeX-Vorlagen und
2720 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
2724 <term><filename>bin_list.ext</filename></term>
2727 <para>Lagerliste</para>
2732 <term><filename>check.ext</filename></term>
2740 <term><filename>invoice.ext</filename></term>
2743 <para>Rechnung</para>
2748 <term><filename>packing_list.ext</filename></term>
2751 <para>Packliste</para>
2756 <term><filename>pick_list.ext</filename></term>
2759 <para>Sammelliste</para>
2764 <term><filename>purchase_delivery_order.ext</filename></term>
2767 <para>Lieferschein (Einkauf)</para>
2772 <term><filename>purcharse_order.ext</filename></term>
2775 <para>Bestellung an Lieferanten</para>
2780 <term><filename>request_quotation.ext</filename></term>
2783 <para>Anfrage an Lieferanten</para>
2788 <term><filename>sales_delivery_order.ext</filename></term>
2791 <para>Lieferschein (Verkauf)</para>
2796 <term><filename>sales_order.ext</filename></term>
2799 <para>Bestellung</para>
2804 <term><filename>sales_quotation.ext</filename></term>
2807 <para>Angebot an Kunden</para>
2812 <term><filename>zahlungserinnerung.ext</filename></term>
2815 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2820 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2823 <para>Rechnung über Mahngebühren (Dateiname im Programm
2824 konfigurierbar)</para>
2830 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2831 <title>Sprache, Drucker und E-Mail</title>
2833 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2834 eingearbeitet. So wird aus der Vorlage
2835 <filename>sales_order.ext</filename> bei Sprache
2836 <function>de</function> und Druckerkürzel <function>lpr2</function>
2837 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2838 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2839 bekommen dann noch das Kürzel <filename>_email</filename>, der
2840 vollständige Vorlagenname wäre dann
2841 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2842 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2843 werden. Diese wird verwendet, wenn keine der anderen Varianten
2844 gefunden wird.</para>
2846 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2847 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2848 verschickt wird, ist:</para>
2852 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2856 <para><filename>sales_order_de_lpr2.tex</filename></para>
2860 <para><filename>sales_order.tex</filename></para>
2864 <para><filename>default.tex</filename></para>
2868 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2869 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2871 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2874 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2875 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2878 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2879 xreflabel="Metainformationen zur angeforderten Vorlage">
2880 <title>Metainformationen zur angeforderten Vorlage</title>
2882 <para>Diese Variablen liefern Informationen darüber welche Variante
2883 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2884 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2885 Formulare einbinden möchten.</para>
2889 <term><varname>template_meta.formname</varname></term>
2892 <para>Basisname der Vorlage. Identisch mit der <link
2893 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2894 zu den Dateinamen</link> ohne die Erweiterung. Ein
2895 Verkaufsauftrag enthält hier
2896 <constant>sales_order</constant>.</para>
2901 <term><varname>template_meta.language.description</varname></term>
2904 <para>Beschreibung der verwendeten Sprache</para>
2909 <term><varname>template_meta.language.template_code</varname></term>
2912 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2913 Kürzel das im Dateinamen verwendetet wird.</para>
2918 <term><varname>template_meta.language.output_numberformat</varname></term>
2921 <para>Zahlenformat der verwendeten Sprache in der Form
2922 "<constant>1.000,00</constant>". Experimentell! Nur
2923 interessant für Vorlagen die mit unformatierten Werten
2929 <term><varname>template_meta.language.output_dateformat</varname></term>
2932 <para>Datumsformat der verwendeten Sprache in der Form
2933 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2934 interessant für Vorlagen die mit unformatierten Werten
2940 <term><varname>template_meta.format</varname></term>
2943 <para>Das angeforderte Format. Kann im Moment die Werte
2944 <constant>pdf</constant>, <constant>postscript</constant>,
2945 <constant>html</constant>, <constant>opendocument</constant>,
2946 <constant>opendocument_pdf</constant> und
2947 <constant>excel</constant> enthalten.</para>
2952 <term><varname>template_meta.extension</varname></term>
2955 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2956 <constant>format</constant> entschieden.</para>
2961 <term><varname>template_meta.media</varname></term>
2964 <para>Ausgabemedium. Kann zur Zeit die Werte
2965 <constant>screen</constant> für Bildschirm,
2966 <constant>email</constant> für E-Mail (triggert das
2967 <constant>_email</constant> Kürzel im Dateinamen),
2968 <constant>printer</constant> für Drucker, und
2969 <constant>queue</constant> für Warteschlange enthalten.</para>
2974 <term><varname>template_meta.printer.description</varname></term>
2977 <para>Beschreibung des ausgewählten Druckers</para>
2982 <term><varname>template_meta.printer.template_code</varname></term>
2985 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2986 dem Kürzel das im Dateinamen verwendetet wird.</para>
2991 <term><varname>template_meta.tmpfile</varname></term>
2994 <para>Datei-Prefix für temporäre Dateien.</para>
3000 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
3001 <title>Stammdaten von Kunden und Lieferanten</title>
3005 <term><varname>account_number</varname></term>
3008 <para>Kontonummer</para>
3013 <term><varname>bank</varname></term>
3016 <para>Name der Bank</para>
3021 <term><varname>bank_code</varname></term>
3024 <para>Bankleitzahl</para>
3029 <term><varname>bic</varname></term>
3032 <para>Bank-Identifikations-Code (Bank Identifier Code,
3038 <term><varname>business</varname></term>
3041 <para>Kunden-/Lieferantentyp</para>
3046 <term><varname>city</varname></term>
3054 <term><varname>contact</varname></term>
3057 <para>Kontakt</para>
3062 <term><varname>country</varname></term>
3070 <term><varname>c_vendor_id</varname></term>
3073 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
3078 <term><varname>v_customer_id</varname></term>
3081 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
3086 <term><varname>cp_email</varname></term>
3089 <para>Email des Ansprechpartners</para>
3094 <term><varname>cp_givenname</varname></term>
3097 <para>Vorname des Ansprechpartners</para>
3102 <term><varname>cp_greeting</varname></term>
3105 <para>Anrede des Ansprechpartners</para>
3110 <term><varname>cp_name</varname></term>
3113 <para>Name des Ansprechpartners</para>
3118 <term><varname>cp_phone1</varname></term>
3121 <para>Telefonnummer 1 des Ansprechpartners</para>
3126 <term><varname>cp_phone2</varname></term>
3129 <para>Telefonnummer 2 des Ansprechpartners</para>
3134 <term><varname>cp_title</varname></term>
3137 <para>Titel des Ansprechpartners</para>
3142 <term><varname>creditlimit</varname></term>
3145 <para>Kreditlimit</para>
3150 <term><varname>customeremail</varname></term>
3153 <para>Email des Kunden; nur für Kunden</para>
3158 <term><varname>customerfax</varname></term>
3161 <para>Faxnummer des Kunden; nur für Kunden</para>
3166 <term><varname>customernotes</varname></term>
3169 <para>Bemerkungen beim Kunden; nur für Kunden</para>
3174 <term><varname>customernumber</varname></term>
3177 <para>Kundennummer; nur für Kunden</para>
3182 <term><varname>customerphone</varname></term>
3185 <para>Telefonnummer des Kunden; nur für Kunden</para>
3190 <term><varname>discount</varname></term>
3198 <term><varname>email</varname></term>
3201 <para>Emailadresse</para>
3206 <term><varname>fax</varname></term>
3209 <para>Faxnummer</para>
3214 <term><varname>greeting</varname></term>
3222 <term><varname>homepage</varname></term>
3225 <para>Homepage</para>
3230 <term><varname>iban</varname></term>
3233 <para>Internationale Kontonummer (International Bank Account
3234 Number, IBAN)</para>
3239 <term><varname>language</varname></term>
3242 <para>Sprache</para>
3247 <term><varname>name</varname></term>
3250 <para>Firmenname</para>
3255 <term><varname>payment_description</varname></term>
3258 <para>Name der Zahlart</para>
3263 <term><varname>payment_terms</varname></term>
3266 <para>Zahlungskonditionen</para>
3271 <term><varname>phone</varname></term>
3274 <para>Telefonnummer</para>
3279 <term><varname>shiptocity</varname></term>
3282 <para>Stadt (Lieferadresse) <link
3283 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3288 <term><varname>shiptocontact</varname></term>
3291 <para>Kontakt (Lieferadresse) <link
3292 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3297 <term><varname>shiptocountry</varname></term>
3300 <para>Land (Lieferadresse) <link
3301 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3306 <term><varname>shiptodepartment1</varname></term>
3309 <para>Abteilung 1 (Lieferadresse) <link
3310 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3315 <term><varname>shiptodepartment2</varname></term>
3318 <para>Abteilung 2 (Lieferadresse) <link
3319 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3324 <term><varname>shiptoemail</varname></term>
3327 <para>Email (Lieferadresse) <link
3328 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3333 <term><varname>shiptofax</varname></term>
3336 <para>Fax (Lieferadresse) <link
3337 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3342 <term><varname>shiptoname</varname></term>
3345 <para>Firmenname (Lieferadresse) <link
3346 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3351 <term><varname>shiptophone</varname></term>
3354 <para>Telefonnummer (Lieferadresse) <link
3355 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3360 <term><varname>shiptostreet</varname></term>
3363 <para>Straße und Hausnummer (Lieferadresse) <link
3364 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3369 <term><varname>shiptozipcode</varname></term>
3372 <para>Postleitzahl (Lieferadresse) <link
3373 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3378 <term><varname>street</varname></term>
3381 <para>Straße und Hausnummer</para>
3386 <term><varname>taxnumber</varname></term>
3389 <para>Steuernummer</para>
3394 <term><varname>ustid</varname></term>
3397 <para>Umsatzsteuer-Identifikationsnummer</para>
3402 <term><varname>vendoremail</varname></term>
3405 <para>Email des Lieferanten; nur für Lieferanten</para>
3410 <term><varname>vendorfax</varname></term>
3413 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
3418 <term><varname>vendornotes</varname></term>
3421 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
3426 <term><varname>vendornumber</varname></term>
3429 <para>Lieferantennummer; nur für Lieferanten</para>
3434 <term><varname>vendorphone</varname></term>
3437 <para>Telefonnummer des Lieferanten; nur für
3443 <term><varname>zipcode</varname></term>
3446 <para>Postleitzahl</para>
3451 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
3452 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
3453 Stammdaten nicht eingetragen, so haben die Variablen
3454 <varname>shipto*</varname> den gleichen Wert wie die die
3455 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
3456 einige <varname>shipto*</varname>-Variablen so nicht in den
3457 Stammdaten wiederfinden sondern schlicht Kopien der
3458 Lieferdatenvariablen sind (z.B.
3459 <varname>shiptocontact</varname>).</para>
3463 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
3464 <title>Informationen über den Bearbeiter</title>
3468 <term><varname>employee_address</varname></term>
3471 <para>Adressfeld</para>
3476 <term><varname>employee_businessnumber</varname></term>
3479 <para>Firmennummer</para>
3484 <term><varname>employee_company</varname></term>
3487 <para>Firmenname</para>
3492 <term><varname>employee_co_ustid</varname></term>
3495 <para>Usatzsteuer-Identifikationsnummer</para>
3500 <term><varname>employee_duns</varname></term>
3503 <para>DUNS-Nummer</para>
3508 <term><varname>employee_email</varname></term>
3516 <term><varname>employee_fax</varname></term>
3524 <term><varname>employee_name</varname></term>
3527 <para>voller Name</para>
3532 <term><varname>employee_signature</varname></term>
3535 <para>Signatur</para>
3540 <term><varname>employee_taxnumber</varname></term>
3543 <para>Steuernummer</para>
3548 <term><varname>employee_tel</varname></term>
3551 <para>Telefonnummer</para>
3557 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
3558 <title>Informationen über den Verkäufer</title>
3562 <term><varname>salesman_address</varname></term>
3565 <para>Adressfeld</para>
3570 <term><varname>salesman_businessnumber</varname></term>
3573 <para>Firmennummer</para>
3578 <term><varname>salesman_company</varname></term>
3581 <para>Firmenname</para>
3586 <term><varname>salesman_co_ustid</varname></term>
3589 <para>Usatzsteuer-Identifikationsnummer</para>
3594 <term><varname>salesman_duns</varname></term>
3597 <para>DUNS-Nummer</para>
3602 <term><varname>salesman_email</varname></term>
3610 <term><varname>salesman_fax</varname></term>
3618 <term><varname>salesman_name</varname></term>
3621 <para>voller Name</para>
3626 <term><varname>salesman_signature</varname></term>
3629 <para>Signatur</para>
3634 <term><varname>salesman_taxnumber</varname></term>
3637 <para>Steuernummer</para>
3642 <term><varname>salesman_tel</varname></term>
3645 <para>Telefonnummer</para>
3651 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
3652 <title>Variablen für die einzelnen Steuern</title>
3656 <term><varname>tax</varname></term>
3664 <term><varname>taxbase</varname></term>
3667 <para>zu versteuernder Betrag</para>
3672 <term><varname>taxdescription</varname></term>
3675 <para>Name der Steuer</para>
3680 <term><varname>taxrate</varname></term>
3683 <para>Steuersatz</para>
3689 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
3690 <title>Variablen für Lieferbedingungen</title>
3694 <term><varname>delivery_term</varname></term>
3695 <listitem><para>Datenbank-Objekt der Lieferbedingung</para></listitem>
3698 <term><varname>delivery_term.description</varname></term>
3699 <listitem><para>Beschreibung der Lieferbedingung</para></listitem>
3702 <term><varname>delivery_term.description_long</varname></term>
3703 <listitem><para>Langtext bzw. übersetzter Langtext der Lieferbedingung</para></listitem>
3709 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
3710 <title>Variablen in Rechnungen</title>
3712 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
3713 <title>Allgemeine Variablen</title>
3717 <term><varname>creditremaining</varname></term>
3720 <para>Verbleibender Kredit</para>
3725 <term><varname>currency</varname></term>
3728 <para>Währung</para>
3733 <term><varname>cusordnumber</varname></term>
3736 <para>Bestellnummer beim Kunden</para>
3741 <term><varname>deliverydate</varname></term>
3744 <para>Lieferdatum</para>
3749 <term><varname>duedate</varname></term>
3752 <para>Fälligkeitsdatum</para>
3757 <term><varname>globalprojectnumber</varname></term>
3760 <para>Projektnummer des ganzen Beleges</para>
3765 <term><varname>globalprojectdescription</varname></term>
3768 <para>Projekbeschreibung des ganzen Beleges</para>
3773 <term><varname>intnotes</varname></term>
3776 <para>Interne Bemerkungen</para>
3781 <term><varname>invdate</varname></term>
3784 <para>Rechnungsdatum</para>
3789 <term><varname>invnumber</varname></term>
3792 <para>Rechnungsnummer</para>
3797 <term><varname>invtotal</varname></term>
3800 <para>gesamter Rechnungsbetrag</para>
3805 <term><varname>notes</varname></term>
3808 <para>Bemerkungen der Rechnung</para>
3813 <term><varname>orddate</varname></term>
3816 <para>Auftragsdatum</para>
3821 <term><varname>ordnumber</varname></term>
3824 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3825 erstellt wurde</para>
3830 <term><varname>payment_description</varname></term>
3833 <para>Name der Zahlart</para>
3838 <term><varname>payment_terms</varname></term>
3841 <para>Zahlungskonditionen</para>
3846 <term><varname>quodate</varname></term>
3849 <para>Angebotsdatum</para>
3854 <term><varname>quonumber</varname></term>
3857 <para>Angebotsnummer</para>
3862 <term><varname>shippingpoint</varname></term>
3865 <para>Versandort</para>
3870 <term><varname>shipvia</varname></term>
3873 <para>Transportmittel</para>
3878 <term><varname>subtotal</varname></term>
3881 <para>Zwischensumme aller Posten ohne Steuern</para>
3886 <term><varname>total</varname></term>
3889 <para>Restsumme der Rechnung (Summe abzüglich bereits
3890 bezahlter Posten)</para>
3895 <term><varname>transaction_description</varname></term>
3898 <para>Vorgangsbezeichnung</para>
3903 <term><varname>transdate</varname></term>
3906 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3907 erstellt wurde</para>
3913 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3914 <title>Variablen für jeden Posten auf der Rechnung</title>
3918 <term><varname>bin</varname></term>
3921 <para>Stellage</para>
3926 <term><varname>description</varname></term>
3929 <para>Artikelbeschreibung</para>
3934 <term><varname>cusordnumber_oe</varname></term>
3937 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der Posten ursprünglich stammt (nur Verkauf)</para>
3942 <term><varname>discount</varname></term>
3945 <para>Rabatt als Betrag</para>
3950 <term><varname>discount_sub</varname></term>
3953 <para>Zwischensumme mit Rabatt</para>
3958 <term><varname>donumber_do</varname></term>
3961 <para>Lieferscheinnummer des Lieferscheins, aus dem die Position ursprünglich stammt, wenn die Rechnung im Rahmen des Workflows aus einem Lieferschein erstellt wurde.</para>
3966 <term><varname>drawing</varname></term>
3969 <para>Zeichnung</para>
3974 <term><varname>ean</varname></term>
3977 <para>EAN-Code</para>
3982 <term><varname>image</varname></term>
3990 <term><varname>linetotal</varname></term>
3993 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
3998 <term><varname>longdescription</varname></term>
4001 <para>Langtext</para>
4006 <term><varname>microfiche</varname></term>
4009 <para>Mikrofilm</para>
4014 <term><varname>netprice</varname></term>
4017 <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>
4022 <term><varname>nodiscount_linetotal</varname></term>
4025 <para>Zeilensumme ohne Rabatt</para>
4030 <term><varname>nodiscount_sub</varname></term>
4033 <para>Zwischensumme ohne Rabatt</para>
4038 <term><varname>number</varname></term>
4041 <para>Artikelnummer</para>
4046 <term><varname>ordnumber_oe</varname></term>
4049 <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>
4054 <term><varname>p_discount</varname></term>
4057 <para>Rabatt in Prozent</para>
4062 <term><varname>partnotes</varname></term>
4065 <para>Die beim Artikel gespeicherten Bemerkungen</para>
4070 <term><varname>partsgroup</varname></term>
4073 <para>Warengruppe</para>
4078 <term><varname>price_factor</varname></term>
4081 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
4087 <term><varname>price_factor_name</varname></term>
4090 <para>Der Name des Preisfaktors, sofern einer eingestellt
4096 <term><varname>projectnumber</varname></term>
4099 <para>Projektnummer</para>
4104 <term><varname>projectdescription</varname></term>
4107 <para>Projektbeschreibung</para>
4112 <term><varname>qty</varname></term>
4120 <term><varname>reqdate</varname></term>
4123 <para>Lieferdatum</para>
4128 <term><varname>runningnumber</varname></term>
4131 <para>Position auf der Rechnung (1, 2, 3...)</para>
4136 <term><varname>sellprice</varname></term>
4139 <para>Verkaufspreis</para>
4144 <term><varname>serialnumber</varname></term>
4147 <para>Seriennummer</para>
4152 <term><varname>tax_rate</varname></term>
4155 <para>Steuersatz</para>
4160 <term><varname>transdate_do</varname></term>
4163 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des Workflows aus einem Lieferschein stammte.</para>
4168 <term><varname>transdate_oe</varname></term>
4171 <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>
4176 <term><varname>transdate_quo</varname></term>
4179 <para>Datum des Angebots, wenn die Position im Rahmen des Workflows aus einem Angebot stammte.</para>
4184 <term><varname>unit</varname></term>
4187 <para>Einheit</para>
4192 <term><varname>weight</varname></term>
4195 <para>Gewicht</para>
4200 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
4201 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
4202 einer <function>foreach</function>-Schleife ausgegeben werden, da
4203 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
4204 können. Die Variablen dafür lauten:</para>
4208 <term><varname>make</varname></term>
4211 <para>Lieferant</para>
4216 <term><varname>model</varname></term>
4219 <para>Lieferantenartikelnummer</para>
4225 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
4226 <title>Variablen für die einzelnen Zahlungseingänge</title>
4230 <term><varname>payment</varname></term>
4238 <term><varname>paymentaccount</varname></term>
4246 <term><varname>paymentdate</varname></term>
4254 <term><varname>paymentmemo</varname></term>
4262 <term><varname>paymentsource</varname></term>
4271 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
4272 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
4274 <para>Die vom Benutzer definierten Variablen für Kunden und
4275 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
4276 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
4277 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
4278 Variablennamen zusammen.</para>
4280 <para>Beispiel: Der Benutzer hat eine Variable namens
4281 <varname>number_of_employees</varname> definiert, die die Anzahl der
4282 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
4283 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
4288 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
4289 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
4291 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
4292 <title>Namen der Vorlagen</title>
4294 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
4295 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
4296 Erstellung einer Rechnung über die Mahngebühren und Zinsen
4297 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
4298 Vorlagenname für diese Mahnstufe mit dem Zusatz
4299 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
4300 für die ausgewählte Sprache und den ausgewählten Drucker
4304 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
4305 <title>Allgemeine Variablen in Mahnungen</title>
4307 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4308 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4309 Kunden stehen als Variablen <varname>name</varname>,
4310 <varname>street</varname>, <varname>zipcode</varname>,
4311 <varname>city</varname>, <varname>country</varname>,
4312 <varname>department_1</varname>, <varname>department_2</varname>,
4313 und <varname>email</varname> zur Verfügung.</para>
4315 <para>Weitere Variablen beinhalten:</para>
4319 <term><varname>dunning_date</varname></term>
4322 <para>Datum der Mahnung</para>
4327 <term><varname>dunning_duedate</varname></term>
4330 <para>Fälligkeitsdatum für diese Mahhnung</para>
4335 <term><varname>dunning_id</varname></term>
4338 <para>Mahnungsnummer</para>
4343 <term><varname>fee</varname></term>
4346 <para>Kummulative Mahngebühren</para>
4351 <term><varname>interest_rate</varname></term>
4354 <para>Zinssatz per anno in Prozent</para>
4359 <term><varname>total_amount</varname></term>
4362 <para>Gesamter noch zu zahlender Betrag als
4363 <function>fee</function> + <function>total_interest</function>
4364 + <function>total_open_amount</function></para>
4369 <term><varname>total_interest</varname></term>
4372 <para>Zinsen per anno über alle Rechnungen</para>
4377 <term><varname>total_open_amount</varname></term>
4380 <para>Summe über alle offene Beträge der Rechnungen</para>
4386 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
4387 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
4391 <term><varname>dn_amount</varname></term>
4394 <para>Rechnungssumme (brutto)</para>
4399 <term><varname>dn_duedate</varname></term>
4402 <para>Originales Fälligkeitsdatum der Rechnung</para>
4407 <term><varname>dn_dunning_date</varname></term>
4410 <para>Datum der Mahnung</para>
4415 <term><varname>dn_dunning_duedate</varname></term>
4418 <para>Fälligkeitsdatum der Mahnung</para>
4423 <term><varname>dn_fee</varname></term>
4426 <para>Kummulative Mahngebühr</para>
4431 <term><varname>dn_interest</varname></term>
4434 <para>Zinsen per anno für diese Rechnung</para>
4439 <term><varname>dn_invnumber</varname></term>
4442 <para>Rechnungsnummer</para>
4447 <term><varname>dn_linetotal</varname></term>
4450 <para>Noch zu zahlender Betrag (ergibt sich aus
4451 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
4452 + <varname>dn_interest</varname>)</para>
4457 <term><varname>dn_netamount</varname></term>
4460 <para>Rechnungssumme (netto)</para>
4465 <term><varname>dn_open_amount</varname></term>
4468 <para>Offener Rechnungsbetrag</para>
4473 <term><varname>dn_ordnumber</varname></term>
4476 <para>Bestellnummer</para>
4481 <term><varname>dn_transdate</varname></term>
4484 <para>Rechnungsdatum</para>
4489 <term><varname>dn_curr</varname></term>
4492 <para>Währung, in der die Rechnung erstellt wurde. (Die
4493 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
4499 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
4500 <title>Variablen in automatisch erzeugten Rechnungen über
4501 Mahngebühren</title>
4503 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4504 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4505 Kunden stehen als Variablen <varname>name</varname>,
4506 <varname>street</varname>, <varname>zipcode</varname>,
4507 <varname>city</varname>, <varname>country</varname>,
4508 <varname>department_1</varname>, <varname>department_2</varname>,
4509 und <varname>email</varname> zur Verfügung.</para>
4511 <para>Weitere Variablen beinhalten:</para>
4515 <term><varname>duedate</varname></term>
4518 <para>Fälligkeitsdatum der Rechnung</para>
4523 <term><varname>dunning_id</varname></term>
4526 <para>Mahnungsnummer</para>
4531 <term><varname>fee</varname></term>
4534 <para>Mahngebühren</para>
4539 <term><varname>interest</varname></term>
4547 <term><varname>invamount</varname></term>
4550 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
4551 <varname>interest</varname>)</para>
4556 <term><varname>invdate</varname></term>
4559 <para>Rechnungsdatum</para>
4564 <term><varname>invnumber</varname></term>
4567 <para>Rechnungsnummer</para>
4574 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
4575 <title>Variablen in anderen Vorlagen</title>
4578 <title>Einführung</title>
4580 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
4581 Rechnung. Allerdings heißen die Variablen, die mit
4582 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
4583 fangen sie mit <varname>quo</varname> für "quotation" an:
4584 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
4585 wiederum fangen sie mit <varname>ord</varname> für "order" an:
4586 <varname>ordnumber</varname> für Bestellnummer etc.</para>
4588 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
4589 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
4590 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
4591 Vorlage keine Bedeutung haben oder noch nicht belegt sein
4594 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
4595 in Rechnungen aufgeführt.</para>
4598 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
4599 <title>Angebote und Preisanfragen</title>
4603 <term><varname>quonumber</varname></term>
4606 <para>Angebots- bzw. Anfragenummer</para>
4611 <term><varname>reqdate</varname></term>
4614 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
4615 Preisanfragen)</para>
4620 <term><varname>transdate</varname></term>
4623 <para>Angebots- bzw. Anfragedatum</para>
4629 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
4630 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
4634 <term><varname>ordnumber</varname></term>
4637 <para>Auftragsnummer</para>
4642 <term><varname>reqdate</varname></term>
4645 <para>Lieferdatum</para>
4650 <term><varname>transdate</varname></term>
4653 <para>Auftragsdatum</para>
4659 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
4660 <title>Lieferscheine (Verkauf und Einkauf)</title>
4664 <term><varname>cusordnumber</varname></term>
4667 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
4668 des Lieferanten (im Einkauf)</para>
4673 <term><varname>donumber</varname></term>
4676 <para>Lieferscheinnummer</para>
4681 <term><varname>transdate</varname></term>
4684 <para>Lieferscheindatum</para>
4689 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
4690 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
4691 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
4692 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
4693 <function>foreach</function>-Schleife ausgegeben werden. Diese
4694 Variablen sind:</para>
4698 <term><varname>si_bin</varname></term>
4701 <para>Lagerplatz</para>
4706 <term><varname>si_chargenumber</varname></term>
4709 <para>Chargennummer</para>
4714 <term><varname>si_bestbefore</varname></term>
4717 <para>Mindesthaltbarkeit</para>
4722 <term><varname>si_number</varname></term>
4725 <para>Artikelnummer</para>
4730 <term><varname>si_qty</varname></term>
4733 <para>Anzahl bzw. Menge</para>
4738 <term><varname>si_runningnumber</varname></term>
4741 <para>Positionsnummer (1, 2, 3 etc)</para>
4746 <term><varname>si_unit</varname></term>
4749 <para>Einheit</para>
4754 <term><varname>si_warehouse</varname></term>
4763 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
4764 <title>Variablen für Sammelrechnung</title>
4768 <term><varname>c0total</varname></term>
4771 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
4777 <term><varname>c30total</varname></term>
4780 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
4781 und < 60 Tage</para>
4786 <term><varname>c60total</varname></term>
4789 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
4790 und < 90 Tage</para>
4795 <term><varname>c90total</varname></term>
4798 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
4804 <term><varname>total</varname></term>
4807 <para>Gesamtbetrag aller Rechnungen</para>
4812 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
4816 <term><varname>invnumber</varname></term>
4819 <para>Rechnungsnummer</para>
4824 <term><varname>invdate</varname></term>
4827 <para>Rechnungsdatum</para>
4832 <term><varname>duedate</varname></term>
4835 <para>Fälligkeitsdatum</para>
4840 <term><varname>amount</varname></term>
4843 <para>Summe der Rechnung</para>
4848 <term><varname>open</varname></term>
4851 <para>Noch offener Betrag der Rechnung</para>
4856 <term><varname>c0</varname></term>
4859 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4865 <term><varname>c30</varname></term>
4868 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4874 <term><varname>c60</varname></term>
4877 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4883 <term><varname>c90</varname></term>
4886 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4894 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4895 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4897 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4898 <title>Einführung</title>
4900 <para>Der Parser kennt neben den Variablen einige weitere
4901 Konstrukte, die gesondert behandelt werden. Diese sind wie
4902 Variablennamen in spezieller Weise markiert:
4903 <command><%anweisung%> ... <%end%></command></para>
4905 <para>Anmerkung zum <command><%end%></command>: Der besseren
4906 Verständlichkeit halber kann man nach dem <command>end</command>
4907 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4908 Anweisung (z.B. <command>if</command> oder
4909 <command>foreach</command>) damit abgeschlossen wird.</para>
4911 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4912 <command><%if type == "sales_quotation"%></command>, so könnte
4913 er mit <command><%end%></command> genauso abgeschlossen werden
4914 wie mit <command><%end if%></command> oder auch
4915 <command><%end type == "sales_quotation"%></command>.</para>
4918 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4919 <title>Der if-Block</title>
4921 <programlisting><%if variablenname%>
4923 <%end%></programlisting>
4925 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4926 und dem "end" werden nur ausgegeben, wenn die Variable
4927 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4929 <para>Handelt es sich bei der benannten Variable um ein Array, also um einen Variablennamen, über den man mit
4930 <command><%foreach variablenname%></command> iteriert, so wird mit diesem Konstrukt darauf getestet, ob das Array Elemente
4931 enthält. Somit würde im folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt ihrer Überschrift "Zahlungseingänge"
4932 ausgegeben, wenn tatsächlich welche getätigt wurden:</para>
4934 <programlisting><%if payment%>
4936 <%foreach payment%>
4937 Am <%paymentdate%>: <%payment%> €
4938 <%end foreach%>
4939 <%end if%></programlisting>
4941 <para>Die Bedingung kann auch negiert werden, indem das Wort
4942 <function>not</function> nach dem <filename>if</filename> verwendet
4943 wird. Beispiel:</para>
4945 <programlisting><%if not cp_greeting%>
4947 <%end%></programlisting>
4949 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4950 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4951 einer Variablen mit einer festen Zeichenkette oder einer anderen
4952 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4953 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4954 die rechte Seite des Vergleichsoperators in Anführungszeichen
4955 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4956 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4959 <programlisting><%if var1 == "Wert"%></programlisting>
4961 <para>Testet die Variable <varname>var1</varname> auf
4962 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4963 Mittels <function>!=</function> anstelle von <function>==</function>
4964 würde auf Ungleichheit getestet.</para>
4966 <programlisting><%if var1 == var2%></programlisting>
4968 <para>Testet die Variable <varname>var1</varname> auf
4969 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4970 <function>!=</function> anstelle von <function>==</function> würde
4971 auf Ungleichheit getestet.</para>
4973 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4974 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
4975 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4976 dieselbe Syntax wie oben nur mit <function>=~</function> und
4977 <function>!~</function> als Vergleichsoperatoren.</para>
4979 <para>Beispiel für einen Test, ob die Variable
4980 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4981 <constant>schwierig</constant> enthält:</para>
4983 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
4986 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
4987 <title>Der foreach-Block</title>
4989 <programlisting><%foreach variablenname%>
4991 <%end%></programlisting>
4993 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
4994 wie das Perl-Array der Variablen <varname>variablenname</varname>
4995 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
4996 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
4997 benutzt. In jedem Durchlauf werden die <link
4998 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
4999 Variablen</link> jeweils auf den Wert für die aktuelle Position
5002 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
5004 <programlisting><%foreach number%>
5005 Position: <%runningnumber%>
5006 Anzahl: <%qty%>
5007 Artikelnummer: <%number%>
5008 Beschreibung: <%description%>
5010 <%end%></programlisting>
5012 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
5013 <function><%foreach%></function>-Block innerhalb einer
5014 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
5015 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
5016 Inhalt zwischen <function><%foreach%></function> und
5017 <function><%end%></function> wiederholt, nicht aber die
5018 komplette Zeile, in der er steht.</para>
5022 <sect2 id="dokumentenvorlagen-und-variablen.markup">
5023 <title>Markup-Code zur Textformatierung innerhalb von
5026 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
5027 anders formatiert haben möchte, so ist dies begrenzt möglich.
5028 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
5029 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
5030 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
5031 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
5032 (HTML oder PDF über LaTeX) umgesetzt.</para>
5034 <para>Die unterstützen Formatierungen sind:</para>
5038 <term><b>Text</b></term>
5041 <para>Text wird in Fettdruck gesetzt.</para>
5046 <term><i>Text</i></term>
5049 <para>Text wird kursiv gesetzt.</para>
5054 <term><u>Text</u></term>
5057 <para>Text wird unterstrichen.</para>
5062 <term><s>Text</s></term>
5065 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
5066 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
5071 <term><bullet></term>
5074 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
5080 <para>Der Befehl <command><bullet></command> funktioniert
5081 momentan auch nur in Latex-Vorlagen.</para>
5085 <sect1 id="excel-templates">
5086 <title>Excel-Vorlagen</title>
5088 <sect2 id="excel-templates.summary">
5089 <title>Zusammenfassung</title>
5091 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
5092 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
5096 <sect2 id="excel-templates.usage">
5097 <title>Bedienung</title>
5099 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
5100 werden. Die Konfigurationsoption heißt <varname>excel_templates =
5101 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
5103 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
5104 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
5105 werden. In den normalen Verkaufsmasken taucht nun
5106 <constant>Excel</constant> als auswählbares Format auf und kann von da
5107 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
5109 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
5110 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
5111 <filename>sales_quotation.xls</filename> gespeichert.</para>
5114 <sect2 id="excel-templates.syntax">
5115 <title>Variablensyntax</title>
5117 <para>Einfache Syntax:
5118 <command><<varname>></command></para>
5120 <para>Dabei sind <constant><<</constant> und
5121 <constant>>></constant> die Delimiter. Da Excel auf festen
5122 Breiten besteht, kann der Tag künstlich verlängert werden, indem
5123 weitere <constant><</constant> oder <constant>></constant>
5124 eingefügt werden. Der Tag muss nicht symmetrisch sein.
5127 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
5129 <para>Um die Limitierung der festen Breite zu reduzieren, können
5130 weitere Variablen in einem Block interpoliert werden. Whitespace wird
5131 dazwishen dann erhalten. Beispiel:</para>
5133 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
5135 <para>Die Variablen werden interpoliert, und linksbündig mit
5136 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
5137 lang, werden überzählige Zeichen abgeschnitten.</para>
5139 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
5140 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
5142 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
5144 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
5145 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
5149 <sect2 id="excel-templates.limitations">
5150 <title>Einschränkungen</title>
5152 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
5153 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
5154 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
5155 Text zu ersetzen.</para>
5157 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
5158 <command><%if%></command> und
5159 <command><%foreach%></command> nicht vorhanden. Der Delimiter
5160 <constant><% %></constant> kommt in den Headerinformationen
5161 evtl. vor. Deshalb wurde auf den sichereren Delimiter
5162 <constant><<</constant> und <constant>>></constant>
5166 <sect1 id="features.warehouse">
5167 <title>Mandantenkonfiguration Lager</title>
5168 Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt:
5169 Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die Möglichkeit hier über den
5170 Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. Ferner kann
5171 jede Position eines Lieferscheins ein-, bzw. ausgelagert werden (Einkauf-, bzw. Verkauf).
5172 Es können beliebig viele Lager mit beliebig vielen Lagerplätzen abgebildet werden.
5173 Die Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder Einzelposition und
5174 das Auswählen dieser Position zu einem Lager mit Lagerplatz.
5175 Dieses Verfahren lässt sich schrittweise vereinfachen, je nachdem wie die Einstellungen in
5176 der Mandatenkonfiguration gesetzt werden.
5179 <para><option>Auslagern über Standardlagerplatz</option> Hier wird ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz)
5180 in dem Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über den Standardlagerplatz (konfigurierbar pro Ware) durchführt.
5184 <para><option>Auslagern ohne Bestandsprüfung</option>Das obige Auslagern schlägt fehl, wenn die entsprechende Menge für
5185 die Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit dieser Option
5186 erlauben. Hierfür muss ein entsprechender Lagerplatz (Fehlbestand, o.ä.) konfiguriert sein.</para>
5189 Zusätzliche Funktionshinweise:
5191 <listitem><para><option>Standard-Lagerplatz</option>Ist dieser konfiguriert, wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
5192 Stammdaten-> Waren / Dienstleistung / Erzeugnis verwendet.
5195 <listitem><para><option>Standard-Lagerplatz verwenden, falls keiner in Stammdaten definiert</option>Wird beim 'Auslagern über Standardlagerplatz'
5196 keine Standardlagerplatz zu der Ware gefunden, so wird mit dieser Option einfach der Standardlagerplatz verwendet.
5204 <title>Entwicklerdokumentation</title>
5206 <sect1 id="devel.globals" xreflabel="Globale Variablen">
5207 <title>Globale Variablen</title>
5210 <title>Wie sehen globale Variablen in Perl aus?</title>
5212 <para>Globale Variablen liegen in einem speziellen namespace namens
5213 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
5214 globs global und die meisten speziellen Variablen sind...
5217 <para>Daraus ergeben sich folgende Formen:</para>
5221 <term><literal>$main::form</literal></term>
5224 <para>expliziter Namespace "main"</para>
5229 <term><literal>$::form</literal></term>
5232 <para>impliziter Namespace "main"</para>
5237 <term><literal>open FILE, "file.txt"</literal></term>
5240 <para><varname>FILE</varname> ist global</para>
5245 <term><literal>$_</literal></term>
5248 <para>speziell</para>
5253 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
5254 Schlüsselwort wie "<function>global</function>", mit dem man
5255 importieren kann. <function>my</function>, <function>our</function>
5256 und <function>local</function> machen was anderes.</para>
5260 <term><literal>my $form</literal></term>
5263 <para>lexikalische Variable, gültig bis zum Ende des
5269 <term><literal>our $form</literal></term>
5272 <para><varname>$form</varname> referenziert ab hier
5273 <varname>$PACKAGE::form</varname>.</para>
5278 <term><literal>local $form</literal></term>
5281 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
5282 des scopes zurückgesetzt</para>
5289 <title>Warum sind globale Variablen ein Problem?</title>
5291 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
5293 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
5294 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
5295 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
5296 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
5297 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
5298 Datenbankverbindungen, weil die sehr lange zum Initialisieren
5301 <para>Das zweite Problem ist <function>strict</function>. Unter
5302 <function>strict</function> werden alle Variablen die nicht explizit
5303 mit <function>Package</function>, <function>my</function> oder
5304 <function>our</function> angegeben werden als Tippfehler angemarkert,
5305 dies hat, seit der Einführung, u.a. schon so manche langwierige
5306 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
5307 angegeben werden, werden die nicht geprüft, und somit kann sich
5308 schnell ein Tippfehler einschleichen.</para>
5312 <title>Kanonische globale Variablen</title>
5314 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
5315 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
5316 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
5317 umhergereicht werden.</para>
5319 <para>Diese Variablen sind im Moment die folgenden neun:</para>
5323 <para><varname>$::form</varname></para>
5327 <para><varname>%::myconfig</varname></para>
5331 <para><varname>$::locale</varname></para>
5335 <para><varname>$::lxdebug</varname></para>
5339 <para><varname>$::auth</varname></para>
5343 <para><varname>$::lx_office_conf</varname></para>
5347 <para><varname>$::instance_conf</varname></para>
5351 <para><varname>$::dispatcher</varname></para>
5355 <para><varname>$::request</varname></para>
5359 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
5360 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
5361 Eigenschaften (Konventionen):</para>
5364 <title>$::form</title>
5368 <para>Ist ein Objekt der Klasse
5369 "<classname>Form</classname>"</para>
5373 <para>Wird nach jedem Request gelöscht</para>
5377 <para>Muss auch in Tests und Konsolenscripts vorhanden
5382 <para>Enthält am Anfang eines Requests die Requestparameter vom
5387 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
5388 cachen, das wird aber momentan absichtlich zerstört</para>
5392 <para><varname>$::form</varname> wurde unter <productname>SQL
5393 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
5394 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
5395 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
5396 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
5397 <function>IS->retrieve_customer()</function> in Sicherheit
5400 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
5401 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
5402 3552, Stand version 2.7beta), um dies hinterher wieder auf den
5403 richtigen Wert zu setzen:</para>
5405 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
5406 $::myconfig{numberformat} = $numberformat;
5407 # (...) div Berechnungen
5408 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
5410 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
5411 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
5412 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
5413 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
5414 Es geht ziemlich sicher etwas kaputt.</para>
5416 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
5417 in den <productname>Template::Toolkit</productname> Templates
5418 außerhalb der Controller: der Ausdruck <function>[% var
5419 %]</function> greift auf <varname>$::form->{var}</varname> zu.
5420 Unter Controllern ist der Standard Scope anders, da lautet der
5421 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
5422 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
5423 <function><%var%></function> zeigt auf
5424 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
5425 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
5428 <programlisting>[%- IF business %]
5429 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
5430 [%- END %]</programlisting>
5432 <para>Entweder wird hier dann $::form->{business} ausgewertet
5433 oder aber der Funktion
5434 <function>$form->parse_html_template</function> wird explizit
5435 noch ein zusätzlicher Hash übergeben, der dann auch in den
5436 (Web-)Templates zu Verfügung steht, bspw. so:</para>
5438 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
5440 <para>Innerhalb von Schleifen wird
5441 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
5442 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
5443 welches über alle Positionen eines Lieferscheins in Schleife
5446 <programlisting>for $i (1 .. $form->{rowcount}) {
5448 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
5449 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
5450 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
5456 <title>%::myconfig</title>
5460 <para>Das einzige Hash unter den globalen Variablen</para>
5464 <para>Wird spätestens benötigt wenn auf die Datenbank
5465 zugegriffen wird</para>
5469 <para>Wird bei jedem Request neu erstellt.</para>
5473 <para>Enthält die Userdaten des aktuellen Logins</para>
5477 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
5478 extern serialisiert werden, weil da auch der Datenbankzugriff
5479 für diesen user drinsteht.</para>
5483 <para>Enthält unter anderem Listenbegrenzung vclimit,
5484 Datumsformat dateformat und Nummernformat numberformat</para>
5488 <para>Enthält Datenbankzugriffinformationen</para>
5492 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
5493 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
5494 aktuellen Users entscheiden müssen, befragen
5495 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
5496 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
5497 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
5498 Informationen über den Benutzer die über die
5499 Administrator-Schnittstelle eingegeben wurden.</para>
5503 <title>$::locale</title>
5507 <para>Objekt der Klasse "Locale"</para>
5511 <para>Wird pro Request erstellt</para>
5515 <para>Muss auch für Tests und Scripte immer verfügbar
5520 <para>Cached intern über Requestgrenzen hinweg benutzte
5525 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
5526 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
5530 <title>$::lxdebug</title>
5534 <para>Objekt der Klasse "LXDebug"</para>
5538 <para>Wird global gecached</para>
5542 <para>Muss immer verfügbar sein, in nahezu allen
5547 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
5548 bereit, wie "<function>enter_sub</function>" und
5549 "<function>leave_sub</function>", mit denen in den alten Modulen ein
5550 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
5551 der man die Wallclockzeit seit Requeststart loggen kann, sowie
5552 "<function>message</function>" und "<function>dump</function>" mit
5553 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
5556 <para>Beispielsweise so:</para>
5558 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
5559 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
5563 <title>$::auth</title>
5567 <para>Objekt der Klasse "SL::Auth"</para>
5571 <para>Wird global gecached</para>
5575 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
5579 <para>Wird nach jedem Request resettet.</para>
5583 <para><varname>$::auth</varname> stellt Funktionen bereit um die
5584 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
5585 vom aktuellen User abhängen wird das Objekt aus
5586 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
5587 Request kurz resettet.</para>
5589 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten. Dessen Einstellungen können über
5590 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert ist ein Hash mit den Werten aus der Tabelle
5591 <literal>auth.clients</literal>.</para>
5595 <title>$::lx_office_conf</title>
5599 <para>Objekt der Klasse
5600 "<classname>SL::LxOfficeConf</classname>"</para>
5604 <para>Global gecached</para>
5608 <para>Repräsentation der
5609 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
5613 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
5614 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
5615 das Programm die Konfiguration ändern kann oder sollte.</para>
5617 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
5618 Debug- und Trace-Log-Datei wie folgt konfiguriert und
5621 <programlisting>[debug]
5622 file_name = /tmp/kivitendo-debug.log</programlisting>
5624 <para>ist der Key <varname>file</varname> im Programm als
5625 <varname>$::lx_office_conf->{debug}{file}</varname>
5629 <para>Zugriff auf die Konfiguration erfolgt im Moment über
5630 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
5635 <title>$::instance_conf</title>
5639 <para>Objekt der Klasse
5640 "<classname>SL::InstanceConfiguration</classname>"</para>
5644 <para>wird pro Request neu erstellt</para>
5648 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
5649 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
5650 ist hier eine Mandantendatenbank. Beispielsweise überprüft
5651 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
5652 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
5656 <title>$::dispatcher</title>
5660 <para>Objekt der Klasse
5661 "<varname>SL::Dispatcher</varname>"</para>
5665 <para>wird pro Serverprozess erstellt.</para>
5669 <para>enthält Informationen über die technische Verbindung zum
5674 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
5675 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
5676 Objekt untergebracht.</para>
5680 <title>$::request</title>
5684 <para>Hashref (evtl später Objekt)</para>
5688 <para>Wird pro Request neu initialisiert.</para>
5692 <para>Keine Unterstruktur garantiert.</para>
5696 <para><varname>$::request</varname> ist ein generischer Platz um
5697 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
5698 at a distance benutzt werden, sondern um lokales memoizing zu
5699 ermöglichen, das garantiert am Ende des Requests zerstört
5702 <para>Vieles von dem, was im moment in <varname>$::form</varname>
5703 liegt, sollte eigentlich hier liegen. Die groben
5704 Differentialkriterien sind:</para>
5708 <para>Kommt es vom User, und soll unverändert wieder an den
5709 User? Dann <varname>$::form</varname>, steht da eh schon</para>
5713 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
5714 Requests gebraucht werden? Dann
5715 <varname>$::request</varname></para>
5719 <para>Muss ich von anderen Teilen des Programms lesend drauf
5720 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
5721 Wrappermethode</para>
5728 <title>Ehemalige globale Variablen</title>
5730 <para>Die folgenden Variablen waren einmal im Programm, und wurden
5734 <title>$::cgi</title>
5738 <para>war nötig, weil cookie Methoden nicht als
5739 Klassenfunktionen funktionieren</para>
5743 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
5744 Klassennamespace gehalten wird und über Requestgrenzen
5749 <para>liegt jetzt unter
5750 <varname>$::request->{cgi}</varname></para>
5756 <title>$::all_units</title>
5760 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
5761 ein paar hundert mal pro Request eine Liste der Einheiten
5762 brauchen, und de als Parameter durch einen Riesenstack von
5763 Funktionen geschleift werden müssten.</para>
5767 <para>Liegt jetzt unter
5768 <varname>$::request->{cache}{all_units}</varname></para>
5773 <function>AM->retrieve_all_units()</function> gesetzt oder
5780 <title>%::called_subs</title>
5784 <para>wurde benutzt um callsub deep recursions
5789 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
5790 möglichen Rekursioenen darstellt, und da nie welche
5795 <para>komplette recursion protection wurde entfernt.</para>
5802 <sect1 id="devel.fcgi">
5803 <title>Entwicklung unter FastCGI</title>
5805 <sect2 id="devel.fcgi.general">
5806 <title>Allgemeines</title>
5808 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
5809 werden, muss der Webserver neu gestartet werden.</para>
5811 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
5812 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
5813 müssen folgende Aspekte beachtet werden.</para>
5816 <sect2 id="devel.fcgi.exiting">
5817 <title>Programmende und Ausnahmen</title>
5819 <para>Betrifft die Funktionen <function>warn</function>,
5820 <function>die</function>, <function>exit</function>,
5821 <function>carp</function> und <function>confess</function>.</para>
5823 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
5824 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
5825 am Laufen zu halten. Man kann mit <function>die</function>,
5826 <function>confess</function> oder <function>carp</function> Fehler
5827 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
5828 eigene <function>$::form-</function>error()> tut im Prinzip das
5829 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
5830 <function>exit</function> hingegen werden nicht abgefangen.
5831 <function>warn</function> wird direkt nach STDERR, also in Server Log
5832 eine Nachricht schreiben (sofern in der Konfiguration nicht die
5833 Warnungen in das kivitendo Log umgeleitet wurden), und
5834 <function>exit</function> wird die Ausführung beenden.</para>
5836 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
5837 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
5838 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
5839 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
5842 <sect2 id="devel.fcgi.globals">
5843 <title>Globale Variablen</title>
5845 <para>Um zu vermeiden, dass Informationen von einem Request in einen
5846 anderen gelangen, müssen alle globalen Variablen vor einem Request
5847 sauber initialisiert werden. Das ist besonders wichtig im
5848 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
5849 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
5852 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
5853 abgetrennten Block, der alle kanonischen globalen Variablen listet und
5854 erklärt. Bitte keine anderen einführen ohne das sauber zu
5855 dokumentieren.</para>
5857 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
5858 man sicher geht, dass man die richtige erwischt.</para>
5861 <sect2 id="devel.fcgi.performance">
5862 <title>Performance und Statistiken</title>
5864 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
5865 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
5866 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
5867 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
5868 sind es je nach Menge der definierten Variablen 1-2s. Ab der
5869 Moose/Rose::DB Version sind es 5-6s.</para>
5871 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
5872 den kritischen Pfaden, unter 0,15 sonst.</para>
5876 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
5877 <title>SQL-Upgradedateien</title>
5879 <sect2 id="db-upgrade-files.introduction"
5880 xreflabel="Einführung in die Datenbank-Upgradedateien">
5881 <title>Einführung</title>
5883 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte gesteuert, die sich im Verzeichnis <filename>sql/Pg-upgrade2</filename>
5884 befinden. In diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren, die neben den eigentlich auszuführenden SQL- oder
5885 Perl-Befehlen einige Kontrollinformationen enthält.</para>
5887 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten, sodass Datenbankscripte zwar in einer sicheren Reihenfolge
5888 ausgeführt werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt werden, wenn die Tabelle mit <literal>CREATE
5889 TABLE</literal> angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man keine Versionsnummern braucht.</para>
5891 <para>kivitendo merkt sich dabei, welches der Upgradescripte in <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
5892 führt diese nicht erneut aus. Dazu dient die Tabelle "<literal>schema_info</literal>", die bei der Anmeldung automatisch angelegt
5896 <sect2 id="db-upgrade-files.format"
5897 xreflabel="Format der Upgradedateien">
5898 <title>Format der Kontrollinformationen</title>
5900 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5901 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5902 hat dabei das folgende Format:</para>
5904 <para>Für SQL-Upgradedateien:</para>
5906 <programlisting>-- @key: value</programlisting>
5908 <para>Für Perl-Upgradedateien:</para>
5910 <programlisting># @key: value</programlisting>
5912 <para>Leerzeichen vor "<varname>value</varname>" werden
5915 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5919 <term><varname>tag</varname></term>
5922 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5923 Dieser "tag" kann von anderen Kontrolldateien in ihren
5924 Abhängigkeiten verwendet werden (Schlüsselwort
5925 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5926 in der Datenbank eingetragen wird.</para>
5928 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5929 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5931 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5932 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5933 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5939 <term><varname>charset</varname></term>
5942 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5943 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
5944 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte hingegen müssen immer in UTF-8 encodiert sein und sollten
5945 demnach auch ein "<literal>use utf8;</literal>" enthalten.</para>
5950 <term><varname>description</varname></term>
5953 <para>Benötigt. Eine Beschreibung, was in diesem Update
5954 passiert. Diese wird dem Benutzer beim eigentlichen
5955 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
5956 sein sollte, sollte die Beschreibung auf Deutsch
5962 <term><varname>depends</varname></term>
5965 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5966 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
5967 dass die in dieser Liste aufgeführten Scripte bereits
5968 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5970 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5971 Script "b" existiert, das von Änderungen in "a" abhängt, und
5972 eine neue Kontrolldatei für "c" erstellt wird, die von
5973 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5974 Tag "b" als Abhängigkeit zu definieren.</para>
5976 <para>Es ist nicht erlaubt, sich selbst referenzierende
5977 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5978 und "c" -> "a").</para>
5983 <term><varname>priority</varname></term>
5986 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
5987 der Scripte ausgeführt werden, die die gleichen
5988 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
5989 der Wert 1000 benutzt.</para>
5991 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
5992 "depends" benutzt werden. kivitendo sortiert die auszuführenden
5993 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
5994 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
5995 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
5996 dann "y", dann "z"), dann nach der Priorität und bei gleicher
5997 Priorität alphabetisch nach dem "tag".</para>
6002 <term><varname>ignore</varname></term>
6005 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
6006 Skript bei der Anmeldung ignoriert und entsprechend nicht
6013 <sect2 id="db-upgrade-files.format-perl-files" xreflabel="Format von Perl-Upgradedateien">
6014 <title>Format von in Perl geschriebenen Datenbankupgradescripten</title>
6016 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so ausgeführt sondern müssen sich an gewisse Konventionen
6017 halten. Dafür bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
6019 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse dar, die vom Elternobjekt
6020 "<literal>SL::DBUpgrade2::Base</literal>" erben und eine Funktion namens "<literal>run</literal>" zur Verfügung stellen muss. Das
6021 Script wird ausgeführt, indem eine Instanz dieser Klasse erzeugt und darauf die erwähnte "<literal>run</literal>" aufgerufen
6024 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert für "<literal>@tag</literal>" ableitet. Dabei werden alle
6025 Zeichen, die in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche ersetzt. Insgesamt sieht der Paketname wie folgt
6026 aus: "<literal>SL::DBUpgrade2::tag</literal>".</para>
6028 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
6029 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
6031 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie folgt aus:</para>
6033 <programlisting># @tag: beispiel-upgrade-file42
6034 # @description: Ein schönes Beispielscript
6035 # @depends: release_3_1_0
6036 package SL::DBUpgrade2::beispiel_upgrade_file42;
6041 use parent qw(SL::DBUpgrade2::Base);
6046 # hier Aktionen ausführen
6055 <sect2 id="db-upgrade-files.dbupgrade-tool"
6056 xreflabel="Hilfsscript dbupgrade2_tool.pl">
6057 <title>Hilfsscript dbupgrade2_tool.pl</title>
6059 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
6060 existiert ein Hilfsscript namens
6061 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
6062 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
6063 liest alle Datenbankupgradescripte aus dem Verzeichnis
6064 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
6065 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
6066 von der Kommandozeile überprüft werden können.</para>
6068 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
6069 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
6070 sich aber auch Informationen auf verschiedene Art ausgeben
6075 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
6076 --list</command>"</para>
6078 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
6079 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
6080 würde. Es werden neben der Listenposition der Tag, die
6081 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
6085 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
6086 --tree</command>"</para>
6088 <para>Listet alle Tags in Baumform basierend auf den
6089 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
6090 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
6091 beim übergeordneten Script als Abhängigkeit eingetragen
6095 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
6096 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
6097 --rtree</command>"</para>
6099 <para>Listet alle Tags in Baumform basierend auf den
6100 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
6101 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
6102 die das übergeordnete Script als Abhängigkeit eingetragen
6107 <para>Baumform mit Postscriptausgabe:
6108 "<command>./scripts/dbupgrade2_tool.pl
6109 --graphviz</command>"</para>
6111 <para>Benötigt das Tool "<command>graphviz</command>", um mit
6112 seiner Hilfe die <link
6113 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
6114 Baumform</link> in eine Postscriptdatei namens
6115 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
6116 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
6117 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
6118 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
6123 <para>Scripte, von denen kein anderes Script abhängt:
6124 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
6126 <para>Listet die Tags aller Scripte auf, von denen keine anderen
6127 Scripte abhängen.</para>
6133 <sect1 id="translations-languages" xreflabel="Translations and languages">
6134 <title>Translations and languages</title>
6136 <sect2 id="translations-languages.introduction"
6137 xreflabel="Introduction to translations and languages">
6138 <title>Introduction</title>
6141 <para>Dieser Abschnitt ist in Englisch geschrieben, um
6142 internationalen Übersetzern die Arbeit zu erleichtern.</para>
6145 <para>This section describes how localization packages in kivitendo
6146 are built. Currently the only language fully supported is German, and
6147 since most of the internal messages are held in English the English
6148 version is usable too.</para>
6150 <para>A stub version of French is included but not functunal at this
6154 <sect2 id="translations-languages.character-set"
6155 xreflabel="Character set">
6156 <title>Character set</title>
6158 <para>All files included in a language pack must use UTF-8 as their encoding.</para>
6161 <sect2 id="translations-languages.file-structure"
6162 xreflabel="File structure">
6163 <title>File structure</title>
6165 <para>The structure of locales in kivitendo is:</para>
6167 <programlisting>kivitendo/locale/<langcode>/</programlisting>
6169 <para>where <langcode> stands for an abbreviation of the
6170 language package. The builtin packages use two letter <ulink
6171 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
6172 but the actual name is not relevant for the program and can easily be
6174 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
6175 tags</ulink> (i.e. "en_GB"). In fact the original language packages
6176 from SQL Ledger are named in this way.</para>
6178 <para>In such a language directory the following files are
6183 <term>LANGUAGE</term>
6186 <para>This file is mandatory.</para>
6188 <para>The <filename>LANGUAGE</filename> file contains the self
6189 descripted name of the language. It should contain a native
6190 representation first, and in parenthesis an english translation
6191 after that. Example:</para>
6193 <programlisting>Deutsch (German)</programlisting>
6201 <para>This file is mandatory.</para>
6203 <para>The central translation file. It is essentially an inline
6204 Perl script autogenerated by <command>locales.pl</command>. To
6205 generate it, generate the directory and the two files mentioned
6206 above, and execute the following command:</para>
6208 <programlisting>scripts/locales.pl <langcode></programlisting>
6210 <para>Otherwise you can simply copy one of the other languages.
6211 You will be told how many are missing like this:</para>
6213 <programlisting>$ scripts/locales.pl en
6214 English - 0.6% - 2015/2028 missing</programlisting>
6216 <para>A file named "<filename>missing</filename>" will be
6217 generated and can be edited. You can also edit the
6218 "<filename>all</filename>" file directly. Edit everything you
6219 like to fit the target language and execute
6220 <command>locales.pl</command> again. See how the missing words
6226 <term>Num2text</term>
6229 <para>Legacy code from SQL Ledger. It provides a means for
6230 numbers to be converted into natural language, like
6231 <literal>1523 => one thousand five hundred twenty
6232 three</literal>. If you want to provide it, it must be inlinable
6233 Perl code which provides a <function>num2text</function> sub. If
6234 an <function>init</function> sub exists it will be executed
6237 <para>Only used in the check and receipt printing module.</para>
6242 <term>special_chars</term>
6245 <para>kivitendo comes with a lot of interfaces to different
6246 formats, some of which are rather picky with their accepted
6247 charset. The <filename>special_chars</filename> file contains a
6248 listing of chars not suited for different file format and
6249 provides substitutions. It is written in "Simple Ini" style,
6250 containing a block for every file format.</para>
6252 <para>First entry should be the order of substitution for
6253 entries as a whitespace separated list. All entries are
6254 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
6255 and <literal>\\</literal> all work.</para>
6257 <para>After that every entry is a special char that should be
6258 translated when writing text into such a file.</para>
6260 <para>Example:</para>
6262 <programlisting>[Template/XML]
6263 order=& < > \n
6267 \n=<br></programlisting>
6269 <para>Note the importance of the order in this example.
6270 Substituting < and > befor & would lead to $gt; become
6273 <para>For a list of valid formats, see the German
6274 <filename>special_chars</filename> entry. As of this writing the
6275 following are recognized:</para>
6277 <programlisting>HTML
6282 Template/OpenDocument
6283 filenames</programlisting>
6285 <para>The last of which is very machine dependant. Remember that
6286 a lot of characters are forbidden by some filesystems, for
6287 exmaple MS Windows doesn't like ':' in its files where Linux
6288 doesn't mind that. If you want the files created with your
6289 language pack to be portable, find all chars that could cause
6295 <term>missing</term>
6298 <para>This file is not a part of the language package
6301 <para>This is a file generated by
6302 <command>scripts/locales.pl</command> while processing your
6303 locales. It's only to have the missing entries singled out and
6304 does not belong to a language package.</para>
6312 <para>This file is not a part of the language package
6315 <para>Another file generated by
6316 <command>scripts/locales.pl</command>. If for any reason a
6317 translation does not appear anymore and can be deleted, it gets
6318 moved here. The last 50 or so entries deleted are saved here in
6319 case you made a typo, so that you don't have to translate
6320 everything again. If a tranlsation is missing, the lost file is
6321 checked first. If you maintain a language package, you might
6322 want to keep this safe somewhere.</para>
6329 <sect1 id="devel.testsuite">
6330 <title>Die kivitendo-Test-Suite</title>
6332 <sect2 id="devel.testsuite.intro">
6333 <title>Einführung</title>
6335 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul <literal>Test::More</literal>.</para>
6337 <para>Die grundlegenden Fakten sind:</para>
6340 <listitem><para>Alle Tests liegen im Unterverzeichnis <filename>t/</filename>.</para></listitem>
6342 <listitem><para>Ein Script (bzw. ein Test) in <filename>t/</filename> enthält einen oder mehrere Testfälle.</para></listitem>
6344 <listitem><para>Alle Dateinamen von Tests enden auf <literal>.t</literal>. Es sind selbstständig ausführbare Perl-Scripte.</para></listitem>
6346 <listitem><para>Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in <filename>t/</filename>, deren
6347 Dateiname auf <literal>.t</literal> endet.</para></listitem>
6351 <sect2 id="devel.testsuite.prerequisites">
6352 <title>Voraussetzungen</title>
6354 <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>
6357 <listitem><para><literal>Test::Deep</literal> (Debian-Paketname: <literal>libtest-deep-perl</literal>; Fedora Core:
6358 <literal>perl-Test-Deep</literal>; openSUSE: <literal>perl-Test-Deep</literal>)</para></listitem>
6359 <listitem><para><literal>Test::Exception</literal> (Debian-Paketname: <literal>libtest-exception-perl</literal>; Fedora Core:
6360 <literal>perl-Test-Exception</literal>; openSUSE: <literal>perl-Test-Exception</literal>)</para></listitem>
6361 <listitem><para><literal>Test::Output</literal> (Debian-Paketname: <literal>libtest-output-perl</literal>; Fedora Core:
6362 <literal>perl-Test-Output</literal>; openSUSE: <literal>perl-Test-Output</literal>)</para></listitem>
6363 <listitem><para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses Modul ist ab Perl 5.10.1 Bestandteil der
6364 Perl-Distribution und kann für frühere Versionen aus dem <ulink url="http://www.cpan.org">CPAN</ulink> bezogen
6365 werden.</para></listitem>
6366 <listitem><para><literal>LWP::Simple</literal> aus dem Paket <literal>libwww-perl</literal> (Debian-Panetname:
6367 <literal>libwww-perl</literal>; Fedora Core: <literal>perl-libwww-perl</literal>; openSUSE:
6368 <literal>perl-libwww-perl</literal>)</para></listitem>
6369 <listitem><para><literal>URI::Find</literal> (Debian-Panetname: <literal>liburi-find-perl</literal>; Fedora Core:
6370 <literal>perl-URI-Find</literal>; openSUSE: <literal>perl-URI-Find</literal>)</para></listitem>
6373 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
6374 müssen in der Konfigurationsdatei im Abschnit <literal>testing/database</literal> Datenbankverbindungsparameter angegeben
6375 werden. Der hier angegebene Benutzer muss weiterhin das Recht haben, Datenbanken anzulegen und zu löschen.</para>
6378 <sect2 id="devel.testsuite.execution">
6380 Existierende Tests ausführen
6383 <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
6384 gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript <filename>t/test.pl</filename>.</para>
6386 <para>Will man die komplette Test-Suite ausführen, so muss man einfach nur <filename>t/test.pl</filename> ohne weitere Parameter aus
6387 dem kivitendo-Basisverzeichnis heraus ausführen.</para>
6389 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an <filename>t/test.pl</filename>. Beispielsweise:</para>
6391 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
6395 <sect2 id="devel.testsuite.meaning_of_scripts">
6397 Bedeutung der verschiedenen Test-Scripte
6400 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch
6401 während der Entwicklung nützliche Tests sind:</para>
6404 <listitem><para><filename>t/001compile.t</filename> -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab</para></listitem>
6405 <listitem><para><filename>t/002goodperl.t</filename> -- überprüft alle Perl-Dateien auf Anwesenheit von '<literal>use strict</literal>'-Anweisungen</para></listitem>
6406 <listitem><para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von <function>system()</function> und <function>exec()</function> auf Gültigkeit</para></listitem>
6407 <listitem><para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien Tab-Zeichen enthalten</para></listitem>
6408 <listitem><para><filename>t/006spelling.t</filename> -- sucht nach häufigen Rechtschreibfehlern</para></listitem>
6409 <listitem><para><filename>t/011pod.t</filename> -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit</para></listitem>
6412 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module.</para>
6415 <sect2 id="devel.testsuite.create_new">
6417 Neue Test-Scripte erstellen
6420 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende
6421 Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden.</para>
6423 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
6425 Ideen für neue Test-Scripte, die keine konkreten Funktionen testen
6428 <para> Ideen, die abgesehen von Funktionen noch nicht umgesetzt wurden:</para>
6431 <listitem><para>Überprüfung auf fehlende symbolische Links</para></listitem>
6432 <listitem><para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten)</para></listitem>
6433 <listitem><para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para></listitem>
6434 <listitem><para>Überprüfung auf Leerzeichen am Ende von Zeilen</para></listitem>
6435 <listitem><para>Test, ob alle zu übersetzenden Strings in <filename>locale/de/all</filename> vorhanden sind</para></listitem>
6436 <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>
6440 <sect3 id="devel.testsuite.directory_and_test_names">
6442 Konvention für Verzeichnis- und Dateinamen
6445 <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>
6448 <listitem><para>Die Dateiendung muss <filename>.t</filename> lauten.</para></listitem>
6450 <listitem><para>Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise
6451 <filename>bad_function_params.t</filename>).</para></listitem>
6453 <listitem><para>Unterverzeichnisse sollten grob nach dem Themenbereich benannt sein, mit dem sich die Scripte darin befassen
6454 (beispielsweise <filename>background_jobs</filename> für Tests rund um Hintergrund-Jobs).</para></listitem>
6456 <listitem><para>Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist
6457 (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben.</para></listitem>
6461 <sect3 id="devel.testsuite.minimal_example">
6463 Minimales Skelett für eigene Scripte
6466 <para>Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden:</para>
6468 <programlisting>use Test::More tests => 0;
6472 use Support::TestSetup;
6474 Support::TestSetup::login();</programlisting>
6476 <para>Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie
6477 <varname>$::auth</varname>, <varname>$::form</varname> oder <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
6478 <filename>config/kivitendo.conf</filename> im Abschnitt <literal>testing.login</literal> ein gültiger Login-Name eingetragen
6479 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
6481 <para>Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile <code>Support::TestSetup::login();</code>
6482 weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.</para>
6487 <sect1 id="devel.style-guide">
6488 <title>Stil-Richtlinien</title>
6490 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
6491 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
6492 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
6493 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
6495 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
6498 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
6499 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
6504 <para>Es werden keine echten Tabs sondern Leerzeichen
6509 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
6511 <programlisting>foreach my $row (@data) {
6513 # do something with $row
6517 $row->{modules} = MODULE->retrieve(
6518 id => $row->{id},
6519 date => $use_now ? localtime() : $row->{time},
6523 $report->add($row);
6528 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
6529 Zeile wie der letzte Befehl. Beispiele:</para>
6531 <programlisting>sub debug {
6537 <programlisting>if ($form->{item_rows} > 0) {
6543 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
6544 der Befehl / die öffnende schließende Klammer, die den Block
6545 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
6546 Beispiele wie bei 3. gelten.</para>
6550 <para>Die Wörter "<function>else</function>",
6551 "<function>elsif</function>", "<function>while</function>" befinden
6552 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
6555 <programlisting>if ($form->{sum} > 1000) {
6557 } elsif ($form->{sum} > 0) {
6565 } until ($a > 0);</programlisting>
6569 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
6570 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
6571 und grep-ähnliche Operatoren. Beispiel:</para>
6573 <programlisting>$main::lxdebug->message("Could not find file.");
6574 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
6578 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
6580 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
6581 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
6582 Blöcke schon. Beispiel:</para>
6584 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
6589 $form->{sum} += $form->{"row_$i"};
6590 $form->{ $form->{index} } += 1;
6592 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
6596 <para>Mehrzeilige Befehle</para>
6600 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
6601 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
6602 werden, in der die ersten Funktionsparameter in der ersten Zeile
6603 stehen. Beispiel:</para>
6605 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
6606 $form->{some_col_value});</programlisting>
6610 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
6611 besten in einer übersichtlichen Tabellenstruktur organisiert
6612 wird. Beispiel:</para>
6614 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
6615 : $form->{oldcount} ? $form->{oldcount} + 1
6616 : $form->{rowcount} - $form->{rowbase};</programlisting>
6622 <para>Kommentare</para>
6626 <para>Kommentare, die alleine in einer Zeile stehen, sollten
6627 soweit wie der Code eingerückt sein.</para>
6631 <para>Seitliche hängende Kommentare sollten einheitlich
6632 formatiert werden.</para>
6636 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
6637 auf Englisch zu verfassen. So wie ich keine Lust habe,
6638 französischen Quelltext zu lesen, sollte auch der kivitendo
6639 Quelltext für nicht-Deutschsprachige lesbar sein.
6642 <programlisting>my $found = 0;
6650 $i = 0 # initialize $i
6652 $i *= $const; # do something crazy
6653 $i = $n; # recover $i</programlisting>
6659 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
6660 Interpolation gewünscht ist. Beispiel:</para>
6662 <programlisting>$form->{sum} = 0;
6663 $form->{"row_$i"} = $form->{"row_$i"} - 5;
6664 $some_hash{42} = 54;</programlisting>
6668 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
6669 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
6670 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
6671 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
6673 <para>Als Beispiel sei die Funktion
6674 <function>print_options</function> aus
6675 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
6679 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
6680 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
6683 <para>Emacs und vim haben beide recht einfache Methoden zur
6684 Entfernung von trailing whitespace. Emacs kennt das Kommande
6685 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
6686 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
6687 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
6692 <para>Es wird kein <command>perltidy</command> verwendet.</para>
6694 <para>In der Vergangenheit wurde versucht,
6695 <command>perltidy</command> zu verwenden, um einen einheitlichen
6696 Stil zu erlangen. Es hat sich aber gezeigt, dass
6697 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
6698 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
6699 den Interessierten sind hier die
6700 <command>perltidy</command>-Optionen, die grob den beschriebenen
6701 Richtlinien entsprechen:</para>
6703 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
6704 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
6705 -lp -vt=1 -vtc=1</programlisting>
6709 <para><varname>STDERR</varname> ist tabu. Unkonditionale
6710 Debugmeldungen auch.</para>
6712 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
6713 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
6714 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
6716 <para>Die <classname>LXDebug</classname>-Methode
6717 "<function>message</function>" nimmt als ersten Paramter außerdem
6718 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
6719 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
6720 und werden in den meisten Fällen auch vom Repository
6721 zurückgewiesen.</para>
6725 <para>Alle neuen Module müssen use strict verwenden.</para>
6727 <para><varname>$form</varname>, <varname>$auth</varname>,
6728 <varname>$locale</varname>, <varname>$lxdebug</varname> und
6729 <varname>%myconfig</varname> werden derzeit aus dem main package
6730 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
6731 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
6736 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
6737 <title>Dokumentation erstellen</title>
6739 <sect2 id="devel.build-doc.introduction">
6740 <title>Einführung</title>
6742 <para>Diese Dokumentation ist in <productname>DocBook</productname>
6743 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
6744 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
6745 Editor nutzt, der spezielle Unterstützung für
6746 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
6747 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
6748 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
6752 <sect2 id="devel.build-doc.required-software">
6753 <title>Benötigte Software</title>
6755 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
6756 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
6757 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
6758 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
6759 <command>scripts/build_doc.sh</command>.</para>
6761 <para>Das Script benötigt zur Konvertierung verschiedene
6762 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
6768 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
6769 in einer halbwegs aktuellen Version</para>
6773 <para>Das Java-Build-System <ulink
6774 url="http://ant.apache.org/">Apache Ant</ulink></para>
6778 <para>Das Dokumentations-System Dobudish für
6779 <productname>DocBook</productname> 4.5, eine Zusammenstellung
6780 diverser Stylesheets und Grafiken zur Konvertierung von
6781 <productname>DocBook</productname> XML in andere Formate. Das
6782 Paket, das benötigt wird, ist zum Zeitpunkt der
6783 Dokumentationserstellung
6784 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
6785 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
6790 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
6791 sind auf allen gängigen Plattformen verfügbar. Beispiel für
6792 Debian/Ubuntu:</para>
6794 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
6796 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
6797 <filename>doc/build</filename> entpackt werden. Beispiel unter der
6798 Annahme, das <productname>Dobudish</productname> in
6799 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
6801 <programlisting>cd doc/build
6802 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
6805 <sect2 id="devel.build-doc.build">
6806 <title>PDFs und HTML-Seiten erstellen</title>
6808 <para>Die eigentliche Konvertierung erfolgt nach Installation der
6809 benötigten Software mit einem einfachen Aufruf direkt aus dem
6810 kivitendo-Installationsverzeichnis heraus:</para>
6812 <programlisting>./scripts/build_doc.sh</programlisting>
6815 <sect2 id="devel.build-doc.repository">
6816 <title>Einchecken in das Git-Repository</title>
6818 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
6819 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
6820 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
6821 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
6823 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
6824 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob