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 Community-Forum: <ulink
15 url="https://forum.kivitendo.org:32443">https://forum.kivitendo.org:32443</ulink></para>
18 <para>im Kunden-Forum: <ulink
19 url="http://redmine.kivitendo-premium.de/projects/forum/boards/">http://redmine.kivitendo-premium.de/projects/forum/boards/</ulink></para>
22 <para>in der doc/UPGRADE Datei im doc-Verzeichnis der Installation</para>
25 <para>Im Schulungs- und Dienstleistungsangebot der entsprechenden kivitendo-Partner: <ulink
26 url="http://www.kivitendo.de/partner.html">http://www.kivitendo.de/partner.html</ulink></para>
32 <title>Installation und Grundkonfiguration</title>
34 <sect1 id="Installation-Übersicht">
35 <title>Übersicht</title>
38 Die Installation von kivitendo umfasst mehrere Schritte. Die folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
39 Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit minimalen Features möglichst schnell zum Laufen zu kriegen.
43 <listitem><para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo benötigt gewisse Ressourcen und benutzt weitere
44 Programme. Das Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert diese. Auch die Liste der benötigten Perl-Module
45 befindet sich hier.</para></listitem>
47 <listitem><para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst die "<xref
48 linkend="Manuelle-Installation-des-Programmpaketes"/>" sowie grundlegende Einstellungen, die der "<xref
49 linkend="config.config-file"/>" erläutert.</para></listitem>
51 <listitem><para><emphasis>Konfiguration externer Programme</emphasis>: hierzu gehören die Datenbank ("<xref
52 linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der Webserver ("<xref
53 linkend="Apache-Konfiguration"/>"). </para></listitem>
55 <listitem><para><emphasis>Benutzerinformationen speichern können</emphasis>: man benötigt mindestens eine Datenbank, in der
56 Informationen zur Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man das als Administrator macht, verrät "<xref
57 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para></listitem>
59 <listitem><para><emphasis>Benutzer, Gruppen und Datenbanken anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
60 linkend="Benutzer--und-Gruppenverwaltung"/>".</para></listitem>
62 <listitem><para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann kann es losgehen: "<xref
63 linkend="kivitendo-ERP-verwenden"/>"</para></listitem>
67 Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen
72 <sect1 id="Benötigte-Software-und-Pakete">
73 <title>Benötigte Software und Pakete</title>
75 <sect2 id="Betriebssystem">
76 <title>Betriebssystem</title>
78 <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
79 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
80 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
81 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
82 ohne große Probleme auf den derzeit aktuellen verbreiteten
83 Distributionen läuft.</para>
85 <para>Anfang 2014 sind das folgende Systeme, von denen bekannt ist,
86 dass kivitendo auf ihnen läuft:</para>
94 <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>
97 <para>7.0 "Wheezy"</para>
103 <para>Ubuntu 12.04 LTS "Precise Pangolin", 12.10 "Quantal Quetzal", 13.04 "Precise Pangolin" und 14.04 "Trusty Tahr" LTS Alpha</para>
107 <para>openSUSE 12.2, 12.3 und 13.1</para>
111 <para>SuSE Linux Enterprice Server 11</para>
115 <para>Fedora 16 bis 19</para>
120 <sect2 id="Pakete" xreflabel="Pakete">
121 <title>Benötigte Perl-Pakete installieren</title>
123 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
124 Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.4)
127 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht Bestandteil einer Standard-Perl-Installation sind. Um zu
128 überprüfen, ob die erforderlichen Pakete installiert und aktuell genug sind, wird ein Script mitgeliefert, das wie folgt aufgerufen
131 <programlisting>./scripts/installation_check.pl</programlisting>
133 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
136 <listitem><para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para></listitem>
138 <listitem><para><literal>Archive::Zip</literal></para></listitem>
140 <listitem><para><literal>Config::Std</literal></para></listitem>
142 <listitem><para><literal>DateTime</literal></para></listitem>
144 <listitem><para><literal>DBI</literal></para></listitem>
146 <listitem><para><literal>DBD::Pg</literal></para></listitem>
148 <listitem><para><literal>Email::Address</literal></para></listitem>
150 <listitem><para><literal>Email::MIME</literal></para></listitem>
152 <listitem><para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71 inklusive; siehe <xref linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para></listitem>
154 <listitem><para><literal>File::Copy::Recursive</literal></para></listitem>
156 <listitem><para><literal>JSON</literal></para></listitem>
158 <listitem><para><literal>List::MoreUtils</literal></para></listitem>
160 <listitem><para><literal>Net::SMTP::SSL</literal> (optional, bei E-Mail-Versand über SSL; siehe Abschnitt "<xref
161 linkend="config.sending-email.smtp"/>")</para></listitem>
163 <listitem><para><literal>Net::SSLGlue</literal> (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "<xref
164 linkend="config.sending-email.smtp"/>")</para></listitem>
166 <listitem><para><literal>Params::Validate</literal></para></listitem>
168 <listitem><para><literal>PDF::API2</literal></para></listitem>
170 <listitem><para><literal>Rose::Object</literal></para></listitem>
172 <listitem><para><literal>Rose::DB</literal></para></listitem>
174 <listitem><para><literal>Rose::DB::Object</literal> Version 0.788 oder neuer</para></listitem>
176 <listitem><para><literal>Template</literal></para></listitem>
178 <listitem><para><literal>Text::CSV_XS</literal></para></listitem>
180 <listitem><para><literal>Text::Iconv</literal></para></listitem>
182 <listitem><para><literal>URI</literal></para></listitem>
184 <listitem><para><literal>XML::Writer</literal></para></listitem>
186 <listitem><para><literal>YAML</literal></para></listitem>
189 <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen: <literal>GD</literal>, <literal>HTML::Restrict</literal>, <literal>Image::Info</literal></para>
190 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen: <literal>File::Copy::Recursive</literal>.</para>
192 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen: <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
193 <literal>Net::SSLGlue</literal>.</para>
195 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
196 hinzugekommen, <literal>URI</literal> und
197 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
200 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
201 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
202 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
203 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
205 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
206 hinzugekommen.</para>
208 <para><literal>Email::Address</literal> und
209 <literal>List::MoreUtils</literal> sind schon länger feste
210 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
211 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
212 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
213 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
217 <title>Debian und Ubuntu</title>
219 <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>
221 <programlisting>apt-get install apache2 libarchive-zip-perl libclone-perl \
222 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
223 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
224 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
225 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
226 librose-db-perl librose-object-perl libsort-naturally-perl \
227 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
228 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
229 libimage-info-perl libgd-gd2-perl \
230 libfile-copy-recursive-perl postgresql</programlisting>
232 <para>Für das Paket HTML::Restrict gibt es kein Debian-Paket, dies muß per CPAN installiert werden. Unter Ubuntu funktioniert das mit:</para>
233 <programlisting>apt-get install build-essential
234 cpan HTML::Restrict</programlisting>
238 <title>Fedora Core</title>
240 <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>
242 <programlisting>yum install httpd perl-Archive-Zip perl-Clone perl-DBD-Pg \
243 perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
244 perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
245 perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
246 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
247 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
248 perl-XML-Writer perl-YAML perl-parent postgresql-server</programlisting>
250 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
252 <programlisting>yum install perl-CPAN
253 cpan Config::Std</programlisting>
258 <title>openSUSE</title>
260 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
261 installiert werden:</para>
263 <programlisting>zypper install apache2 perl-Archive-Zip perl-Clone \
264 perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
265 perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
266 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
267 perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
268 perl-URI perl-XML-Writer perl-YAML postgresql-server</programlisting>
270 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
272 <programlisting>yum install perl-CPAN
273 cpan Rose::Db::Object</programlisting>
279 <sect1 id="Manuelle-Installation-des-Programmpaketes"
280 xreflabel="Manuelle Installation des Programmpaketes">
281 <title>Manuelle Installation des Programmpaketes</title>
282 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github gehostet und kann
283 <ulink url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink> heruntergeladen werden.</para>
284 <para>Die kivitendo ERP Installationsdatei (<filename>kivitendo-erp-3.3.0.tgz</filename>) wird im Dokumentenverzeichnis des Webservers
285 (z.B. <filename>/var/www/html/</filename>, <filename>/srv/www/htdocs</filename> oder <filename>/var/www/</filename>) entpackt:</para>
287 <programlisting>cd /var/www
288 tar xvzf kivitendo-erp-3.3.0.tgz</programlisting>
290 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
292 <programlisting>cd kivitendo-erp</programlisting>
294 <para>Alternativ können Sie auch einen Alias in der
295 Webserverkonfiguration benutzen, um auf das tatsächliche
296 Installationsverzeichnis zu verweisen.</para>
298 <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
300 <programlisting>mkdir webdav</programlisting>
302 <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
303 beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
304 Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
305 core <constant>apache</constant> oder bei OpenSUSE <constant>wwwrun</constant>).</para>
307 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
308 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
310 <programlisting>chown -R www-data users spool webdav</programlisting>
312 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
313 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>
315 <programlisting>chown www-data templates users</programlisting>
318 <sect1 id="config.config-file">
319 <title>kivitendo-Konfigurationsdatei</title>
321 <sect2 id="config.config-file.introduction"
322 xreflabel="Einführung in die Konfigurationsdatei">
323 <title>Einführung</title>
325 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei,
326 die benötigt wird: <filename>config/kivitendo.conf</filename> (kurz:
327 "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
328 von kivitendo bzw. der Migration von älteren Versionen angelegt
331 <para>Als Vorlage dient die Datei
332 <filename>config/kivitendo.conf.default</filename> (kurz: "die
333 Default-Datei"):</para>
335 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
337 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
338 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
339 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
340 Abschnitte und Werte enthalten, die von denen der Default-Datei
345 Vor der Umbenennung in kivitendo hieß diese Datei noch <filename>config/lx_office.conf</filename>. Aus Gründen der Kompatibilität
346 wird diese Datei eingelesen, sofern die Datei <filename>config/kivitendo.conf</filename> nicht existiert.
350 <para>Diese Hauptkonfigurationsdatei ist dann eine
351 installationsspezifische Datei, d.h. sie enthält bspw. lokale
352 Passwörter und wird auch nicht im Versionsmanagement (git)
355 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
356 Mandaten, bzw. Datenbanken gleich.</para>
359 <sect2 id="config.config-file.sections-parameters">
360 <title>Abschnitte und Parameter</title>
362 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
363 entsprechend kommentiert sind:</para>
366 <listitem><para><literal>authentication</literal> (siehe Abschnitt "<xref
367 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>" in diesem Kapitel)</para></listitem>
369 <listitem><para><literal>authentication/database</literal></para></listitem>
371 <listitem><para><literal>authentication/ldap</literal></para></listitem>
373 <listitem><para><literal>system</literal></para></listitem>
375 <listitem><para><literal>paths</literal></para></listitem>
377 <listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>
379 <listitem><para><literal>applications</literal></para></listitem>
381 <listitem><para><literal>environment</literal></para></listitem>
384 <listitem><para><literal>print_templates</literal></para></listitem>
386 <listitem><para><literal>task_server</literal></para></listitem>
388 <listitem><para><literal>periodic_invoices</literal></para></listitem>
390 <listitem><para><literal>self_tests</literal></para></listitem>
392 <listitem><para><literal>console</literal></para></listitem>
394 <listitem><para><literal>testing</literal></para></listitem>
396 <listitem><para><literal>testing/database</literal></para></listitem>
398 <listitem><para><literal>debug</literal></para></listitem>
401 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
402 einzustellen oder zu kontrollieren sind, sind:</para>
404 <programlisting>[authentication]
405 admin_password = geheim
407 [authentication/database]
412 password =</programlisting>
414 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
415 <varname>[periodic_invoices]</varname> den Login eines Benutzers
416 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
417 mit Informationen über die erstellten Rechnungen bekommt.</para>
419 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten Ausführung bestimmter Aufgaben mit, den <link
420 linkend="config.task-server">Taskserver</link>. Er wird u.a. für Features wie die <link
421 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link> benötigt, erledigt aber auch andere erforderliche Aufgaben
422 und muss daher in Betrieb genommen werden. Der Taskserver benötigt zwei Konfigurationseinstellungen, die unter
423 <varname>[task_server]</varname> anzugeben sind: ein Mandant (entweder der Mandantenname oder eine Datenbank-ID, Variable
424 <varname>client</varname>), aus dem die Datenbankkonfiguration entnommen wird, sowie ein Login (Variable <varname>login</varname>)
425 eines Benutzers, der für gewisse Dinge wie die Rechnungserstellung als Verkäufer eingetragen wird.</para>
427 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
428 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
431 <sect2 id="config.config-file.prior-versions">
432 <title>Versionen vor 2.6.3</title>
434 <para>In älteren kivitendo Versionen gab es im Verzeichnis
435 <filename>config</filename> die Dateien
436 <filename>authentication.pl</filename> und
437 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
438 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
439 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
440 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
442 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
443 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
444 manuell übertragen und die alten Konfigurationsdateien anschließend
445 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
446 entsprechende Fehlermeldung an.</para>
450 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
451 <title>Anpassung der PostgreSQL-Konfiguration</title>
453 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
455 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
456 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
458 <para>kivitendo setzt zwingend voraus, dass die Datenbank Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen Serverinstallationen
459 braucht man hier meist nicht einzugreifen.</para>
461 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so
462 braucht man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
464 <programlisting>su postgres
466 exit </programlisting>
468 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
469 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
470 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
473 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
475 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
476 Versionsnummer angepasst werden.</para>
478 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
480 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
481 <literal>\l</literal> geprüft werden.</para>
484 <sect2 id="Änderungen-an-Konfigurationsdateien">
485 <title>Änderungen an Konfigurationsdateien</title>
487 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
488 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
489 <filename>/var/lib/pgsql/data/</filename> oder
490 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
491 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
492 Parameter <varname>listen_address</varname> gesteuert. Laufen
493 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
494 <literal>localhost</literal> verwendet werden. Andernfalls müssen
495 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
496 was mit dem Wert <literal>*</literal> geschieht.</para>
498 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
499 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
500 sein sollte, müssen die Berechtigungen für den Zugriff geändert
501 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
502 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
503 Datenbank zum Beispiel:</para>
505 <programlisting>local all kivitendo password
506 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
509 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
510 <title>Erweiterung für servergespeicherte Prozeduren</title>
512 <para>In der Datenbank <literal>template1</literal> muss die
513 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
514 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
515 <programlisting>su - postgres
516 psql template1</programlisting>
518 führen Sie die folgenden Kommandos aus:</para>
520 <programlisting>create language 'plpgsql';
524 <sect2 id="Datenbankbenutzer-anlegen">
525 <title>Datenbankbenutzer anlegen</title>
527 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
528 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
529 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
532 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit nein
533 beantworten, genauso ist die Berechtigung neue User (Roles) zu
534 generieren nicht nötig.</para>
535 <programlisting>su - postgres
536 createuser -d -P kivitendo
537 exit</programlisting>
539 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
540 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.
541 den hier gewählten Benutzernamen.</para>
545 <sect1 id="Apache-Konfiguration">
546 <title>Webserver-Konfiguration</title>
549 <title>Grundkonfiguration mittels CGI</title>
552 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
553 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
554 <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
557 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
558 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
559 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
560 anderen Datei hinzu, die beim Starten des Webservers eingelesen
563 <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
564 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
566 <Directory /var/www/kivitendo-erp>
567 AddHandler cgi-script .pl
568 Options ExecCGI Includes FollowSymlinks
571 <Directory /var/www/kivitendo-erp/users>
574 </Directory></programlisting>
576 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
577 das kivitendo-Archiv entpacket haben.</para>
580 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
581 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
582 <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss noch explizit
583 das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting> aktiviert
587 <para>Auf einigen Webservern werden manchmal die Grafiken und
588 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
589 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
591 <programlisting>EnableSendfile Off</programlisting>
594 <sect2 id="Apache-Konfiguration.FCGI"
595 xreflabel="Konfiguration für FastCGI/FCGI">
596 <title>Konfiguration für FastCGI/FCGI</title>
598 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
599 <title>Was ist FastCGI?</title>
601 <para>Direkt aus <ulink
602 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
605 <para><citation> FastCGI ist ein Standard für die Einbindung
606 externer Software zur Generierung dynamischer Webseiten in einem
607 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
608 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
609 umgehen. </citation></para>
612 <sect3 id="Apache-Konfiguration.FCGI.Warum">
613 <title>Warum FastCGI?</title>
615 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
616 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
617 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
618 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
619 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
620 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
621 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
622 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
623 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
624 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
625 deutlich länger dauert als früher, und dass davon 90% für das Laden
626 der Module verwendet wird.</para>
628 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
629 wird nur die eigentliche Programmlogik ausgeführt.</para>
632 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
633 <title>Getestete Kombinationen aus Webservern und Plugin</title>
635 <para>Folgende Kombinationen sind getestet:</para>
639 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
643 <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
647 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
651 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
652 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
653 mod_fastcgi nicht mehr explizit eingegangen.</para>
655 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
659 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem strict in der Behandlung von Unicode, und verweigern
660 bestimmte Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer Installation gibt, muss zwingend Version 0.68 oder
661 aber Version 0.72 und neuer eingesetzt werden.</para>
663 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie sich die Vorgängerversion wie folgt
666 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
670 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
671 <title>Konfiguration des Webservers</title>
673 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
674 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
675 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
676 debuggen die beim ersten aufsetzen auftreten können. Sollte die
677 Installation schon funktionieren, lesen Sie weiter.</para>
679 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
680 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
682 <programlisting>a2enmod fcgid</programlisting>
684 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
685 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
686 und <function>Directory</function>-Direktiven. Dabei wird zwischen
687 dem Installationspfad von kivitendo im Dateisystem
688 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
689 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
690 ("<filename>/url/for/kivitendo-erp</filename>").</para>
692 <para>Folgender Konfigurationsschnipsel funktioniert mit
695 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
696 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
698 <Directory /path/to/kivitendo-erp>
700 Options ExecCGI Includes FollowSymlinks
705 <DirectoryMatch /path/to/kivitendo-erp/users>
708 </DirectoryMatch></programlisting>
711 <para>Im Vergleich zu Apache 2.2 hat sich in Apache 2.4 die Syntax der Directorydirektiven verändert. Statt</para>
714 Allow from All </programlisting>
715 <para> muß man jetzt Folgendes einstellen:</para>
716 <programlisting>Require all granted</programlisting>
719 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
720 die maximale Größe eines Requests. Diese sollte wie folgt
721 hochgesetzt werden:</para>
723 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
726 <para>Das Ganze sollte dann so aussehen:</para>
728 <programlisting>AddHandler fcgid-script .fpl
729 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
730 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
731 FcgidMaxRequestLen 10485760
733 <Directory /path/to/kivitendo-erp>
735 Options ExecCGI Includes FollowSymlinks
740 <DirectoryMatch /path/to/kivitendo-erp/users>
743 </DirectoryMatch></programlisting>
745 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
746 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
747 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
748 gibt es hier kleine Performance-Einbußen.</para>
750 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
751 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
752 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
754 <programlisting># Zugriff über CGI
755 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
757 # Zugriff mit mod_fcgid:
758 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
759 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
761 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
762 die normale Version erreichbar, und unter
763 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
764 FastCGI-Version.</para>
768 <title>Weitergehende Konfiguration</title>
769 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung von kivitendo
770 nur über https-verschlüsselten Verbindungen, sowie weiteren Zusatzmassnahmen,
771 wie beispielsweise Basic Authenticate.
772 Die Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser Anleitung, hier ein
773 Hinweis auf einen entsprechenden <ulink
774 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag (Stand Sept. 2015)</ulink></para>
778 <sect1 id="config.task-server">
779 <title>Der Task-Server</title>
781 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und
782 diese zu festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess wird u.a. für die Erzeugung der wiederkehrenden
783 Rechnungen und weitere essenzielle Aufgaben benutzt.</para>
785 <sect2 id="Konfiguration-des-Task-Servers">
786 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
788 <para>Die Konfiguration erfolgt über den Abschnitt
789 <literal>[task_server]</literal> in der Datei
790 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
791 Optionen sind:</para>
795 <term><varname>client</varname></term>
798 <para>Name oder Datenbank-ID eines vorhandenen kivitendo-Mandanten, der benutzt wird, um die zu verwendende
799 Datenbankverbindung auszulesen. Der Mandant muss in der Administration angelegt werden. Diese Option muss angegeben
802 <para>Diese Option kam mit Release v3.x.0 hinzu und muss daher in Konfigurationen, die von älteren Versionen aktualisiert
803 wurden, ergänzt werden.</para>
808 <term><varname>login</varname></term>
811 <para>gültiger kivitendo-Benutzername, der z.B. als Verkäufer beim Erzeugen wiederkehrender Rechnungen benötigt wird. Der
812 Benutzer muss in der Administration angelegt werden. Diese Option muss angegeben werden.</para>
817 <term><varname>run_as</varname></term>
820 <para>Wird der Server vom Systembenutzer <literal>root</literal>
821 gestartet, so wechselt er auf den mit <literal>run_as</literal>
822 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
823 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
825 linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
826 ist es sinnvoll, hier denselben Systembenutzer einzutragen,
827 unter dem auch der Webserver läuft.</para>
832 <term><varname>debug</varname></term>
835 <para>Schaltet Debug-Informationen an und aus.</para>
841 <sect2 id="Einbinden-in-den-Boot-Prozess">
842 <title>Automatisches Starten des Task-Servers beim Booten</title>
844 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
845 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
846 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
848 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
849 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
850 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
851 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
852 anstelle eines symbolischen Links verwendet werden können.</para>
855 <title>SystemV-basierende Systeme (z.B. Debian, ältere OpenSUSE, ältere Fedora Core)</title>
857 <para>Kopieren Sie die Datei
858 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
859 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
860 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
861 <literal>DAEMON=....</literal>). Binden Sie das Script in den
862 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
866 <para>Debian-basierende Systeme:</para>
868 <programlisting>update-rc.d kivitendo-task-server defaults
869 # Nur bei Debian Squeeze und neuer:
870 insserv kivitendo-task-server</programlisting>
874 <para>Ältere OpenSUSE und ältere Fedora Core:</para>
876 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
880 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
883 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
887 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
889 <para>Kopieren Sie die Datei
890 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
891 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
892 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
893 <literal>exec ....</literal>).</para>
895 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
898 <programlisting>service kivitendo-task-server start</programlisting>
902 <title>systemd-basierende Systeme (z.B. neure OpenSUSE, neuere Fedora Core)</title>
904 <para>Verlinken Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
905 <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
906 <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>). Binden Sie das Script in den Boot-Prozess ein.
909 <para>Alle hierzu benötigten Befehle sehen so aus:</para>
911 <programlisting>cd /var/www/kivitendo-erp/scripts/boot/systemd
912 ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
914 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
917 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
921 <sect2 id="Prozesskontrolle">
922 <title>Wie der Task-Server gestartet und beendet wird</title>
924 <para>Der Task-Server wird wie folgt kontrolliert:</para>
926 <programlisting>./scripts/task_server.pl Befehl</programlisting>
928 <para><literal>Befehl</literal> ist dabei eine der folgenden
933 <para><literal>start</literal> startet eine neue Instanz des
934 Task-Servers. Die Prozess-ID wird innerhalb des
935 <filename>users</filename>-Verzeichnisses abgelegt.</para>
939 <para><literal>stop</literal> beendet einen laufenden
944 <para><literal>restart</literal> beendet und startet ihn
949 <para><literal>status</literal> berichtet, ob der Task-Server
954 <para>Der Task-Server wechselt beim Starten automatisch in das
955 kivitendo-Installationsverzeichnis.</para>
957 <para>Dieselben Optionen können auch für die SystemV-basierenden
958 Runlevel-Scripte benutzt werden (siehe oben).</para>
960 <sect2 id="Prozesskontrolle2">
961 <title>Task-Server mit mehreren Mandanten</title>
963 <para>Beim Task-Server werden der zu verwendende Mandant und Login-Name des Benutzers, unter dem der Task-Server laufen soll, in die
964 Konfigurationsdatei geschrieben. Hat man mehrere Mandanten, muss man auch mehrere Konfigurationsdateien anlegen.</para>
966 <para>Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf, wo in der Kategorie <varname>[task_server]</varname> die
967 gewünschten Werte für <varname>client</varname> und <varname>login</varname> eingetragen werden.</para>
969 <para>Der alternative Task-Server wird dann mit folgendem Befehl
972 <programlisting>./scripts/task_server.pl -c config/DATEINAME.conf</programlisting>
976 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
977 <title>Benutzerauthentifizierung und Administratorpasswort</title>
979 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
980 über die Verwaltung von Gruppen und weitere Einstellungen</para>
982 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
983 <title>Grundlagen zur Benutzerauthentifizierung</title>
985 <para>kivitendo verwaltet die Benutzerinformationen in einer
986 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
987 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
988 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
989 können, müssen aber nicht unterschiedlich sein.</para>
991 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
992 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
993 abgelegt werden.</para>
995 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
996 entweder gegen die Authentifizierungsdatenbank oder gegen einen
997 LDAP-Server überprüft werden.</para>
999 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1000 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1001 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1002 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1003 einer Version vor v2.6.0 angelegt werden. Eine
1004 Beispielkonfigurationsdatei
1005 <filename>config/kivitendo.conf.default</filename> existiert, die als
1006 Vorlage benutzt werden kann.</para>
1009 <sect2 id="Administratorpasswort">
1010 <title>Administratorpasswort</title>
1012 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface von kivitendo
1013 benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
1014 nur dort und nicht mehr im Administrationsinterface selber geändert
1015 werden. Der Parameter dazu heißt <varname>admin_password</varname> im
1016 Abschnitt <varname>[authentication]</varname>.</para>
1019 <sect2 id="Authentifizierungsdatenbank">
1020 <title>Authentifizierungsdatenbank</title>
1022 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1023 Parametern in <varname>[authentication/database]</varname>
1024 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1028 <term><literal>host</literal></term>
1031 <para>Der Rechnername oder die IP-Adresse des
1032 Datenbankservers</para>
1037 <term><literal>port</literal></term>
1040 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1045 <term><literal>db</literal></term>
1048 <para>Der Name der Authentifizierungsdatenbank</para>
1053 <term><literal>user</literal></term>
1056 <para>Der Benutzername, mit dem sich kivitendo beim
1057 Datenbankserver anmeldet (z.B.
1058 "<literal>postgres</literal>")</para>
1063 <term><literal>password</literal></term>
1066 <para>Das Passwort für den Datenbankbenutzer</para>
1071 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1072 automatisch anlegen (mehr dazu siehe unten).</para>
1075 <sect2 id="Passwortüberprüfung">
1076 <title>Passwortüberprüfung</title>
1078 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1079 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1080 Active-Directory-Server. Welche davon benutzt wird, regelt der
1081 Parameter <varname>module</varname> im Abschnitt
1082 <varname>[authentication]</varname>.</para>
1084 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1085 gespeichert werden, so muss der Parameter <varname>module</varname>
1086 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1087 der Administrator als auch die Benutzer selber ihre Psaswörter in
1088 kivitendo ändern.</para>
1090 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1091 benutzt werden, so muss der Parameter <varname>module</varname> auf
1092 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1093 zusätzliche Informationen über den LDAP-Server im Abschnitt
1094 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1098 <term><literal>host</literal></term>
1101 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1102 Active-Directory-Servers. Diese Angabe ist zwingend
1103 erforderlich.</para>
1108 <term><literal>port</literal></term>
1111 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1116 <term><literal>tls</literal></term>
1119 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1120 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1121 ‘<literal>0</literal>’ belassen</para>
1126 <term><literal>attribute</literal></term>
1129 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1130 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1131 meist ‘<literal>sAMAccountName</literal>’, für andere
1132 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1133 zwingend erforderlich.</para>
1138 <term><literal>base_dn</literal></term>
1141 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1142 Diese Angabe ist zwingend erforderlich.</para>
1147 <term><literal>filter</literal></term>
1150 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1151 <literal><%login%></literal>, so wird dieses durch den vom
1152 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1153 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1154 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1159 <term><literal>bind_dn</literal> und
1160 <literal>bind_password</literal></term>
1163 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1164 durchsucht werden kann (z.B. ist dies bei
1165 Active-Directory-Servern der Fall), so kann diese hier angegeben
1166 werden. Für Active-Directory-Server kann als
1167 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1168 z.B. ‘<literal>cn=Martin
1169 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1170 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1171 also ‘<literal>Martin Mustermann</literal>’.</para>
1177 <sect2 id="Name-des-Session-Cookies">
1178 <title>Name des Session-Cookies</title>
1180 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1181 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1182 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1183 Parameter <varname>cookie_name</varname> im Abschnitt
1184 <varname>[authentication]</varname>gesetzt.</para>
1186 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1187 Server existiert.</para>
1190 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1191 <title>Anlegen der Authentifizierungsdatenbank</title>
1193 <para>Nachdem alle Einstellungen in
1194 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1195 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1196 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1197 der folgenden URL erreichbar sein sollte:</para>
1200 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1204 <sect1 id="Benutzer--und-Gruppenverwaltung">
1205 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1207 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und Datenbanken angelegt werden. Dieses geschieht im
1208 Administrationsmenü, das Sie unter folgender URL finden:</para>
1211 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1213 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1214 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1216 <sect2 id="Zusammenhänge">
1217 <title>Zusammenhänge</title>
1219 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung in einer oder zwei Datenbanken gespeichert werden.</para>
1221 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat
1222 Zugriff auf welche Mandanten, und welche Gruppe verfügt über welche Rechte. Diese Informationen werden in der
1223 Authentifizierungsdatenbank gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter in der Konfigurationsdatei
1224 <filename>config/kivitendo.conf</filename> gespeichert werden.</para>
1226 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten, Waren) und Belege
1227 (Angebote, Lieferscheine, Rechnungen). Diese werden in einer Mandantendatenbank gespeichert. Die
1228 Verbindungsinformationen einer solchen Mandantendatenbank werden im Administrationsbereich konfiguriert, indem man einen Mandanten
1229 anlegt und dort die Parameter einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1231 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich, die Authentifizierungsdatenbank und eine der
1232 Mandantendatenbanken in ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit mehr als einem Mandanten, wird
1233 empfohlen, für die Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die nicht gleichzeitig für einen Mandanten
1234 verwendet wird.</para>
1237 <sect2 id="Mandanten-Benutzer-Gruppen">
1238 <title>Mandanten, Benutzer und Gruppen</title>
1240 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen, die sich frei zueinander zuordnen lassen.</para>
1242 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1243 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1244 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank. Diese sollte über die <link
1245 linkend="Datenbanken-anlegen">Datenbankverwaltung</link> geschehen.</para>
1247 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten soll. Sie erhält einen Loginnamen sowie ein
1248 Passwort. Weiterhin legt der Administrator fest, an welchen Mandanten sich ein Benutzer anmelden kann, was beim Login verifiziert
1251 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür
1252 vom Administrator gewisse Rechte zugeordnet. Weiterhin legt der Administrator fest, für welche Mandanten eine Gruppe gilt, und
1253 welche Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer dann an einem Mandanten an, so erhält er alle Rechte von
1254 allen denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in denen der Benutzer zum Anderen Mitglied ist, </para>
1256 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und Benutzer angelegt werden, kann im Prinzip beliebig gewählt
1257 werden. Die folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1259 <orderedlist numeration="arabic">
1261 <para>Datenbank anlegen</para>
1265 <para>Gruppen anlegen</para>
1269 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1273 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1278 <sect2 id="Datenbanken-anlegen">
1279 <title>Datenbanken anlegen</title>
1281 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1282 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1283 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1286 <sect2 id="Gruppen-anlegen">
1287 <title>Gruppen anlegen</title>
1289 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1290 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1291 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1292 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1294 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank gespeichert, gelten aber nicht automatisch für alle
1295 Mandanten. Der Administrator legt vielmehr fest, für welche Mandanten eine Gruppe gültig ist. Dies kann entweder beim Bearbeiten der
1296 Gruppe geschehen ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn man einen Mandanten bearbeitet ("für diesen
1297 Mandanten sind die Gruppen A, B und C gültig").</para>
1299 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder dieser Gruppe festgelegt werden ("in dieser Gruppe sind die
1300 Benutzer X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten eines Benutzers geschehen ("dieser Benutzer ist
1301 Mitglied in den Gruppen A, B und C").</para>
1304 <sect2 id="Benutzer-anlegen">
1305 <title>Benutzer anlegen</title>
1307 <para>Beim Anlegen von Benutzern werden für viele Parameter Standardeinstellungen vorgenommen, die den Gepflogenheiten des deutschen
1308 Raumes entsprechen.</para>
1310 <para>Zwingend anzugeben ist der Loginname. Wenn die Passwortauthentifizierung über die Datenbank eingestellt ist, so kann hier auch
1311 das Benutzerpasswort gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1314 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier auch konfiguriert werden, auf welche Mandanten der Benutzer
1315 Zugriff hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können sowohl beim Benutzer vorgenommen werden ("dieser
1316 Benutzer hat Zugriff auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen X, Y und Z") als auch beim Mandanten ("auf
1317 diesen Mandanten haben Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe sind Benutzer A, B und C
1318 Mitglieder").</para>
1321 <sect2 id="Mandanten-anlegen">
1322 <title>Mandanten anlegen</title>
1324 <para>Ein Mandant besteht aus Administrationssicht primär aus einem eindeutigen Namen. Weiterhin wird hier hinterlegt, welche
1325 Datenbank als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten einer der eben angelegten Datenbanken eingetragen
1328 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch konfiguriert werden, welche Benutzer Zugriff auf den
1329 Mandanten haben bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen können sowohl beim Mandanten vorgenommen werden
1330 ("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
1331 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
1335 <sect1 id="Drucker--Systemverwaltung">
1336 <title>Drucker- und Systemverwaltung</title>
1337 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte Druckeradministration und System.</para>
1338 <sect2 id="Druckeradministration">
1339 <title>Druckeradministration</title>
1340 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig viele "Druckbefehle" im System verwalten. Diese Befehle werden mandantenweise
1341 zugeordnet. Unter Druckerbeschreibung wird der Namen des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs angezeigt wird.</para>
1342 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl, der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P meinDrucker' oder ein
1343 kompletter Pfad zu einem Skript (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh).
1344 Wird ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich ergänzt, ist
1345 bspw. das Kürzel 'epson_drucker' definiert, so wird beim Ausdruck eines Angebots folgende Vorlage geparst: sales_quotation_epson_drucker.tex.</para>
1348 <title>System sperren / entsperren</title>
1350 <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>
1351 <para>Falls die Sperre gesetzt ist, erscheint anstelle der Anmeldemaske die Information: 'kivitendo ist momentan zwecks Wartungsarbeiten nicht zugänglich.'.
1353 <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
1354 mit einem inkonsistenten Datenbestand weitergearbeitet werden.</para>
1358 <sect1 id="config.sending-email" xreflabel="E-Mail-Versand aus kivitendo heraus">
1359 <title>E-Mail-Versand aus kivitendo heraus</title>
1361 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden, z.B. um ein Angebot direkt an einen Kunden zu
1362 verschicken. Damit dies funktioniert, muss eingestellt werden, über welchen Server die E-Mails verschickt werden sollen. kivitendo
1363 unterstützt dabei zwei Mechanismen: Versand über einen lokalen E-Mail-Server (z.B. mit <productname>Postfix</productname> oder
1364 <productname>Exim</productname>, was auch die standardmäßig aktive Methode ist) sowie Versand über einen SMTP-Server (z.B. der des
1365 eigenen Internet-Providers).</para>
1367 <para>Welche Methode und welcher Server verwendet werden, wird über die Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1368 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1370 <sect2 id="config.sending-email.sendmail" xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1371 <title>Versand über lokalen E-Mail-Server</title>
1373 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie
1374 z.B. <productname>Postfix</productname>, <productname>Exim</productname> oder <productname>Sendmail</productname> läuft.</para>
1376 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1377 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1379 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet wird, dient der Parameter '<literal>sendmail =
1380 ...</literal>'. Der Standardwert verweist auf das Programm <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1381 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1383 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen dieses sprengen. Hierfür sei auf die Dokumentation des
1384 E-Mail-Servers verwiesen.</para>
1387 <sect2 id="config.sending-email.smtp" xreflabel="E-Mail-Versand über einen SMTP-Server">
1388 <title>Versand über einen SMTP-Server</title>
1390 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server vorhanden oder zwar einer vorhanden, dieser aber nicht
1391 konfiguriert ist.</para>
1393 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1394 Parameter dienen dabei der weiteren Konfiguration:</para>
1398 <term><varname>hostname</varname></term>
1400 <listitem><para>Name oder IP-Adresse des SMTP-Servers. Standardwert: '<literal>localhost</literal>'</para></listitem>
1404 <term><varname>port</varname></term>
1406 <listitem><para>Portnummer. Der Standardwert hängt von der verwendeten Verschlüsselungsmethode ab. Gilt '<literal>security =
1407 none</literal>' oder '<literal>security = tls</literal>', so ist 25 die Standardportnummer. Für '<literal>security =
1408 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht geändert werden.</para></listitem>
1412 <term><varname>security</varname></term>
1414 <listitem><para>Wahl der zu verwendenden Verschlüsselung der Verbindung mit dem Server. Standardwert ist
1415 '<literal>none</literal>', wodurch keine Verschlüsselung verwendet wird. Mit '<literal>tls</literal>' wird TLS-Verschlüsselung
1416 eingeschaltet, und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL eingeschaltet. Achtung: Für
1417 '<literal>tls</literal>' und '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt (siehe unten).</para></listitem>
1421 <term><varname>login</varname> und <varname>password</varname></term>
1423 <listitem><para>Falls der E-Mail-Server eine Authentifizierung verlangt, so können mit diesen zwei Parametern der Benutzername
1424 und das Passwort angegeben werden. Wird Authentifizierung verwendet, so sollte aus Sicherheitsgründen auch eine Form von
1425 Verschlüsselung aktiviert werden.</para></listitem>
1429 <para>Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind:</para>
1432 <listitem><para>TLS-Verschlüsselung: Modul <literal>Net::SSLGlue</literal> (Debian-Paketname
1433 <literal>libnet-sslglue-perl</literal>, Fedora Core: <literal>perl-Net-SSLGlue</literal>, openSUSE:
1434 <literal>perl-Net-SSLGlue</literal></para></listitem>
1436 <listitem><para>SSL-Verschlüsselung: Modul <literal>Net::SMTP::SSL</literal> (Debian-Paketname
1437 <literal>libnet-smtp-ssl-perl</literal>, Fedora Core: <literal>perl-Net-SMTP-SSL</literal>, openSUSE:
1438 <literal>perl-Net-SMTP-SSL</literal></para></listitem>
1443 <sect1 id="Drucken-mit-kivitendo">
1444 <title>Drucken mit kivitendo</title>
1446 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen. Um drucken zu können, braucht der Server ein geeignetes
1447 LaTeX System. Am einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter debianoiden Betriebssystemen installiert man
1448 die Pakete mit:</para>
1450 <para><programlisting>aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
1451 texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
1453 <para>TODO: RPM-Pakete.</para>
1455 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
1457 <listitem><para>RB</para></listitem>
1458 <listitem><para>f-tex</para></listitem>
1459 <listitem><para>rev-odt</para></listitem>
1462 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
1464 <sect2 id="Vorlagenverzeichnis-anlegen" xreflabel="Vorlagenverzeichnis anlegen">
1465 <title>Vorlagenverzeichnis anlegen</title>
1466 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
1468 <programlisting>./scripts/installation_check.pl -lv</programlisting>
1470 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
1471 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch <xref linkend="Gruppen-anlegen"/>.
1473 <para>Im Userbereich lässt sich unter:
1474 "<guimenu>System</guimenu> ->
1475 <guisubmenu>Mandantenverwaltung</guisubmenu> -> <guimenuitem>Verschiedenes</guimenuitem>" die Option
1476 "Neue Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
1479 <listitem><para><option>Vorlagen auswählen</option>: Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll
1480 (<filename>RB</filename>, <filename>f-tex</filename> oder <filename>odt-rev</filename>.)</para></listitem>
1481 <listitem><para><option>Neuer Name</option>: Der Verzeichnisname für den neuen Vorlagensatz. Dieser kann im Rahmen der üblichen
1482 Bedingungen für Verzeichnisnamen frei gewählt werden.</para></listitem>
1485 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist für den aktuellen Mandanten ausgewählt.
1486 Der gleiche Vorlagensatz kann, wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
1487 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch vorgenommen werden. Den Ordner findet man im Dateisystem unter
1488 <filename>./templates/[Neuer Name]</filename></para>
1493 <sect2 id="Vorlagen-RB">
1494 <title>Der Druckvorlagensatz RB</title>
1496 <para>Hierbei handelt es sich um einen vollständigen LaTeX Dokumentensatz mit alternativem Design. Die odt oder html-Varianten sind nicht gepflegt.</para>
1497 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
1498 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
1499 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die eigenen Firmendaten finden sich in der Datei Readme.tex im Vorlagenverzeichnis.</para>
1501 <para>Eine kurze Übersicht der Features:</para>
1503 <listitem><para>Mehrsprachenfähig, mit Deutscher und Englischer Übersetzung</para></listitem>
1504 <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>
1505 <listitem><para>mehrere vordefinierte Varianten für Logos/Hintergrundbilder</para></listitem>
1506 <listitem><para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder "Außerhalb EU"</para></listitem>
1512 <title>f-tex</title>
1514 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt.</para>
1516 <sect3 id="f-tex-Feature-Übersicht">
1517 <title>Feature-Übersicht</title>
1519 <listitem><para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage für alle briefartigen Dokumente verwendet. Also
1520 Angebot, Rechnung, Proformarechnung, Lieferschein, aber eben nicht für Paketaufkleber etc.</para></listitem>
1522 <listitem><para>Leichte Anpassung an das Firmen-Layout durch Verwendung eines Hintergrund-PDFs. Dieses kann leicht mit dem
1523 eigenen Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp, Adobe*)</para></listitem>
1525 <listitem><para>Hintergrund-PDF umschaltbar auf "nur erste Seite" (Standard) oder "alle Seiten" (Option
1526 "<option>bgPdfFirstPageOnly</option>" in Datei <filename>letter.lco</filename>)</para></listitem>
1528 <listitem><para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
1529 versendeten Dokumenten eingebunden (Option "<option>bgPdfEmailOnly</option>" in Datei
1530 <filename>letter.lco</filename>).</para></listitem>
1532 <listitem><para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch, Wiederholung von Kopfzeilen, Zwischensummen
1533 etc. (danke an Kai-Martin Knaak für die Vorarbeit)</para></listitem>
1535 <listitem><para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom Land des eigenen Unternehmens abweicht (also die
1536 Rechnung das Land verlässt).</para></listitem>
1538 <listitem><para>Multisprachfähig leicht um weitere Sprachen zu erweitern, alle Übersetzungen in der Datei
1539 <filename>translatinos.tex</filename>.</para></listitem>
1541 <listitem><para>Auflistung von Bruttopreisen für Endverbraucher.</para></listitem>
1545 <sect3 id="f-tex-Installation">
1546 <title>Die Installation</title>
1548 <listitem><para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref linkend="Vorlagenverzeichnis-anlegen"/>. Das
1549 Vorlagensystem funktioniert jetzt schon, hat allerdings noch einen Beispiel-Briefkopf.</para></listitem>
1551 <listitem><para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach <filename>./letter_head.pdf</filename>.</para></listitem>
1552 <listitem><para>Editiere den Bereich "<option>settings</option>" in der datei <filename>letter.lco</filename>.</para></listitem>
1555 <para>oder etwas detaillierter:</para>
1558 Es wird eine Datei <filename>sample.lco</filename> erstellt und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
1559 ist dies die Datei die für die firmenspezifischen Anpassungen gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig
1560 ist, wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle über dieses PDF die persönlichen Layoutanpassungen
1561 vorzunehmen und <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung über eine
1562 <filename>*.lco</filename>-Datei, die letztlich auf <filename>letter.lco</filename> verlinkt ist ist aber auch möglich.
1566 Es wird eine Datei <filename>sample_head.pdf</filename> mit ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
1567 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage. Schau Dir nach Abschluss der Installation die Datei
1568 <filename>sample_head.pdf</filename> an und erstelle ein entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
1569 Template Verzeichniss ablegen und statt <filename>sample_head.pdf</filename> nach <filename>letter_head.pdf</filename>
1574 Letzlich muss <filename>letter_head.pdf</filename> auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
1579 Es wird eine Datei <filename>mydata.tex.example</filename> ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
1580 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das Land verwendet. Die Datei muss also nicht angefasst
1581 werden. Die anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit nicht im öffentlichen Zweig).
1584 Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc. sollten über die Hintergrund-PDF-Datei oder die
1585 <filename>*.lco</filename>-Datei erfolgen.
1589 <sect3 id="f-tex-Funktionsübersicht">
1590 <title>f-tex Funktionsübersicht</title>
1592 Das Konzept von kivitendo sieht vor, für jedes Dokument (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine LaTeX-Vorlage
1593 vorzuhalten, dies ist sehr wartungsunfreundlich. Auch das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
1594 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
1595 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche LaTeX-Vorlage verwendet, welche über Codeweichen die
1596 Besonderheiten der jeweiligen Dokumente berücksichtigt:
1600 <listitem><para>Tabellen mit oder ohne Preis</para></listitem>
1601 <listitem><para>Sprache der Tabellenüberschriften etc.</para></listitem>
1602 <listitem><para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus Angebotsnummer)</para></listitem>
1603 <listitem><para>Darstellung von Brutto oder Netto-Preisen in der Auflistung (Endverbraucher versus gewerblicher
1604 Kunde)</para></listitem>
1607 <para>Nachteil:</para>
1610 LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
1611 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder geübt ist Scriptsparachen nachzuvollziehen kann natürlich
1612 auch innerhalb der Tabellendarstellung gut persönliche Anpassungen vornehmen. Aber man kann sich hier bei Veränderungen sehr
1613 schnell heftig in den Fuss schiessen.
1616 <para>Wer nicht so tief in die Materie einsteigen will oder leicht zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
1617 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen, und sich an der Form der dargestellten Tabellen, wie sie
1618 ausgeliefert werden, erfreuen.
1621 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine, kontinuierliche Schritte gehen.</para>
1625 <sect3 id="f-tex-Bruttopreise">
1626 <title>Bruttopreise für Endverbraucher</title>
1628 <para>Der auszuweisende Bruttopreis wird innerhalb der LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen "alle
1629 Preise Brutto" auszuwählen, aber:</para>
1632 <para>hierfür müssen die Preise auch in Brutto in der Datenbank stehen (ja - das lässt sich über die Preisgruppen und die
1633 Zuordung einer Default-Preisgruppe handhaben)</para>
1636 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
1637 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche Knackpunkt)</para>
1642 Es gibt mit f-tex eine weitere Alternative. Die Information ob Brutto oder Nettorechnung wird mit den Zahlarten
1643 verknüpft. Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben werden sollen, enden mit "_E" (für
1644 Endverbraucher). Falls identische Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt man diese einfach doppelt
1645 an (einmal mit der Namensendung "_E"). Gewinn:</para>
1648 <listitem><para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist nicht mehr fix mit einer Preisliste verbunden.</para></listitem>
1649 <listitem><para>Die Default-Zahlart kann im Kundendatensatz hinterlegt werden, und man muss nicht mehr daran denken, "alle Preise
1650 Netto" auszuwählen.</para></listitem>
1651 <listitem><para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen werden, kann direkt beim Drucken revidiert werden,
1652 ohne dass sich der Auftragswert ändert.</para></listitem>
1656 <sect3 id="f-tex-lieferadressen">
1657 <title>Lieferadressen</title>
1659 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen im Adressfeld zum Einsatz. Wenn die
1660 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende Adressvariable eingesetzt. Wenn also die Lieferadresse in
1661 Straße, Hausnummer und Ort abweicht, müssen auch nur diese Felder in der Lieferadresse ausgefüllt werden. Für den Firmenname wird
1662 der Wert der Hauptadresse angezeigt.
1667 <sect2 id="Vorlagen-rev-odt">
1668 <title>Der Druckvorlagensatz rev-odt</title>
1670 <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.
1671 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it, Zürich erstellt
1672 und werden laufend aktualisiert. Ein paar der Formulierungen in den Druckvorlagen entsprechen dem Schweizer Sprachgebrauch, z.B. "Offerte" oder "allfällig".
1676 Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für KundInnen und LieferantInnen,
1677 sowie bei Lieferadressen:
1678 Die in diesem Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das entsprechende
1679 Kürzel, das in Adressen vor die Postleitzahl gesetzt wird.
1680 Das Feld kann auch komplett leer bleiben.
1681 Wer dies anders handhaben möchte, muss die Vorlagen entsprechend anpassen.
1684 odt-Vorlagen können mit LibreOffice oder OpenOffice editiert
1685 und den eigenen Bedürfnissen angepasst werden.
1686 Wichtig beim Editieren von if-Blöcken ist, dass immer der gesamte Block
1687 überschrieben werden muss und nicht nur Teile davon, da dies sonst oft
1688 zu einer odt-Datei führt, die vom Parser nicht korrekt gelesen werden kann.
1691 Zur Zeit gibt es in kivitendo noch keine Möglichkeit, odt-Vorlagen bei Mahnungen
1692 einzusetzen. Entsprechende Vorlagen sind deshalb nicht vorhanden.
1695 Inwieweit es möglich ist, für die in Version 3.2.0 neu eingeführten Pflichtenhefte
1696 odt-Vorlagen zu erstellen, sind wir am abklären.
1697 Wenn dies möglich ist, werden wir in Zukunft auch eine odt-Vorlage für Pflichtenhefte
1698 in diesem Vorlagensatz zur Verfügung stellen.
1701 Fehlermeldungen, Anregungen und Wünsche bitte senden an:
1702 empfang@revamp-it.ch
1707 <sect2 id="allgemeine-hinweise-zu-latex">
1708 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
1709 <para>In den allermeisten Installationen sollte das Drucken jetzt schon
1710 funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
1711 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeile,
1712 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1717 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1718 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1719 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1723 <para>! Package inputenc Error: Unicode char \u8:... set up for
1724 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1725 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1726 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1727 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1728 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1732 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des Templates,
1733 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1734 Prüfen Sie den Namen in der Konfiguration (Standard:
1735 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1736 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1739 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser verifizieren lässt:</para>
1742 <para> editiere [kivitendo-home]/config/kivitendo.conf und ändere "keep_temp_files" auf 1</para>
1743 <para><programlisting>keep_temp_files = 1;</programlisting></para>
1746 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
1749 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
1752 <para>wechsel in das users Verzeichnis von kivitendo</para>
1753 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
1756 <para>LaTeX Suchpfad anpassen:</para>
1757 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
1760 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf erstellt hat</para>
1761 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
1762 <para>Es sollte die letzte Datei ganz unten sein</para>
1765 <para>für besseren Hinweis auf Fehler texdatei nochmals übersetzen</para>
1766 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
1767 <para>in der *.tex datei nach dem Fehler suchen.</para>
1773 <sect1 id="OpenDocument-Vorlagen">
1774 <title>OpenDocument-Vorlagen</title>
1776 <para>kivitendo unterstützt die Verwendung von Vorlagen im
1777 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1778 kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1779 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1780 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1781 <filename>config/kivitendo.conf</filename> die Variable
1782 <literal>opendocument</literal> im Abschnitt
1783 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1784 Dieses ist die Standardeinstellung.</para>
1786 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1787 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1788 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1789 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1790 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1791 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1793 <para>Nach der Installation müssen in der Datei
1794 <filename>config/kivitendo.conf</filename> zwei weitere Variablen
1795 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1796 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1797 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1798 enthalten. Beide stehen im Abschnitt
1799 <literal>applications</literal>.</para>
1801 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
1802 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1803 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1804 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1805 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1806 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1807 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1808 werden muss. Der Nachteil ist, dass diese Methode Python und die
1809 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1814 Für die Verbindung zu OpenOffice wird normalerweise der Python-Interpreter <filename>/usr/bin/python</filename> benutzt. Sollte
1815 dies nicht der richtige sein, so kann man mit zwei Konfigurationsvariablen entscheiden, welcher Python-Interpreter genutzt
1816 wird. Mit der Option <literal>python_uno</literal> aus dem Abschnitt <literal>applications</literal> wird der Interpreter selber
1817 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert <literal>/usr/bin/python</literal>.
1821 Zusätzlich ist es möglich, Pfade anzugeben, in denen Python neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
1822 z.B. falls sich diese in einem gesonderten OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
1823 <literal>python_uno_path</literal> und befindet sich im Abschnitt <literal>environment</literal>. Sie ist standardmäßig
1824 leer. Werden hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte voneinander getrennt werden. Der Inhalt wird an den
1825 Python-Interpreter über die Umgebungsvariable <literal>PYTHONPATH</literal> übergeben.
1829 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1830 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1831 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1832 Dokumentenvorlage enthalten sein und
1833 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1834 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1835 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1836 ebenfalls enthalten sein muss.</para>
1838 <para>Als letztes muss herausgefunden werden, welchen Namen
1839 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1840 gibt. Unter Debian ist dies momentan
1841 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1842 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1843 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1844 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1845 folgender Befehl auszuführen:</para>
1847 <para><literal>mv users/.openoffice.org2
1848 users/.openoffice</literal></para>
1850 <para>Dieses Verzeichnis, wie auch das komplette
1851 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1852 sein. Dieses wurde bereits erledigt (siehe <xref
1853 linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
1854 erneut überprüft werden, wenn die Konvertierung nach PDF
1858 <sect1 id="config.eur">
1859 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
1862 <sect2 id="config.eur.introduction"
1863 xreflabel="Einführung in die Konfiguration zur EUR">
1864 <title>Einführung</title>
1866 <para>kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1867 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals noch <filename>config/lx_office.conf</filename>)
1868 befand. Somit galt er für alle Mandanten, die in dieser Installation benutzt wurden.</para>
1870 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
1871 die Mandantendatenbank verschoben und dabei auch gleich in drei
1872 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
1873 steuern lässt.</para>
1876 <sect2 id="config.eur.parameters"
1877 xreflabel="Konfigurationsparameter für EUR">
1878 <title>Konfigurationsparameter</title>
1880 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
1881 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
1885 <term><varname>profit_determination</varname></term>
1888 <para>Dieser Parameter legt die Berechnungsmethode für die
1889 Gewinnermittlung fest. Er enthält entweder
1890 <literal>balance</literal> für
1891 Betriebsvermögensvergleich/Bilanzierung oder
1892 <literal>income</literal> für die
1893 Einnahmen-Überschuss-Rechnung.</para>
1898 <term><varname>accounting_method</varname></term>
1901 <para>Dieser Parameter steuert die Buchungs- und
1902 Berechnungsmethoden für die Versteuerungsart. Er enthält
1903 entweder <literal>accrual</literal> für die Soll-Versteuerung
1904 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
1909 <term><varname>inventory_system</varname></term>
1912 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
1913 enthält entweder <literal>perpetual</literal> für die
1914 Bestandsmethode oder <literal>periodic</literal> für die
1915 Aufwandsmethode.</para>
1920 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
1921 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1922 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
1923 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1924 Bestandsmethode.</para>
1926 <para>Die Konfiguration "<varname>eur</varname>" unter
1927 <varname>[system]</varname> in der <link
1928 linkend="config.config-file">Konfigurationsdatei</link>
1929 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
1930 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
1933 <sect2 id="config.eur.setting-parameters">
1934 <title>Festlegen der Parameter</title>
1936 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
1937 der Admininstration können diese Optionen nun unabhängig voneinander
1938 eingestellt werden.</para>
1940 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
1941 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1944 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
1945 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
1946 angezeigt. Unter <guimenu>System</guimenu>
1947 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> können
1948 die Einstellungen auch geändert werden. Dabei ist zu beachten,
1949 dass eine Änderung vorhandene Daten so belässt und damit
1950 evtl. die Ergebnisse verfälscht. Dies gilt vor Allem für die
1951 Warenbuchungsmethode (siehe auch
1952 <link linkend="config.eur.inventory-system-perpetual">
1953 Bemerkungen zur Bestandsmethode</link>).</para>
1956 <sect2 id="config.eur.inventory-system-perpetual">
1957 <title>Bemerkungen zur Bestandsmethode</title>
1959 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
1960 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
1961 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
1962 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
1963 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
1964 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
1965 Einkaufsrechnungen berechnet wird.</para>
1967 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
1968 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1969 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
1973 <sect2 id="config.eur.knonw-issues">
1974 <title>Bekannte Probleme</title>
1976 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
1977 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
1978 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
1979 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1980 die Konfigurationsvariable
1981 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
1984 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
1985 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
1989 <sect1 id="config.skr04-update-3804">
1990 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
1992 <sect2 id="config.skr04-update-3804.introduction">
1993 <title>Einführung</title>
1995 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
1996 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
1997 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
1998 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
1999 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
2000 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
2001 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
2002 vielleicht schon selbst geholfen hat und mit seinen Änderungen
2003 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
2004 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
2005 Screenshots dargestellt.</para>
2007 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
2008 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
2009 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
2010 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
2013 <sect2 id="config.skr04-update-3804.create-chart">
2014 <title>Konto 3804 manuell anlegen</title>
2016 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
2017 anzulegen und zu konfigurieren. Zuerst wird in
2018 <guimenu>System</guimenu> ->
2019 <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
2020 erfassen</guimenuitem> das Konto angelegt.</para>
2023 <screeninfo>Konto 3804 erfassen</screeninfo>
2027 <imagedata fileref="images/skr04-update-3804/konto3804.png" />
2033 Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
2034 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
2035 wie im folgenden Screenshot angezeigt anpassen.
2039 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
2043 <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
2049 Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
2050 <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
2054 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
2058 <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
2064 Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
2065 Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
2066 müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
2067 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
2071 <screeninfo>Konto 4315 anpassen</screeninfo>
2075 <imagedata fileref="images/skr04-update-3804/konto4315.png" />
2081 Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
2082 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
2086 <screeninfo>Steuerliste vergleichen</screeninfo>
2090 <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
2097 <title>Verhalten des Bilanzberichts</title>
2099 Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als Grundlage für das
2100 Startdatum benutzt. Schließt man die Bücher allerdings monatsweise führt dies
2101 zu falschen Werten.</para>
2102 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau einstellen indem man:</para>
2105 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu vorher)</para>
2108 <para>immer den Jahresanfang nimmt (1.1. relativ zum Stichtag)</para>
2111 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
2112 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen gibt</para>
2113 <para>- oder mit "alle Buchungen" als Alternative"</para>
2116 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen gibt </para>
2119 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
2123 Folgende Hinweise zu den Optionen:
2124 Das "Bücher schließen Datum" ist sinnvoll, wenn man nur komplette Jahre
2125 schließt. Bei Wirtschaftsjahr = Kalendarjahr entspricht dies aber auch
2127 "Alle Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
2129 Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B. sinnvoll, wenn man
2130 am sich Anfang des zweiten Buchungsjahres befindet, und noch keinen
2131 Jahreswechsel und auch noch keine EB-Buchungen hat.
2132 Bei den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1. Tag
2133 des Wirtschaftsjahres gebucht werden.
2134 Zur Sicherheit wird das Startdatum im Bilanzbericht jetzt zusätzlich zum
2135 Stichtag mit angezeigt. Das hilft auch bei der Kontrolle für den
2136 Abgleich mit der GuV.
2139 <sect1 id="config.client">
2140 <title>Einstellungen pro Mandant</title>
2142 <para>Einige Einstellungen können von einem Benutzer mit dem
2143 <link linkend="Zusammenhänge">Recht</link> "Administration
2144 (Für die Verwaltung der aktuellen Instanz aus einem Userlogin heraus)"
2145 gemacht werden. Diese Einstellungen sind dann für die aktuellen
2146 Mandanten-Datenbank gültig. Die Einstellungen sind
2147 unter <guimenu>System</guimenu>
2148 -> <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
2150 <para>Bitte beachten Sie die Hinweise zu den einzelnen
2151 Einstellungen. Einige Einstellungen sollten nicht ohne Weiteres
2152 im laufenden Betrieb geändert werden (siehe
2153 auch <link linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
2154 Bestandsmethode</link>).</para>
2156 <para>Die Einstellungen <literal>show_bestbefore</literal>
2157 und <literal>payments_changeable</literal> aus dem
2158 Abschnitt <literal>features</literal> und die Einstellungen im
2159 Abschnitt <literal>datev_check</literal> (sofern schon vorhanden)
2160 der <link linkend="config.config-file">kivitendo-Konfigurationsdatei</link>
2161 werden bei einem Datenbankupdate einer älteren Version automatisch
2162 übernommen. Diese Einträge können danach aus der Konfigurationsdatei
2163 entfernt werden.</para>
2166 <sect1 id="kivitendo-ERP-verwenden">
2167 <title>kivitendo ERP verwenden</title>
2169 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
2170 folgender URL erreichbar:</para>
2173 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
2175 <para>Die Administrationsseite erreichen Sie unter:</para>
2178 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
2182 <chapter id="features" xreflabel="Features und Funktionen">
2183 <title>Features und Funktionen</title>
2185 <sect1 id="features.periodic-invoices"
2186 xreflabel="Wiederkehrende Rechnungen">
2187 <title>Wiederkehrende Rechnungen</title>
2189 <sect2 id="features.periodic-invoices.introduction"
2190 xreflabel="Einführung in wiederkehrende Rechnungen">
2191 <title>Einführung</title>
2193 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
2194 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
2195 Die konfigurierten Aufträge werden später automatisch in Rechnungen
2196 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
2197 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
2198 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
2199 wiederzufinden sind.</para>
2202 <sect2 id="features.periodic-invoices.configuration"
2203 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
2204 <title>Konfiguration</title>
2206 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
2207 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
2208 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
2209 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
2210 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
2213 <para>Folgende Parameter kann man konfigurieren:</para>
2220 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
2221 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang eines
2222 neuen Monats).</para>
2224 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
2225 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
2226 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
2227 nächsten Periodenwechsel für alle Perioden, seit der letzten
2228 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
2229 verhindern, muss man vorher das Startdatum neu setzen.</para>
2231 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
2232 erstellt. Man kann sich diese Aufträge aber gesondert in den
2233 Berichten anzeigen lassen.</para>
2238 <term>Periodizität</term>
2241 <para>Ob monatlich, quartalsweise oder jährlich auf neue
2242 Rechnungen überprüft werden soll. Für jede Periode seit dem
2243 Startdatum wird überprüft, ob für die Periode (beginnend immer
2244 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
2245 wurde. Unter Umständen können bei einem Startdatum in der
2246 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
2251 <term>Buchen auf</term>
2254 <para>Das Forderungskonto, in der Regel "Forderungen aus
2255 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
2256 Buchungsgruppen der betreffenden Waren.</para>
2261 <term>Startdatum</term>
2264 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
2270 <term>Enddatum</term>
2273 <para>ab wann keine Rechnungen mehr erstellt werden
2279 <term>Automatische Verlängerung um x Monate</term>
2282 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
2283 eingetragenen Enddatums weiterhin erstellt werden, so kann man
2284 hier die Anzahl der Monate eingeben, um die das Enddatum
2285 automatisch nach hinten geschoben wird.</para>
2290 <term>Drucken</term>
2293 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
2294 Rechnungen auch gleich ausdrucken lassen.</para>
2299 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
2300 Informationen zu den erstellten Rechnungen verschickt werden.
2301 Konfiguriert wird dies in der <link
2302 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
2303 <filename>config/kivitendo.conf</filename> im Abschnitt
2304 <varname>[periodic_invoices]</varname>.</para>
2307 <sect2 id="features.periodic-invoices.variables">
2308 <title>Spezielle Variablen</title>
2311 Um die erzeugten Rechnungen individualisieren zu können, werden beim Umwandeln des Auftrags in eine Rechnung einige speziell
2312 formatierte Variablen durch für die jeweils aktuelle Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B. den
2313 Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei die Syntax <literal><%variablenname%></literal>.
2317 Sofern es sich um eine Datumsvariable handelt, kann das Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
2318 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus: <literal><%variablenname
2319 FORMAT=Formatinformation%></literal>. Die zur verfügung stehenden Formatinformationen werden unten genauer beschrieben.
2323 Diese Variablen werden in den folgenden Elementen des Auftrags ersetzt:
2327 <listitem><para>Bemerkungen</para></listitem>
2328 <listitem><para>Interne Bemerkungen</para></listitem>
2329 <listitem><para>Vorgangsbezeichnung</para></listitem>
2330 <listitem><para>In den Beschreibungs- und Langtextfeldern aller Positionen</para></listitem>
2333 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
2337 <term><varname><%current_quarter%></varname>, <varname><%previous_quarter%></varname>, <varname><%next_quarter%></varname></term>
2341 Aktuelles, vorheriges und nächstes Quartal als Zahl zwischen <literal>1</literal> und <literal>4</literal>.
2347 <term><varname><%current_month%></varname>, <varname><%previous_month%></varname>, <varname><%next_month%></varname></term>
2351 Aktueller, vorheriger und nächster Monat als Zahl zwischen <literal>1</literal> und <literal>12</literal>.
2357 <term><varname><%current_month_long%></varname>, <varname><%previous_month_long%></varname>, <varname><%next_month_long%></varname></term>
2361 Aktueller, vorheriger und nächster Monat als Name (<literal>Januar</literal>, <literal>Februar</literal> etc.).
2367 <term><varname><%current_year%></varname>, <varname><%previous_year%></varname>, <varname><%next_year%></varname></term>
2371 Aktuelles, vorheriges und nächstes Jahr als vierstellige Jahreszahl (<literal>2013</literal> etc.).
2377 <term><varname><%period_start_date%></varname>, <varname><%period_end_date%></varname></term>
2381 Formatiertes Datum des ersten und letzten Tages im Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im ersten
2382 Quartal von 2013 wären dies der <literal>01.01.2013</literal> und <literal>31.03.2013</literal>).
2389 Die invidiuellen Formatinformationen bestehen aus Paaren von Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
2390 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal> durch das viertstellige Jahr ersetzt. Alle möglichen
2397 <term><varname>%a</varname></term>
2400 <para>Der abgekürzte Wochentagsname.</para>
2405 <term><varname>%A</varname></term>
2408 <para>Der ausgeschriebene Wochentagsname.</para>
2413 <term><varname>%b</varname></term>
2416 <para>Der abgekürzte Monatsname.</para>
2421 <term><varname>%B</varname></term>
2424 <para>Der ausgeschriebene Monatsname.</para>
2429 <term><varname>%C</varname></term>
2432 <para>Das Jahrhundert (Jahr/100) als eine zweistellige Zahl.</para>
2437 <term><varname>%d</varname></term>
2440 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
2445 <term><varname>%D</varname></term>
2448 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
2453 <term><varname>%e</varname></term>
2456 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings werden führende Nullen durch Leerzeichen ersetzt.</para>
2461 <term><varname>%F</varname></term>
2464 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
2469 <term><varname>%j</varname></term>
2472 <para>Der Tag im Jahr als Zahl zwischen 001 und 366 inklusive.</para>
2477 <term><varname>%m</varname></term>
2480 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
2485 <term><varname>%u</varname></term>
2488 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei die 1 dem Montag entspricht.</para>
2493 <term><varname>%U</varname></term>
2496 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive, wobei der erste Sonntag im Jahr das Startdatum von Woche 01 ist.</para>
2501 <term><varname>%V</varname></term>
2504 <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>
2509 <term><varname>%w</varname></term>
2512 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei die 0 dem Sonntag entspricht.</para>
2517 <term><varname>%W</varname></term>
2520 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive, wobei der erste Montag im Jahr das Startdatum von Woche 01 ist.</para>
2525 <term><varname>%y</varname></term>
2528 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99 inklusive.</para>
2533 <term><varname>%Y</varname></term>
2536 <para>Das Jahr als vierstellige Zahl.</para>
2541 <term><varname>%%</varname></term>
2544 <para>Das Prozentzeichen selber.</para>
2550 Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode
2551 dauert: <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%> bis <%period_end_date FORMAT=%m/%Y%></literal>
2555 <sect2 id="features.periodic-invoices.reports">
2556 <title>Auflisten</title>
2558 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
2559 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
2560 Rechnungen inaktiv", mit denen man sich einen Überglick über die
2561 wiederkehrenden Rechnungen verschaffen kann.</para>
2564 <sect2 id="features.periodic-invoices.task-server">
2565 <title>Erzeugung der eigentlichen Rechnungen</title>
2567 <para>Die zeitliche und periodische Überprüfung, ob eine
2568 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
2569 durch den <link linkend="config.task-server">Taskserver</link>, einen
2570 externen Dienst, der automatisch beim Start des Servers gestartet
2571 werden sollte.</para>
2574 <sect2 id="features.periodic-invoices.create-for-current-month">
2575 <title>Erste Rechnung für aktuellen Monat erstellen</title>
2577 <para>Will man im laufenden Monat eine monatlich wiederkehrende
2578 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
2579 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
2580 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
2581 generiert hat. Alternativ setzt man das Startdatum auf den
2582 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
2583 manuell über den Workflow.</para>
2586 <sect1 id="features.bank"
2587 xreflabel="bankerweiterung">
2588 <title>Bankerweiterung</title>
2590 <sect2 id="features.bank.introduction"
2591 xreflabel="Einführung in die Bankerweiterung">
2592 <title>Einführung</title>
2594 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch im Wiki und soll von dort später hierhin übernommen werden:</para>
2597 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
2600 <sect1 id="dokumentenvorlagen-und-variablen">
2601 <title>Dokumentenvorlagen und verfügbare Variablen</title>
2603 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
2604 <title>Einführung</title>
2606 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
2607 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
2608 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
2609 <function><%variablenname%></function> verwendet wird. Für
2610 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
2612 linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
2614 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
2615 unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
2616 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
2617 alle Vorlagenarten.</para>
2619 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
2620 verfügbar als hier aufgelistet werden. Die meisten davon können
2621 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
2622 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
2623 diese wie folgt erhalten werden:</para>
2627 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
2628 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
2632 <para>In <filename>Form.pm</filename> die Funktion
2633 <function>parse_template</function> suchen und hier die Zeile
2634 <command>print(STDERR Dumper($self));</command> einfügen.</para>
2638 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
2639 ein PDF für eine Rechnung erzeugen.</para>
2643 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
2644 der Variablen <varname>$self</varname> in der Form <varname>'key'
2645 => 'value',</varname>. Alle <varname>key</varname>s sind
2651 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
2652 <title>Variablen ausgeben</title>
2654 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
2655 Tags geschrieben werden, also z.B.
2656 <varname><%variablenname%></varname>.</para>
2658 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
2659 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
2660 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
2661 werden die folgenden Flags unterstützt:</para>
2665 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
2666 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
2667 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
2668 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
2672 <para><option>NOESCAPE</option> unterdrückt das Escapen von
2673 Sonderzeichen für die Vorlagensprache. Wenn also in einer
2674 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
2675 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
2676 ist dieses Flag sinnvoll.</para>
2680 <para>Beispiel:</para>
2682 <programlisting><%quototal NOFORMAT%></programlisting>
2685 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
2686 <title>Verwendung in Druckbefehlen</title>
2688 <para>In der Admininstration können Drucker definiert werden. Auch im
2689 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
2690 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
2691 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
2692 <function>`...`</function> nicht zu unerwünschtem Verhalten
2695 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
2696 für das die Telefonnummer eines Ansprechpartners als Teil der
2697 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
2698 z.B. wie folgt aussehen:</para>
2700 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
2703 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
2704 xreflabel="Anfang und Ende der Tags verändern">
2705 <title>Anfang und Ende der Tags verändern</title>
2707 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
2708 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
2709 Prozentzeichen und dem Größerzeichen endet, beispielsweise
2710 <function><%customer%></function>. Da diese Form aber z.B. in
2711 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
2712 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
2713 Stil umgestellt werden.</para>
2715 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
2716 Format gültigen Kommentarzeichen anfangen, dann
2717 <function>config:</function> enthalten, die entsprechende Option
2718 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
2719 enden. Beispiel für LaTeX:</para>
2721 <programlisting>% config: tag-style=($ $)</programlisting>
2723 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
2724 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
2725 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
2727 <programlisting><!-- config: tag-style=($ $) --></programlisting>
2730 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
2731 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
2733 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
2734 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
2735 "<filename>.ext</filename>" geeignet zu ersetzen:
2736 "<filename>.tex</filename>" für LaTeX-Vorlagen und
2737 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
2741 <term><filename>bin_list.ext</filename></term>
2744 <para>Lagerliste</para>
2749 <term><filename>check.ext</filename></term>
2757 <term><filename>invoice.ext</filename></term>
2760 <para>Rechnung</para>
2765 <term><filename>packing_list.ext</filename></term>
2768 <para>Packliste</para>
2773 <term><filename>pick_list.ext</filename></term>
2776 <para>Sammelliste</para>
2781 <term><filename>purchase_delivery_order.ext</filename></term>
2784 <para>Lieferschein (Einkauf)</para>
2789 <term><filename>purcharse_order.ext</filename></term>
2792 <para>Bestellung an Lieferanten</para>
2797 <term><filename>request_quotation.ext</filename></term>
2800 <para>Anfrage an Lieferanten</para>
2805 <term><filename>sales_delivery_order.ext</filename></term>
2808 <para>Lieferschein (Verkauf)</para>
2813 <term><filename>sales_order.ext</filename></term>
2816 <para>Bestellung</para>
2821 <term><filename>sales_quotation.ext</filename></term>
2824 <para>Angebot an Kunden</para>
2829 <term><filename>zahlungserinnerung.ext</filename></term>
2832 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
2837 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
2840 <para>Rechnung über Mahngebühren (Dateiname im Programm
2841 konfigurierbar)</para>
2847 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
2848 <title>Sprache, Drucker und E-Mail</title>
2850 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
2851 eingearbeitet. So wird aus der Vorlage
2852 <filename>sales_order.ext</filename> bei Sprache
2853 <function>de</function> und Druckerkürzel <function>lpr2</function>
2854 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
2855 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
2856 bekommen dann noch das Kürzel <filename>_email</filename>, der
2857 vollständige Vorlagenname wäre dann
2858 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
2859 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
2860 werden. Diese wird verwendet, wenn keine der anderen Varianten
2861 gefunden wird.</para>
2863 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
2864 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
2865 verschickt wird, ist:</para>
2869 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
2873 <para><filename>sales_order_de_lpr2.tex</filename></para>
2877 <para><filename>sales_order.tex</filename></para>
2881 <para><filename>default.tex</filename></para>
2885 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
2886 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
2888 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
2891 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
2892 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
2895 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
2896 xreflabel="Metainformationen zur angeforderten Vorlage">
2897 <title>Metainformationen zur angeforderten Vorlage</title>
2899 <para>Diese Variablen liefern Informationen darüber welche Variante
2900 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
2901 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
2902 Formulare einbinden möchten.</para>
2906 <term><varname>template_meta.formname</varname></term>
2909 <para>Basisname der Vorlage. Identisch mit der <link
2910 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
2911 zu den Dateinamen</link> ohne die Erweiterung. Ein
2912 Verkaufsauftrag enthält hier
2913 <constant>sales_order</constant>.</para>
2918 <term><varname>template_meta.language.description</varname></term>
2921 <para>Beschreibung der verwendeten Sprache</para>
2926 <term><varname>template_meta.language.template_code</varname></term>
2929 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
2930 Kürzel das im Dateinamen verwendetet wird.</para>
2935 <term><varname>template_meta.language.output_numberformat</varname></term>
2938 <para>Zahlenformat der verwendeten Sprache in der Form
2939 "<constant>1.000,00</constant>". Experimentell! Nur
2940 interessant für Vorlagen die mit unformatierten Werten
2946 <term><varname>template_meta.language.output_dateformat</varname></term>
2949 <para>Datumsformat der verwendeten Sprache in der Form
2950 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
2951 interessant für Vorlagen die mit unformatierten Werten
2957 <term><varname>template_meta.format</varname></term>
2960 <para>Das angeforderte Format. Kann im Moment die Werte
2961 <constant>pdf</constant>, <constant>postscript</constant>,
2962 <constant>html</constant>, <constant>opendocument</constant>,
2963 <constant>opendocument_pdf</constant> und
2964 <constant>excel</constant> enthalten.</para>
2969 <term><varname>template_meta.extension</varname></term>
2972 <para>Dateierweiterung, wie im Dateinamen. Wird aus
2973 <constant>format</constant> entschieden.</para>
2978 <term><varname>template_meta.media</varname></term>
2981 <para>Ausgabemedium. Kann zur Zeit die Werte
2982 <constant>screen</constant> für Bildschirm,
2983 <constant>email</constant> für E-Mail (triggert das
2984 <constant>_email</constant> Kürzel im Dateinamen),
2985 <constant>printer</constant> für Drucker, und
2986 <constant>queue</constant> für Warteschlange enthalten.</para>
2991 <term><varname>template_meta.printer.description</varname></term>
2994 <para>Beschreibung des ausgewählten Druckers</para>
2999 <term><varname>template_meta.printer.template_code</varname></term>
3002 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
3003 dem Kürzel das im Dateinamen verwendetet wird.</para>
3008 <term><varname>template_meta.tmpfile</varname></term>
3011 <para>Datei-Prefix für temporäre Dateien.</para>
3017 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
3018 <title>Stammdaten von Kunden und Lieferanten</title>
3022 <term><varname>account_number</varname></term>
3025 <para>Kontonummer</para>
3030 <term><varname>bank</varname></term>
3033 <para>Name der Bank</para>
3038 <term><varname>bank_code</varname></term>
3041 <para>Bankleitzahl</para>
3046 <term><varname>bic</varname></term>
3049 <para>Bank-Identifikations-Code (Bank Identifier Code,
3055 <term><varname>business</varname></term>
3058 <para>Kunden-/Lieferantentyp</para>
3063 <term><varname>city</varname></term>
3071 <term><varname>contact</varname></term>
3074 <para>Kontakt</para>
3079 <term><varname>country</varname></term>
3087 <term><varname>c_vendor_id</varname></term>
3090 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
3095 <term><varname>v_customer_id</varname></term>
3098 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
3103 <term><varname>cp_email</varname></term>
3106 <para>Email des Ansprechpartners</para>
3111 <term><varname>cp_givenname</varname></term>
3114 <para>Vorname des Ansprechpartners</para>
3119 <term><varname>cp_greeting</varname></term>
3122 <para>Anrede des Ansprechpartners</para>
3127 <term><varname>cp_name</varname></term>
3130 <para>Name des Ansprechpartners</para>
3135 <term><varname>cp_phone1</varname></term>
3138 <para>Telefonnummer 1 des Ansprechpartners</para>
3143 <term><varname>cp_phone2</varname></term>
3146 <para>Telefonnummer 2 des Ansprechpartners</para>
3151 <term><varname>cp_title</varname></term>
3154 <para>Titel des Ansprechpartners</para>
3159 <term><varname>creditlimit</varname></term>
3162 <para>Kreditlimit</para>
3167 <term><varname>customeremail</varname></term>
3170 <para>Email des Kunden; nur für Kunden</para>
3175 <term><varname>customerfax</varname></term>
3178 <para>Faxnummer des Kunden; nur für Kunden</para>
3183 <term><varname>customernotes</varname></term>
3186 <para>Bemerkungen beim Kunden; nur für Kunden</para>
3191 <term><varname>customernumber</varname></term>
3194 <para>Kundennummer; nur für Kunden</para>
3199 <term><varname>customerphone</varname></term>
3202 <para>Telefonnummer des Kunden; nur für Kunden</para>
3207 <term><varname>discount</varname></term>
3215 <term><varname>email</varname></term>
3218 <para>Emailadresse</para>
3223 <term><varname>fax</varname></term>
3226 <para>Faxnummer</para>
3231 <term><varname>greeting</varname></term>
3239 <term><varname>homepage</varname></term>
3242 <para>Homepage</para>
3247 <term><varname>iban</varname></term>
3250 <para>Internationale Kontonummer (International Bank Account
3251 Number, IBAN)</para>
3256 <term><varname>language</varname></term>
3259 <para>Sprache</para>
3264 <term><varname>name</varname></term>
3267 <para>Firmenname</para>
3272 <term><varname>payment_description</varname></term>
3275 <para>Name der Zahlart</para>
3280 <term><varname>payment_terms</varname></term>
3283 <para>Zahlungskonditionen</para>
3288 <term><varname>phone</varname></term>
3291 <para>Telefonnummer</para>
3296 <term><varname>shiptocity</varname></term>
3299 <para>Stadt (Lieferadresse) <link
3300 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3305 <term><varname>shiptocontact</varname></term>
3308 <para>Kontakt (Lieferadresse) <link
3309 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3314 <term><varname>shiptocountry</varname></term>
3317 <para>Land (Lieferadresse) <link
3318 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3323 <term><varname>shiptodepartment1</varname></term>
3326 <para>Abteilung 1 (Lieferadresse) <link
3327 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3332 <term><varname>shiptodepartment2</varname></term>
3335 <para>Abteilung 2 (Lieferadresse) <link
3336 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3341 <term><varname>shiptoemail</varname></term>
3344 <para>Email (Lieferadresse) <link
3345 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3350 <term><varname>shiptofax</varname></term>
3353 <para>Fax (Lieferadresse) <link
3354 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3359 <term><varname>shiptoname</varname></term>
3362 <para>Firmenname (Lieferadresse) <link
3363 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3368 <term><varname>shiptophone</varname></term>
3371 <para>Telefonnummer (Lieferadresse) <link
3372 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3377 <term><varname>shiptostreet</varname></term>
3380 <para>Straße und Hausnummer (Lieferadresse) <link
3381 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3386 <term><varname>shiptozipcode</varname></term>
3389 <para>Postleitzahl (Lieferadresse) <link
3390 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
3395 <term><varname>street</varname></term>
3398 <para>Straße und Hausnummer</para>
3403 <term><varname>taxnumber</varname></term>
3406 <para>Steuernummer</para>
3411 <term><varname>ustid</varname></term>
3414 <para>Umsatzsteuer-Identifikationsnummer</para>
3419 <term><varname>vendoremail</varname></term>
3422 <para>Email des Lieferanten; nur für Lieferanten</para>
3427 <term><varname>vendorfax</varname></term>
3430 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
3435 <term><varname>vendornotes</varname></term>
3438 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
3443 <term><varname>vendornumber</varname></term>
3446 <para>Lieferantennummer; nur für Lieferanten</para>
3451 <term><varname>vendorphone</varname></term>
3454 <para>Telefonnummer des Lieferanten; nur für
3460 <term><varname>zipcode</varname></term>
3463 <para>Postleitzahl</para>
3468 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
3469 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
3470 Stammdaten nicht eingetragen, so haben die Variablen
3471 <varname>shipto*</varname> den gleichen Wert wie die die
3472 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
3473 einige <varname>shipto*</varname>-Variablen so nicht in den
3474 Stammdaten wiederfinden sondern schlicht Kopien der
3475 Lieferdatenvariablen sind (z.B.
3476 <varname>shiptocontact</varname>).</para>
3480 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
3481 <title>Informationen über den Bearbeiter</title>
3485 <term><varname>employee_address</varname></term>
3488 <para>Adressfeld</para>
3493 <term><varname>employee_businessnumber</varname></term>
3496 <para>Firmennummer</para>
3501 <term><varname>employee_company</varname></term>
3504 <para>Firmenname</para>
3509 <term><varname>employee_co_ustid</varname></term>
3512 <para>Usatzsteuer-Identifikationsnummer</para>
3517 <term><varname>employee_duns</varname></term>
3520 <para>DUNS-Nummer</para>
3525 <term><varname>employee_email</varname></term>
3533 <term><varname>employee_fax</varname></term>
3541 <term><varname>employee_name</varname></term>
3544 <para>voller Name</para>
3549 <term><varname>employee_signature</varname></term>
3552 <para>Signatur</para>
3557 <term><varname>employee_taxnumber</varname></term>
3560 <para>Steuernummer</para>
3565 <term><varname>employee_tel</varname></term>
3568 <para>Telefonnummer</para>
3574 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
3575 <title>Informationen über den Verkäufer</title>
3579 <term><varname>salesman_address</varname></term>
3582 <para>Adressfeld</para>
3587 <term><varname>salesman_businessnumber</varname></term>
3590 <para>Firmennummer</para>
3595 <term><varname>salesman_company</varname></term>
3598 <para>Firmenname</para>
3603 <term><varname>salesman_co_ustid</varname></term>
3606 <para>Usatzsteuer-Identifikationsnummer</para>
3611 <term><varname>salesman_duns</varname></term>
3614 <para>DUNS-Nummer</para>
3619 <term><varname>salesman_email</varname></term>
3627 <term><varname>salesman_fax</varname></term>
3635 <term><varname>salesman_name</varname></term>
3638 <para>voller Name</para>
3643 <term><varname>salesman_signature</varname></term>
3646 <para>Signatur</para>
3651 <term><varname>salesman_taxnumber</varname></term>
3654 <para>Steuernummer</para>
3659 <term><varname>salesman_tel</varname></term>
3662 <para>Telefonnummer</para>
3668 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
3669 <title>Variablen für die einzelnen Steuern</title>
3673 <term><varname>tax</varname></term>
3681 <term><varname>taxbase</varname></term>
3684 <para>zu versteuernder Betrag</para>
3689 <term><varname>taxdescription</varname></term>
3692 <para>Name der Steuer</para>
3697 <term><varname>taxrate</varname></term>
3700 <para>Steuersatz</para>
3706 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
3707 <title>Variablen für Lieferbedingungen</title>
3711 <term><varname>delivery_term</varname></term>
3712 <listitem><para>Datenbank-Objekt der Lieferbedingung</para></listitem>
3715 <term><varname>delivery_term.description</varname></term>
3716 <listitem><para>Beschreibung der Lieferbedingung</para></listitem>
3719 <term><varname>delivery_term.description_long</varname></term>
3720 <listitem><para>Langtext bzw. übersetzter Langtext der Lieferbedingung</para></listitem>
3726 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
3727 <title>Variablen in Rechnungen</title>
3729 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
3730 <title>Allgemeine Variablen</title>
3734 <term><varname>creditremaining</varname></term>
3737 <para>Verbleibender Kredit</para>
3742 <term><varname>currency</varname></term>
3745 <para>Währung</para>
3750 <term><varname>cusordnumber</varname></term>
3753 <para>Bestellnummer beim Kunden</para>
3758 <term><varname>deliverydate</varname></term>
3761 <para>Lieferdatum</para>
3766 <term><varname>duedate</varname></term>
3769 <para>Fälligkeitsdatum</para>
3774 <term><varname>globalprojectnumber</varname></term>
3777 <para>Projektnummer des ganzen Beleges</para>
3782 <term><varname>globalprojectdescription</varname></term>
3785 <para>Projekbeschreibung des ganzen Beleges</para>
3790 <term><varname>intnotes</varname></term>
3793 <para>Interne Bemerkungen</para>
3798 <term><varname>invdate</varname></term>
3801 <para>Rechnungsdatum</para>
3806 <term><varname>invnumber</varname></term>
3809 <para>Rechnungsnummer</para>
3814 <term><varname>invtotal</varname></term>
3817 <para>gesamter Rechnungsbetrag</para>
3822 <term><varname>notes</varname></term>
3825 <para>Bemerkungen der Rechnung</para>
3830 <term><varname>orddate</varname></term>
3833 <para>Auftragsdatum</para>
3838 <term><varname>ordnumber</varname></term>
3841 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
3842 erstellt wurde</para>
3847 <term><varname>payment_description</varname></term>
3850 <para>Name der Zahlart</para>
3855 <term><varname>payment_terms</varname></term>
3858 <para>Zahlungskonditionen</para>
3863 <term><varname>quodate</varname></term>
3866 <para>Angebotsdatum</para>
3871 <term><varname>quonumber</varname></term>
3874 <para>Angebotsnummer</para>
3879 <term><varname>shippingpoint</varname></term>
3882 <para>Versandort</para>
3887 <term><varname>shipvia</varname></term>
3890 <para>Transportmittel</para>
3895 <term><varname>subtotal</varname></term>
3898 <para>Zwischensumme aller Posten ohne Steuern</para>
3903 <term><varname>total</varname></term>
3906 <para>Restsumme der Rechnung (Summe abzüglich bereits
3907 bezahlter Posten)</para>
3912 <term><varname>transaction_description</varname></term>
3915 <para>Vorgangsbezeichnung</para>
3920 <term><varname>transdate</varname></term>
3923 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
3924 erstellt wurde</para>
3930 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
3931 <title>Variablen für jeden Posten auf der Rechnung</title>
3935 <term><varname>bin</varname></term>
3938 <para>Stellage</para>
3943 <term><varname>description</varname></term>
3946 <para>Artikelbeschreibung</para>
3951 <term><varname>cusordnumber_oe</varname></term>
3954 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der Posten ursprünglich stammt (nur Verkauf)</para>
3959 <term><varname>discount</varname></term>
3962 <para>Rabatt als Betrag</para>
3967 <term><varname>discount_sub</varname></term>
3970 <para>Zwischensumme mit Rabatt</para>
3975 <term><varname>donumber_do</varname></term>
3978 <para>Lieferscheinnummer des Lieferscheins, aus dem die Position ursprünglich stammt, wenn die Rechnung im Rahmen des Workflows aus einem Lieferschein erstellt wurde.</para>
3983 <term><varname>drawing</varname></term>
3986 <para>Zeichnung</para>
3991 <term><varname>ean</varname></term>
3994 <para>EAN-Code</para>
3999 <term><varname>image</varname></term>
4007 <term><varname>linetotal</varname></term>
4010 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
4015 <term><varname>longdescription</varname></term>
4018 <para>Langtext</para>
4023 <term><varname>microfiche</varname></term>
4026 <para>Mikrofilm</para>
4031 <term><varname>netprice</varname></term>
4034 <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>
4039 <term><varname>nodiscount_linetotal</varname></term>
4042 <para>Zeilensumme ohne Rabatt</para>
4047 <term><varname>nodiscount_sub</varname></term>
4050 <para>Zwischensumme ohne Rabatt</para>
4055 <term><varname>number</varname></term>
4058 <para>Artikelnummer</para>
4063 <term><varname>ordnumber_oe</varname></term>
4066 <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>
4071 <term><varname>p_discount</varname></term>
4074 <para>Rabatt in Prozent</para>
4079 <term><varname>partnotes</varname></term>
4082 <para>Die beim Artikel gespeicherten Bemerkungen</para>
4087 <term><varname>partsgroup</varname></term>
4090 <para>Warengruppe</para>
4095 <term><varname>price_factor</varname></term>
4098 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
4104 <term><varname>price_factor_name</varname></term>
4107 <para>Der Name des Preisfaktors, sofern einer eingestellt
4113 <term><varname>projectnumber</varname></term>
4116 <para>Projektnummer</para>
4121 <term><varname>projectdescription</varname></term>
4124 <para>Projektbeschreibung</para>
4129 <term><varname>qty</varname></term>
4137 <term><varname>reqdate</varname></term>
4140 <para>Lieferdatum</para>
4145 <term><varname>runningnumber</varname></term>
4148 <para>Position auf der Rechnung (1, 2, 3...)</para>
4153 <term><varname>sellprice</varname></term>
4156 <para>Verkaufspreis</para>
4161 <term><varname>serialnumber</varname></term>
4164 <para>Seriennummer</para>
4169 <term><varname>tax_rate</varname></term>
4172 <para>Steuersatz</para>
4177 <term><varname>transdate_do</varname></term>
4180 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des Workflows aus einem Lieferschein stammte.</para>
4185 <term><varname>transdate_oe</varname></term>
4188 <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>
4193 <term><varname>transdate_quo</varname></term>
4196 <para>Datum des Angebots, wenn die Position im Rahmen des Workflows aus einem Angebot stammte.</para>
4201 <term><varname>unit</varname></term>
4204 <para>Einheit</para>
4209 <term><varname>weight</varname></term>
4212 <para>Gewicht</para>
4217 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
4218 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
4219 einer <function>foreach</function>-Schleife ausgegeben werden, da
4220 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
4221 können. Die Variablen dafür lauten:</para>
4225 <term><varname>make</varname></term>
4228 <para>Lieferant</para>
4233 <term><varname>model</varname></term>
4236 <para>Lieferantenartikelnummer</para>
4242 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
4243 <title>Variablen für die einzelnen Zahlungseingänge</title>
4247 <term><varname>payment</varname></term>
4255 <term><varname>paymentaccount</varname></term>
4263 <term><varname>paymentdate</varname></term>
4271 <term><varname>paymentmemo</varname></term>
4279 <term><varname>paymentsource</varname></term>
4288 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
4289 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
4291 <para>Die vom Benutzer definierten Variablen für Kunden und
4292 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
4293 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
4294 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
4295 Variablennamen zusammen.</para>
4297 <para>Beispiel: Der Benutzer hat eine Variable namens
4298 <varname>number_of_employees</varname> definiert, die die Anzahl der
4299 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
4300 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
4305 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
4306 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
4308 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
4309 <title>Namen der Vorlagen</title>
4311 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
4312 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
4313 Erstellung einer Rechnung über die Mahngebühren und Zinsen
4314 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
4315 Vorlagenname für diese Mahnstufe mit dem Zusatz
4316 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
4317 für die ausgewählte Sprache und den ausgewählten Drucker
4321 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
4322 <title>Allgemeine Variablen in Mahnungen</title>
4324 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4325 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4326 Kunden stehen als Variablen <varname>name</varname>,
4327 <varname>street</varname>, <varname>zipcode</varname>,
4328 <varname>city</varname>, <varname>country</varname>,
4329 <varname>department_1</varname>, <varname>department_2</varname>,
4330 und <varname>email</varname> zur Verfügung.</para>
4332 <para>Weitere Variablen beinhalten:</para>
4336 <term><varname>dunning_date</varname></term>
4339 <para>Datum der Mahnung</para>
4344 <term><varname>dunning_duedate</varname></term>
4347 <para>Fälligkeitsdatum für diese Mahhnung</para>
4352 <term><varname>dunning_id</varname></term>
4355 <para>Mahnungsnummer</para>
4360 <term><varname>fee</varname></term>
4363 <para>Kummulative Mahngebühren</para>
4368 <term><varname>interest_rate</varname></term>
4371 <para>Zinssatz per anno in Prozent</para>
4376 <term><varname>total_amount</varname></term>
4379 <para>Gesamter noch zu zahlender Betrag als
4380 <function>fee</function> + <function>total_interest</function>
4381 + <function>total_open_amount</function></para>
4386 <term><varname>total_interest</varname></term>
4389 <para>Zinsen per anno über alle Rechnungen</para>
4394 <term><varname>total_open_amount</varname></term>
4397 <para>Summe über alle offene Beträge der Rechnungen</para>
4403 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
4404 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
4408 <term><varname>dn_amount</varname></term>
4411 <para>Rechnungssumme (brutto)</para>
4416 <term><varname>dn_duedate</varname></term>
4419 <para>Originales Fälligkeitsdatum der Rechnung</para>
4424 <term><varname>dn_dunning_date</varname></term>
4427 <para>Datum der Mahnung</para>
4432 <term><varname>dn_dunning_duedate</varname></term>
4435 <para>Fälligkeitsdatum der Mahnung</para>
4440 <term><varname>dn_fee</varname></term>
4443 <para>Kummulative Mahngebühr</para>
4448 <term><varname>dn_interest</varname></term>
4451 <para>Zinsen per anno für diese Rechnung</para>
4456 <term><varname>dn_invnumber</varname></term>
4459 <para>Rechnungsnummer</para>
4464 <term><varname>dn_linetotal</varname></term>
4467 <para>Noch zu zahlender Betrag (ergibt sich aus
4468 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
4469 + <varname>dn_interest</varname>)</para>
4474 <term><varname>dn_netamount</varname></term>
4477 <para>Rechnungssumme (netto)</para>
4482 <term><varname>dn_open_amount</varname></term>
4485 <para>Offener Rechnungsbetrag</para>
4490 <term><varname>dn_ordnumber</varname></term>
4493 <para>Bestellnummer</para>
4498 <term><varname>dn_transdate</varname></term>
4501 <para>Rechnungsdatum</para>
4506 <term><varname>dn_curr</varname></term>
4509 <para>Währung, in der die Rechnung erstellt wurde. (Die
4510 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
4516 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
4517 <title>Variablen in automatisch erzeugten Rechnungen über
4518 Mahngebühren</title>
4520 <para>Die Variablen des Verkäufers stehen wie gewohnt als
4521 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
4522 Kunden stehen als Variablen <varname>name</varname>,
4523 <varname>street</varname>, <varname>zipcode</varname>,
4524 <varname>city</varname>, <varname>country</varname>,
4525 <varname>department_1</varname>, <varname>department_2</varname>,
4526 und <varname>email</varname> zur Verfügung.</para>
4528 <para>Weitere Variablen beinhalten:</para>
4532 <term><varname>duedate</varname></term>
4535 <para>Fälligkeitsdatum der Rechnung</para>
4540 <term><varname>dunning_id</varname></term>
4543 <para>Mahnungsnummer</para>
4548 <term><varname>fee</varname></term>
4551 <para>Mahngebühren</para>
4556 <term><varname>interest</varname></term>
4564 <term><varname>invamount</varname></term>
4567 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
4568 <varname>interest</varname>)</para>
4573 <term><varname>invdate</varname></term>
4576 <para>Rechnungsdatum</para>
4581 <term><varname>invnumber</varname></term>
4584 <para>Rechnungsnummer</para>
4591 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
4592 <title>Variablen in anderen Vorlagen</title>
4595 <title>Einführung</title>
4597 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
4598 Rechnung. Allerdings heißen die Variablen, die mit
4599 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
4600 fangen sie mit <varname>quo</varname> für "quotation" an:
4601 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
4602 wiederum fangen sie mit <varname>ord</varname> für "order" an:
4603 <varname>ordnumber</varname> für Bestellnummer etc.</para>
4605 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
4606 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
4607 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
4608 Vorlage keine Bedeutung haben oder noch nicht belegt sein
4611 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
4612 in Rechnungen aufgeführt.</para>
4615 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
4616 <title>Angebote und Preisanfragen</title>
4620 <term><varname>quonumber</varname></term>
4623 <para>Angebots- bzw. Anfragenummer</para>
4628 <term><varname>reqdate</varname></term>
4631 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
4632 Preisanfragen)</para>
4637 <term><varname>transdate</varname></term>
4640 <para>Angebots- bzw. Anfragedatum</para>
4646 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
4647 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
4651 <term><varname>ordnumber</varname></term>
4654 <para>Auftragsnummer</para>
4659 <term><varname>reqdate</varname></term>
4662 <para>Lieferdatum</para>
4667 <term><varname>transdate</varname></term>
4670 <para>Auftragsdatum</para>
4676 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
4677 <title>Lieferscheine (Verkauf und Einkauf)</title>
4681 <term><varname>cusordnumber</varname></term>
4684 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
4685 des Lieferanten (im Einkauf)</para>
4690 <term><varname>donumber</varname></term>
4693 <para>Lieferscheinnummer</para>
4698 <term><varname>transdate</varname></term>
4701 <para>Lieferscheindatum</para>
4706 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
4707 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
4708 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
4709 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
4710 <function>foreach</function>-Schleife ausgegeben werden. Diese
4711 Variablen sind:</para>
4715 <term><varname>si_bin</varname></term>
4718 <para>Lagerplatz</para>
4723 <term><varname>si_chargenumber</varname></term>
4726 <para>Chargennummer</para>
4731 <term><varname>si_bestbefore</varname></term>
4734 <para>Mindesthaltbarkeit</para>
4739 <term><varname>si_number</varname></term>
4742 <para>Artikelnummer</para>
4747 <term><varname>si_qty</varname></term>
4750 <para>Anzahl bzw. Menge</para>
4755 <term><varname>si_runningnumber</varname></term>
4758 <para>Positionsnummer (1, 2, 3 etc)</para>
4763 <term><varname>si_unit</varname></term>
4766 <para>Einheit</para>
4771 <term><varname>si_warehouse</varname></term>
4780 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
4781 <title>Variablen für Sammelrechnung</title>
4785 <term><varname>c0total</varname></term>
4788 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
4794 <term><varname>c30total</varname></term>
4797 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
4798 und < 60 Tage</para>
4803 <term><varname>c60total</varname></term>
4806 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
4807 und < 90 Tage</para>
4812 <term><varname>c90total</varname></term>
4815 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
4821 <term><varname>total</varname></term>
4824 <para>Gesamtbetrag aller Rechnungen</para>
4829 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
4833 <term><varname>invnumber</varname></term>
4836 <para>Rechnungsnummer</para>
4841 <term><varname>invdate</varname></term>
4844 <para>Rechnungsdatum</para>
4849 <term><varname>duedate</varname></term>
4852 <para>Fälligkeitsdatum</para>
4857 <term><varname>amount</varname></term>
4860 <para>Summe der Rechnung</para>
4865 <term><varname>open</varname></term>
4868 <para>Noch offener Betrag der Rechnung</para>
4873 <term><varname>c0</varname></term>
4876 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
4882 <term><varname>c30</varname></term>
4885 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
4891 <term><varname>c60</varname></term>
4894 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
4900 <term><varname>c90</varname></term>
4903 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
4911 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
4912 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
4914 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
4915 <title>Einführung</title>
4917 <para>Der Parser kennt neben den Variablen einige weitere
4918 Konstrukte, die gesondert behandelt werden. Diese sind wie
4919 Variablennamen in spezieller Weise markiert:
4920 <command><%anweisung%> ... <%end%></command></para>
4922 <para>Anmerkung zum <command><%end%></command>: Der besseren
4923 Verständlichkeit halber kann man nach dem <command>end</command>
4924 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
4925 Anweisung (z.B. <command>if</command> oder
4926 <command>foreach</command>) damit abgeschlossen wird.</para>
4928 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
4929 <command><%if type == "sales_quotation"%></command>, so könnte
4930 er mit <command><%end%></command> genauso abgeschlossen werden
4931 wie mit <command><%end if%></command> oder auch
4932 <command><%end type == "sales_quotation"%></command>.</para>
4935 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
4936 <title>Der if-Block</title>
4938 <programlisting><%if variablenname%>
4940 <%end%></programlisting>
4942 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
4943 und dem "end" werden nur ausgegeben, wenn die Variable
4944 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
4946 <para>Handelt es sich bei der benannten Variable um ein Array, also um einen Variablennamen, über den man mit
4947 <command><%foreach variablenname%></command> iteriert, so wird mit diesem Konstrukt darauf getestet, ob das Array Elemente
4948 enthält. Somit würde im folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt ihrer Überschrift "Zahlungseingänge"
4949 ausgegeben, wenn tatsächlich welche getätigt wurden:</para>
4951 <programlisting><%if payment%>
4953 <%foreach payment%>
4954 Am <%paymentdate%>: <%payment%> €
4955 <%end foreach%>
4956 <%end if%></programlisting>
4958 <para>Die Bedingung kann auch negiert werden, indem das Wort
4959 <function>not</function> nach dem <filename>if</filename> verwendet
4960 wird. Beispiel:</para>
4962 <programlisting><%if not cp_greeting%>
4964 <%end%></programlisting>
4966 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
4967 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
4968 einer Variablen mit einer festen Zeichenkette oder einer anderen
4969 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
4970 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
4971 die rechte Seite des Vergleichsoperators in Anführungszeichen
4972 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
4973 anderer Variablen). Zwei Beispiele, die beide Vergleiche
4976 <programlisting><%if var1 == "Wert"%></programlisting>
4978 <para>Testet die Variable <varname>var1</varname> auf
4979 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
4980 Mittels <function>!=</function> anstelle von <function>==</function>
4981 würde auf Ungleichheit getestet.</para>
4983 <programlisting><%if var1 == var2%></programlisting>
4985 <para>Testet die Variable <varname>var1</varname> auf
4986 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
4987 <function>!=</function> anstelle von <function>==</function> würde
4988 auf Ungleichheit getestet.</para>
4990 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
4991 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
4992 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
4993 dieselbe Syntax wie oben nur mit <function>=~</function> und
4994 <function>!~</function> als Vergleichsoperatoren.</para>
4996 <para>Beispiel für einen Test, ob die Variable
4997 <varname>intnotes</varname> (interne Bemerkungen) das Wort
4998 <constant>schwierig</constant> enthält:</para>
5000 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
5003 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
5004 <title>Der foreach-Block</title>
5006 <programlisting><%foreach variablenname%>
5008 <%end%></programlisting>
5010 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
5011 wie das Perl-Array der Variablen <varname>variablenname</varname>
5012 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
5013 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
5014 benutzt. In jedem Durchlauf werden die <link
5015 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
5016 Variablen</link> jeweils auf den Wert für die aktuelle Position
5019 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
5021 <programlisting><%foreach number%>
5022 Position: <%runningnumber%>
5023 Anzahl: <%qty%>
5024 Artikelnummer: <%number%>
5025 Beschreibung: <%description%>
5027 <%end%></programlisting>
5029 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
5030 <function><%foreach%></function>-Block innerhalb einer
5031 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
5032 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
5033 Inhalt zwischen <function><%foreach%></function> und
5034 <function><%end%></function> wiederholt, nicht aber die
5035 komplette Zeile, in der er steht.</para>
5039 <sect2 id="dokumentenvorlagen-und-variablen.markup">
5040 <title>Markup-Code zur Textformatierung innerhalb von
5043 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
5044 anders formatiert haben möchte, so ist dies begrenzt möglich.
5045 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
5046 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
5047 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
5048 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
5049 (HTML oder PDF über LaTeX) umgesetzt.</para>
5051 <para>Die unterstützen Formatierungen sind:</para>
5055 <term><b>Text</b></term>
5058 <para>Text wird in Fettdruck gesetzt.</para>
5063 <term><i>Text</i></term>
5066 <para>Text wird kursiv gesetzt.</para>
5071 <term><u>Text</u></term>
5074 <para>Text wird unterstrichen.</para>
5079 <term><s>Text</s></term>
5082 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
5083 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
5088 <term><bullet></term>
5091 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
5097 <para>Der Befehl <command><bullet></command> funktioniert
5098 momentan auch nur in Latex-Vorlagen.</para>
5102 <sect1 id="excel-templates">
5103 <title>Excel-Vorlagen</title>
5105 <sect2 id="excel-templates.summary">
5106 <title>Zusammenfassung</title>
5108 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
5109 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
5113 <sect2 id="excel-templates.usage">
5114 <title>Bedienung</title>
5116 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
5117 werden. Die Konfigurationsoption heißt <varname>excel_templates =
5118 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
5120 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
5121 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
5122 werden. In den normalen Verkaufsmasken taucht nun
5123 <constant>Excel</constant> als auswählbares Format auf und kann von da
5124 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
5126 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
5127 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
5128 <filename>sales_quotation.xls</filename> gespeichert.</para>
5131 <sect2 id="excel-templates.syntax">
5132 <title>Variablensyntax</title>
5134 <para>Einfache Syntax:
5135 <command><<varname>></command></para>
5137 <para>Dabei sind <constant><<</constant> und
5138 <constant>>></constant> die Delimiter. Da Excel auf festen
5139 Breiten besteht, kann der Tag künstlich verlängert werden, indem
5140 weitere <constant><</constant> oder <constant>></constant>
5141 eingefügt werden. Der Tag muss nicht symmetrisch sein.
5144 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
5146 <para>Um die Limitierung der festen Breite zu reduzieren, können
5147 weitere Variablen in einem Block interpoliert werden. Whitespace wird
5148 dazwishen dann erhalten. Beispiel:</para>
5150 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
5152 <para>Die Variablen werden interpoliert, und linksbündig mit
5153 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
5154 lang, werden überzählige Zeichen abgeschnitten.</para>
5156 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
5157 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
5159 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
5161 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
5162 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
5166 <sect2 id="excel-templates.limitations">
5167 <title>Einschränkungen</title>
5169 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
5170 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
5171 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
5172 Text zu ersetzen.</para>
5174 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
5175 <command><%if%></command> und
5176 <command><%foreach%></command> nicht vorhanden. Der Delimiter
5177 <constant><% %></constant> kommt in den Headerinformationen
5178 evtl. vor. Deshalb wurde auf den sichereren Delimiter
5179 <constant><<</constant> und <constant>>></constant>
5183 <sect1 id="features.warehouse">
5184 <title>Mandantenkonfiguration Lager</title>
5185 Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt:
5186 Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die Möglichkeit hier über den
5187 Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. Ferner kann
5188 jede Position eines Lieferscheins ein-, bzw. ausgelagert werden (Einkauf-, bzw. Verkauf).
5189 Es können beliebig viele Lager mit beliebig vielen Lagerplätzen abgebildet werden.
5190 Die Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder Einzelposition und
5191 das Auswählen dieser Position zu einem Lager mit Lagerplatz.
5192 Dieses Verfahren lässt sich schrittweise vereinfachen, je nachdem wie die Einstellungen in
5193 der Mandatenkonfiguration gesetzt werden.
5196 <para><option>Auslagern über Standardlagerplatz</option> Hier wird ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz)
5197 in dem Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über den Standardlagerplatz (konfigurierbar pro Ware) durchführt.
5201 <para><option>Auslagern ohne Bestandsprüfung</option>Das obige Auslagern schlägt fehl, wenn die entsprechende Menge für
5202 die Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit dieser Option
5203 erlauben. Hierfür muss ein entsprechender Lagerplatz (Fehlbestand, o.ä.) konfiguriert sein.</para>
5206 Zusätzliche Funktionshinweise:
5208 <listitem><para><option>Standard-Lagerplatz</option>Ist dieser konfiguriert, wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
5209 Stammdaten-> Waren / Dienstleistung / Erzeugnis verwendet.
5212 <listitem><para><option>Standard-Lagerplatz verwenden, falls keiner in Stammdaten definiert</option>Wird beim 'Auslagern über Standardlagerplatz'
5213 keine Standardlagerplatz zu der Ware gefunden, so wird mit dieser Option einfach der Standardlagerplatz verwendet.
5221 <title>Entwicklerdokumentation</title>
5223 <sect1 id="devel.globals" xreflabel="Globale Variablen">
5224 <title>Globale Variablen</title>
5227 <title>Wie sehen globale Variablen in Perl aus?</title>
5229 <para>Globale Variablen liegen in einem speziellen namespace namens
5230 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
5231 globs global und die meisten speziellen Variablen sind...
5234 <para>Daraus ergeben sich folgende Formen:</para>
5238 <term><literal>$main::form</literal></term>
5241 <para>expliziter Namespace "main"</para>
5246 <term><literal>$::form</literal></term>
5249 <para>impliziter Namespace "main"</para>
5254 <term><literal>open FILE, "file.txt"</literal></term>
5257 <para><varname>FILE</varname> ist global</para>
5262 <term><literal>$_</literal></term>
5265 <para>speziell</para>
5270 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
5271 Schlüsselwort wie "<function>global</function>", mit dem man
5272 importieren kann. <function>my</function>, <function>our</function>
5273 und <function>local</function> machen was anderes.</para>
5277 <term><literal>my $form</literal></term>
5280 <para>lexikalische Variable, gültig bis zum Ende des
5286 <term><literal>our $form</literal></term>
5289 <para><varname>$form</varname> referenziert ab hier
5290 <varname>$PACKAGE::form</varname>.</para>
5295 <term><literal>local $form</literal></term>
5298 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
5299 des scopes zurückgesetzt</para>
5306 <title>Warum sind globale Variablen ein Problem?</title>
5308 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
5310 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
5311 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
5312 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
5313 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
5314 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
5315 Datenbankverbindungen, weil die sehr lange zum Initialisieren
5318 <para>Das zweite Problem ist <function>strict</function>. Unter
5319 <function>strict</function> werden alle Variablen die nicht explizit
5320 mit <function>Package</function>, <function>my</function> oder
5321 <function>our</function> angegeben werden als Tippfehler angemarkert,
5322 dies hat, seit der Einführung, u.a. schon so manche langwierige
5323 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
5324 angegeben werden, werden die nicht geprüft, und somit kann sich
5325 schnell ein Tippfehler einschleichen.</para>
5329 <title>Kanonische globale Variablen</title>
5331 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
5332 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
5333 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
5334 umhergereicht werden.</para>
5336 <para>Diese Variablen sind im Moment die folgenden neun:</para>
5340 <para><varname>$::form</varname></para>
5344 <para><varname>%::myconfig</varname></para>
5348 <para><varname>$::locale</varname></para>
5352 <para><varname>$::lxdebug</varname></para>
5356 <para><varname>$::auth</varname></para>
5360 <para><varname>$::lx_office_conf</varname></para>
5364 <para><varname>$::instance_conf</varname></para>
5368 <para><varname>$::dispatcher</varname></para>
5372 <para><varname>$::request</varname></para>
5376 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
5377 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
5378 Eigenschaften (Konventionen):</para>
5381 <title>$::form</title>
5385 <para>Ist ein Objekt der Klasse
5386 "<classname>Form</classname>"</para>
5390 <para>Wird nach jedem Request gelöscht</para>
5394 <para>Muss auch in Tests und Konsolenscripts vorhanden
5399 <para>Enthält am Anfang eines Requests die Requestparameter vom
5404 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
5405 cachen, das wird aber momentan absichtlich zerstört</para>
5409 <para><varname>$::form</varname> wurde unter <productname>SQL
5410 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
5411 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
5412 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
5413 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
5414 <function>IS->retrieve_customer()</function> in Sicherheit
5417 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
5418 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
5419 3552, Stand version 2.7beta), um dies hinterher wieder auf den
5420 richtigen Wert zu setzen:</para>
5422 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
5423 $::myconfig{numberformat} = $numberformat;
5424 # (...) div Berechnungen
5425 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
5427 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
5428 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
5429 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
5430 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
5431 Es geht ziemlich sicher etwas kaputt.</para>
5433 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
5434 in den <productname>Template::Toolkit</productname> Templates
5435 außerhalb der Controller: der Ausdruck <function>[% var
5436 %]</function> greift auf <varname>$::form->{var}</varname> zu.
5437 Unter Controllern ist der Standard Scope anders, da lautet der
5438 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
5439 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
5440 <function><%var%></function> zeigt auf
5441 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
5442 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
5445 <programlisting>[%- IF business %]
5446 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
5447 [%- END %]</programlisting>
5449 <para>Entweder wird hier dann $::form->{business} ausgewertet
5450 oder aber der Funktion
5451 <function>$form->parse_html_template</function> wird explizit
5452 noch ein zusätzlicher Hash übergeben, der dann auch in den
5453 (Web-)Templates zu Verfügung steht, bspw. so:</para>
5455 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
5457 <para>Innerhalb von Schleifen wird
5458 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
5459 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
5460 welches über alle Positionen eines Lieferscheins in Schleife
5463 <programlisting>for $i (1 .. $form->{rowcount}) {
5465 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
5466 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
5467 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
5473 <title>%::myconfig</title>
5477 <para>Das einzige Hash unter den globalen Variablen</para>
5481 <para>Wird spätestens benötigt wenn auf die Datenbank
5482 zugegriffen wird</para>
5486 <para>Wird bei jedem Request neu erstellt.</para>
5490 <para>Enthält die Userdaten des aktuellen Logins</para>
5494 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
5495 extern serialisiert werden, weil da auch der Datenbankzugriff
5496 für diesen user drinsteht.</para>
5500 <para>Enthält unter anderem Listenbegrenzung vclimit,
5501 Datumsformat dateformat und Nummernformat numberformat</para>
5505 <para>Enthält Datenbankzugriffinformationen</para>
5509 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
5510 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
5511 aktuellen Users entscheiden müssen, befragen
5512 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
5513 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
5514 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
5515 Informationen über den Benutzer die über die
5516 Administrator-Schnittstelle eingegeben wurden.</para>
5520 <title>$::locale</title>
5524 <para>Objekt der Klasse "Locale"</para>
5528 <para>Wird pro Request erstellt</para>
5532 <para>Muss auch für Tests und Scripte immer verfügbar
5537 <para>Cached intern über Requestgrenzen hinweg benutzte
5542 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
5543 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
5547 <title>$::lxdebug</title>
5551 <para>Objekt der Klasse "LXDebug"</para>
5555 <para>Wird global gecached</para>
5559 <para>Muss immer verfügbar sein, in nahezu allen
5564 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
5565 bereit, wie "<function>enter_sub</function>" und
5566 "<function>leave_sub</function>", mit denen in den alten Modulen ein
5567 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
5568 der man die Wallclockzeit seit Requeststart loggen kann, sowie
5569 "<function>message</function>" und "<function>dump</function>" mit
5570 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
5573 <para>Beispielsweise so:</para>
5575 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
5576 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
5580 <title>$::auth</title>
5584 <para>Objekt der Klasse "SL::Auth"</para>
5588 <para>Wird global gecached</para>
5592 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
5596 <para>Wird nach jedem Request resettet.</para>
5600 <para><varname>$::auth</varname> stellt Funktionen bereit um die
5601 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
5602 vom aktuellen User abhängen wird das Objekt aus
5603 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
5604 Request kurz resettet.</para>
5606 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten. Dessen Einstellungen können über
5607 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert ist ein Hash mit den Werten aus der Tabelle
5608 <literal>auth.clients</literal>.</para>
5612 <title>$::lx_office_conf</title>
5616 <para>Objekt der Klasse
5617 "<classname>SL::LxOfficeConf</classname>"</para>
5621 <para>Global gecached</para>
5625 <para>Repräsentation der
5626 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
5630 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
5631 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
5632 das Programm die Konfiguration ändern kann oder sollte.</para>
5634 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
5635 Debug- und Trace-Log-Datei wie folgt konfiguriert und
5638 <programlisting>[debug]
5639 file_name = /tmp/kivitendo-debug.log</programlisting>
5641 <para>ist der Key <varname>file</varname> im Programm als
5642 <varname>$::lx_office_conf->{debug}{file}</varname>
5646 <para>Zugriff auf die Konfiguration erfolgt im Moment über
5647 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
5652 <title>$::instance_conf</title>
5656 <para>Objekt der Klasse
5657 "<classname>SL::InstanceConfiguration</classname>"</para>
5661 <para>wird pro Request neu erstellt</para>
5665 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
5666 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
5667 ist hier eine Mandantendatenbank. Beispielsweise überprüft
5668 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
5669 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
5673 <title>$::dispatcher</title>
5677 <para>Objekt der Klasse
5678 "<varname>SL::Dispatcher</varname>"</para>
5682 <para>wird pro Serverprozess erstellt.</para>
5686 <para>enthält Informationen über die technische Verbindung zum
5691 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
5692 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
5693 Objekt untergebracht.</para>
5697 <title>$::request</title>
5701 <para>Hashref (evtl später Objekt)</para>
5705 <para>Wird pro Request neu initialisiert.</para>
5709 <para>Keine Unterstruktur garantiert.</para>
5713 <para><varname>$::request</varname> ist ein generischer Platz um
5714 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
5715 at a distance benutzt werden, sondern um lokales memoizing zu
5716 ermöglichen, das garantiert am Ende des Requests zerstört
5719 <para>Vieles von dem, was im moment in <varname>$::form</varname>
5720 liegt, sollte eigentlich hier liegen. Die groben
5721 Differentialkriterien sind:</para>
5725 <para>Kommt es vom User, und soll unverändert wieder an den
5726 User? Dann <varname>$::form</varname>, steht da eh schon</para>
5730 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
5731 Requests gebraucht werden? Dann
5732 <varname>$::request</varname></para>
5736 <para>Muss ich von anderen Teilen des Programms lesend drauf
5737 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
5738 Wrappermethode</para>
5745 <title>Ehemalige globale Variablen</title>
5747 <para>Die folgenden Variablen waren einmal im Programm, und wurden
5751 <title>$::cgi</title>
5755 <para>war nötig, weil cookie Methoden nicht als
5756 Klassenfunktionen funktionieren</para>
5760 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
5761 Klassennamespace gehalten wird und über Requestgrenzen
5766 <para>liegt jetzt unter
5767 <varname>$::request->{cgi}</varname></para>
5773 <title>$::all_units</title>
5777 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
5778 ein paar hundert mal pro Request eine Liste der Einheiten
5779 brauchen, und de als Parameter durch einen Riesenstack von
5780 Funktionen geschleift werden müssten.</para>
5784 <para>Liegt jetzt unter
5785 <varname>$::request->{cache}{all_units}</varname></para>
5790 <function>AM->retrieve_all_units()</function> gesetzt oder
5797 <title>%::called_subs</title>
5801 <para>wurde benutzt um callsub deep recursions
5806 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
5807 möglichen Rekursioenen darstellt, und da nie welche
5812 <para>komplette recursion protection wurde entfernt.</para>
5819 <sect1 id="devel.fcgi">
5820 <title>Entwicklung unter FastCGI</title>
5822 <sect2 id="devel.fcgi.general">
5823 <title>Allgemeines</title>
5825 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
5826 werden, muss der Webserver neu gestartet werden.</para>
5828 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
5829 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
5830 müssen folgende Aspekte beachtet werden.</para>
5833 <sect2 id="devel.fcgi.exiting">
5834 <title>Programmende und Ausnahmen</title>
5836 <para>Betrifft die Funktionen <function>warn</function>,
5837 <function>die</function>, <function>exit</function>,
5838 <function>carp</function> und <function>confess</function>.</para>
5840 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
5841 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
5842 am Laufen zu halten. Man kann mit <function>die</function>,
5843 <function>confess</function> oder <function>carp</function> Fehler
5844 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
5845 eigene <function>$::form-</function>error()> tut im Prinzip das
5846 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
5847 <function>exit</function> hingegen werden nicht abgefangen.
5848 <function>warn</function> wird direkt nach STDERR, also in Server Log
5849 eine Nachricht schreiben (sofern in der Konfiguration nicht die
5850 Warnungen in das kivitendo Log umgeleitet wurden), und
5851 <function>exit</function> wird die Ausführung beenden.</para>
5853 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
5854 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
5855 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
5856 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
5859 <sect2 id="devel.fcgi.globals">
5860 <title>Globale Variablen</title>
5862 <para>Um zu vermeiden, dass Informationen von einem Request in einen
5863 anderen gelangen, müssen alle globalen Variablen vor einem Request
5864 sauber initialisiert werden. Das ist besonders wichtig im
5865 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
5866 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
5869 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
5870 abgetrennten Block, der alle kanonischen globalen Variablen listet und
5871 erklärt. Bitte keine anderen einführen ohne das sauber zu
5872 dokumentieren.</para>
5874 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
5875 man sicher geht, dass man die richtige erwischt.</para>
5878 <sect2 id="devel.fcgi.performance">
5879 <title>Performance und Statistiken</title>
5881 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
5882 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
5883 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
5884 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
5885 sind es je nach Menge der definierten Variablen 1-2s. Ab der
5886 Moose/Rose::DB Version sind es 5-6s.</para>
5888 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
5889 den kritischen Pfaden, unter 0,15 sonst.</para>
5893 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
5894 <title>SQL-Upgradedateien</title>
5896 <sect2 id="db-upgrade-files.introduction"
5897 xreflabel="Einführung in die Datenbank-Upgradedateien">
5898 <title>Einführung</title>
5900 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte gesteuert, die sich im Verzeichnis <filename>sql/Pg-upgrade2</filename>
5901 befinden. In diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren, die neben den eigentlich auszuführenden SQL- oder
5902 Perl-Befehlen einige Kontrollinformationen enthält.</para>
5904 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten, sodass Datenbankscripte zwar in einer sicheren Reihenfolge
5905 ausgeführt werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt werden, wenn die Tabelle mit <literal>CREATE
5906 TABLE</literal> angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man keine Versionsnummern braucht.</para>
5908 <para>kivitendo merkt sich dabei, welches der Upgradescripte in <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
5909 führt diese nicht erneut aus. Dazu dient die Tabelle "<literal>schema_info</literal>", die bei der Anmeldung automatisch angelegt
5913 <sect2 id="db-upgrade-files.format"
5914 xreflabel="Format der Upgradedateien">
5915 <title>Format der Kontrollinformationen</title>
5917 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
5918 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
5919 hat dabei das folgende Format:</para>
5921 <para>Für SQL-Upgradedateien:</para>
5923 <programlisting>-- @key: value</programlisting>
5925 <para>Für Perl-Upgradedateien:</para>
5927 <programlisting># @key: value</programlisting>
5929 <para>Leerzeichen vor "<varname>value</varname>" werden
5932 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
5936 <term><varname>tag</varname></term>
5939 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
5940 Dieser "tag" kann von anderen Kontrolldateien in ihren
5941 Abhängigkeiten verwendet werden (Schlüsselwort
5942 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
5943 in der Datenbank eingetragen wird.</para>
5945 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
5946 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
5948 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
5949 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
5950 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
5956 <term><varname>charset</varname></term>
5959 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
5960 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
5961 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte hingegen müssen immer in UTF-8 encodiert sein und sollten
5962 demnach auch ein "<literal>use utf8;</literal>" enthalten.</para>
5967 <term><varname>description</varname></term>
5970 <para>Benötigt. Eine Beschreibung, was in diesem Update
5971 passiert. Diese wird dem Benutzer beim eigentlichen
5972 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
5973 sein sollte, sollte die Beschreibung auf Deutsch
5979 <term><varname>depends</varname></term>
5982 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
5983 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
5984 dass die in dieser Liste aufgeführten Scripte bereits
5985 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
5987 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
5988 Script "b" existiert, das von Änderungen in "a" abhängt, und
5989 eine neue Kontrolldatei für "c" erstellt wird, die von
5990 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
5991 Tag "b" als Abhängigkeit zu definieren.</para>
5993 <para>Es ist nicht erlaubt, sich selbst referenzierende
5994 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
5995 und "c" -> "a").</para>
6000 <term><varname>priority</varname></term>
6003 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
6004 der Scripte ausgeführt werden, die die gleichen
6005 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
6006 der Wert 1000 benutzt.</para>
6008 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
6009 "depends" benutzt werden. kivitendo sortiert die auszuführenden
6010 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
6011 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
6012 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
6013 dann "y", dann "z"), dann nach der Priorität und bei gleicher
6014 Priorität alphabetisch nach dem "tag".</para>
6019 <term><varname>ignore</varname></term>
6022 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
6023 Skript bei der Anmeldung ignoriert und entsprechend nicht
6030 <sect2 id="db-upgrade-files.format-perl-files" xreflabel="Format von Perl-Upgradedateien">
6031 <title>Format von in Perl geschriebenen Datenbankupgradescripten</title>
6033 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so ausgeführt sondern müssen sich an gewisse Konventionen
6034 halten. Dafür bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
6036 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse dar, die vom Elternobjekt
6037 "<literal>SL::DBUpgrade2::Base</literal>" erben und eine Funktion namens "<literal>run</literal>" zur Verfügung stellen muss. Das
6038 Script wird ausgeführt, indem eine Instanz dieser Klasse erzeugt und darauf die erwähnte "<literal>run</literal>" aufgerufen
6041 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert für "<literal>@tag</literal>" ableitet. Dabei werden alle
6042 Zeichen, die in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche ersetzt. Insgesamt sieht der Paketname wie folgt
6043 aus: "<literal>SL::DBUpgrade2::tag</literal>".</para>
6045 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
6046 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
6048 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie folgt aus:</para>
6050 <programlisting># @tag: beispiel-upgrade-file42
6051 # @description: Ein schönes Beispielscript
6052 # @depends: release_3_1_0
6053 package SL::DBUpgrade2::beispiel_upgrade_file42;
6058 use parent qw(SL::DBUpgrade2::Base);
6063 # hier Aktionen ausführen
6072 <sect2 id="db-upgrade-files.dbupgrade-tool"
6073 xreflabel="Hilfsscript dbupgrade2_tool.pl">
6074 <title>Hilfsscript dbupgrade2_tool.pl</title>
6076 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
6077 existiert ein Hilfsscript namens
6078 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
6079 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
6080 liest alle Datenbankupgradescripte aus dem Verzeichnis
6081 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
6082 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
6083 von der Kommandozeile überprüft werden können.</para>
6085 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
6086 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
6087 sich aber auch Informationen auf verschiedene Art ausgeben
6092 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
6093 --list</command>"</para>
6095 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
6096 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
6097 würde. Es werden neben der Listenposition der Tag, die
6098 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
6102 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
6103 --tree</command>"</para>
6105 <para>Listet alle Tags in Baumform basierend auf den
6106 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
6107 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
6108 beim übergeordneten Script als Abhängigkeit eingetragen
6112 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
6113 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
6114 --rtree</command>"</para>
6116 <para>Listet alle Tags in Baumform basierend auf den
6117 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
6118 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
6119 die das übergeordnete Script als Abhängigkeit eingetragen
6124 <para>Baumform mit Postscriptausgabe:
6125 "<command>./scripts/dbupgrade2_tool.pl
6126 --graphviz</command>"</para>
6128 <para>Benötigt das Tool "<command>graphviz</command>", um mit
6129 seiner Hilfe die <link
6130 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
6131 Baumform</link> in eine Postscriptdatei namens
6132 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
6133 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
6134 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
6135 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
6140 <para>Scripte, von denen kein anderes Script abhängt:
6141 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
6143 <para>Listet die Tags aller Scripte auf, von denen keine anderen
6144 Scripte abhängen.</para>
6150 <sect1 id="translations-languages" xreflabel="Translations and languages">
6151 <title>Translations and languages</title>
6153 <sect2 id="translations-languages.introduction"
6154 xreflabel="Introduction to translations and languages">
6155 <title>Introduction</title>
6158 <para>Dieser Abschnitt ist in Englisch geschrieben, um
6159 internationalen Übersetzern die Arbeit zu erleichtern.</para>
6162 <para>This section describes how localization packages in kivitendo
6163 are built. Currently the only language fully supported is German, and
6164 since most of the internal messages are held in English the English
6165 version is usable too.</para>
6167 <para>A stub version of French is included but not functunal at this
6171 <sect2 id="translations-languages.character-set"
6172 xreflabel="Character set">
6173 <title>Character set</title>
6175 <para>All files included in a language pack must use UTF-8 as their encoding.</para>
6178 <sect2 id="translations-languages.file-structure"
6179 xreflabel="File structure">
6180 <title>File structure</title>
6182 <para>The structure of locales in kivitendo is:</para>
6184 <programlisting>kivitendo/locale/<langcode>/</programlisting>
6186 <para>where <langcode> stands for an abbreviation of the
6187 language package. The builtin packages use two letter <ulink
6188 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
6189 but the actual name is not relevant for the program and can easily be
6191 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
6192 tags</ulink> (i.e. "en_GB"). In fact the original language packages
6193 from SQL Ledger are named in this way.</para>
6195 <para>In such a language directory the following files are
6200 <term>LANGUAGE</term>
6203 <para>This file is mandatory.</para>
6205 <para>The <filename>LANGUAGE</filename> file contains the self
6206 descripted name of the language. It should contain a native
6207 representation first, and in parenthesis an english translation
6208 after that. Example:</para>
6210 <programlisting>Deutsch (German)</programlisting>
6218 <para>This file is mandatory.</para>
6220 <para>The central translation file. It is essentially an inline
6221 Perl script autogenerated by <command>locales.pl</command>. To
6222 generate it, generate the directory and the two files mentioned
6223 above, and execute the following command:</para>
6225 <programlisting>scripts/locales.pl <langcode></programlisting>
6227 <para>Otherwise you can simply copy one of the other languages.
6228 You will be told how many are missing like this:</para>
6230 <programlisting>$ scripts/locales.pl en
6231 English - 0.6% - 2015/2028 missing</programlisting>
6233 <para>A file named "<filename>missing</filename>" will be
6234 generated and can be edited. You can also edit the
6235 "<filename>all</filename>" file directly. Edit everything you
6236 like to fit the target language and execute
6237 <command>locales.pl</command> again. See how the missing words
6243 <term>Num2text</term>
6246 <para>Legacy code from SQL Ledger. It provides a means for
6247 numbers to be converted into natural language, like
6248 <literal>1523 => one thousand five hundred twenty
6249 three</literal>. If you want to provide it, it must be inlinable
6250 Perl code which provides a <function>num2text</function> sub. If
6251 an <function>init</function> sub exists it will be executed
6254 <para>Only used in the check and receipt printing module.</para>
6259 <term>special_chars</term>
6262 <para>kivitendo comes with a lot of interfaces to different
6263 formats, some of which are rather picky with their accepted
6264 charset. The <filename>special_chars</filename> file contains a
6265 listing of chars not suited for different file format and
6266 provides substitutions. It is written in "Simple Ini" style,
6267 containing a block for every file format.</para>
6269 <para>First entry should be the order of substitution for
6270 entries as a whitespace separated list. All entries are
6271 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
6272 and <literal>\\</literal> all work.</para>
6274 <para>After that every entry is a special char that should be
6275 translated when writing text into such a file.</para>
6277 <para>Example:</para>
6279 <programlisting>[Template/XML]
6280 order=& < > \n
6284 \n=<br></programlisting>
6286 <para>Note the importance of the order in this example.
6287 Substituting < and > befor & would lead to $gt; become
6290 <para>For a list of valid formats, see the German
6291 <filename>special_chars</filename> entry. As of this writing the
6292 following are recognized:</para>
6294 <programlisting>HTML
6299 Template/OpenDocument
6300 filenames</programlisting>
6302 <para>The last of which is very machine dependant. Remember that
6303 a lot of characters are forbidden by some filesystems, for
6304 exmaple MS Windows doesn't like ':' in its files where Linux
6305 doesn't mind that. If you want the files created with your
6306 language pack to be portable, find all chars that could cause
6312 <term>missing</term>
6315 <para>This file is not a part of the language package
6318 <para>This is a file generated by
6319 <command>scripts/locales.pl</command> while processing your
6320 locales. It's only to have the missing entries singled out and
6321 does not belong to a language package.</para>
6329 <para>This file is not a part of the language package
6332 <para>Another file generated by
6333 <command>scripts/locales.pl</command>. If for any reason a
6334 translation does not appear anymore and can be deleted, it gets
6335 moved here. The last 50 or so entries deleted are saved here in
6336 case you made a typo, so that you don't have to translate
6337 everything again. If a tranlsation is missing, the lost file is
6338 checked first. If you maintain a language package, you might
6339 want to keep this safe somewhere.</para>
6346 <sect1 id="devel.testsuite">
6347 <title>Die kivitendo-Test-Suite</title>
6349 <sect2 id="devel.testsuite.intro">
6350 <title>Einführung</title>
6352 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie basiert auf dem Standard-Perl-Modul <literal>Test::More</literal>.</para>
6354 <para>Die grundlegenden Fakten sind:</para>
6357 <listitem><para>Alle Tests liegen im Unterverzeichnis <filename>t/</filename>.</para></listitem>
6359 <listitem><para>Ein Script (bzw. ein Test) in <filename>t/</filename> enthält einen oder mehrere Testfälle.</para></listitem>
6361 <listitem><para>Alle Dateinamen von Tests enden auf <literal>.t</literal>. Es sind selbstständig ausführbare Perl-Scripte.</para></listitem>
6363 <listitem><para>Die Test-Suite besteht aus der Gesamtheit aller Tests, sprich aller Scripte in <filename>t/</filename>, deren
6364 Dateiname auf <literal>.t</literal> endet.</para></listitem>
6368 <sect2 id="devel.testsuite.prerequisites">
6369 <title>Voraussetzungen</title>
6371 <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>
6374 <listitem><para><literal>Test::Deep</literal> (Debian-Paketname: <literal>libtest-deep-perl</literal>; Fedora Core:
6375 <literal>perl-Test-Deep</literal>; openSUSE: <literal>perl-Test-Deep</literal>)</para></listitem>
6376 <listitem><para><literal>Test::Exception</literal> (Debian-Paketname: <literal>libtest-exception-perl</literal>; Fedora Core:
6377 <literal>perl-Test-Exception</literal>; openSUSE: <literal>perl-Test-Exception</literal>)</para></listitem>
6378 <listitem><para><literal>Test::Output</literal> (Debian-Paketname: <literal>libtest-output-perl</literal>; Fedora Core:
6379 <literal>perl-Test-Output</literal>; openSUSE: <literal>perl-Test-Output</literal>)</para></listitem>
6380 <listitem><para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses Modul ist ab Perl 5.10.1 Bestandteil der
6381 Perl-Distribution und kann für frühere Versionen aus dem <ulink url="http://www.cpan.org">CPAN</ulink> bezogen
6382 werden.</para></listitem>
6383 <listitem><para><literal>LWP::Simple</literal> aus dem Paket <literal>libwww-perl</literal> (Debian-Panetname:
6384 <literal>libwww-perl</literal>; Fedora Core: <literal>perl-libwww-perl</literal>; openSUSE:
6385 <literal>perl-libwww-perl</literal>)</para></listitem>
6386 <listitem><para><literal>URI::Find</literal> (Debian-Panetname: <literal>liburi-find-perl</literal>; Fedora Core:
6387 <literal>perl-URI-Find</literal>; openSUSE: <literal>perl-URI-Find</literal>)</para></listitem>
6390 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
6391 müssen in der Konfigurationsdatei im Abschnit <literal>testing/database</literal> Datenbankverbindungsparameter angegeben
6392 werden. Der hier angegebene Benutzer muss weiterhin das Recht haben, Datenbanken anzulegen und zu löschen.</para>
6395 <sect2 id="devel.testsuite.execution">
6397 Existierende Tests ausführen
6400 <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
6401 gezielt einzelne Scripte aus. Für beide Fälle gibt es das Helferscript <filename>t/test.pl</filename>.</para>
6403 <para>Will man die komplette Test-Suite ausführen, so muss man einfach nur <filename>t/test.pl</filename> ohne weitere Parameter aus
6404 dem kivitendo-Basisverzeichnis heraus ausführen.</para>
6406 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen an <filename>t/test.pl</filename>. Beispielsweise:</para>
6408 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
6412 <sect2 id="devel.testsuite.meaning_of_scripts">
6414 Bedeutung der verschiedenen Test-Scripte
6417 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für Programmierstil. Einige besonders zu erwähnende, weil auch
6418 während der Entwicklung nützliche Tests sind:</para>
6421 <listitem><para><filename>t/001compile.t</filename> -- compiliert alle Quelldateien und bricht bei Fehlern sofort ab</para></listitem>
6422 <listitem><para><filename>t/002goodperl.t</filename> -- überprüft alle Perl-Dateien auf Anwesenheit von '<literal>use strict</literal>'-Anweisungen</para></listitem>
6423 <listitem><para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von <function>system()</function> und <function>exec()</function> auf Gültigkeit</para></listitem>
6424 <listitem><para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien Tab-Zeichen enthalten</para></listitem>
6425 <listitem><para><filename>t/006spelling.t</filename> -- sucht nach häufigen Rechtschreibfehlern</para></listitem>
6426 <listitem><para><filename>t/011pod.t</filename> -- überprüft die Syntax von Dokumentation im POD-Format auf Gültigkeit</para></listitem>
6429 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise einzelner Funktionen und Module.</para>
6432 <sect2 id="devel.testsuite.create_new">
6434 Neue Test-Scripte erstellen
6437 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich mit einem Test-Script abgesichert wird. Auch bestehende
6438 Funktion darf und soll ausdrücklich nachträglich mit Test-Scripten abgesichert werden.</para>
6440 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
6442 Ideen für neue Test-Scripte, die keine konkreten Funktionen testen
6445 <para> Ideen, die abgesehen von Funktionen noch nicht umgesetzt wurden:</para>
6448 <listitem><para>Überprüfung auf fehlende symbolische Links</para></listitem>
6449 <listitem><para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit gewissen Einschränkungen wie das Erlauben von deutschen Umlauten)</para></listitem>
6450 <listitem><para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para></listitem>
6451 <listitem><para>Überprüfung auf Leerzeichen am Ende von Zeilen</para></listitem>
6452 <listitem><para>Test, ob alle zu übersetzenden Strings in <filename>locale/de/all</filename> vorhanden sind</para></listitem>
6453 <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>
6457 <sect3 id="devel.testsuite.directory_and_test_names">
6459 Konvention für Verzeichnis- und Dateinamen
6462 <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>
6465 <listitem><para>Die Dateiendung muss <filename>.t</filename> lauten.</para></listitem>
6467 <listitem><para>Namen sind englisch, komplett klein geschrieben und einzelne Wörter mit Unterstrichten getrennt (beispielsweise
6468 <filename>bad_function_params.t</filename>).</para></listitem>
6470 <listitem><para>Unterverzeichnisse sollten grob nach dem Themenbereich benannt sein, mit dem sich die Scripte darin befassen
6471 (beispielsweise <filename>background_jobs</filename> für Tests rund um Hintergrund-Jobs).</para></listitem>
6473 <listitem><para>Test-Scripte sollten einen überschaubaren Bereich von Funktionalität testen, der logisch zusammenhängend ist
6474 (z.B. nur Tests für eine einzelne Funktion in einem Modul). Lieber mehrere Test-Scripte schreiben.</para></listitem>
6478 <sect3 id="devel.testsuite.minimal_example">
6480 Minimales Skelett für eigene Scripte
6483 <para>Der folgenden Programmcode enthält das kleinstmögliche Testscript und kann als Ausgangspunkt für eigene Tests verwendet werden:</para>
6485 <programlisting>use Test::More tests => 0;
6489 use Support::TestSetup;
6491 Support::TestSetup::login();</programlisting>
6493 <para>Wird eine vollständig initialisierte kivitendo-Umgebung benötigt (Stichwort: alle globalen Variablen wie
6494 <varname>$::auth</varname>, <varname>$::form</varname> oder <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
6495 <filename>config/kivitendo.conf</filename> im Abschnitt <literal>testing.login</literal> ein gültiger Login-Name eingetragen
6496 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
6498 <para>Wir keine vollständig initialisierte Umgebung benötigt, so kann die letzte Zeile <code>Support::TestSetup::login();</code>
6499 weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.</para>
6504 <sect1 id="devel.style-guide">
6505 <title>Stil-Richtlinien</title>
6507 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
6508 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
6509 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
6510 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
6512 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
6515 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
6516 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
6521 <para>Es werden keine echten Tabs sondern Leerzeichen
6526 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
6528 <programlisting>foreach my $row (@data) {
6530 # do something with $row
6534 $row->{modules} = MODULE->retrieve(
6535 id => $row->{id},
6536 date => $use_now ? localtime() : $row->{time},
6540 $report->add($row);
6545 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
6546 Zeile wie der letzte Befehl. Beispiele:</para>
6548 <programlisting>sub debug {
6554 <programlisting>if ($form->{item_rows} > 0) {
6560 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
6561 der Befehl / die öffnende schließende Klammer, die den Block
6562 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
6563 Beispiele wie bei 3. gelten.</para>
6567 <para>Die Wörter "<function>else</function>",
6568 "<function>elsif</function>", "<function>while</function>" befinden
6569 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
6572 <programlisting>if ($form->{sum} > 1000) {
6574 } elsif ($form->{sum} > 0) {
6582 } until ($a > 0);</programlisting>
6586 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
6587 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
6588 und grep-ähnliche Operatoren. Beispiel:</para>
6590 <programlisting>$main::lxdebug->message("Could not find file.");
6591 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
6595 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
6597 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
6598 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
6599 Blöcke schon. Beispiel:</para>
6601 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
6606 $form->{sum} += $form->{"row_$i"};
6607 $form->{ $form->{index} } += 1;
6609 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
6613 <para>Mehrzeilige Befehle</para>
6617 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
6618 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
6619 werden, in der die ersten Funktionsparameter in der ersten Zeile
6620 stehen. Beispiel:</para>
6622 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
6623 $form->{some_col_value});</programlisting>
6627 <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
6628 besten in einer übersichtlichen Tabellenstruktur organisiert
6629 wird. Beispiel:</para>
6631 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
6632 : $form->{oldcount} ? $form->{oldcount} + 1
6633 : $form->{rowcount} - $form->{rowbase};</programlisting>
6639 <para>Kommentare</para>
6643 <para>Kommentare, die alleine in einer Zeile stehen, sollten
6644 soweit wie der Code eingerückt sein.</para>
6648 <para>Seitliche hängende Kommentare sollten einheitlich
6649 formatiert werden.</para>
6653 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
6654 auf Englisch zu verfassen. So wie ich keine Lust habe,
6655 französischen Quelltext zu lesen, sollte auch der kivitendo
6656 Quelltext für nicht-Deutschsprachige lesbar sein.
6659 <programlisting>my $found = 0;
6667 $i = 0 # initialize $i
6669 $i *= $const; # do something crazy
6670 $i = $n; # recover $i</programlisting>
6676 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
6677 Interpolation gewünscht ist. Beispiel:</para>
6679 <programlisting>$form->{sum} = 0;
6680 $form->{"row_$i"} = $form->{"row_$i"} - 5;
6681 $some_hash{42} = 54;</programlisting>
6685 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
6686 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
6687 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
6688 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
6690 <para>Als Beispiel sei die Funktion
6691 <function>print_options</function> aus
6692 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
6696 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
6697 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
6700 <para>Emacs und vim haben beide recht einfache Methoden zur
6701 Entfernung von trailing whitespace. Emacs kennt das Kommande
6702 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
6703 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
6704 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
6709 <para>Es wird kein <command>perltidy</command> verwendet.</para>
6711 <para>In der Vergangenheit wurde versucht,
6712 <command>perltidy</command> zu verwenden, um einen einheitlichen
6713 Stil zu erlangen. Es hat sich aber gezeigt, dass
6714 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
6715 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
6716 den Interessierten sind hier die
6717 <command>perltidy</command>-Optionen, die grob den beschriebenen
6718 Richtlinien entsprechen:</para>
6720 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
6721 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
6722 -lp -vt=1 -vtc=1</programlisting>
6726 <para><varname>STDERR</varname> ist tabu. Unkonditionale
6727 Debugmeldungen auch.</para>
6729 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
6730 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
6731 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
6733 <para>Die <classname>LXDebug</classname>-Methode
6734 "<function>message</function>" nimmt als ersten Paramter außerdem
6735 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
6736 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
6737 und werden in den meisten Fällen auch vom Repository
6738 zurückgewiesen.</para>
6742 <para>Alle neuen Module müssen use strict verwenden.</para>
6744 <para><varname>$form</varname>, <varname>$auth</varname>,
6745 <varname>$locale</varname>, <varname>$lxdebug</varname> und
6746 <varname>%myconfig</varname> werden derzeit aus dem main package
6747 importiert (siehe <xref linkend="devel.globals" />. Alle anderen
6748 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
6753 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
6754 <title>Dokumentation erstellen</title>
6756 <sect2 id="devel.build-doc.introduction">
6757 <title>Einführung</title>
6759 <para>Diese Dokumentation ist in <productname>DocBook</productname>
6760 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
6761 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
6762 Editor nutzt, der spezielle Unterstützung für
6763 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
6764 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
6765 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
6769 <sect2 id="devel.build-doc.required-software">
6770 <title>Benötigte Software</title>
6772 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
6773 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
6774 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
6775 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
6776 <command>scripts/build_doc.sh</command>.</para>
6778 <para>Das Script benötigt zur Konvertierung verschiedene
6779 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
6785 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
6786 in einer halbwegs aktuellen Version</para>
6790 <para>Das Java-Build-System <ulink
6791 url="http://ant.apache.org/">Apache Ant</ulink></para>
6795 <para>Das Dokumentations-System Dobudish für
6796 <productname>DocBook</productname> 4.5, eine Zusammenstellung
6797 diverser Stylesheets und Grafiken zur Konvertierung von
6798 <productname>DocBook</productname> XML in andere Formate. Das
6799 Paket, das benötigt wird, ist zum Zeitpunkt der
6800 Dokumentationserstellung
6801 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
6802 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
6807 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
6808 sind auf allen gängigen Plattformen verfügbar. Beispiel für
6809 Debian/Ubuntu:</para>
6811 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
6813 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
6814 <filename>doc/build</filename> entpackt werden. Beispiel unter der
6815 Annahme, das <productname>Dobudish</productname> in
6816 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
6818 <programlisting>cd doc/build
6819 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
6822 <sect2 id="devel.build-doc.build">
6823 <title>PDFs und HTML-Seiten erstellen</title>
6825 <para>Die eigentliche Konvertierung erfolgt nach Installation der
6826 benötigten Software mit einem einfachen Aufruf direkt aus dem
6827 kivitendo-Installationsverzeichnis heraus:</para>
6829 <programlisting>./scripts/build_doc.sh</programlisting>
6832 <sect2 id="devel.build-doc.repository">
6833 <title>Einchecken in das Git-Repository</title>
6835 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
6836 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
6837 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
6838 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
6840 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
6841 symbolischen Links gehören hingegen nicht in das Repository.</para>
projects / kivitendo-erp.git / blob