doc/dokumentation.xml

   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.5.6.1: Installation, Konfiguration,
   6   Entwicklung</title>
   7
   8   <chapter id="Aktuelle-Hinweise">
   9     <title>Aktuelle Hinweise</title>
  10
  11     <para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>
  12
  13     <itemizedlist>
  14       <listitem>
  15         <para>im Community-Forum: <ulink
  16         url="https://forum.kivitendo.de">https://forum.kivitendo.de</ulink></para>
  17       </listitem>
  18
  19       <listitem>
  20         <para>im Kunden-Forum: <ulink
  21         url="http://redmine.kivitendo-premium.de/projects/forum/boards/">http://redmine.kivitendo-premium.de/projects/forum/boards/</ulink></para>
  22       </listitem>
  23
  24       <listitem>
  25         <para>in der doc/UPGRADE Datei im doc-Verzeichnis der
  26         Installation</para>
  27       </listitem>
  28
  29       <listitem>
  30         <para>Im Schulungs- und Dienstleistungsangebot der entsprechenden
  31         kivitendo-Partner: <ulink
  32         url="http://www.kivitendo.de/partner.html">http://www.kivitendo.de/partner.html</ulink></para>
  33       </listitem>
  34     </itemizedlist>
  35   </chapter>
  36
  37   <chapter id="config">
  38     <title>Installation und Grundkonfiguration</title>
  39
  40     <sect1 id="Installation-Übersicht">
  41       <title>Übersicht</title>
  42
  43       <para>Die Installation von kivitendo umfasst mehrere Schritte. Die
  44       folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
  45       Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit
  46       minimalen Features möglichst schnell zum Laufen zu kriegen.</para>
  47
  48       <orderedlist>
  49         <listitem>
  50           <para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo
  51           benötigt gewisse Ressourcen und benutzt weitere Programme. Das
  52           Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert
  53           diese. Auch die Liste der benötigten Perl-Module befindet sich
  54           hier.</para>
  55         </listitem>
  56
  57         <listitem>
  58           <para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst
  59           die "<xref linkend="Manuelle-Installation-des-Programmpaketes"/>"
  60           sowie grundlegende Einstellungen, die der "<xref
  61           linkend="config.config-file"/>" erläutert.</para>
  62         </listitem>
  63
  64         <listitem>
  65           <para><emphasis>Konfiguration externer Programme</emphasis>: hierzu
  66           gehören die Datenbank ("<xref
  67           linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der
  68           Webserver ("<xref linkend="Apache-Konfiguration"/>").</para>
  69         </listitem>
  70
  71         <listitem>
  72           <para><emphasis>Benutzerinformationen speichern können</emphasis>:
  73           man benötigt mindestens eine Datenbank, in der Informationen zur
  74           Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man
  75           das als Administrator macht, verrät "<xref
  76           linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para>
  77         </listitem>
  78
  79         <listitem>
  80           <para><emphasis>Benutzer, Gruppen und Datenbanken
  81           anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
  82           linkend="Benutzer--und-Gruppenverwaltung"/>".</para>
  83         </listitem>
  84
  85         <listitem>
  86           <para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann
  87           kann es losgehen: "<xref linkend="kivitendo-ERP-verwenden"/>"</para>
  88         </listitem>
  89       </orderedlist>
  90
  91       <para>Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls
  92       wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen
  93       werden.</para>
  94     </sect1>
  95
  96     <sect1 id="Benötigte-Software-und-Pakete">
  97       <title>Benötigte Software und Pakete</title>
  98
  99       <sect2 id="Betriebssystem">
 100         <title>Betriebssystem</title>
 101
 102         <para>kivitendo ist für Linux konzipiert, und sollte auf jedem
 103         unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
 104         diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
 105         bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
 106         ohne große Probleme auf den derzeit aktuellen verbreiteten
 107         Distributionen läuft.</para>
 108
 109         <para>Mitte 2020 (ab Version 3.5.6) empfehlen wir:</para>
 110
 111         <itemizedlist>
 112           <listitem>
 113             <para>Debian</para>
 114
 115             <itemizedlist>
 116               <listitem>
 117                 <para>10.0 "Buster"</para>
 118               </listitem>
 119               <listitem>
 120                 <para>11.0 "Bullseye"</para>
 121               </listitem>
 122             </itemizedlist>
 123           </listitem>
 124
 125           <listitem>
 126             <para>20.04 "Focal Fossa" LTS
 127           </para>
 128           </listitem>
 129
 130           <listitem>
 131             <para>openSUSE Leap 15.x und SUSE Linux Enterprise Server 15 GA</para>
 132           </listitem>
 133
 134           <listitem>
 135             <para>Fedora 29</para>
 136           </listitem>
 137         </itemizedlist>
 138       </sect2>
 139
 140       <sect2 id="Pakete" xreflabel="Pakete">
 141         <title>Benötigte Perl-Pakete installieren</title>
 142
 143         <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
 144         Apache) und ein Datenbankserver (PostgreSQL) in einer aktuellen
 145         Version (s.a. Liste der unterstützten Betriebssysteme)
 146         benötigt.</para>
 147
 148         <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht
 149         Bestandteil einer Standard-Perl-Installation sind. Um zu überprüfen,
 150         ob die erforderlichen Pakete installiert und aktuell genug sind, wird
 151         ein Script mitgeliefert, das wie folgt aufgerufen wird:</para>
 152
 153         <programlisting>./scripts/installation_check.pl</programlisting>
 154
 155         <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
 156
 157         <itemizedlist>
 158           <listitem>
 159             <para><literal>Algorithm::CheckDigits</literal></para>
 160           </listitem>
 161
 162           <listitem>
 163             <para><literal>Archive::Zip</literal></para>
 164           </listitem>
 165
 166           <listitem>
 167             <para><literal>CAM::PDF</literal></para>
 168           </listitem>
 169
 170           <listitem>
 171             <para><literal>CGI</literal></para>
 172           </listitem>
 173
 174           <listitem>
 175             <para><literal>Clone</literal></para>
 176           </listitem>
 177
 178           <listitem>
 179             <para><literal>Config::Std</literal></para>
 180           </listitem>
 181
 182           <listitem>
 183             <para><literal>Daemon::Generic</literal></para>
 184           </listitem>
 185
 186           <listitem>
 187             <para><literal>DateTime</literal></para>
 188           </listitem>
 189
 190           <listitem>
 191             <para><literal>DateTime::Event::Cron</literal></para>
 192           </listitem>
 193
 194           <listitem>
 195             <para><literal>DateTime::Format::Strptime</literal></para>
 196           </listitem>
 197
 198           <listitem>
 199             <para><literal>DateTime::Set</literal></para>
 200           </listitem>
 201
 202           <listitem>
 203             <para><literal>DBI</literal></para>
 204           </listitem>
 205
 206           <listitem>
 207             <para><literal>DBD::Pg</literal></para>
 208           </listitem>
 209
 210           <listitem>
 211             <para><literal>Email::Address</literal></para>
 212           </listitem>
 213
 214           <listitem>
 215             <para><literal>Email::MIME</literal></para>
 216           </listitem>
 217
 218           <listitem>
 219             <para><literal>Exception::Class</literal></para>
 220           </listitem>
 221
 222           <listitem>
 223             <para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71
 224             inklusive; siehe <xref
 225             linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para>
 226           </listitem>
 227
 228           <listitem>
 229             <para><literal>File::Copy::Recursive</literal></para>
 230           </listitem>
 231
 232           <listitem>
 233             <para><literal>File::Flock</literal></para>
 234           </listitem>
 235
 236           <listitem>
 237             <para><literal>File::MimeInfo</literal></para>
 238           </listitem>
 239
 240           <listitem>
 241             <para><literal>File::Slurp</literal></para>
 242           </listitem>
 243
 244           <listitem>
 245             <para><literal>GD</literal></para>
 246           </listitem>
 247
 248           <listitem>
 249             <para><literal>HTML::Parser</literal></para>
 250           </listitem>
 251
 252           <listitem>
 253             <para><literal>HTML::Restrict</literal></para>
 254           </listitem>
 255
 256           <listitem>
 257             <para><literal>Image::Info</literal></para>
 258           </listitem>
 259
 260           <listitem>
 261             <para><literal>JSON</literal></para>
 262           </listitem>
 263
 264           <listitem>
 265             <para><literal>List::MoreUtils</literal></para>
 266           </listitem>
 267
 268           <listitem>
 269             <para><literal>List::UtilsBy</literal></para>
 270           </listitem>
 271
 272           <listitem>
 273             <para>LWP::Authen::Digest</para>
 274           </listitem>
 275
 276           <listitem>
 277             <para>LWP::UserAgent</para>
 278           </listitem>
 279
 280           <listitem>
 281             <para><literal>Net::SMTP::SSL</literal> (optional, bei
 282             E-Mail-Versand über SSL; siehe Abschnitt "<xref
 283             linkend="config.sending-email.smtp"/>")</para>
 284           </listitem>
 285
 286           <listitem>
 287             <para><literal>Net::SSLGlue</literal> (optional, bei
 288             E-Mail-Versand über TLS; siehe Abschnitt "<xref
 289             linkend="config.sending-email.smtp"/>")</para>
 290           </listitem>
 291
 292           <listitem>
 293             <para><literal>Params::Validate</literal></para>
 294           </listitem>
 295
 296           <listitem>
 297             <para><literal>PBKDF2::Tiny</literal></para>
 298           </listitem>
 299
 300           <listitem>
 301             <para><literal>PDF::API2</literal></para>
 302           </listitem>
 303
 304           <listitem>
 305             <para><literal>Regexp::IPv6</literal></para>
 306           </listitem>
 307
 308           <listitem>
 309             <para><literal>Rose::Object</literal></para>
 310           </listitem>
 311
 312           <listitem>
 313             <para><literal>Rose::DB</literal></para>
 314           </listitem>
 315
 316           <listitem>
 317             <para><literal>Rose::DB::Object</literal> Version 0.788 oder
 318             neuer</para>
 319           </listitem>
 320
 321           <listitem>
 322             <para><literal>Set::Infinite</literal></para>
 323           </listitem>
 324
 325           <listitem>
 326             <para><literal>String::ShellQuote</literal></para>
 327           </listitem>
 328
 329           <listitem>
 330             <para><literal>Sort::Naturally</literal></para>
 331           </listitem>
 332
 333           <listitem>
 334             <para><literal>Template</literal></para>
 335           </listitem>
 336
 337           <listitem>
 338             <para><literal>Text::CSV_XS</literal></para>
 339           </listitem>
 340
 341           <listitem>
 342             <para><literal>Text::Iconv</literal></para>
 343           </listitem>
 344
 345           <listitem>
 346             <para><literal>Text::Unidecode</literal></para>
 347           </listitem>
 348
 349           <listitem>
 350             <para><literal>URI</literal></para>
 351           </listitem>
 352
 353           <listitem>
 354             <para><literal>XML::Writer</literal></para>
 355           </listitem>
 356
 357           <listitem>
 358             <para><literal>XML::LibXML</literal></para>
 359           </listitem>
 360
 361           <listitem>
 362             <para><literal>YAML::XS</literal> oder <literal>YAML</literal></para>
 363           </listitem>
 364         </itemizedlist>
 365
 366
 367         <para>Seit Version größer v3.5.6 sind die folgenden Pakete hinzugekommen: <literal>XML::LibXML</literal>, <literal>CAM::PDF</literal></para>
 368         <para>Seit Version größer v3.5.3 sind die folgenden Pakete hinzugekommen: <literal>Exception::Class</literal></para>
 369
 370         <para>Seit Version größer v3.5.1 sind die folgenden Pakete hinzugekommen: <literal>Set::Infinite</literal>,
 371         <literal>List::UtilsBy</literal>, <literal>DateTime::Set</literal>, <literal>DateTime::Event::Cron</literal>
 372         <literal>Daemon::Generic</literal>, <literal>DateTime::Event::Cron</literal>, <literal>File::Flock</literal>,
 373         <literal>File::Slurp</literal></para>
 374
 375         <para>Seit Version größer v3.5.0 sind die folgenden Pakete
 376         hinzugekommen: <literal>Text::Unidecode</literal>,
 377         <literal>LWP::Authen::Digest</literal>,
 378         <literal>LWP::UserAgent</literal></para>
 379
 380         <para>Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen:
 381         <literal>Algorithm::CheckDigits</literal>,
 382         <literal>PBKDF2::Tiny</literal></para>
 383
 384         <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen:
 385         <literal>GD</literal>, <literal>HTML::Restrict</literal>,
 386         <literal>Image::Info</literal></para>
 387
 388         <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen:
 389         <literal>File::Copy::Recursive</literal>.</para>
 390
 391         <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen:
 392         <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
 393         <literal>Net::SSLGlue</literal>.</para>
 394
 395         <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
 396         hinzugekommen, <literal>URI</literal> und
 397         <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
 398         nicht.</para>
 399
 400         <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
 401         <literal>DateTime</literal>, <literal>Rose::Object</literal>,
 402         <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
 403         neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
 404
 405         <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
 406         hinzugekommen.</para>
 407
 408         <para><literal>Email::Address</literal> und
 409         <literal>List::MoreUtils</literal> sind schon länger feste
 410         Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
 411         sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
 412         zukünftigen Version aber aus dem Paket entfernt werden. Es wird
 413         empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
 414         installieren.</para>
 415
 416         <sect3>
 417           <title>Debian und Ubuntu</title>
 418           <para>Für Debian und Ubuntu stehen die meisten der benötigten
 419           Pakete als Debian-Pakete zur Verfügung. Sie können mit
 420           folgendem Befehl installiert werden:</para>
 421
 422           <programlisting>apt install  apache2 libarchive-zip-perl libclone-perl \
 423   libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
 424   libemail-address-perl  libemail-mime-perl libfcgi-perl libjson-perl \
 425   liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
 426   libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
 427   librose-db-perl librose-object-perl libsort-naturally-perl \
 428   libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
 429   libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
 430   libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \
 431   libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \
 432   libcrypt-pbkdf2-perl git libcgi-pm-perl libtext-unidecode-perl libwww-perl\
 433   postgresql-contrib poppler-utils libhtml-restrict-perl\
 434   libdatetime-set-perl libset-infinite-perl liblist-utilsby-perl\
 435   libdaemon-generic-perl libfile-flock-perl libfile-slurp-perl\
 436   libfile-mimeinfo-perl libpbkdf2-tiny-perl libregexp-ipv6-perl \
 437   libdatetime-event-cron-perl libexception-class-perl libcam-pdf-perl \
 438   libxml-libxml-perl
 439 </programlisting>
 440 <para>Sollten Pakete nicht zu Verfügung stehen, so können diese auch mittels CPAN installiert werden. Ferner muss für Ubuntu das Repository "Universe" aktiv sein (s.a. Anmerkungen).</para>
 441           <note id="ubuntu-universe">
 442             <para>Die Perl Pakete für Ubuntu befinden sich im "Universe" Repository. Falls dies nicht aktiv ist, kann dies mit folgendem Aufruf aktiviert werden:
 443 <programlisting>add-apt-repository universe</programlisting></para>
 444           </note>
 445         </sect3>
 446
 447         <sect3>
 448           <title>Fedora</title>
 449
 450           <para>Für Fedora stehen die meisten der benötigten Perl-Pakete als
 451           RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
 452           installiert werden:</para>
 453
 454           <programlisting>dnf install httpd mod_fcgid postgresql-server postgresql-contrib\
 455   perl-Algorithm-CheckDigits perl-Archive-Zip perl-CPAN perl-Class-XSAccessor \
 456   perl-Clone perl-Config-Std perl-DBD-Pg perl-DBI perl-Daemon-Generic \
 457   perl-DateTime perl-DateTime-Set perl-Email-Address perl-Email-MIME perl-FCGI \
 458   perl-File-Copy-Recursive perl-File-Flock perl-File-MimeInfo perl-File-Slurp \
 459   perl-GD perl-HTML-Restrict perl-JSON perl-List-MoreUtils perl-List-UtilsBy \
 460   perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PBKDF2-Tiny perl-PDF-API2 \
 461   perl-Params-Validate perl-Regexp-IPv6 perl-Rose-DB perl-Rose-DB-Object \
 462   perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
 463   perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI perl-XML-Writer \
 464   perl-YAML perl-libwww-perl</programlisting>
 465         </sect3>
 466
 467         <sect3>
 468           <title>openSUSE Leap 15.x und SUSE Linux Enterprise Server 15 GA</title>
 469
 470           <para>Für openSUSE Leap 15.x stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung.</para>
 471           <para>Damit diese installiert werden können, muß das System die erforderlichen Repositories kennen und Zugriff über das Internet darauf haben.</para>
 472           <para>Daher machen wir die Repositories dem System bekannt.</para>
 473           <para>Um die zusätzlichen Repositories für die Installation zur Verfügung zu stellen, kann man diese mit YaST oder auch in einem Terminal auf der Konsole bekannt geben. Wir beschränken uns hier mit der Eingabe auf der Konsole. In den allermeisten Fällen verwenden die Administratoren eine sichere SSH-Verbindung zum zu administrierenden Server.</para>
 474           <para>Dazu geben wir folgenden Befehl ein:</para>
 475           <programlisting>zypper addrepo -f \
 476   http://download.opensuse.org/repositories/devel:languages:perl/openSUSE_Leap_15.2/ \
 477   "devel:languages:perl"
 478           </programlisting>
 479           <programlisting>zypper addrepo -f \
 480   https://download.opensuse.org/repositories/devel:languages:haskell:lts:13/\
 481   openSUSE_Leap_15.0/ "devel:languages:haskell:lts:13"
 482           </programlisting>
 483           <programlisting>zypper addrepo -f \
 484   https://download.opensuse.org/repositories/devel:languages:haskell:lts:13/\
 485   openSUSE_Leap_15.0/ "devel:languages:haskell:lts:13"
 486           </programlisting>
 487           <para>Danach geben wir noch die beiden folgenden Befehle ein:</para>
 488           <programlisting>zypper clean</programlisting>
 489           <programlisting>zypper refresh</programlisting>
 490           <para>Sollte zypper eine Meldung ausgeben, ob der Repositorie Key abgelehnt, nicht vertraut oder für immer akzeptiert werden soll, ist die Beantwortung durch drücken der "i" Taste am besten geeignet. Wer noch mehr über zypper erfahren möchte, kann sich einmal die zypper Hilfe anschauen.</para>
 491           <programlisting>zypper --help</programlisting>
 492           <note>
 493           <para>Offiziell wird von openSUSE nur noch Versionen ab 15.2 unterstützt. Die SuSE Macher haben ab Version 15.x einen großen Umbau in der Verwaltung der Pakete vorgenommen, das heißt, der Paketumfang ist der SLES 15 als Programmunterbau angepasst. Dies gilt besonders der openSUSE Distribution. Es gibt ja einmal die openSUSE Distri und die Professionelle SLES Version. Dadurch sind viele Pakete aus dem ursprünglich nur für die openSUSE geltenen Repositorie enfernt worden, aber auch viele auf aktuellem Stand gehalten.</para>
 494           </note>
 495           <para>Ab openSUSE Leap 15.x kann man die Distribution auch als reine Text Version, also ohne KDE Oberfläche aufsetzen. Vorteil hierbei ist, dass weniger Balast und unnötige Pakte installiert werden.</para>
 496           <para>Bei openSUSE Versionen bis 15.x, also 10.x, 11.x, 12.x, 13.x hatte der Administrator die Möglichkeit, bei der Installation der Distribution die KDE Oberfläche zu aktivieren. In dieser Konstellation hat man die Möglichkeit, eine VNC Verbindung vom administrativen Client zu verwenden. Ist das nicht eingerichtet, arbeitet der Admin dann direkt am Bildschirm des Servers. Nun loggen wir uns am Server direkt ein, starten Yast2 in einer Konsole wie folgt:</para>
 497           <para>yast2 return.</para>
 498           <para>Oder über die Menüführung wie folgt: Ein Klick auf das runde Icon, ganz links unten in der Menüleiste, dann die Maus verfahren auf System und YaST.</para>
 499           <para>Im weiteren Verlauf der Installation, beschränken wir uns mit dem Installations Werkzeug zypper. Zypper ist ein Komandozeilen basiertes Installations Tool, welches bei openSUSE Standard ist. Zypper weist ein etwas eigenartiges Verhalten auf, dass sich in etwa wie folgt darstellt. Hat man die Repositories eingerichtet, kann man diese mit Yast als auch mit Zypper benutzen, setzt man einen Befehl wie etwa: zypper up ab, so findet zypper mehr neuere Programmversionen als Yast. Ich habe im allgemeinen noch keine Nachteile damit erlebt.</para>
 500           <para>Programmpakete können mit folgendem Befehl installiert werden:</para>
 501           <para>zypper install Paketname</para>
 502           <para>Es wird empfohlen zusätzliche Pakete nicht direkt mit CPAN zu installieren, da man diese auch über andere Repositories beziehen kann, die bei openSUSE zur Verfügung stehen. Dadurch hat man den Vorteil, dass die Pakete mit YaST verwaltet werden, also wieder deinstalliert oder durch neuere ersetzt werden können. Zudem kann man auch noch eventuelle Bugs an openSUSE senden und diese dem Maintainer melden.</para>
 503
 504           <programlisting>zypper install perl-threads-shared ghc-pdfinfo apache2-mod_fcgid \
 505   yast2-http-server postgresql-server postgresql-contrib perl-Algorithm-CheckDigits \
 506   perl-Archive-Zip perl-CGI perl-CGI-Ajax perl-Clone \
 507   perl-Config-Std perl-Class-XSAccessor perl-Daemon-Generic perl-DateTime \
 508   perl-DateTime-Event-Cron perl-DateTime-Format-Strptime perl-DateTime-Set \
 509   perl-DBI perl-DBD-Pg perl-Devel-REPL perl-FastCGI perl-Email-Address \
 510   perl-Email-MIME perl-Email-MIME-ContentType perl-Email-MIME-Encodings \
 511   perl-FCGI perl-File-Copy-Recursive perl-File-Flock perl-File-MimeInfo \
 512   perl-File-Slurp perl-GD perl-HTML-Restrict perl-Image-Info \
 513   perl-JSON perl-List-MoreUtils perl-List-UtilsBy perl-Log-Log4perl perl-Net-LDAP-Server \
 514   perl-Net-SSLGlue perl-Net-SMTP-SSL perl-PBKDF2-Tiny perl-PDF-API2 \
 515   perl-Params-Validate perl-Regexp-IPv6 perl-Rose-DB perl-Rose-Object \
 516   perl-Rose-DB-Object perl-MooseX-Role-Cmd perl-Set-Crontab perl-Set-Infinite \
 517   perl-Sort-Naturally perl-String-ShellQuote perl-Sys-CPU perl-Template-Toolkit \
 518   perl-Text-CSV_XS perl-Test-Deep perl-Test-Output perl-Text-Iconv \
 519   perl-Text-Unidecode perl-URI perl-URI-Find perl-XML-Writer \
 520   perl-YAML perl-libwww-perl
 521           </programlisting>
 522
 523           <para>Für die Entwickler installiert man noch die folgenden Pakete:</para>
 524
 525           <programlisting>zypper install ghc-mtl-devel ghc-old-locale-devel \
 526   ghc-process-extras-devel ghc-rpm-macros ghc-text-devel ghc-time-devel \
 527   ghc-Cabal-devel ghc-time-locale-compat-devel perl-Log-Log4perl ghc-pdfinfo \
 528   ghc-pdfinfo-devel perl-Devel-REPL perl-URI-Find perl-Class-Utils \
 529   perl-Error-Pure perl-File-Object perl-Readonly perl-Test-Warnings \
 530   perl-Test-NoWarnings perl-Test-Deep perl-Test-Output perl-Test-Strict \
 531   perl-Test-LongString perl-File-Find-Rule
 532           </programlisting>
 533
 534           <para>Zusätzlich müssen einige Pakete für den Umgang mit Latex installiert werden. Die Latex Module barcodes sind nützliche Helfer um auch Barcodes im Dokument zu platzieren, der Vollständigkeit halber hier für die Installation mit angegeben.
 535               Dazu können Sie die folgenden Befehle nutzen:</para>
 536
 537           <programlisting>zypper install texlive-wallpaper texlive-colortbl \
 538   texlive-scrlttr2copy texlive-eurosym \
 539   texlive-geometry texlive-german texlive-graphbox texlive-hyperref \
 540   texlive-xifthen texlive-luainputenc texlive-lastpage texlive-ltabptch \
 541   texlive-nomentbl texlive-threeparttablex texlive-substr texlive-tabulary \
 542   texlive-ulem texlive-wallpaper texlive-xcolor texlive-xstring \
 543   texlive-xypic texlive-mwe texlive-mweights texlive-barcodes \
 544   texlive-GS1 texlive-ean texlive-makebarcode texlive-pst-barcode \
 545   texlive-upca
 546           </programlisting>
 547
 548           <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
 549           werden. Dazu können Sie die folgenden Befehle anwenden:</para>
 550
 551           <programlisting>cpan DateTime::event::Cron DateTime::Set FCGI \
 552   HTML::Restrict PBKDF2::Tiny Rose::Db::Object Set::Infinite</programlisting>
 553         </sect3>
 554       </sect2>
 555
 556       <sect2>
 557         <title>Andere Pakete installieren</title>
 558
 559         <itemizedlist>
 560           <listitem>
 561             <para><literal>poppler-utils</literal> 'pdfinfo' zum Erkennen der Seitenanzahl bei der PDF-Generierung</para>
 562           </listitem>
 563           <listitem>
 564             <para><literal>Postgres Trigram-Index</literal> Für datenbankoptimierte Suchanfragen. Bspw. im Paket <literal>postgresql-contrib</literal> enthalten</para>
 565           </listitem>
 566         </itemizedlist>
 567         <para>Debian und Ubuntu: <programlisting>apt install postgresql-contrib poppler-utils</programlisting></para>
 568         <para>Fedora: <programlisting>dnf install poppler-utils postgresql-contrib</programlisting></para>
 569         <para>openSUSE: <programlisting>zypper install poppler-tools</programlisting></para>
 570       </sect2>
 571     </sect1>
 572
 573     <sect1 id="Manuelle-Installation-des-Programmpaketes"
 574            xreflabel="Manuelle Installation des Programmpaketes">
 575       <title>Manuelle Installation des Programmpaketes</title>
 576
 577       <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github
 578       gehostet und kann <ulink
 579       url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
 580       heruntergeladen werden.</para>
 581
 582       <para>Das aktuelleste kivitendo ERP-Archiv
 583       (<filename>kivitendo-erp-*.tgz</filename>) wird dann im
 584       Dokumentenverzeichnis des Webservers (z.B.
 585       <filename>/var/www/html/</filename>,
 586       <filename>/srv/www/htdocs</filename> oder
 587       <filename>/var/www/</filename>) entpackt:</para>
 588
 589       <programlisting>cd /var/www
 590 tar xvzf kivitendo-erp-*.tgz</programlisting>
 591
 592       <para>Wechseln Sie in das entpackte Verzeichnis:</para>
 593
 594       <programlisting>cd kivitendo-erp</programlisting>
 595
 596       <para>Alternativ können Sie auch einen Alias in der
 597       Webserverkonfiguration benutzen, um auf das tatsächliche
 598       Installationsverzeichnis zu verweisen.</para>
 599
 600       <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
 601       WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
 602
 603       <programlisting>mkdir webdav</programlisting>
 604
 605       <para>Die Verzeichnisse <filename>users</filename>,
 606       <filename>spool</filename> und <filename>webdav</filename> müssen für
 607       den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
 608       restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer-
 609       und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich
 610       (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
 611       <constant>apache</constant> oder bei openSUSE
 612       <constant>wwwrun</constant>).</para>
 613
 614       <para>Der folgende Befehl ändert den Besitzer für die oben genannten
 615       Verzeichnisse auf einem Debian/Ubuntu-System:</para>
 616
 617       <programlisting>chown -R www-data users spool webdav</programlisting>
 618
 619       <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen
 620       <filename>templates</filename> und <filename>users</filename>
 621       Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in
 622       kivitendo angelegt wird:</para>
 623
 624       <programlisting>chown www-data templates users</programlisting>
 625
 626       <note>
 627         <para>Wir empfehlen eine Installation mittels des Versionsmanagager
 628         git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr
 629         viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte
 630         die Pfade anpassen) bspw. wie folgt: <programlisting>cd /var/www/
 631 git clone https://github.com/kivitendo/kivitendo-erp.git
 632 cd kivitendo-erp/
 633 git checkout `git tag -l | egrep -ve "(alpha|beta|rc)" | tail -1`</programlisting>
 634         Erläuterung: Der Befehl wechselt zur letzten Stable-Version (git tag
 635         -l listet alle Tags auf, das egrep schmeisst alle Einträge mit alpha,
 636         beta oder rc raus und das tail gibt davon den obersten Treffer
 637         zurück). Sehr sinnvoll ist es, direkt im Anschluss einen eigenen
 638         Branch zu erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen
 639         damit zu verwalten. Hierfür reicht ein simples <programlisting>  git checkout -b meine_eigenen_änderungen</programlisting>
 640         nach dem letzten Kommando (weiterführende Informationen <ulink
 641         url="http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html">
 642         Git Magic</ulink>).</para>
 643
 644         <para>Ein beispielhafter Workflow für Druckvorlagen-Anpassungen von
 645         3.4.1 nach 3.5: <programlisting>
 646 $ git clone https://github.com/kivitendo/kivitendo-erp.git
 647 $ cd kivitendo-erp/
 648 $ git checkout release-3.4.1                # das ist ein alter release aus dem wir starten ...
 649 $ git checkout -b meine_eigene_änderungen   # unser lokaler branch - unabhängig von allen anderen
 650 $ git add templates/mein_druck              # das sind unsere druckvorlagen inkl. produktbilder
 651 $ git commit -m "juhu tolle änderungen"
 652
 653 [meine_aenderungen 1d89e41] juhu tolle ändernungen
 654  4 files changed, 380 insertions(+)
 655  create mode 100644 templates/mein_druck/img/webdav/tesla.png
 656  create mode 100644 templates/mein_druck/mahnung.tex
 657  create mode 100644 templates/mein_druck/zahlungserinnerung_zwei.tex
 658  create mode 100644 templates/mein_druck/zahlungserinnerung_zwei_invoice.tex
 659
 660 # 5 Jahre später ...
 661 # webserver abschalten!
 662
 663 $ git checkout master
 664 $ git pull                                  # oder git fetch und danach ein stable release tag auswählen (s.o.)
 665 $ git checkout meine_eigenen_änderungen
 666 $ git rebase master
 667
 668 Zunächst wird der Branch zurückgespult, um Ihre Änderungen
 669 darauf neu anzuwenden ...
 670 Wende an: juhu tolle änderungen
 671 $ service apache2 restart                   # webserver starten!
 672 </programlisting></para>
 673       </note>
 674     </sect1>
 675
 676     <sect1 id="config.config-file">
 677       <title>kivitendo-Konfigurationsdatei</title>
 678
 679       <sect2 id="config.config-file.introduction"
 680              xreflabel="Einführung in die Konfigurationsdatei">
 681         <title>Einführung</title>
 682
 683         <para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
 684         benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die
 685         Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von
 686         kivitendo bzw. der Migration von älteren Versionen angelegt
 687         werden.</para>
 688
 689         <para>Als Vorlage dient die Datei
 690         <filename>config/kivitendo.conf.default</filename> (kurz: "die
 691         Default-Datei"):</para>
 692
 693         <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
 694
 695         <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
 696         der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
 697         Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
 698         Abschnitte und Werte enthalten, die von denen der Default-Datei
 699         abweichen.</para>
 700
 701         <note>
 702           <para>Vor der Umbenennung in kivitendo hieß diese Datei noch
 703           <filename>config/lx_office.conf</filename>. Aus Gründen der
 704           Kompatibilität wird diese Datei eingelesen, sofern die Datei
 705           <filename>config/kivitendo.conf</filename> nicht existiert.</para>
 706         </note>
 707
 708         <para>Diese Hauptkonfigurationsdatei ist dann eine
 709         installationsspezifische Datei, d.h. sie enthält bspw. lokale
 710         Passwörter und wird auch nicht im Versionsmanagement (git)
 711         verwaltet.</para>
 712
 713         <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
 714         Mandaten, bzw. Datenbanken gleich.</para>
 715       </sect2>
 716
 717       <sect2 id="config.config-file.sections-parameters">
 718         <title>Abschnitte und Parameter</title>
 719
 720         <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
 721         entsprechend kommentiert sind:</para>
 722
 723         <itemizedlist>
 724           <listitem>
 725             <para><literal>authentication</literal> (siehe Abschnitt "<xref
 726             linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
 727             in diesem Kapitel)</para>
 728           </listitem>
 729
 730           <listitem>
 731             <para><literal>authentication/database</literal></para>
 732           </listitem>
 733
 734           <listitem>
 735             <para><literal>authentication/ldap</literal></para>
 736           </listitem>
 737
 738           <listitem>
 739             <para><literal>system</literal></para>
 740           </listitem>
 741
 742           <listitem>
 743             <para><literal>paths</literal></para>
 744           </listitem>
 745
 746           <listitem>
 747             <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
 748             linkend="config.sending-email.smtp"/>)</para>
 749           </listitem>
 750
 751           <listitem>
 752             <para><literal>applications</literal></para>
 753           </listitem>
 754
 755           <listitem>
 756             <para><literal>environment</literal></para>
 757           </listitem>
 758
 759           <listitem>
 760             <para><literal>print_templates</literal></para>
 761           </listitem>
 762
 763           <listitem>
 764             <para><literal>task_server</literal></para>
 765           </listitem>
 766
 767           <listitem>
 768             <para><literal>periodic_invoices</literal></para>
 769           </listitem>
 770
 771           <listitem>
 772             <para><literal>self_tests</literal></para>
 773           </listitem>
 774
 775           <listitem>
 776             <para><literal>console</literal></para>
 777           </listitem>
 778
 779           <listitem>
 780             <para><literal>testing</literal></para>
 781           </listitem>
 782
 783           <listitem>
 784             <para><literal>testing/database</literal></para>
 785           </listitem>
 786
 787           <listitem>
 788             <para><literal>debug</literal></para>
 789           </listitem>
 790         </itemizedlist>
 791
 792         <para>Die üblicherweise wichtigsten Parameter, die am Anfang
 793         einzustellen oder zu kontrollieren sind, sind:</para>
 794
 795         <programlisting>[authentication]
 796 admin_password = geheim
 797
 798 [authentication/database]
 799 host     = localhost
 800 port     = 5432
 801 db       = kivitendo_auth
 802 user     = postgres
 803 password =
 804
 805 [system]
 806 default_manager = german</programlisting>
 807
 808         <para>Für kivitendo Installationen in der Schweiz sollte hier
 809         <varname>german</varname> durch <varname>swiss</varname> ersetzt
 810         werden.</para>
 811
 812         <para>Die Einstellung <varname>default_manager = swiss</varname>
 813         bewirkt:</para>
 814
 815         <itemizedlist>
 816           <listitem>
 817             <para>Beim Erstellen einer neuen Datenbank in der kivitendo
 818             Administration werden automatisch die Standard-Werte für die
 819             Schweiz voreingestellt: Währung CHF, 5er-Rundung, Schweizer
 820             KMU-Kontenplan, Sollversteuerung, Aufwandsmethode, Bilanzierung
 821             (die Werte können aber manuell angepasst werden).</para>
 822           </listitem>
 823
 824           <listitem>
 825             <para>Einstellen der Standardkonten für Rundungserträge und
 826             -aufwendungen (unter Mandantenkonfiguration → Standardkonten
 827             veränderbar)</para>
 828           </listitem>
 829
 830           <listitem>
 831             <para>das verwendete Zahlenformat wird auf
 832             <varname>1'000.00</varname> eingestellt (unter Programm →
 833             Benutzereinstellungen veränderbar)</para>
 834           </listitem>
 835
 836           <listitem>
 837             <para>DATEV-Automatik und UStVA werden nicht angezeigt,
 838             Erfolgsrechnung ersetzt GUV ( unter Mandantenkonfiguration →
 839             Features veränderbar)</para>
 840           </listitem>
 841         </itemizedlist>
 842
 843         <para>Nutzt man wiederkehrende Rechnungen, kann man unter
 844         <varname>[periodic_invoices]</varname> den Login eines Benutzers
 845         angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
 846         mit Informationen über die erstellten Rechnungen bekommt.</para>
 847
 848         <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
 849         Ausführung bestimmter Aufgaben mit, den <link
 850         linkend="config.task-server">Task-Server</link>. Er wird u.a. für
 851         Features wie die <link
 852         linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
 853         benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
 854         daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
 855         <link linkend="config.task-server">Task-Server</link> genauer
 856         beschrieben.</para>
 857
 858         <para>Für Entwickler finden sich unter <varname>[debug]</varname>
 859         wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
 860       </sect2>
 861
 862       <sect2 id="config.config-file.prior-versions">
 863         <title>Versionen vor 2.6.3</title>
 864
 865         <para>In älteren kivitendo Versionen gab es im Verzeichnis
 866         <filename>config</filename> die Dateien
 867         <filename>authentication.pl</filename> und
 868         <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
 869         gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
 870         zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
 871         2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
 872
 873         <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
 874         jünger müssen die Einstellungen aus den alten Konfigurationsdateien
 875         manuell übertragen und die alten Konfigurationsdateien anschließend
 876         gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
 877         entsprechende Fehlermeldung an.</para>
 878       </sect2>
 879     </sect1>
 880
 881     <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
 882       <title>Anpassung der PostgreSQL-Konfiguration</title>
 883
 884       <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
 885       <para>Dies variert je nach eingesetzter Distribution, da distributionsabhängig unterschiedliche Strategien beim Upgrade der Postgres Version eingesetzt werden.
 886             Als Hinweis einige Links zu den drei Distribution (Stand Dezember 2018):</para>
 887           <itemizedlist>
 888             <listitem>
 889               <para><ulink url="https://fedoraproject.org/wiki/PostgreSQL">Fedora (Postgres-Installation unter Fedora)</ulink></para>
 890             </listitem>
 891             <listitem>
 892               <para><ulink url="https://help.ubuntu.com/lts/serverguide/postgresql.html">Ubuntu (Infos für Postgres für die aktuelle LTS Version)</ulink></para>
 893             </listitem>
 894             <listitem>
 895               <para><ulink url="https://de.opensuse.org/PostgreSQL">OpenSuSE (aktuell nur bis Version OpenSuSE 13 verifiziert)</ulink></para>
 896             </listitem>
 897           </itemizedlist>
 898       <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
 899         <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
 900
 901         <para>kivitendo setzt zwingend voraus, dass die Datenbank
 902         Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
 903         Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
 904
 905         <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
 906         Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
 907         man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
 908
 909         <programlisting>su postgres
 910 echo '\l' | psql
 911 exit </programlisting>
 912
 913         <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
 914         Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
 915         Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
 916         getan werden:</para>
 917
 918         <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
 919
 920         <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
 921         Versionsnummer angepasst werden.</para>
 922
 923         <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
 924
 925         <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
 926         <literal>\l</literal> geprüft werden.</para>
 927       </sect2>
 928
 929       <sect2 id="Änderungen-an-Konfigurationsdateien">
 930         <title>Änderungen an Konfigurationsdateien</title>
 931
 932         <para>In der Datei <filename>postgresql.conf</filename>, die je nach
 933         Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
 934         <filename>/var/lib/pgsql/data/</filename> oder
 935         <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
 936         dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
 937         Parameter <varname>listen_address</varname> gesteuert. Laufen
 938         PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
 939         <literal>localhost</literal> verwendet werden. Andernfalls müssen
 940         Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
 941         was mit dem Wert <literal>*</literal> geschieht.</para>
 942
 943         <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
 944         Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
 945         sein sollte, müssen die Berechtigungen für den Zugriff geändert
 946         werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
 947         nötigen Verbindungen immer zuzulassen, für eine lokal laufende
 948         Datenbank zum Beispiel:</para>
 949
 950         <programlisting>local all kivitendo password
 951 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
 952       </sect2>
 953
 954       <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
 955         <title>Erweiterung für servergespeicherte Prozeduren</title>
 956
 957         <para>In der Datenbank <literal>template1</literal> muss die
 958         Unterstützung für servergespeicherte Prozeduren eingerichet werden.
 959         Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
 960         <programlisting>su - postgres
 961 psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
 962
 963         <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
 964 \q</programlisting>
 965
 966         <note>
 967           <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
 968           bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
 969           anzulegen. In diesen Versionen ist die Extension meist auch schon
 970           vorhanden. Sollten Sie eine ältere Version von Postgres haben,
 971           benutzen Sie stattdessen den folgenden Befehl.</para>
 972
 973           <programlisting>CREATE LANGUAGE 'plpgsql';
 974 \q</programlisting>
 975         </note>
 976       </sect2>
 977
 978       <sect2 id="Erweiterung-für-trigram">
 979         <title>Erweiterung für Trigram Prozeduren</title>
 980
 981         <para>Ab Version 3.5.1 wird die Trigram-Index-Erweiterung benötigt.
 982         Diese wird mit dem SQL-Updatescript
 983         sql/Pg-upgrade2/trigram_extension.sql und Datenbank-Super-Benutzer
 984         Rechten automatisch installiert. Dazu braucht der
 985         DatenbankSuperbenutzer "postgres" ein Passwort.</para>
 986
 987         <programlisting>su - postgres
 988 psql
 989 \password postgres
 990
 991 Eingabe Passwort
 992 \q</programlisting>
 993
 994         <para>Benutzername Postgres und Passwort können jetzt beim Anlegen
 995         einer Datenbank bzw. bei Updatescripten, die SuperuserRechte
 996         benötigen, eingegeben werden.</para>
 997
 998         <note>
 999           <para><literal>pg_trgm</literal> ist je nach Distribution nicht im
1000           Standard-Paket von Postgres enthalten. Ein <programlisting>select * from pg_available_extensions where name ='pg_trgm';</programlisting>
1001           in template1 sollte entsprechend erfolgreich sein. Andernfalls muss
1002           das Paket nachinstalliert werden, bspw. bei debian/ubuntu
1003           <programlisting>apt install postgresql-contrib</programlisting></para>
1004         </note>
1005       </sect2>
1006
1007       <sect2 id="Datenbankbenutzer-anlegen">
1008         <title>Datenbankbenutzer anlegen</title>
1009
1010         <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
1011         benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
1012         anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
1013         können:</para>
1014
1015         <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
1016         nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
1017         generieren nicht nötig.</para>
1018
1019         <programlisting>su - postgres
1020 createuser -d -P kivitendo
1021 exit</programlisting>
1022
1023         <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
1024         Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
1025         bzw. den hier gewählten Benutzernamen.</para>
1026       </sect2>
1027     </sect1>
1028
1029     <sect1 id="Apache-Konfiguration">
1030       <title>Webserver-Konfiguration</title>
1031
1032       <sect2>
1033         <title>Grundkonfiguration mittels CGI</title>
1034
1035         <note>
1036           <para>Für einen deutlichen Performanceschub sorgt die Ausführung
1037           mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
1038           <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
1039         </note>
1040
1041         <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
1042         Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
1043         werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
1044         anderen Datei hinzu, die beim Starten des Webservers eingelesen
1045         wird:</para>
1046
1047         <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
1048 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
1049
1050 &lt;Directory /var/www/kivitendo-erp&gt;
1051  AddHandler cgi-script .pl
1052  Options ExecCGI Includes FollowSymlinks
1053 &lt;/Directory&gt;
1054
1055 &lt;Directory /var/www/kivitendo-erp/users&gt;
1056  Require all granted
1057 &lt;/Directory&gt;</programlisting>
1058
1059         <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
1060         das kivitendo-Archiv entpacket haben.</para>
1061
1062         <note>
1063           <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
1064           Plus ‘<literal>+</literal>’ gesetzt werden.</para>
1065
1066           <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
1067           noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
1068           aktiviert werden.</para>
1069         </note>
1070
1071         <para>Auf einigen Webservern werden manchmal die Grafiken und
1072         Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
1073         geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
1074
1075         <programlisting>EnableSendfile Off</programlisting>
1076       </sect2>
1077
1078       <sect2 id="Apache-Konfiguration.FCGI"
1079              xreflabel="Konfiguration für FastCGI/FCGI">
1080         <title>Konfiguration für FastCGI/FCGI</title>
1081
1082         <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
1083           <title>Was ist FastCGI?</title>
1084
1085           <para>Direkt aus <ulink
1086           url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
1087           kopiert:</para>
1088
1089           <para><citation> FastCGI ist ein Standard für die Einbindung
1090           externer Software zur Generierung dynamischer Webseiten in einem
1091           Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
1092           (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
1093           umgehen. </citation></para>
1094         </sect3>
1095
1096         <sect3 id="Apache-Konfiguration.FCGI.Warum">
1097           <title>Warum FastCGI?</title>
1098
1099           <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
1100           kompiliert. Stattdessen werden die Quelldateien bei jedem Start
1101           übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
1102           ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
1103           einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
1104           müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
1105           immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
1106           benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
1107           entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
1108           führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
1109           deutlich länger dauert als früher, und dass davon 90% für das Laden
1110           der Module verwendet wird.</para>
1111
1112           <para>Mit FastCGI werden nun die Module einmal geladen, und danach
1113           wird nur die eigentliche Programmlogik ausgeführt.</para>
1114         </sect3>
1115
1116         <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
1117           <title>Getestete Kombinationen aus Webservern und Plugin</title>
1118
1119           <para>Folgende Kombinationen sind getestet:</para>
1120
1121           <itemizedlist>
1122             <listitem>
1123               <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
1124             </listitem>
1125             <listitem>
1126               <para>Apache 2.4.18 (Ubuntu 16.04 LTS) und mod_fcgid</para>
1127             </listitem>
1128             <listitem>
1129               <para>Apache 2.4.29 (Ubuntu 18.04 LTS) und mod_fcgid</para>
1130             </listitem>
1131              <listitem>
1132               <para>Apache 2.4.41 (Ubuntu 20.04 LTS) und mod_fcgid</para>
1133             </listitem>
1134
1135           </itemizedlist>
1136
1137           <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
1138           verwendet.</para>
1139
1140           <warning>
1141             <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
1142             strict in der Behandlung von Unicode, und verweigern bestimmte
1143             Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
1144             Installation gibt, muss zwingend Version 0.68 oder aber Version
1145             0.72 und neuer eingesetzt werden.</para>
1146
1147             <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
1148             sich die Vorgängerversion wie folgt installieren:</para>
1149
1150             <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
1151           </warning>
1152         </sect3>
1153
1154         <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
1155           <title>Konfiguration des Webservers</title>
1156
1157           <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
1158           laufen zu lassen, empfiehlt es sich die Installation ersteinmal
1159           unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
1160           debuggen die beim ersten aufsetzen auftreten können. Sollte die
1161           Installation schon funktionieren, lesen Sie weiter.</para>
1162
1163           <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
1164           unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
1165
1166           <programlisting>a2enmod fcgid</programlisting>
1167
1168           <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
1169           erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
1170           und <function>Directory</function>-Direktiven. Dabei wird zwischen
1171           dem Installationspfad von kivitendo im Dateisystem
1172           ("<filename>/path/to/kivitendo-erp</filename>") und der URL
1173           unterschieden, unter der kivitendo im Webbrowser erreichbar ist
1174           ("<filename>/url/for/kivitendo-erp</filename>").</para>
1175
1176           <para>Folgender Konfigurationsschnipsel funktioniert mit
1177           mod_fastcgi:</para>
1178
1179           <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
1180 Alias       /url/for/kivitendo-erp/          /path/to/kivitendo-erp/
1181
1182 &lt;Directory /path/to/kivitendo-erp&gt;
1183   AllowOverride All
1184   Options ExecCGI Includes FollowSymlinks
1185   Require all granted
1186 &lt;/Directory&gt;
1187
1188 &lt;DirectoryMatch /path/to/kivitendo-erp/users&gt;
1189 Require all denied
1190 &lt;/DirectoryMatch&gt;</programlisting>
1191
1192           <warning>
1193             <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
1194             muss entsprechend die Syntax der Directorydirektiven verändert.
1195             Statt</para>
1196
1197             <programlisting>Require all granted</programlisting>
1198
1199             <para>muß man Folgendes einstellen:</para>
1200
1201             <programlisting>
1202   Order Allow,Deny
1203   Allow from All </programlisting>
1204
1205             <para>und statt</para>
1206
1207             <programlisting>Require all denied</programlisting>
1208
1209             <para>muss stehen:</para>
1210
1211             <programlisting>
1212   Order Deny,Allow
1213   Deny from All </programlisting>
1214           </warning>
1215
1216           <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
1217           die maximale Größe eines Requests. Diese sollte wie folgt
1218           hochgesetzt werden:</para>
1219
1220           <programlisting>FcgidMaxRequestLen 10485760</programlisting>
1221
1222           <para>Das Ganze sollte dann so aussehen:</para>
1223
1224           <programlisting>AddHandler fcgid-script .fpl
1225 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1226 Alias       /url/for/kivitendo-erp/          /path/to/kivitendo-erp/
1227 FcgidMaxRequestLen 10485760
1228
1229 &lt;Directory /path/to/kivitendo-erp&gt;
1230   AllowOverride All
1231   Options ExecCGI Includes FollowSymlinks
1232   Require all granted
1233 &lt;/Directory&gt;
1234
1235 &lt;DirectoryMatch /path/to/kivitendo-erp/users&gt;
1236 Require all denied
1237 &lt;/DirectoryMatch&gt;</programlisting>
1238
1239           <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
1240           Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
1241           Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
1242           gibt es hier kleine Performance-Einbußen.</para>
1243
1244           <para>Es ist möglich, die gleiche kivitendo Version parallel unter
1245           CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
1246           wie oben beschrieben, die URLs werden aber umgeleitet:</para>
1247
1248           <programlisting># Zugriff über CGI
1249 Alias       /url/for/kivitendo-erp                /path/to/kivitendo-erp
1250
1251 # Zugriff mit mod_fcgid:
1252 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1253 Alias       /url/for/kivitendo-erp-fcgid/          /path/to/kivitendo-erp/</programlisting>
1254
1255           <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
1256           die normale Version erreichbar, und unter
1257           <constant>/url/for/kivitendo-erp-fcgid/</constant> die
1258           FastCGI-Version.</para>
1259         </sect3>
1260       </sect2>
1261
1262       <sect2>
1263        <title>Authentifizierung mittels HTTP Basic Authentication</title>
1264
1265        <para>
1266         Kivitendo unterstützt, dass Benutzerauthentifizierung über den Webserver mittels des »Basic«-HTTP-Authentifizierungs-Schema erfolgt
1267         (siehe <ulink url="https://tools.ietf.org/html/rfc7617">RFC 7617</ulink>). Dazu ist es aber nötig, dass der dabei vom Client
1268         mitgeschickte Header <constant>Authorization</constant> vom Webserver an Kivitendo über die Umgebungsvariable
1269         <constant>HTTP_AUTHORIZATION</constant> weitergegeben wird, was standardmäßig nicht der Fall ist. Für Apache kann dies über die
1270         folgende Konfigurationsoption aktiviert werden:
1271        </para>
1272
1273        <programlisting>SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1</programlisting>
1274       </sect2>
1275       <sect2>
1276        <title>Aktivierung von mod_rewrite/directory_match für git basierte Installationen</title>
1277
1278        <para>
1279         Aufgrund von aktuellen (Mitte 2020) Sicherheitswarnungen für git basierte Webanwendungen ist die mitausgelieferte .htaccess
1280         restriktiver geworden und verhindert somit das Auslesen von git basierten Daten.
1281         Für debian/ubuntu muss das Modul mod_rewrite einmalig so aktiviert werden:
1282         <programlisting>a2enmod rewrite</programlisting>
1283         Alternativ und für Installationen ohne Apache ist folgender Artikel interessant:
1284         <ulink url="https://www.cyberscan.io/blog/git-luecke">git-lücke</ulink>.
1285         Anstelle des dort beschriebenen DirectoryMatch für Apache2 würden wir etwas weitergehend auch noch das Verzeichnis config miteinbeziehen
1286         sowie ferner auch die Möglichkeit nicht ausschließen, dass es in Unterverzeichnissen auch noch .git Repositories geben kann.
1287         Die Empfehlung für Apache 2.4 wäre damit:
1288         <programlisting>
1289         &lt;DirectoryMatch "/(\.git|config)/"&gt;
1290           Require all denied
1291         &lt;/DirectoryMatch&gt;</programlisting>
1292        </para>
1293       </sect2>
1294
1295
1296       <sect2>
1297         <title>Weitergehende Konfiguration</title>
1298
1299         <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
1300         von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1301         weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1302         Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1303         Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1304         url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1305         (Stand Sept. 2015)</ulink> und einen aktuellen (Stand Mai 2017) <ulink
1306         url="https://mozilla.github.io/server-side-tls/ssl-config-generator/">
1307         SSL-Konfigurations-Generator</ulink>.</para>
1308       </sect2>
1309       <sect3>
1310         <title>Aktivierung von Apache2 modsecurity</title>
1311
1312         <para>Aufgrund des OpenSource Charakters ist kivitendo nicht "out of the box" sicher.
1313   Organisatorisch empfehlen wir hier die enge Zusammenarbeit mit einem kivitendo Partner der auch in der
1314 Lage ist weiterführende Fragen in Bezug auf Datenschutz und Datensicherheit zu beantworten.
1315 Unabhängig davon empfehlen wir im Webserver Bereich die Aktivierung und Konfiguration des Moduls modsecurity für den Apache2, damit
1316 XSS und SQL-Injections verhindert werden.</para>
1317 <para> Als Idee hierfür sei dieser Blog-Eintrag genannt:
1318 <ulink url="https://doxsec.wordpress.com/2017/06/11/using-modsecurity-web-application-firewall-to-prevent-sql-injection-and-xss-using-blocking-rules/">
1319         Test Apache2 modsecurity for SQL Injection</ulink>.</para>
1320       </sect3>
1321
1322     </sect1>
1323
1324     <sect1 id="config.task-server">
1325       <title>Der Task-Server</title>
1326
1327       <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1328       regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1329       festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1330       wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1331       essenzielle Aufgaben benutzt.</para>
1332
1333       <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1334       konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1335       laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1336
1337       <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1338       Servers integriert werden muss, damit er automatisch gestartet wird.
1339       Dies kann kivitendo nicht für Sie erledigen.</para>
1340
1341       <para>Da der Task-Server als Perlscript läuft, wird Arbeitsspeicher, der
1342       einmal benötigt wurde, nicht mehr an das Betriebssystem zurückgegeben,
1343       solange der Task-Server läuft. Dies kann dazu führen, dass ein länger
1344       laufender Task-Server mit der Zeit immer mehr Arbeitsspeicher für sich
1345       beansprucht. Es ist deshalb sinnvoll, dass der Task-Server in
1346       regelmässigen Abständen neu gestartet wird. Allerdings berücksichtigt der
1347       Task-Server ein Memory-Limit, wenn dieses in der Konfigurationsdatei
1348       angegeben ist. Bei Überschreiten dieses Limits beendet sich der
1349       Task-Server. Sofern der Task-Server als systemd-Service mit dem
1350       mitgelieferten Skript eingerichtet wurde, startet dieser danach
1351       automatisch erneut.</para>
1352
1353       <sect2 id="Konfiguration-des-Task-Servers">
1354         <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1355
1356         <para>Die Konfiguration erfolgt über den Abschnitt
1357         <literal>[task_server]</literal> in der Datei
1358         <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1359         Optionen sind:</para>
1360
1361         <variablelist>
1362           <varlistentry>
1363             <term><varname>run_as</varname></term>
1364
1365             <listitem>
1366               <para>Wird der Server vom Systembenutzer <literal>root</literal>
1367               gestartet, so wechselt er auf den mit <literal>run_as</literal>
1368               angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1369               Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1370               (siehe see <xref
1371               linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1372               ist es erforderlich, hier denselben Systembenutzer einzutragen,
1373               unter dem auch der Webserver läuft.</para>
1374             </listitem>
1375           </varlistentry>
1376
1377           <varlistentry>
1378             <term><varname>debug</varname></term>
1379
1380             <listitem>
1381               <para>Schaltet Debug-Informationen an und aus.</para>
1382             </listitem>
1383           </varlistentry>
1384         </variablelist>
1385       </sect2>
1386
1387       <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1388         <title>Konfiguration der Mandanten für den Task-Server</title>
1389
1390         <para>Ist der Task-Server grundlegend konfiguriert, so muss
1391         anschließend jeder Mandant, für den der Task-Server laufen soll,
1392         einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1393         von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1394         ausgewählt werden, unter der der Task-Server seine Arbeit
1395         verrichtet.</para>
1396
1397         <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1398         wird der Task-Server für diesen Mandanten keine Aufgaben
1399         ausführen.</para>
1400       </sect2>
1401
1402       <sect2 id="Einbinden-in-den-Boot-Prozess">
1403         <title>Automatisches Starten des Task-Servers beim Booten</title>
1404
1405         <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1406         reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1407         Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1408
1409         <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1410         Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1411         einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1412         zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1413         anstelle eines symbolischen Links verwendet werden können.</para>
1414
1415         <sect3>
1416           <title>SystemV-basierende Systeme (z.B. ältere Debian, ältere
1417           openSUSE, ältere Fedora)</title>
1418
1419           <para>Kopieren Sie die Datei
1420           <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1421           nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1422           Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1423           <literal>DAEMON=....</literal>). Binden Sie das Script in den
1424           Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1425
1426           <itemizedlist>
1427             <listitem>
1428               <para>Debian-basierende Systeme:</para>
1429
1430               <programlisting>update-rc.d kivitendo-task-server defaults
1431 insserv kivitendo-task-server</programlisting>
1432             </listitem>
1433
1434             <listitem>
1435               <para>Ältere openSUSE und ältere Fedora:</para>
1436
1437               <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1438             </listitem>
1439           </itemizedlist>
1440
1441           <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1442           werden:</para>
1443
1444           <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1445         </sect3>
1446
1447         <sect3>
1448           <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1449
1450           <para>Kopieren Sie die Datei
1451           <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1452           nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1453           Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1454           <literal>exec ....</literal>).</para>
1455
1456           <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1457           werden:</para>
1458
1459           <programlisting>service kivitendo-task-server start</programlisting>
1460         </sect3>
1461
1462         <sect3>
1463           <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1464           Fedora, neuere Ubuntu und neuere Debians)</title>
1465
1466           <para>Kopieren Sie die Datei
1467           <filename>scripts/boot/systemd/kivitendo-task-server.service</filename>
1468           nach <filename>/etc/systemd/system/</filename>. Passen Sie in der
1469           kopierten Datei den Pfad zum Task-Server an (Zeilen
1470           <literal>ExecStart=....</literal> und
1471           <literal>ExecStop=...</literal>).</para>
1472
1473           <para>Machen Sie anschließend das Script systemd bekannt, und binden
1474           Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden Befehl
1475           aus:</para>
1476
1477           <programlisting>systemctl daemon-reload
1478 systemctl enable kivitendo-task-server.service</programlisting>
1479
1480           <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt
1481           den Server neu zu starten, so können Sie das mit dem folgenden
1482           Befehl tun:</para>
1483
1484           <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1485
1486           <para>Ein so eingerichteter Task-Server startet nach Beendigung
1487           automatisch erneut. Das betrifft eine Beendigung über die Oberfläche,
1488           eine Beendingung über die Prozesskontrolle und eine Beendigung bei
1489           Überschreiten des Memory-Limits. Soll der Task-Server nicht erneut
1490           starten, so können Sie ihn mit folgendem Befehl stoppen:</para>
1491
1492           <programlisting>systemctl stop kivitendo-task-server.service</programlisting>
1493
1494         </sect3>
1495       </sect2>
1496
1497       <sect2 id="Prozesskontrolle">
1498         <title>Wie der Task-Server gestartet und beendet wird</title>
1499
1500         <para>Der Task-Server wird wie folgt kontrolliert:</para>
1501
1502         <programlisting>./scripts/task_server.pl Befehl</programlisting>
1503
1504         <para><literal>Befehl</literal> ist dabei eine der folgenden
1505         Optionen:</para>
1506
1507         <itemizedlist>
1508           <listitem>
1509             <para><literal>start</literal> startet eine neue Instanz des
1510             Task-Servers. Die Prozess-ID wird innerhalb des
1511             <filename>users</filename>-Verzeichnisses abgelegt.</para>
1512           </listitem>
1513
1514           <listitem>
1515             <para><literal>stop</literal> beendet einen laufenden
1516             Task-Server.</para>
1517           </listitem>
1518
1519           <listitem>
1520             <para><literal>restart</literal> beendet und startet ihn
1521             neu.</para>
1522           </listitem>
1523
1524           <listitem>
1525             <para><literal>status</literal> berichtet, ob der Task-Server
1526             läuft.</para>
1527           </listitem>yy
1528         </itemizedlist>
1529
1530         <para>Der Task-Server wechselt beim Starten automatisch in das
1531         kivitendo-Installationsverzeichnis.</para>
1532
1533         <para>Dieselben Optionen können auch für die SystemV-basierenden
1534         Runlevel-Scripte benutzt werden (siehe oben).</para>
1535
1536         <para>Wurde der Task-Server als systemd-Service eingerichtet (s.o.),
1537         so startet dieser nach Beendigung automatisch erneut.</para>
1538
1539       </sect2>
1540       <sect2 id="Tasks konfigurieren">
1541         <title>Exemplarische Konfiguration eines Hintergrund-Jobs, der die Jahreszahl in allen Nummernkreisen zum Jahreswechsel erhöht</title>
1542
1543         <para>Hintergrund-Jobs werden über System -> Hintergrund-Jobs und Task-Server -> Aktuelle Hintergrund-Jobs anzeigen -> Aktions-Knopf 'erfassen' angelegt. </para>
1544         <para>Nachdem wir über das Menü dort angelangt sind, legen wir unseren exemplarischen Hintergrund-Jobs "Erhöhung der Nummernkreise" mit folgenden Werten an:</para>
1545         <itemizedlist>
1546           <listitem>
1547             <para><literal>Aktiv:</literal> Hier ein 'Ja' auswählen</para>
1548           </listitem>
1549           <listitem>
1550             <para><literal>Ausführungsart:</literal> 'wiederholte Ausführung' auswählen</para>
1551           </listitem>
1552           <listitem>
1553             <para><literal>Paketname:</literal> 'SetNumberRange' auswählen</para>
1554           </listitem>
1555           <listitem>
1556             <para><literal>Ausführungszeitplan:</literal> Hier entsprechend Werte wie in der crontab eingeben.</para><para>Syntax:</para>
1557 <programlisting>* * * * *
1558 ┬ ┬ ┬ ┬ ┬
1559 │ │ │ │ │
1560 │ │ │ │ └──── Wochentag (0-7, Sonntag ist 0 oder 7)
1561 │ │ │ └────── Monat (1-12)
1562 │ │ └──────── Tag (1-31)
1563 │ └────────── Stunde (0-23)
1564 └──────────── Minute (0-59)  </programlisting>
1565             <para>Die Sterne können folgende Werte haben:</para>
1566             <programlisting>
1567 1 2 3 4 5
1568
1569 1 = Minute (0-59)
1570 2 = Stunde (0-23)
1571 3 = Tag (0-31)
1572 4 = Monat (1-12)
1573 5 = Wochentag (0-7, Sonntag ist 0 oder 7)
1574 </programlisting>
1575 <para>Um die Ausführung auf eine Minute vor Sylvester zu setzen, müssen die folgenden Werte eingetragen werden:</para>
1576 <programlisting>59 23 31 12 *</programlisting>
1577           </listitem>
1578           <listitem>
1579             <para><literal>Daten:</literal>In diesem Feld können optionale Parameter für den Hintergrund im JSON-Format gesetzt werden. Der Hintergrund-Job <literal>SetNumberRange</literal> akzeptiert zwei Variable nämlich <literal>digit_year</literal> sowieso <literal>multiplier</literal>.</para><para> <literal>digit_year</literal> kann zwei Werte haben entweder 2 oder 4, darüber wird gesteuert ob die Jahreszahl zwei oder vierstellig kodiert wird (für 2019, dann entweder 19 oder 2019). Der Standardwert ist vierstellig.</para><para> <literal>multiplier</literal> ist ein Vielfaches von 10, darüber wird die erste Nummer im Nummernkreis (die Anzahl der Stellen) wie folgt bestimmt:</para>
1580 <programlisting>
1581 multiplier     Nummernkreis 2020
1582 10        ->   20200
1583 100       ->   202000
1584 1000      ->   2020000
1585 </programlisting>
1586 <para>Wir gehen jetzt beispielhaft von einer letzten Rechnungsnummer von RE2019456 aus. Demnach sollte ab Januar 2020 die erste Nummer RE2020001 sein. Da der Task auch Präfixe berücksichtigt, kann dies mit folgenden JSON-kodierten Werten umgesetzt werden:</para>
1587 <literal>Daten:</literal><programlisting>multiplier: 100
1588 digits_year: 4</programlisting>
1589           </listitem>
1590         </itemizedlist>
1591      </sect2>
1592     </sect1>
1593     <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1594       <title>Benutzerauthentifizierung und Administratorpasswort</title>
1595
1596       <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1597       über die Verwaltung von Gruppen und weitere Einstellungen</para>
1598
1599       <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1600         <title>Grundlagen zur Benutzerauthentifizierung</title>
1601
1602         <para>kivitendo verwaltet die Benutzerinformationen in einer
1603         Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1604         wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1605         eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1606         können, müssen aber nicht unterschiedlich sein.</para>
1607
1608         <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1609         Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1610         abgelegt werden.</para>
1611
1612         <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter gegen die Authentifizierungsdatenbank oder gegen einen oder
1613         mehrere LDAP-Server überprüft werden.</para>
1614
1615         <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1616         kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1617         Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1618         festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1619         einer Version vor v2.6.0 angelegt werden. Eine
1620         Beispielkonfigurationsdatei
1621         <filename>config/kivitendo.conf.default</filename> existiert, die als
1622         Vorlage benutzt werden kann.</para>
1623       </sect2>
1624
1625       <sect2 id="Administratorpasswort">
1626         <title>Administratorpasswort</title>
1627
1628         <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1629         von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1630         gespeichert. Es kann auch nur dort und nicht mehr im
1631         Administrationsinterface selber geändert werden. Der Parameter dazu
1632         heißt <varname>admin_password</varname> im Abschnitt
1633         <varname>[authentication]</varname>.</para>
1634       </sect2>
1635
1636       <sect2 id="Authentifizierungsdatenbank">
1637         <title>Authentifizierungsdatenbank</title>
1638
1639         <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1640         Parametern in <varname>[authentication/database]</varname>
1641         konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1642
1643         <variablelist>
1644           <varlistentry>
1645             <term><literal>host</literal></term>
1646
1647             <listitem>
1648               <para>Der Rechnername oder die IP-Adresse des
1649               Datenbankservers</para>
1650             </listitem>
1651           </varlistentry>
1652
1653           <varlistentry>
1654             <term><literal>port</literal></term>
1655
1656             <listitem>
1657               <para>Die Portnummer des Datenbankservers, meist 5432</para>
1658             </listitem>
1659           </varlistentry>
1660
1661           <varlistentry>
1662             <term><literal>db</literal></term>
1663
1664             <listitem>
1665               <para>Der Name der Authentifizierungsdatenbank</para>
1666             </listitem>
1667           </varlistentry>
1668
1669           <varlistentry>
1670             <term><literal>user</literal></term>
1671
1672             <listitem>
1673               <para>Der Benutzername, mit dem sich kivitendo beim
1674               Datenbankserver anmeldet (z.B.
1675               "<literal>postgres</literal>")</para>
1676             </listitem>
1677           </varlistentry>
1678
1679           <varlistentry>
1680             <term><literal>password</literal></term>
1681
1682             <listitem>
1683               <para>Das Passwort für den Datenbankbenutzer</para>
1684             </listitem>
1685           </varlistentry>
1686         </variablelist>
1687
1688         <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1689         automatisch anlegen (mehr dazu siehe unten).</para>
1690       </sect2>
1691
1692       <sect2 id="Passwortüberprüfung">
1693         <title>Passwortüberprüfung</title>
1694
1695         <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1696         die Authentifizierungsdatenbank und gegen externe LDAP- oder
1697         Active-Directory-Server. Welche davon benutzt wird, regelt der
1698         Parameter <varname>module</varname> im Abschnitt
1699         <varname>[authentication]</varname>.</para>
1700
1701         <para>Dieser Parameter listet die zu verwendenden Authentifizierungsmodule auf. Es muss mindestens ein Modul angegeben werden, es
1702         können aber auch mehrere angegeben werden. Weiterhin ist es möglich, das LDAP-Modul mehrfach zu verwenden und für jede Verwendung
1703         eine unterschiedliche Konfiguration zu nutzen, z.B. um einen Fallback-Server anzugeben, der benutzt wird, sofern der Hauptserver
1704         nicht erreichbar ist.</para>
1705
1706         <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank geprüft werden, so muss der Parameter
1707         <varname>module</varname> das Modul <literal>DB</literal> enthalten. Sofern das Modul in der Liste enthalten ist, egal an welcher
1708         Position, können sowohl der Administrator als auch die Benutzer selber ihre Passwörter in kivitendo ändern.</para>
1709
1710         <para>Wenn Passwörter gegen einen oder mehrere externe LDAP- oder Active-Directory-Server geprüft werden, so muss der Parameter
1711         <varname>module</varname> den Wert <literal>LDAP</literal> enthalten. In diesem Fall müssen zusätzliche Informationen über den
1712         LDAP-Server im Abschnitt <literal>[authentication/ldap]</literal> angegeben werden. Das Modul kann auch mehrfach angegeben werden,
1713         wobei jedes Modul eine eigene Konfiguration bekommen sollte. Der Name der Konfiguration wird dabei mit einem Doppelpunkt getrennt an
1714         den Modulnamen angehängt (<literal>LDAP:Name-der-Konfiguration</literal>). Der entsprechende Abschnitt in der Konfigurationsdatei
1715         lautet dann <literal>[authentication/Name-der-Konfiguration]</literal>.</para>
1716
1717         <para>Die verfügbaren Parameter für die LDAP-Konfiguration lauten:</para>
1718
1719         <variablelist>
1720           <varlistentry>
1721             <term><literal>host</literal></term>
1722
1723             <listitem>
1724               <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1725               Active-Directory-Servers. Diese Angabe ist zwingend
1726               erforderlich.</para>
1727             </listitem>
1728           </varlistentry>
1729
1730           <varlistentry>
1731             <term><literal>port</literal></term>
1732
1733             <listitem>
1734               <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1735             </listitem>
1736           </varlistentry>
1737
1738           <varlistentry>
1739             <term><literal>tls</literal></term>
1740
1741             <listitem>
1742               <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1743               Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1744               ‘<literal>0</literal>’ belassen</para>
1745             </listitem>
1746           </varlistentry>
1747
1748           <varlistentry>
1749             <term><literal>verify</literal></term>
1750
1751             <listitem>
1752               <para>Wenn Verbindungsverschlüsselung gewünscht und der Parameter <parameter>tls</parameter> gesetzt ist, so gibt dieser
1753               Parameter an, ob das Serverzertifikat auf Gültigkeit geprüft wird. Mögliche Werte sind <literal>require</literal> (Zertifikat
1754               wird überprüft und muss gültig sei; dies ist der Standard) und <literal>none</literal> (Zertifikat wird nicht
1755               überpfüft).</para>
1756             </listitem>
1757           </varlistentry>
1758
1759           <varlistentry>
1760             <term><literal>attribute</literal></term>
1761
1762             <listitem>
1763               <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1764               Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1765               meist ‘<literal>sAMAccountName</literal>’, für andere
1766               LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1767               zwingend erforderlich.</para>
1768             </listitem>
1769           </varlistentry>
1770
1771           <varlistentry>
1772             <term><literal>base_dn</literal></term>
1773
1774             <listitem>
1775               <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1776               Diese Angabe ist zwingend erforderlich.</para>
1777             </listitem>
1778           </varlistentry>
1779
1780           <varlistentry>
1781             <term><literal>filter</literal></term>
1782
1783             <listitem>
1784               <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1785               <literal>&lt;%login%&gt;</literal>, so wird dieses durch den vom
1786               Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1787               der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1788               angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1789             </listitem>
1790           </varlistentry>
1791
1792           <varlistentry>
1793             <term><literal>bind_dn</literal> und
1794             <literal>bind_password</literal></term>
1795
1796             <listitem>
1797               <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1798               durchsucht werden kann (z.B. ist dies bei
1799               Active-Directory-Servern der Fall), so kann diese hier angegeben
1800               werden. Für Active-Directory-Server kann als
1801               ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1802               z.B. ‘<literal>cn=Martin
1803               Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1804               volle Name des Benutzers eingegeben werden; in diesem Beispiel
1805               also ‘<literal>Martin Mustermann</literal>’.</para>
1806             </listitem>
1807           </varlistentry>
1808
1809           <varlistentry>
1810             <term><literal>timeout</literal></term>
1811
1812             <listitem>
1813               <para>Timeout beim Verbindungsversuch, bevor der Server als nicht erreichbar gilt; Standardwert: 10</para>
1814             </listitem>
1815           </varlistentry>
1816         </variablelist>
1817       </sect2>
1818
1819       <sect2 id="Name-des-Session-Cookies">
1820         <title>Name des Session-Cookies</title>
1821
1822         <para>Sollen auf einem Server mehrere kivitendo-Installationen
1823         aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1824         Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1825         Parameter <varname>cookie_name</varname> im Abschnitt
1826         <varname>[authentication]</varname>gesetzt.</para>
1827
1828         <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1829         Server existiert.</para>
1830       </sect2>
1831
1832       <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1833         <title>Anlegen der Authentifizierungsdatenbank</title>
1834
1835         <para>Nachdem alle Einstellungen in
1836         <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1837         kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1838         automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1839         der folgenden URL erreichbar sein sollte:</para>
1840
1841         <para><ulink
1842         url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1843       </sect2>
1844     </sect1>
1845
1846     <sect1 id="Benutzer--und-Gruppenverwaltung">
1847       <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1848
1849       <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1850       Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1851       das Sie unter folgender URL finden:</para>
1852
1853       <para><ulink
1854       url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1855
1856       <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1857       <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1858
1859       <sect2 id="Zusammenhänge">
1860         <title>Zusammenhänge</title>
1861
1862         <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1863         in einer oder zwei Datenbanken gespeichert werden.</para>
1864
1865         <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1866         und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1867         auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1868         Diese Informationen werden in der Authentifizierungsdatenbank
1869         gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1870         in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1871         gespeichert werden.</para>
1872
1873         <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1874         Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1875         Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1876         in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1877         einer solchen Mandantendatenbank werden im Administrationsbereich
1878         konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1879         einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1880
1881         <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1882         die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1883         ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1884         mehr als einem Mandanten, wird empfohlen, für die
1885         Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1886         nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1887       </sect2>
1888
1889       <sect2 id="Mandanten-Benutzer-Gruppen">
1890         <title>Mandanten, Benutzer und Gruppen</title>
1891
1892         <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1893         die sich frei zueinander zuordnen lassen.</para>
1894
1895         <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1896         verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1897         ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1898         vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1899         Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1900         Diese sollte über die <link
1901         linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1902         geschehen.</para>
1903
1904         <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1905         soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1906         der Administrator fest, an welchen Mandanten sich ein Benutzer
1907         anmelden kann, was beim Login verifiziert wird.</para>
1908
1909         <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1910         auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1911         Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1912         Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1913         Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1914         dann an einem Mandanten an, so erhält er alle Rechte von allen
1915         denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1916         denen der Benutzer zum Anderen Mitglied ist,</para>
1917
1918         <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1919         Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1920         folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1921
1922         <orderedlist numeration="arabic">
1923           <listitem>
1924             <para>Datenbank anlegen</para>
1925           </listitem>
1926
1927           <listitem>
1928             <para>Gruppen anlegen</para>
1929           </listitem>
1930
1931           <listitem>
1932             <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1933           </listitem>
1934
1935           <listitem>
1936             <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1937           </listitem>
1938         </orderedlist>
1939       </sect2>
1940
1941       <sect2 id="Datenbanken-anlegen">
1942         <title>Datenbanken anlegen</title>
1943
1944         <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1945         den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1946         Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1947       </sect2>
1948
1949       <sect2 id="Gruppen-anlegen">
1950         <title>Gruppen anlegen</title>
1951
1952         <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1953         Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1954         Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1955         Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1956
1957         <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1958         gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1959         Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1960         gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1961         ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1962         man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1963         A, B und C gültig").</para>
1964
1965         <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1966         dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1967         X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1968         eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1969         Gruppen A, B und C").</para>
1970       </sect2>
1971
1972       <sect2 id="Benutzer-anlegen">
1973         <title>Benutzer anlegen</title>
1974
1975         <para>Beim Anlegen von Benutzern werden für viele Parameter
1976         Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1977         deutschen Raumes entsprechen.</para>
1978
1979         <para>Zwingend anzugeben ist der Loginname. Wenn die
1980         Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
1981         hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
1982         hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1983         deaktiviert.</para>
1984
1985         <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
1986         auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
1987         hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
1988         sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
1989         auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
1990         X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
1991         Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
1992         sind Benutzer A, B und C Mitglieder").</para>
1993       </sect2>
1994
1995       <sect2 id="Mandanten-anlegen">
1996         <title>Mandanten anlegen</title>
1997
1998         <para>Ein Mandant besteht aus Administrationssicht primär aus einem
1999         eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
2000         als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
2001         einer der eben angelegten Datenbanken eingetragen werden.</para>
2002
2003         <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
2004         konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
2005         bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
2006         können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
2007         haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
2008         Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
2009         hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
2010         Gruppe ist für Mandanten A, B und C gültig").</para>
2011       </sect2>
2012     </sect1>
2013
2014     <sect1 id="Drucker--Systemverwaltung">
2015       <title>Drucker- und Systemverwaltung</title>
2016
2017       <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
2018       Druckeradministration und System.</para>
2019
2020       <sect2 id="Druckeradministration">
2021         <title>Druckeradministration</title>
2022
2023         <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
2024         viele "Druckbefehle" im System verwalten. Diese Befehle werden
2025         mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
2026         des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
2027         angezeigt wird.</para>
2028
2029         <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
2030         der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
2031         meinDrucker' oder ein kompletter Pfad zu einem Skript
2032         (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
2033         ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
2034         Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
2035         ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
2036         Ausdruck eines Angebots folgende Vorlage geparst:
2037         sales_quotation_epson_drucker.tex.</para>
2038       </sect2>
2039
2040       <sect2 id="System">
2041         <title>System sperren / entsperren</title>
2042
2043         <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
2044         sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
2045         gesamten kivitendo Installation gesperrt.</para>
2046
2047         <para>Falls die Sperre gesetzt ist, erscheint anstelle der
2048         Anmeldemaske die Information: 'kivitendo ist momentan zwecks
2049         Wartungsarbeiten nicht zugänglich.'.</para>
2050
2051         <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
2052         automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
2053         Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
2054         inkonsistenten Datenbestand weitergearbeitet werden.</para>
2055       </sect2>
2056     </sect1>
2057
2058     <sect1 id="config.sending-email"
2059            xreflabel="E-Mail-Versand aus kivitendo heraus">
2060       <title>E-Mail-Versand aus kivitendo heraus</title>
2061
2062       <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
2063       z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
2064       funktioniert, muss eingestellt werden, über welchen Server die E-Mails
2065       verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
2066       Versand über einen lokalen E-Mail-Server (z.B. mit
2067       <productname>Postfix</productname> oder <productname>Exim</productname>,
2068       was auch die standardmäßig aktive Methode ist) sowie Versand über einen
2069       SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
2070
2071       <para>Welche Methode und welcher Server verwendet werden, wird über die
2072       Konfigurationsdatei <filename>config/kivitendo.conf</filename>
2073       festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
2074       Abschnitt '<literal>[mail_delivery]</literal>'.</para>
2075
2076       <sect2 id="config.sending-email.sendmail"
2077              xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
2078         <title>Versand über lokalen E-Mail-Server</title>
2079
2080         <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
2081         kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
2082         <productname>Postfix</productname>, <productname>Exim</productname>
2083         oder <productname>Sendmail</productname> läuft.</para>
2084
2085         <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
2086         '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
2087         gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
2088
2089         <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
2090         wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
2091         Standardwert verweist auf das Programm
2092         <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
2093         E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
2094
2095         <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
2096         dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
2097         verwiesen.</para>
2098       </sect2>
2099
2100       <sect2 id="config.sending-email.smtp"
2101              xreflabel="E-Mail-Versand über einen SMTP-Server">
2102         <title>Versand über einen SMTP-Server</title>
2103
2104         <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
2105         vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
2106         ist.</para>
2107
2108         <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
2109         '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
2110         Parameter dienen dabei der weiteren Konfiguration:</para>
2111
2112         <variablelist>
2113           <varlistentry>
2114             <term><varname>hostname</varname></term>
2115
2116             <listitem>
2117               <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
2118               '<literal>localhost</literal>'</para>
2119             </listitem>
2120           </varlistentry>
2121
2122           <varlistentry>
2123             <term><varname>port</varname></term>
2124
2125             <listitem>
2126               <para>Portnummer. Der Standardwert hängt von der verwendeten
2127               Verschlüsselungsmethode ab. Gilt '<literal>security =
2128               none</literal>' oder '<literal>security = tls</literal>', so ist
2129               25 die Standardportnummer. Für '<literal>security =
2130               ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
2131               geändert werden.</para>
2132             </listitem>
2133           </varlistentry>
2134
2135           <varlistentry>
2136             <term><varname>security</varname></term>
2137
2138             <listitem>
2139               <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
2140               mit dem Server. Standardwert ist '<literal>none</literal>',
2141               wodurch keine Verschlüsselung verwendet wird. Mit
2142               '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
2143               und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
2144               eingeschaltet. Achtung: Für '<literal>tls</literal>' und
2145               '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
2146               (siehe unten).</para>
2147             </listitem>
2148           </varlistentry>
2149
2150           <varlistentry>
2151             <term><varname>login</varname> und
2152             <varname>password</varname></term>
2153
2154             <listitem>
2155               <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
2156               so können mit diesen zwei Parametern der Benutzername und das
2157               Passwort angegeben werden. Wird Authentifizierung verwendet, so
2158               sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
2159               aktiviert werden.</para>
2160             </listitem>
2161           </varlistentry>
2162         </variablelist>
2163       </sect2>
2164     </sect1>
2165
2166     <sect1 id="Drucken-mit-kivitendo">
2167       <title>Drucken mit kivitendo</title>
2168
2169       <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
2170       Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
2171       einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
2172       debianoiden Betriebssystemen installiert man die Pakete mit:</para>
2173
2174       <para><programlisting>apt install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
2175   texlive-latex-extra texlive-lang-german texlive-generic-extra texlive-xetex ghostscript</programlisting></para>
2176
2177       <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
2178
2179       <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
2180   texlive-collection-latexrecommended texlive-collection-langgerman \
2181   texlive-collection-langenglish</programlisting></para>
2182
2183       <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
2184
2185       <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
2186   texlive-collection-latexrecommended texlive-collection-langgerman \
2187   texlive-collection-langenglish</programlisting></para>
2188
2189       <note>kivitendo erwartet eine aktuelle TeX Live Umgebung, um PDF/A zu erzeugen. Aktuelle Distributionen von 2020 erfüllen diese. Überprüfbar ist dies mit dem Aufruf des installation_check.pl mit Parameter -l: <programlisting>scripts/installations_check.pl -l</programlisting> </note>
2190       <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
2191
2192       <itemizedlist>
2193         <listitem>
2194           <para>RB</para>
2195         </listitem>
2196         <listitem>
2197           <para>marei</para>
2198         </listitem>
2199         <listitem>
2200           <para>rev-odt</para>
2201         </listitem>
2202       </itemizedlist>
2203
2204       <para>Der ehemalige Druckvorlagensatz "f-tex" wurde mit der Version
2205       3.6 entfernt, da er nicht mehr gepflegt wird.</para>
2206
2207       <sect2 id="Vorlagenverzeichnis-anlegen"
2208              xreflabel="Vorlagenverzeichnis anlegen">
2209         <title>Vorlagenverzeichnis anlegen</title>
2210
2211         <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
2212         LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
2213
2214         <programlisting>./scripts/installation_check.pl -lv</programlisting>
2215
2216         <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
2217         Recht "Konfiguration -&gt; Mandantenverwaltung" verfügt. Siehe auch
2218         <xref linkend="Gruppen-anlegen"/>.</para>
2219
2220         <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
2221         -&gt; <guisubmenu>Mandantenverwaltung</guisubmenu> -&gt;
2222         <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
2223         Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
2224
2225         <orderedlist>
2226           <listitem>
2227             <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
2228             Vorlagensatz aus, der kopiert werden soll
2229             (<filename>RB</filename>, <filename>marei</filename> oder
2230             <filename>odt-rev</filename>.)</para>
2231           </listitem>
2232
2233           <listitem>
2234             <para><option>Neuer Name</option>: Der Verzeichnisname für den
2235             neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
2236             für Verzeichnisnamen frei gewählt werden.</para>
2237           </listitem>
2238         </orderedlist>
2239
2240         <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
2241         für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
2242         wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
2243         Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
2244         vorgenommen werden. Den Ordner findet man im Dateisystem unter
2245         <filename>./templates/[Neuer Name]</filename></para>
2246       </sect2>
2247
2248       <sect2 id="Vorlagen-RB">
2249         <title>Der Druckvorlagensatz RB</title>
2250
2251         <para>Hierbei handelt es sich um einen vollständigen LaTeX
2252         Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
2253         sind nicht gepflegt.</para>
2254
2255         <para>Die konzeptionelle Idee der Vorlagen wird <ulink
2256         url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
2257         auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
2258         eigenen Firmendaten finden sich in der Datei Readme.tex im
2259         Vorlagenverzeichnis.</para>
2260
2261         <para>Eine kurze Übersicht der Features:</para>
2262
2263         <itemizedlist>
2264           <listitem>
2265             <para>Mehrsprachenfähig, mit Deutscher und Englischer
2266             Übersetzung</para>
2267           </listitem>
2268
2269           <listitem>
2270             <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
2271             werden, z.B. für Kopf- und Fußzeilen, und Infos wie
2272             Bankdaten</para>
2273           </listitem>
2274
2275           <listitem>
2276             <para>mehrere vordefinierte Varianten für
2277             Logos/Hintergrundbilder</para>
2278           </listitem>
2279
2280           <listitem>
2281             <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
2282             "Außerhalb EU"</para>
2283           </listitem>
2284         </itemizedlist>
2285       </sect2>
2286
2287      <sect2 id="Vorlagen-rev-odt">
2288         <title>Der Druckvorlagensatz rev-odt</title>
2289
2290         <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2291         odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2292         Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2293         Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2294         Zürich erstellt und werden laufend aktualisiert. Ein paar der
2295         Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2296         Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2297
2298         <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2299         KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2300         Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2301         entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2302         wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2303         handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2304
2305         <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2306         den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2307         if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2308         und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2309         die vom Parser nicht korrekt gelesen werden kann.</para>
2310
2311         <para>Mahnungen können unter folgenden Einschränkungen mit den
2312         odt-Vorlagen im Vorlagensatz rev-odt erzeugt werden:</para>
2313
2314         <itemizedlist>
2315           <listitem>
2316             <para>als Druckoption steht nur 'PDF(OpenDocument/OASIS)' zur
2317             Verfügung, das heisst, die Mahnungen werden als PDF-Datei
2318             ausgegeben.</para>
2319           </listitem>
2320
2321           <listitem>
2322             <para>für jede Rechnung muss eine eigene Mahnung erzeugt werden
2323             (auch wenn bei einzelnen KundInnen mehrere überfällige Rechnungen
2324             vorhanden sind).</para>
2325           </listitem>
2326         </itemizedlist>
2327
2328         <para>Mehrere Mahnungen für eine Kundin / einen Kunden werden zu einer
2329         PDF-Datei zusammengefasst</para>
2330
2331         <para>Die Vorlagen zahlungserinnerung.odt sowie mahnung.odt sind für
2332         das Erstellen einer Zahlungserinnerung bzw. Mahnung selbst vorgesehen,
2333         die Vorlage mahnung_invoice.odt für das Erstellen einer Rechnung über
2334         die verrechneten Mahngebühren und Verzugszinsen.</para>
2335
2336         <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2337         odt-Vorlagen bei Briefen und Pflichtenheften einzusetzen.
2338         Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2339
2340         <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2341         empfang@revamp-it.ch</para>
2342       </sect2>
2343
2344       <sect2 id="allgemeine-hinweise-zu-latex">
2345         <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2346
2347         <para>In den allermeisten Installationen sollte das Drucken jetzt
2348         schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2349         Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2350         Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2351         sind zum Beispiel:</para>
2352
2353         <itemizedlist>
2354           <listitem>
2355             <para>! LaTeX Error: File `eurosym.sty' not found. Die
2356             entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2357             allem bei Vorlagen aus der Community auf. Installieren Sie die
2358             entsprechenden Pakete.</para>
2359           </listitem>
2360
2361           <listitem>
2362             <para>! Package inputenc Error: Unicode char \u8:... set up for
2363             use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2364             einer Standardinstallation exotische utf8 Zeichen zu drucken.
2365             TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2366             diversen Tricks dazu gebracht werden andere Zeichen zu
2367             akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2368             Abhilfe.</para>
2369           </listitem>
2370         </itemizedlist>
2371
2372         <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2373         Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2374         gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2375         <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2376         (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2377         darf.</para>
2378
2379         <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2380         verifizieren lässt:</para>
2381
2382         <itemizedlist>
2383           <listitem>
2384             <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2385             "keep_temp_files" auf 1</para>
2386
2387             <para><programlisting>keep_temp_files = 1;</programlisting></para>
2388           </listitem>
2389
2390           <listitem>
2391             <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2392           </listitem>
2393
2394           <listitem>
2395             <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2396           </listitem>
2397
2398           <listitem>
2399             <para>wechsel in das users Verzeichnis von kivitendo</para>
2400
2401             <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2402           </listitem>
2403
2404           <listitem>
2405             <para>LaTeX Suchpfad anpassen:</para>
2406
2407             <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2408           </listitem>
2409
2410           <listitem>
2411             <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2412             erstellt hat</para>
2413
2414             <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2415
2416             <para>Es sollte die letzte Datei ganz unten sein</para>
2417           </listitem>
2418
2419           <listitem>
2420             <para>für besseren Hinweis auf Fehler texdatei nochmals
2421             übersetzen</para>
2422
2423             <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2424
2425             <para>in der *.tex datei nach dem Fehler suchen.</para>
2426           </listitem>
2427         </itemizedlist>
2428       </sect2>
2429     </sect1>
2430
2431     <sect1 id="OpenDocument-Vorlagen">
2432       <title>OpenDocument-Vorlagen</title>
2433
2434       <para>kivitendo unterstützt die Verwendung von Vorlagen im
2435       OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2)
2436       erzeugen. kivitendo kann dabei sowohl neue OpenDocument-Dokumente als
2437       auch aus diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2438       OpenDocument-Vorlagen zu aktivieren muss in der Datei
2439       <filename>config/kivitendo.conf</filename> die Variable
2440       <literal>opendocument</literal> im Abschnitt
2441       <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2442       Dieses ist die Standardeinstellung.</para>
2443
2444       <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2445       weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2446       LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt
2447       werden, so muss neben LibreOffice oder OpenOffice auch der “X virtual
2448       frame buffer” (xvfb) installiert werden. Bei Debian ist er im Paket
2449       “xvfb” enthalten. Andere Distributionen enthalten ihn in anderen
2450       Paketen.</para>
2451
2452       <para>Nach der Installation müssen in der Datei
2453       <filename>config/kivitendo.conf</filename> im Abschnitt
2454       <literal>applications</literal> zwei weitere Variablen angepasst
2455       werden:</para>
2456
2457       <para><literal>openofficeorg_writer</literal> muss den vollständigen
2458       Pfad zu LibreOffice oder OpenOffice enthalten. Dabei dürfen keine
2459       Anführungszeichen eingesetzt werden.</para>
2460
2461       <para>Beispiel für Debian oder Ubuntu:</para>
2462
2463       <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2464
2465       <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2466       enthalten.</para>
2467
2468       <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2469       LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die
2470       benutzt wird, wenn die Variable <literal>$openofficeorg_daemon</literal>
2471       gesetzt ist, startet ein LibreOffice oder OpenOffice, das auch nach der
2472       Umwandlung des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen
2473       wird dann diese laufende Instanz benutzt. Der Vorteil ist, dass die Zeit
2474       zur Umwandlung deutlich reduziert wird, weil nicht für jedes Dokument
2475       ein LibreOffice bzw. OpenOffice gestartet werden muss. Der Nachteil ist,
2476       dass diese Methode Python und die Python-UNO-Bindings benötigt, die
2477       Bestandteil von LibreOffice bzw. OpenOffice sind.</para>
2478
2479       <note>
2480         <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2481         normalerweise der Python-Interpreter
2482         <filename>/usr/bin/python</filename> benutzt. Sollte dies nicht der
2483         richtige sein, so kann man mit zwei Konfigurationsvariablen
2484         entscheiden, welcher Python-Interpreter genutzt wird. Mit der Option
2485         <literal>python_uno</literal> aus dem Abschnitt
2486         <literal>applications</literal> wird der Interpreter selber
2487         festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2488         <literal>/usr/bin/python</literal>.</para>
2489
2490         <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2491         neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2492         z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2493         OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2494         <literal>python_uno_path</literal> und befindet sich im Abschnitt
2495         <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2496         hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2497         voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2498         über die Umgebungsvariable <literal>PYTHONPATH</literal>
2499         übergeben.</para>
2500       </note>
2501
2502       <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2503       wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet und
2504       die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses Makro muss
2505       in der Dokumentenvorlage enthalten sein und
2506       “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2507       ‘<literal>templates/print/rev-odt/invoice.odt</literal>’ enthält ein
2508       solches Makro, das in jeder anderen Dokumentenvorlage ebenfalls
2509       enthalten sein muss.</para>
2510
2511       <para>Als letztes muss herausgefunden werden, welchen Namen OpenOffice
2512       bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen gibt.
2513       Unter Debian ist dies momentan <literal>~/.config/libreoffice</literal>.
2514       kivitendo verwendet das Verzeichnis
2515       <literal>users/.openoffice.org2</literal>. Eventuell muss dieses
2516       Verzeichnis umbenannt werden.</para>
2517
2518       <para>Dieses Verzeichnis, wie auch das komplette
2519       <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2520       sein. Dieses wurde bereits erledigt (siehe <xref
2521       linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber erneut
2522       überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.</para>
2523
2524       <sect2>
2525         <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2526
2527         <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2528         Aufgaben erfüllen.</para>
2529
2530         <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2531         role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2532         Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2533         benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2534         Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2535         zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2536         Anpassungen aufgeführt</emphasis>):</para>
2537
2538         <sect3>
2539           <title>Bezeichnung der Vorlagen</title>
2540
2541           <para>Rechnung: invoice_besr.odt, Auftrag:
2542           sales_order_besr.odt</para>
2543         </sect3>
2544
2545         <sect3>
2546           <title>Vorbereitungen im Adminbereich</title>
2547
2548           <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2549           Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2550           Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2551           ein Drucker eingerichtet werden:</para>
2552
2553           <itemizedlist>
2554             <listitem>
2555               <para>Druckeradministration → Drucker hinzufügen</para>
2556             </listitem>
2557
2558             <listitem>
2559               <para>Mandant wählen</para>
2560             </listitem>
2561
2562             <listitem>
2563               <para>Druckerbeschreibung → aussagekräftiger Text: wird in der
2564               Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B. mit
2565               Einzahlungsschein Bank xy)</para>
2566             </listitem>
2567
2568             <listitem>
2569               <para>Druckbefehl → beliebiger Text (hat für das Erzeugen von
2570               Aufträgen oder Rechnungen als odt-Datei keine Bedeutung, darf
2571               aber nicht leer sein)</para>
2572             </listitem>
2573
2574             <listitem>
2575               <para>Vorlagenkürzel → besr bzw. selbst gewähltes Vorlagensuffix
2576               (muss genau der Zeichenfolge entsprechen, die zwischen
2577               "invoice_" bzw. "sales_order_" und ".odt" steht.)</para>
2578             </listitem>
2579
2580             <listitem>
2581               <para>speichern</para>
2582             </listitem>
2583           </itemizedlist>
2584         </sect3>
2585
2586         <sect3>
2587           <title>Benutzereinstellungen</title>
2588
2589           <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2590           im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2591           dies persönlich für sich bei den Benutzereinstellungen
2592           konfigurieren:</para>
2593
2594           <itemizedlist>
2595             <listitem>
2596               <para>Programm → Benutzereinstellungen → Druckoptionen</para>
2597             </listitem>
2598
2599             <listitem>
2600               <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2601             </listitem>
2602
2603             <listitem>
2604               <para>Standardausgabekanal → Bildschirm</para>
2605             </listitem>
2606
2607             <listitem>
2608               <para>Standarddrucker → gewünschte Druckerbeschreibung auswählen
2609               (z.B. mit Einzahlungsschein Bank xy)</para>
2610             </listitem>
2611
2612             <listitem>
2613               <para>Anzahl Kopien → leer</para>
2614             </listitem>
2615
2616             <listitem>
2617               <para>speichern</para>
2618             </listitem>
2619           </itemizedlist>
2620         </sect3>
2621
2622         <sect3>
2623           <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2624
2625           <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2626           aus dem von kivitendo erzeugten odt-Dokument die korrekte
2627           Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2628           OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2629           schreiben.</para>
2630
2631           <itemizedlist>
2632             <listitem>
2633               <para>Für den Einzahlungsschein ist die letzte Seite des
2634               Dokuments reserviert</para>
2635             </listitem>
2636
2637             <listitem>
2638               <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2639               Zeile mit folgenden Angaben (<emphasis
2640               role="bold">Bank-Konto-Identifikationsnummer und
2641               Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2642               Bank angepasst werden</emphasis>):<itemizedlist>
2643                   <listitem>
2644                     <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2645                     (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2646                         <listitem>
2647                           <para>erster Wert: <emphasis
2648                           role="bold">Bank-Konto-Identifikation</emphasis>
2649                           (nur Ziffern, maximal 6), <emphasis role="bold">muss
2650                           angepasst werden</emphasis>.</para>
2651                         </listitem>
2652
2653                         <listitem>
2654                           <para>zweiter Wert: &lt;%customernumber%&gt;
2655                           (Kundennummer: nur Ziffern, maximal 6)</para>
2656                         </listitem>
2657
2658                         <listitem>
2659                           <para>dritter Wert: &lt;%ordnumber%&gt;
2660                           (Auftragsnummer bei Auftragsvorlage
2661                           sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2662                           führende Buchstaben werden vom Makro entfernt</para>
2663                         </listitem>
2664
2665                         <listitem>
2666                           <para>vierter Wert: &lt;%invnumber%&gt;
2667                           (Rechnungsnummer bei Rechnungsvorlage
2668                           invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2669                           führende Buchstaben werden vom Makro entfernt</para>
2670                         </listitem>
2671                       </itemizedlist></para>
2672                   </listitem>
2673
2674                   <listitem>
2675                     <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2676                     Bank, muss angepasst werden</emphasis>.</para>
2677                   </listitem>
2678
2679                   <listitem>
2680                     <para>DDDBETRAG: &lt;%total%&gt; Einzahlungsbetrag oder 0,
2681                     falls Einzahlungsschein ohne Betrag</para>
2682                   </listitem>
2683
2684                   <listitem>
2685                     <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2686                   </listitem>
2687                 </itemizedlist></para>
2688             </listitem>
2689
2690             <listitem>
2691               <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2692               der Name und die Adresse der Bank, die Postkonto-Nummer der
2693               Bank, sowie der eigene Firmenname und die Firmenadresse
2694               angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2695               sich die Positionen der Postkonto-Nummern der Bank, sowie der
2696               Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2697               verschieben.</para>
2698             </listitem>
2699           </itemizedlist>
2700
2701           <screenshot>
2702             <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2703             ändernde Einträge in rot</screeninfo>
2704
2705             <mediaobject>
2706               <imageobject>
2707                 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2708               </imageobject>
2709             </mediaobject>
2710           </screenshot>
2711         </sect3>
2712
2713         <sect3>
2714           <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2715           odt-Rechnung (analog bei Auftrag)</title>
2716
2717           <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2718           OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2719           Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2720           den Benutzereinstellungen als persönlicher Standard gewählt
2721           wurde.</para>
2722         </sect3>
2723
2724         <sect3>
2725           <title>Makroeinstellungen in LibreOffice anpassen</title>
2726
2727           <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2728           die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2729           ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2730           angepasst werden:</para>
2731
2732           <itemizedlist>
2733             <listitem>
2734               <para>Extras → Optionen → Sicherheit → Makrosicherheit</para>
2735             </listitem>
2736
2737             <listitem>
2738               <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2739               Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2740               von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2741               werden.)</para>
2742             </listitem>
2743
2744             <listitem>
2745               <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2746               der entsprechenden Nachfrage "Makros ausführen"
2747               auswählen.</para>
2748
2749               <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2750               so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2751               ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2752               Vorlagen sind keine speziellen Einstellungen in LibreOffice
2753               nötig.</para>
2754             </listitem>
2755           </itemizedlist>
2756         </sect3>
2757       </sect2>
2758     </sect1>
2759
2760     <sect1 id="nomenclature">
2761       <title>Nomenklatur</title>
2762
2763       <sect2 id="booking.dates">
2764         <title>Datum bei Buchungen</title>
2765
2766         <para>Seit der Version 3.5 werden für Buchungen in kivitendo
2767         einheitlich folgende Bezeichnungen verwendet:</para>
2768
2769         <itemizedlist>
2770           <listitem>
2771             <para><option>Erfassungsdatum</option> (en: <option>Entry
2772             Date</option>, code: <option>Gldate</option>)</para>
2773
2774             <para>bezeichnet das Datum, an dem die Buchung in kivitendo
2775             erfasst wurde.</para>
2776           </listitem>
2777
2778           <listitem>
2779             <para><option>Buchungsdatum</option> (en: <option>Booking
2780             Date</option>, code: <option>Transdate</option>)</para>
2781
2782             <para>bezeichnet das buchhaltungstechnisch für eine Buchung
2783             relevante Datum</para>
2784
2785             <para>Das <option>Rechnungsdatum</option> bei Verkaufs- und
2786             Einkaufsrechnungen entspricht dem Buchungsdatum. Das heisst, in
2787             Berichten wie dem Buchungsjournal, in denen eine Spalte
2788             <option>Buchungsdatum</option> angezeigt werden kann, erscheint
2789             hier im Fall von Rechnungen das Rechnungsdatum.</para>
2790           </listitem>
2791
2792           <listitem>
2793             <para>Bezieht sich ein verbuchter Beleg auf einen Zeitpunkt, der
2794             nicht mit dem Buchungsdatum übereinstimmt, so kann dieses Datum
2795             momentan in kivitendo nur unter Bemerkungen erfasst werden.</para>
2796
2797             <para>Möglicherweise wird für solche Fälle in einer späteren
2798             Version von kivitendo ein dritter Datumswert für Buchungen
2799             erstellt. (Beispiel: Einkaufsbeleg stammt aus einem früheren Jahr,
2800             das bereits buchhaltungstechnisch abgeschlossen wurde, und muss
2801             deshalb später verbucht werden.)</para>
2802           </listitem>
2803         </itemizedlist>
2804       </sect2>
2805     </sect1>
2806
2807     <sect1 id="config.eur">
2808       <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
2809       EUR</title>
2810
2811       <sect2 id="config.eur.introduction"
2812              xreflabel="Einführung in die Konfiguration zur EUR">
2813         <title>Einführung</title>
2814
2815         <para>kivitendo besaß bis inklusive Version 2.6.3 einen
2816         Konfigurationsparameter namens <varname>eur</varname>, der sich in der
2817         Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
2818         noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
2819         für alle Mandanten, die in dieser Installation benutzt wurden.</para>
2820
2821         <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
2822         die Mandantendatenbank verschoben und dabei auch gleich in drei
2823         Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
2824         steuern lässt.</para>
2825       </sect2>
2826
2827       <sect2 id="config.eur.parameters"
2828              xreflabel="Konfigurationsparameter für EUR">
2829         <title>Konfigurationsparameter</title>
2830
2831         <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
2832         Versteuerungsart und die Warenbuchungsmethode regeln:</para>
2833
2834         <variablelist>
2835           <varlistentry>
2836             <term><varname>profit_determination</varname></term>
2837
2838             <listitem>
2839               <para>Dieser Parameter legt die Berechnungsmethode für die
2840               Gewinnermittlung fest. Er enthält entweder
2841               <literal>balance</literal> für
2842               Betriebsvermögensvergleich/Bilanzierung oder
2843               <literal>income</literal> für die
2844               Einnahmen-Überschuss-Rechnung.</para>
2845             </listitem>
2846           </varlistentry>
2847
2848           <varlistentry>
2849             <term><varname>accounting_method</varname></term>
2850
2851             <listitem>
2852               <para>Dieser Parameter steuert die Buchungs- und
2853               Berechnungsmethoden für die Versteuerungsart. Er enthält
2854               entweder <literal>accrual</literal> für die Soll-Versteuerung
2855               oder <literal>cash</literal> für die Ist-Versteuerung.</para>
2856             </listitem>
2857           </varlistentry>
2858
2859           <varlistentry>
2860             <term><varname>inventory_system</varname></term>
2861
2862             <listitem>
2863               <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
2864               enthält entweder <literal>perpetual</literal> für die
2865               Bestandsmethode oder <literal>periodic</literal> für die
2866               Aufwandsmethode.</para>
2867             </listitem>
2868           </varlistentry>
2869         </variablelist>
2870
2871         <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
2872         <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
2873         Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
2874         bedeutete hingegen Bilanzierung, Soll-Versteuerung und
2875         Bestandsmethode.</para>
2876
2877         <para>Die Konfiguration "<varname>eur</varname>" unter
2878         <varname>[system]</varname> in der <link
2879         linkend="config.config-file">Konfigurationsdatei</link>
2880         <filename>config/kivitendo.conf</filename> wird nun nicht mehr
2881         benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
2882       </sect2>
2883
2884       <sect2 id="config.eur.setting-parameters">
2885         <title>Festlegen der Parameter</title>
2886
2887         <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
2888         der Admininstration können diese Optionen nun unabhängig voneinander
2889         eingestellt werden.</para>
2890
2891         <para>Für die Schweiz sind folgende Einstellungen üblich:
2892         <itemizedlist>
2893             <listitem>
2894               <para>Sollversteuerung</para>
2895             </listitem>
2896
2897             <listitem>
2898               <para>Aufwandsmethode</para>
2899             </listitem>
2900
2901             <listitem>
2902               <para>Bilanzierung</para>
2903             </listitem>
2904           </itemizedlist> Diese Einstellungen werden automatisch beim
2905         Erstellen einer neuen Datenbank vorausgewählt, wenn in
2906         <filename>config/kivitendo.conf</filename> unter
2907         <varname>[system]</varname> <literal>default_manager = swiss</literal>
2908         eingestellt ist.</para>
2909
2910         <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
2911         Variablen werden so gesetzt, daß sich an der Funktionalität nichts
2912         ändert.</para>
2913
2914         <para>Die aktuelle Konfiguration wird unter Nummernkreise und
2915         Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
2916         angezeigt. Unter <guimenu>System</guimenu> →
2917         <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
2918         Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
2919         Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
2920         verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
2921         auch <link linkend="config.eur.inventory-system-perpetual">
2922         Bemerkungen zur Bestandsmethode</link>).</para>
2923       </sect2>
2924
2925       <sect2 id="config.eur.inventory-system-perpetual">
2926         <title>Bemerkungen zur Bestandsmethode</title>
2927
2928         <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
2929         funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
2930         Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
2931         werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
2932         anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
2933         der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
2934         Einkaufsrechnungen berechnet wird.</para>
2935
2936         <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
2937         wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
2938         im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
2939         wechseln.</para>
2940       </sect2>
2941
2942       <sect2 id="config.eur.knonw-issues">
2943         <title>Bekannte Probleme</title>
2944
2945         <para>Bei bestimmten Berichten kann man derzeit noch inviduell
2946         einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
2947         werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
2948         Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
2949         die Konfigurationsvariable
2950         <varname>$::lx_office_conf{system}-&gt;{eur}</varname> ausgewertet
2951         wurde.</para>
2952
2953         <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
2954         Optionen bewirken, z.B. mit zwei Standardfällen.</para>
2955       </sect2>
2956     </sect1>
2957
2958     <sect1 id="config.skr04-update-3804">
2959       <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
2960
2961       <sect2 id="config.skr04-update-3804.introduction">
2962         <title>Einführung</title>
2963
2964         <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
2965         Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
2966         kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
2967         erstellt und die Steuereinstellungen korrekt einstellt. Hat der
2968         Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
2969         Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
2970         Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
2971         vielleicht schon selbst geholfen hat und mit seinen Änderungen
2972         zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
2973         ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
2974         Screenshots dargestellt.</para>
2975
2976         <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
2977         USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
2978         dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
2979         und diese Buchungen sollten entsprechend kontrolliert werden.</para>
2980       </sect2>
2981
2982       <sect2 id="config.skr04-update-3804.create-chart">
2983         <title>Konto 3804 manuell anlegen</title>
2984
2985         <para>Die folgenden Schritte sind notwendig, um das Konto manuell
2986         anzulegen und zu konfigurieren. Zuerst wird in
2987         <guimenu>System</guimenu> → <guisubmenu>Kontenübersicht</guisubmenu> →
2988         <guimenuitem>Konto erfassen</guimenuitem> das Konto angelegt.</para>
2989
2990         <screenshot>
2991           <screeninfo>Konto 3804 erfassen</screeninfo>
2992
2993           <mediaobject>
2994             <imageobject>
2995               <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
2996             </imageobject>
2997           </mediaobject>
2998         </screenshot>
2999
3000         <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
3001         werden. Dazu unter <guimenu>System</guimenu> →
3002         <guisubmenu>Steuern</guisubmenu> →
3003         <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
3004         13 auswählen und ihn wie im folgenden Screenshot angezeigt
3005         anpassen.</para>
3006
3007         <screenshot>
3008           <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
3009
3010           <mediaobject>
3011             <imageobject>
3012               <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
3013             </imageobject>
3014           </mediaobject>
3015         </screenshot>
3016
3017         <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
3018         Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
3019         <guisubmenu>Steuern</guisubmenu> → <guimenuitem>Erfassen</guimenuitem>
3020         auswählen und die Werte aus dem Screenshot übernehmen.</para>
3021
3022         <screenshot>
3023           <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
3024
3025           <mediaobject>
3026             <imageobject>
3027               <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
3028             </imageobject>
3029           </mediaobject>
3030         </screenshot>
3031
3032         <para>Als Nächstes sind alle Konten anzupassen, die als
3033         Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
3034         Steuerautomatik auf 3804 bekommen. Dies betrifft in der
3035         Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
3036         müssen Sie dazu unter <guimenu>System</guimenu> →
3037         <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
3038         anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
3039         wie im Screenshot gezeigt vornehmen.</para>
3040
3041         <screenshot>
3042           <screeninfo>Konto 4315 anpassen</screeninfo>
3043
3044           <mediaobject>
3045             <imageobject>
3046               <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
3047             </imageobject>
3048           </mediaobject>
3049         </screenshot>
3050
3051         <para>Als Letztes sollte die Steuerliste unter
3052         <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
3053         <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
3054         Vergleich der Screenshot.</para>
3055
3056         <screenshot>
3057           <screeninfo>Steuerliste vergleichen</screeninfo>
3058
3059           <mediaobject>
3060             <imageobject>
3061               <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
3062             </imageobject>
3063           </mediaobject>
3064         </screenshot>
3065       </sect2>
3066     </sect1>
3067
3068     <sect1 id="config.bilanz">
3069       <title>Verhalten des Bilanzberichts</title>
3070
3071       <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
3072       Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
3073       monatsweise führt dies zu falschen Werten.</para>
3074
3075       <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
3076       einstellen indem man:</para>
3077
3078       <itemizedlist>
3079         <listitem>
3080           <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
3081           vorher)</para>
3082         </listitem>
3083
3084         <listitem>
3085           <para>immer den Jahresanfang nimmt (1.1. relativ zum
3086           Stichtag)</para>
3087         </listitem>
3088
3089         <listitem>
3090           <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
3091
3092           <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3093           gibt</para>
3094
3095           <para>- oder mit "alle Buchungen" als Alternative"</para>
3096         </listitem>
3097
3098         <listitem>
3099           <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3100           gibt</para>
3101         </listitem>
3102
3103         <listitem>
3104           <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
3105         </listitem>
3106       </itemizedlist>
3107
3108       <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
3109       ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
3110       = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
3111       Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
3112       durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
3113       sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
3114       und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
3115       den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
3116       Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
3117       Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
3118       Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
3119       Erfolgsrechnung.</para>
3120     </sect1>
3121
3122     <sect1 id="config.erfolgsrechnung">
3123       <title>Erfolgsrechnung</title>
3124
3125       <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht
3126       <emphasis role="bold"> Erfolgsrechnung</emphasis>.</para>
3127
3128       <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter
3129       Features an- oder abgeschaltet werden. Mit der Einstellung
3130       <varname>default_manager = swiss </varname> in der
3131       <filename>config/kivitendo.conf</filename> wird beim neu Erstellen einer
3132       Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü
3133       <guimenu>Berichte </guimenu> ausgewählt und ersetzt dort die GUV.</para>
3134
3135       <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche
3136       Aufwands- und Erlöskonten einzeln aufgelistet (analog zur Bilanz),
3137       sortiert nach ERTRAG und AUFWAND.</para>
3138
3139       <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der
3140       Erfolgsrechnung erscheinen soll, unter <varname>Sonstige
3141       Einstellungen/Erfolgsrechnung</varname> entweder
3142       <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal>
3143       ausgewählt werden.</para>
3144
3145       <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal>
3146       ausgewählt, so wird dieses Konto als Aufwandsminderung unter AUFWAND
3147       aufgelistet.</para>
3148
3149       <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal>
3150       ausgewählt, so wird dieses Konto als Ertragsminderung unter ERTRAG
3151       aufgelistet.</para>
3152
3153       <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft
3154       zusätzlich die Erfolgsrechnung als Bericht verwendet werden, so müssen
3155       die Einstellungen zu allen Erlös- und Aufwandskonten unter
3156       <varname>Sonstige Einstellungen/Erfolgsrechnung</varname> überprüft und
3157       allenfalls neu gesetzt werden.</para>
3158     </sect1>
3159
3160     <sect1 id="config.rounding">
3161       <title>Rundung in Verkaufsbelegen</title>
3162
3163       <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert
3164       von 5 Rappen (0.05 CHF).</para>
3165
3166       <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer
3167       Genauigkeit von 0.01 CHF verwendet werden können, ist es trotzdem nach
3168       wie vor üblich, Rechnungen mit auf 0.05 CHF gerundeten Beträgen
3169       auszustellen.</para>
3170
3171       <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine
3172       solche Rundung pro Mandant / Datenbank festgelegt werden.</para>
3173
3174       <para>Die Einstellung wird beim Erstellen der Datenbank bei
3175       <literal>Genauigkeit</literal> festgelegt. Sie kann anschliessend über
3176       das Webinterface von kivitendo nicht mehr verändert werden.</para>
3177
3178       <para>Abhängig vom Wert für <varname>default_manager</varname> in
3179       <filename>config/kivitendo.conf</filename> werden dabei folgende Werte
3180       voreingestellt:</para>
3181
3182       <itemizedlist>
3183         <listitem>
3184           <para>0.05 (default_manager = swiss)</para>
3185         </listitem>
3186
3187         <listitem>
3188           <para>0.01 (default_manager = german)</para>
3189         </listitem>
3190       </itemizedlist>
3191
3192       <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
3193       </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
3194
3195       <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
3196       und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet, wenn
3197       dieser nicht der eingestellten Genauigkeit entspricht.</para>
3198
3199       <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
3200       automatisch auf die in der Mandantenkonfiguration festgelegten
3201       Standardkonten für Rundungserträge bzw. Rundungsaufwendungen
3202       gebucht.</para>
3203
3204       <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr
3205       verändert.)</para>
3206
3207       <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
3208       <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
3209       <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
3210
3211       <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege in
3212       anderen Währungen als der Standardwährung erstellt, so muss in kivitendo
3213       ab Version 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
3214
3215       <para>Das heisst, Firmen in der Schweiz, die teilweise
3216       Verkaufsrechnungen in Euro oder anderen Währungen erstellen wollen,
3217       müssen beim Erstellen der Datenbank als Genauigkeit 0.01 wählen und
3218       können zur Zeit die 5er Rundung noch nicht nutzen.</para>
3219     </sect1>
3220
3221     <sect1 id="config.client">
3222       <title>Einstellungen pro Mandant</title>
3223
3224       <para>Einige Einstellungen können von einem Benutzer mit dem <link
3225       linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
3226       der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
3227       Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3228       Die Einstellungen sind unter <guimenu>System</guimenu> →
3229       <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3230
3231       <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3232       Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3233       geändert werden (siehe auch <link
3234       linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3235       Bestandsmethode</link>).</para>
3236
3237       <para>Die Einstellungen <literal>show_bestbefore</literal> und
3238       <literal>payments_changeable</literal> aus dem Abschnitt
3239       <literal>features</literal> und die Einstellungen im Abschnitt
3240       <literal>datev_check</literal> (sofern schon vorhanden) der <link
3241       linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3242       bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3243       Diese Einträge können danach aus der Konfigurationsdatei entfernt
3244       werden.</para>
3245     </sect1>
3246
3247     <sect1 id="kivitendo-ERP-verwenden">
3248       <title>kivitendo ERP verwenden</title>
3249
3250       <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3251       folgender URL erreichbar:</para>
3252
3253       <para><ulink
3254       url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3255
3256       <para>Die Administrationsseite erreichen Sie unter:</para>
3257
3258       <para><ulink
3259       url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3260     </sect1>
3261   </chapter>
3262
3263   <chapter id="features" xreflabel="Features und Funktionen">
3264     <title>Features und Funktionen</title>
3265
3266     <sect1 id="features.periodic-invoices"
3267            xreflabel="Wiederkehrende Rechnungen">
3268       <title>Wiederkehrende Rechnungen</title>
3269
3270       <sect2 id="features.periodic-invoices.introduction"
3271              xreflabel="Einführung in wiederkehrende Rechnungen">
3272         <title>Einführung</title>
3273
3274         <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3275         und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3276         Die konfigurierten Aufträge werden später automatisch in Rechnungen
3277         umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3278         Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3279         Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3280         wiederzufinden sind.</para>
3281       </sect2>
3282
3283       <sect2 id="features.periodic-invoices.configuration"
3284              xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3285         <title>Konfiguration</title>
3286
3287         <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3288         findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3289         "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3290         Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3291         angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3292         oder nicht.</para>
3293
3294         <para>Folgende Parameter kann man konfigurieren:</para>
3295
3296         <variablelist>
3297           <varlistentry>
3298             <term>Status</term>
3299
3300             <listitem>
3301               <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3302               erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3303               eines neuen Monats).</para>
3304
3305               <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3306               wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3307               nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3308               nächsten Periodenwechsel für alle Perioden, seit der letzten
3309               aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3310               verhindern, muss man vorher das Startdatum neu setzen.</para>
3311
3312               <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3313               erstellt. Man kann sich diese Aufträge aber gesondert in den
3314               Berichten anzeigen lassen.</para>
3315             </listitem>
3316           </varlistentry>
3317
3318           <varlistentry>
3319             <term>Periodizität</term>
3320
3321             <listitem>
3322               <para>Ob monatlich, quartalsweise oder jährlich auf neue
3323               Rechnungen überprüft werden soll. Für jede Periode seit dem
3324               Startdatum wird überprüft, ob für die Periode (beginnend immer
3325               mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3326               wurde. Unter Umständen können bei einem Startdatum in der
3327               Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3328             </listitem>
3329           </varlistentry>
3330
3331           <varlistentry>
3332             <term>Buchen auf</term>
3333
3334             <listitem>
3335               <para>Das Forderungskonto, in der Regel "Forderungen aus
3336               Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3337               Buchungsgruppen der betreffenden Waren.</para>
3338             </listitem>
3339           </varlistentry>
3340
3341           <varlistentry>
3342             <term>Startdatum</term>
3343
3344             <listitem>
3345               <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3346               soll</para>
3347             </listitem>
3348           </varlistentry>
3349
3350           <varlistentry>
3351             <term>Enddatum</term>
3352
3353             <listitem>
3354               <para>ab wann keine Rechnungen mehr erstellt werden
3355               sollen</para>
3356             </listitem>
3357           </varlistentry>
3358
3359           <varlistentry>
3360             <term>Automatische Verlängerung um x Monate</term>
3361
3362             <listitem>
3363               <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3364               eingetragenen Enddatums weiterhin erstellt werden, so kann man
3365               hier die Anzahl der Monate eingeben, um die das Enddatum
3366               automatisch nach hinten geschoben wird.</para>
3367             </listitem>
3368           </varlistentry>
3369
3370           <varlistentry>
3371             <term>Drucken</term>
3372
3373             <listitem>
3374               <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3375               Rechnungen auch gleich ausdrucken lassen.</para>
3376             </listitem>
3377           </varlistentry>
3378         </variablelist>
3379
3380         <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3381         Informationen zu den erstellten Rechnungen verschickt werden.
3382         Konfiguriert wird dies in der <link
3383         linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3384         <filename>config/kivitendo.conf</filename> im Abschnitt
3385         <varname>[periodic_invoices]</varname>.</para>
3386       </sect2>
3387
3388       <sect2 id="features.periodic-invoices.variables">
3389         <title>Spezielle Variablen</title>
3390
3391         <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3392         beim Umwandeln des Auftrags in eine Rechnung einige speziell
3393         formatierte Variablen durch für die jeweils aktuelle
3394         Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3395         den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3396         die Syntax <literal>&lt;%variablenname%&gt;</literal>.</para>
3397
3398         <para>Sofern es sich um eine Datumsvariable handelt, kann das
3399         Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3400         Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3401         <literal>&lt;%variablenname FORMAT=Formatinformation%&gt;</literal>.
3402         Die zur verfügung stehenden Formatinformationen werden unten genauer
3403         beschrieben.</para>
3404
3405         <para>Diese Variablen können auch beim automatischen Versand der
3406         erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3407         Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3408
3409         <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3410         ersetzt:</para>
3411
3412         <itemizedlist>
3413           <listitem>
3414             <para>Bemerkungen</para>
3415           </listitem>
3416
3417           <listitem>
3418             <para>Interne Bemerkungen</para>
3419           </listitem>
3420
3421           <listitem>
3422             <para>Vorgangsbezeichnung</para>
3423           </listitem>
3424
3425           <listitem>
3426             <para>In den Beschreibungs- und Langtextfeldern aller
3427             Positionen</para>
3428           </listitem>
3429         </itemizedlist>
3430
3431         <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3432
3433         <variablelist>
3434           <varlistentry>
3435             <term><varname>&lt;%current_quarter%&gt;</varname>,
3436             <varname>&lt;%previous_quarter%&gt;</varname>,
3437             <varname>&lt;%next_quarter%&gt;</varname></term>
3438
3439             <listitem>
3440               <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3441               zwischen <literal>1</literal> und <literal>4</literal>.</para>
3442             </listitem>
3443           </varlistentry>
3444
3445           <varlistentry>
3446             <term><varname>&lt;%current_month%&gt;</varname>,
3447             <varname>&lt;%previous_month%&gt;</varname>,
3448             <varname>&lt;%next_month%&gt;</varname></term>
3449
3450             <listitem>
3451               <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3452               <literal>1</literal> und <literal>12</literal>.</para>
3453             </listitem>
3454           </varlistentry>
3455
3456           <varlistentry>
3457             <term><varname>&lt;%current_month_long%&gt;</varname>,
3458             <varname>&lt;%previous_month_long%&gt;</varname>,
3459             <varname>&lt;%next_month_long%&gt;</varname></term>
3460
3461             <listitem>
3462               <para>Aktueller, vorheriger und nächster Monat als Name
3463               (<literal>Januar</literal>, <literal>Februar</literal>
3464               etc.).</para>
3465             </listitem>
3466           </varlistentry>
3467
3468           <varlistentry>
3469             <term><varname>&lt;%current_year%&gt;</varname>,
3470             <varname>&lt;%previous_year%&gt;</varname>,
3471             <varname>&lt;%next_year%&gt;</varname></term>
3472
3473             <listitem>
3474               <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3475               Jahreszahl (<literal>2013</literal> etc.).</para>
3476             </listitem>
3477           </varlistentry>
3478
3479           <varlistentry>
3480             <term><varname>&lt;%period_start_date%&gt;</varname>,
3481             <varname>&lt;%period_end_date%&gt;</varname></term>
3482
3483             <listitem>
3484               <para>Formatiertes Datum des ersten und letzten Tages im
3485               Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3486               ersten Quartal von 2013 wären dies der
3487               <literal>01.01.2013</literal> und
3488               <literal>31.03.2013</literal>).</para>
3489             </listitem>
3490           </varlistentry>
3491         </variablelist>
3492
3493         <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3494         Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3495         dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3496         durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3497         sind:</para>
3498
3499         <variablelist>
3500           <varlistentry>
3501             <term><varname>%a</varname></term>
3502
3503             <listitem>
3504               <para>Der abgekürzte Wochentagsname.</para>
3505             </listitem>
3506           </varlistentry>
3507
3508           <varlistentry>
3509             <term><varname>%A</varname></term>
3510
3511             <listitem>
3512               <para>Der ausgeschriebene Wochentagsname.</para>
3513             </listitem>
3514           </varlistentry>
3515
3516           <varlistentry>
3517             <term><varname>%b</varname></term>
3518
3519             <listitem>
3520               <para>Der abgekürzte Monatsname.</para>
3521             </listitem>
3522           </varlistentry>
3523
3524           <varlistentry>
3525             <term><varname>%B</varname></term>
3526
3527             <listitem>
3528               <para>Der ausgeschriebene Monatsname.</para>
3529             </listitem>
3530           </varlistentry>
3531
3532           <varlistentry>
3533             <term><varname>%C</varname></term>
3534
3535             <listitem>
3536               <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3537               Zahl.</para>
3538             </listitem>
3539           </varlistentry>
3540
3541           <varlistentry>
3542             <term><varname>%d</varname></term>
3543
3544             <listitem>
3545               <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3546             </listitem>
3547           </varlistentry>
3548
3549           <varlistentry>
3550             <term><varname>%D</varname></term>
3551
3552             <listitem>
3553               <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3554             </listitem>
3555           </varlistentry>
3556
3557           <varlistentry>
3558             <term><varname>%e</varname></term>
3559
3560             <listitem>
3561               <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3562               werden führende Nullen durch Leerzeichen ersetzt.</para>
3563             </listitem>
3564           </varlistentry>
3565
3566           <varlistentry>
3567             <term><varname>%F</varname></term>
3568
3569             <listitem>
3570               <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3571             </listitem>
3572           </varlistentry>
3573
3574           <varlistentry>
3575             <term><varname>%j</varname></term>
3576
3577             <listitem>
3578               <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3579               inklusive.</para>
3580             </listitem>
3581           </varlistentry>
3582
3583           <varlistentry>
3584             <term><varname>%m</varname></term>
3585
3586             <listitem>
3587               <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3588             </listitem>
3589           </varlistentry>
3590
3591           <varlistentry>
3592             <term><varname>%u</varname></term>
3593
3594             <listitem>
3595               <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3596               die 1 dem Montag entspricht.</para>
3597             </listitem>
3598           </varlistentry>
3599
3600           <varlistentry>
3601             <term><varname>%U</varname></term>
3602
3603             <listitem>
3604               <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3605               wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3606               ist.</para>
3607             </listitem>
3608           </varlistentry>
3609
3610           <varlistentry>
3611             <term><varname>%V</varname></term>
3612
3613             <listitem>
3614               <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3615               inklusive, wobei Woche 01 die erste Woche, von der mindestens
3616               vier Tage im Jahr liegen; Montag ist erster Tag der
3617               Woche.</para>
3618             </listitem>
3619           </varlistentry>
3620
3621           <varlistentry>
3622             <term><varname>%w</varname></term>
3623
3624             <listitem>
3625               <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3626               die 0 dem Sonntag entspricht.</para>
3627             </listitem>
3628           </varlistentry>
3629
3630           <varlistentry>
3631             <term><varname>%W</varname></term>
3632
3633             <listitem>
3634               <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3635               wobei der erste Montag im Jahr das Startdatum von Woche 01
3636               ist.</para>
3637             </listitem>
3638           </varlistentry>
3639
3640           <varlistentry>
3641             <term><varname>%y</varname></term>
3642
3643             <listitem>
3644               <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3645               inklusive.</para>
3646             </listitem>
3647           </varlistentry>
3648
3649           <varlistentry>
3650             <term><varname>%Y</varname></term>
3651
3652             <listitem>
3653               <para>Das Jahr als vierstellige Zahl.</para>
3654             </listitem>
3655           </varlistentry>
3656
3657           <varlistentry>
3658             <term><varname>%%</varname></term>
3659
3660             <listitem>
3661               <para>Das Prozentzeichen selber.</para>
3662             </listitem>
3663           </varlistentry>
3664         </variablelist>
3665
3666         <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3667         bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3668         <literal>Abrechnungszeitrum: &lt;%period_start_date FORMAT=%m/%Y%&gt;
3669         bis &lt;%period_end_date FORMAT=%m/%Y%&gt;</literal></para>
3670       </sect2>
3671
3672       <sect2 id="features.periodic-invoices.reports">
3673         <title>Auflisten</title>
3674
3675         <para>Unter Verkauf-&gt;Berichte-&gt;Aufträge finden sich zwei neue
3676         Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3677         Rechnungen inaktiv", mit denen man sich einen Überglick über die
3678         wiederkehrenden Rechnungen verschaffen kann.</para>
3679       </sect2>
3680
3681       <sect2 id="features.periodic-invoices.task-server">
3682         <title>Erzeugung der eigentlichen Rechnungen</title>
3683
3684         <para>Die zeitliche und periodische Überprüfung, ob eine
3685         wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3686         durch den <link linkend="config.task-server">Task-Server</link>, einen
3687         externen Dienst, der automatisch beim Start des Servers gestartet
3688         werden sollte.</para>
3689       </sect2>
3690
3691       <sect2 id="features.periodic-invoices.create-for-current-month">
3692         <title>Erste Rechnung für aktuellen Monat erstellen</title>
3693
3694         <para>Will man im laufenden Monat eine monatlich wiederkehrende
3695         Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3696         auf den Monatsanfang und wartet ein paar Minuten, bis der Task-Server
3697         den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3698         generiert hat. Alternativ setzt man das Startdatum auf den
3699         Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3700         manuell über den Workflow.</para>
3701       </sect2>
3702     </sect1>
3703
3704     <sect1 id="features.bank" xreflabel="bankerweiterung">
3705       <title>Bankerweiterung</title>
3706
3707       <sect2 id="features.bank.introduction"
3708              xreflabel="Einführung in die Bankerweiterung">
3709         <title>Einführung</title>
3710
3711         <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3712         im Wiki und soll von dort später hierhin übernommen werden:</para>
3713
3714         <para><ulink
3715         url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3716       </sect2>
3717     </sect1>
3718
3719     <sect1 id="dokumentenvorlagen-und-variablen">
3720       <title>Dokumentenvorlagen und verfügbare Variablen</title>
3721
3722       <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3723         <title>Einführung</title>
3724
3725         <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3726         aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3727         einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3728         <function>&lt;%variablenname%&gt;</function> verwendet wird. Für
3729         LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3730         (siehe <xref
3731         linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3732
3733         <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3734         Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im Folgenden
3735         gesagte für alle Vorlagenarten.</para>
3736
3737         <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3738         verfügbar als hier aufgelistet werden. Die meisten davon können
3739         allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3740         werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3741         diese wie folgt erhalten werden:</para>
3742
3743         <itemizedlist>
3744           <listitem>
3745             <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3746             Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3747           </listitem>
3748
3749           <listitem>
3750             <para>In <filename>Form.pm</filename> die Funktion
3751             <function>parse_template</function> suchen und hier die Zeile
3752             <command>print(STDERR Dumper($self));</command> einfügen.</para>
3753           </listitem>
3754
3755           <listitem>
3756             <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3757             ein PDF für eine Rechnung erzeugen.</para>
3758           </listitem>
3759
3760           <listitem>
3761             <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3762             der Variablen <varname>$self</varname> in der Form <varname>'key'
3763             =&gt; 'value',</varname>. Alle <varname>key</varname>s sind
3764             verfügbar.</para>
3765           </listitem>
3766         </itemizedlist>
3767       </sect2>
3768
3769       <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3770         <title>Variablen ausgeben</title>
3771
3772         <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3773         Tags geschrieben werden, also z.B.
3774         <varname>&lt;%variablenname%&gt;</varname>.</para>
3775
3776         <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3777         die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3778         <varname>&lt;%variablenname FLAG1 FLAG2%&gt;</varname>. Momentan
3779         werden die folgenden Flags unterstützt:</para>
3780
3781         <itemizedlist>
3782           <listitem>
3783             <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3784             den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3785             mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3786             damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3787           </listitem>
3788
3789           <listitem>
3790             <para><option>NOESCAPE</option> unterdrückt das Escapen von
3791             Sonderzeichen für die Vorlagensprache. Wenn also in einer
3792             Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
3793             auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
3794             ist dieses Flag sinnvoll.</para>
3795           </listitem>
3796         </itemizedlist>
3797
3798         <para>Beispiel:</para>
3799
3800         <programlisting>&lt;%quototal NOFORMAT%&gt;</programlisting>
3801       </sect2>
3802
3803       <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
3804         <title>Verwendung in Druckbefehlen</title>
3805
3806         <para>In der Admininstration können Drucker definiert werden. Auch im
3807         dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
3808         und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
3809         den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
3810         <function>`...`</function> nicht zu unerwünschtem Verhalten
3811         führen.</para>
3812
3813         <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
3814         für das die Telefonnummer eines Ansprechpartners als Teil der
3815         Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
3816         z.B. wie folgt aussehen:</para>
3817
3818         <programlisting>send_fax --number &lt;%if cp_phone2%&gt;&lt;%cp_phone2%&gt;&lt;%else%&gt;&lt;%cp_phone1%&gt;&lt;%end%&gt;</programlisting>
3819       </sect2>
3820
3821       <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
3822              xreflabel="Anfang und Ende der Tags verändern">
3823         <title>Anfang und Ende der Tags verändern</title>
3824
3825         <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
3826         Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
3827         Prozentzeichen und dem Größerzeichen endet, beispielsweise
3828         <function>&lt;%customer%&gt;</function>. Da diese Form aber z.B. in
3829         LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
3830         Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
3831         Stil umgestellt werden.</para>
3832
3833         <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
3834         Format gültigen Kommentarzeichen anfangen, dann
3835         <function>config:</function> enthalten, die entsprechende Option
3836         setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
3837         enden. Beispiel für LaTeX:</para>
3838
3839         <programlisting>% config: tag-style=($ $)</programlisting>
3840
3841         <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
3842         wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
3843         äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
3844
3845         <programlisting>&lt;!-- config: tag-style=($ $) --&gt;</programlisting>
3846       </sect2>
3847
3848       <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
3849         <title>Zuordnung von den Dateinamen zu den Funktionen</title>
3850
3851         <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
3852         welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
3853         "<filename>.ext</filename>" geeignet zu ersetzen:
3854         "<filename>.tex</filename>" für LaTeX-Vorlagen und
3855         "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
3856
3857         <variablelist>
3858           <varlistentry>
3859             <term><filename>bin_list.ext</filename></term>
3860
3861             <listitem>
3862               <para>Lagerliste</para>
3863             </listitem>
3864           </varlistentry>
3865
3866           <varlistentry>
3867             <term><filename>check.ext</filename></term>
3868
3869             <listitem>
3870               <para>?</para>
3871             </listitem>
3872           </varlistentry>
3873
3874           <varlistentry>
3875             <term><filename>invoice.ext</filename></term>
3876
3877             <listitem>
3878               <para>Rechnung</para>
3879             </listitem>
3880           </varlistentry>
3881
3882           <varlistentry>
3883             <term><filename>packing_list.ext</filename></term>
3884
3885             <listitem>
3886               <para>Packliste</para>
3887             </listitem>
3888           </varlistentry>
3889
3890           <varlistentry>
3891             <term><filename>pick_list.ext</filename></term>
3892
3893             <listitem>
3894               <para>Sammelliste</para>
3895             </listitem>
3896           </varlistentry>
3897
3898           <varlistentry>
3899             <term><filename>purchase_delivery_order.ext</filename></term>
3900
3901             <listitem>
3902               <para>Lieferschein (Einkauf)</para>
3903             </listitem>
3904           </varlistentry>
3905
3906           <varlistentry>
3907             <term><filename>purcharse_order.ext</filename></term>
3908
3909             <listitem>
3910               <para>Bestellung an Lieferanten</para>
3911             </listitem>
3912           </varlistentry>
3913
3914           <varlistentry>
3915             <term><filename>request_quotation.ext</filename></term>
3916
3917             <listitem>
3918               <para>Anfrage an Lieferanten</para>
3919             </listitem>
3920           </varlistentry>
3921
3922           <varlistentry>
3923             <term><filename>sales_delivery_order.ext</filename></term>
3924
3925             <listitem>
3926               <para>Lieferschein (Verkauf)</para>
3927             </listitem>
3928           </varlistentry>
3929
3930           <varlistentry>
3931             <term><filename>sales_order.ext</filename></term>
3932
3933             <listitem>
3934               <para>Bestellung</para>
3935             </listitem>
3936           </varlistentry>
3937
3938           <varlistentry>
3939             <term><filename>sales_quotation.ext</filename></term>
3940
3941             <listitem>
3942               <para>Angebot an Kunden</para>
3943             </listitem>
3944           </varlistentry>
3945
3946           <varlistentry>
3947             <term><filename>zahlungserinnerung.ext</filename></term>
3948
3949             <listitem>
3950               <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
3951             </listitem>
3952           </varlistentry>
3953
3954           <varlistentry>
3955             <term><filename>zahlungserinnerung_invoice.ext</filename></term>
3956
3957             <listitem>
3958               <para>Rechnung über Mahngebühren (Dateiname im Programm
3959               konfigurierbar)</para>
3960             </listitem>
3961           </varlistentry>
3962         </variablelist>
3963       </sect2>
3964
3965       <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
3966         <title>Sprache, Drucker und E-Mail</title>
3967
3968         <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
3969         eingearbeitet. So wird aus der Vorlage
3970         <filename>sales_order.ext</filename> bei Sprache
3971         <function>de</function> und Druckerkürzel <function>lpr2</function>
3972         der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
3973         Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
3974         bekommen dann noch das Kürzel <filename>_email</filename>, der
3975         vollständige Vorlagenname wäre dann
3976         <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
3977         kann eine Standarddatei <filename>default.ext</filename> hinterlegt
3978         werden. Diese wird verwendet, wenn keine der anderen Varianten
3979         gefunden wird.</para>
3980
3981         <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
3982         der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
3983         verschickt wird, ist:</para>
3984
3985         <orderedlist>
3986           <listitem>
3987             <para><filename>sales_order_email_de_lpr2.tex</filename></para>
3988           </listitem>
3989
3990           <listitem>
3991             <para><filename>sales_order_de_lpr2.tex</filename></para>
3992           </listitem>
3993
3994           <listitem>
3995             <para><filename>sales_order.tex</filename></para>
3996           </listitem>
3997
3998           <listitem>
3999             <para><filename>default.tex</filename></para>
4000           </listitem>
4001         </orderedlist>
4002
4003         <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
4004         Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
4005         siehe dazu <xref
4006         linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
4007       </sect2>
4008
4009       <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
4010         <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
4011         sind</title>
4012
4013         <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
4014                xreflabel="Metainformationen zur angeforderten Vorlage">
4015           <title>Metainformationen zur angeforderten Vorlage</title>
4016
4017           <para>Diese Variablen liefern Informationen darüber welche Variante
4018           einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
4019           Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
4020           Formulare einbinden möchten.</para>
4021
4022           <variablelist>
4023             <varlistentry>
4024               <term><varname>template_meta.formname</varname></term>
4025
4026               <listitem>
4027                 <para>Basisname der Vorlage. Identisch mit der <link
4028                 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
4029                 zu den Dateinamen</link> ohne die Erweiterung. Ein
4030                 Verkaufsauftrag enthält hier
4031                 <constant>sales_order</constant>.</para>
4032               </listitem>
4033             </varlistentry>
4034
4035             <varlistentry>
4036               <term><varname>template_meta.language.description</varname></term>
4037
4038               <listitem>
4039                 <para>Beschreibung der verwendeten Sprache</para>
4040               </listitem>
4041             </varlistentry>
4042
4043             <varlistentry>
4044               <term><varname>template_meta.language.template_code</varname></term>
4045
4046               <listitem>
4047                 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
4048                 dem Kürzel das im Dateinamen verwendetet wird.</para>
4049               </listitem>
4050             </varlistentry>
4051
4052             <varlistentry>
4053               <term><varname>template_meta.language.output_numberformat</varname></term>
4054
4055               <listitem>
4056                 <para>Zahlenformat der verwendeten Sprache in der Form
4057                 "<constant>1.000,00</constant>". Experimentell! Nur
4058                 interessant für Vorlagen die mit unformatierten Werten
4059                 arbeiten.</para>
4060               </listitem>
4061             </varlistentry>
4062
4063             <varlistentry>
4064               <term><varname>template_meta.language.output_dateformat</varname></term>
4065
4066               <listitem>
4067                 <para>Datumsformat der verwendeten Sprache in der Form
4068                 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
4069                 interessant für Vorlagen die mit unformatierten Werten
4070                 arbeiten.</para>
4071               </listitem>
4072             </varlistentry>
4073
4074             <varlistentry>
4075               <term><varname>template_meta.format</varname></term>
4076
4077               <listitem>
4078                 <para>Das angeforderte Format. Kann im Moment die Werte
4079                 <constant>pdf</constant>, <constant>postscript</constant>,
4080                 <constant>html</constant>, <constant>opendocument</constant>,
4081                 <constant>opendocument_pdf</constant> und
4082                 <constant>excel</constant> enthalten.</para>
4083               </listitem>
4084             </varlistentry>
4085
4086             <varlistentry>
4087               <term><varname>template_meta.extension</varname></term>
4088
4089               <listitem>
4090                 <para>Dateierweiterung, wie im Dateinamen. Wird aus
4091                 <constant>format</constant> entschieden.</para>
4092               </listitem>
4093             </varlistentry>
4094
4095             <varlistentry>
4096               <term><varname>template_meta.media</varname></term>
4097
4098               <listitem>
4099                 <para>Ausgabemedium. Kann zur Zeit die Werte
4100                 <constant>screen</constant> für Bildschirm,
4101                 <constant>email</constant> für E-Mail (triggert das
4102                 <constant>_email</constant> Kürzel im Dateinamen),
4103                 <constant>printer</constant> für Drucker, und
4104                 <constant>queue</constant> für Warteschlange enthalten.</para>
4105               </listitem>
4106             </varlistentry>
4107
4108             <varlistentry>
4109               <term><varname>template_meta.printer.description</varname></term>
4110
4111               <listitem>
4112                 <para>Beschreibung des ausgewählten Druckers</para>
4113               </listitem>
4114             </varlistentry>
4115
4116             <varlistentry>
4117               <term><varname>template_meta.printer.template_code</varname></term>
4118
4119               <listitem>
4120                 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
4121                 dem Kürzel das im Dateinamen verwendetet wird.</para>
4122               </listitem>
4123             </varlistentry>
4124
4125             <varlistentry>
4126               <term><varname>template_meta.tmpfile</varname></term>
4127
4128               <listitem>
4129                 <para>Datei-Prefix für temporäre Dateien.</para>
4130               </listitem>
4131             </varlistentry>
4132           </variablelist>
4133         </sect3>
4134
4135         <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
4136           <title>Stammdaten von Kunden und Lieferanten</title>
4137
4138           <variablelist>
4139             <varlistentry>
4140               <term><varname>account_number</varname></term>
4141
4142               <listitem>
4143                 <para>Kontonummer</para>
4144               </listitem>
4145             </varlistentry>
4146
4147             <varlistentry>
4148               <term><varname>bank</varname></term>
4149
4150               <listitem>
4151                 <para>Name der Bank</para>
4152               </listitem>
4153             </varlistentry>
4154
4155             <varlistentry>
4156               <term><varname>bank_code</varname></term>
4157
4158               <listitem>
4159                 <para>Bankleitzahl</para>
4160               </listitem>
4161             </varlistentry>
4162
4163             <varlistentry>
4164               <term><varname>bic</varname></term>
4165
4166               <listitem>
4167                 <para>Bank-Identifikations-Code (Bank Identifier Code,
4168                 BIC)</para>
4169               </listitem>
4170             </varlistentry>
4171
4172             <varlistentry>
4173               <term><varname>business</varname></term>
4174
4175               <listitem>
4176                 <para>Kunden-/Lieferantentyp</para>
4177               </listitem>
4178             </varlistentry>
4179
4180             <varlistentry>
4181               <term><varname>city</varname></term>
4182
4183               <listitem>
4184                 <para>Stadt</para>
4185               </listitem>
4186             </varlistentry>
4187
4188             <varlistentry>
4189               <term><varname>contact</varname></term>
4190
4191               <listitem>
4192                 <para>Kontakt</para>
4193               </listitem>
4194             </varlistentry>
4195
4196             <varlistentry>
4197               <term><varname>country</varname></term>
4198
4199               <listitem>
4200                 <para>Land</para>
4201               </listitem>
4202             </varlistentry>
4203
4204             <varlistentry>
4205               <term><varname>c_vendor_id</varname></term>
4206
4207               <listitem>
4208                 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
4209               </listitem>
4210             </varlistentry>
4211
4212             <varlistentry>
4213               <term><varname>v_customer_id</varname></term>
4214
4215               <listitem>
4216                 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
4217               </listitem>
4218             </varlistentry>
4219
4220             <varlistentry>
4221               <term><varname>cp_email</varname></term>
4222
4223               <listitem>
4224                 <para>Email des Ansprechpartners</para>
4225               </listitem>
4226             </varlistentry>
4227
4228             <varlistentry>
4229               <term><varname>cp_givenname</varname></term>
4230
4231               <listitem>
4232                 <para>Vorname des Ansprechpartners</para>
4233               </listitem>
4234             </varlistentry>
4235
4236             <varlistentry>
4237               <term><varname>cp_greeting</varname></term>
4238
4239               <listitem>
4240                 <para>Anrede des Ansprechpartners</para>
4241               </listitem>
4242             </varlistentry>
4243
4244             <varlistentry>
4245               <term><varname>cp_name</varname></term>
4246
4247               <listitem>
4248                 <para>Name des Ansprechpartners</para>
4249               </listitem>
4250             </varlistentry>
4251
4252             <varlistentry>
4253               <term><varname>cp_phone1</varname></term>
4254
4255               <listitem>
4256                 <para>Telefonnummer 1 des Ansprechpartners</para>
4257               </listitem>
4258             </varlistentry>
4259
4260             <varlistentry>
4261               <term><varname>cp_phone2</varname></term>
4262
4263               <listitem>
4264                 <para>Telefonnummer 2 des Ansprechpartners</para>
4265               </listitem>
4266             </varlistentry>
4267
4268             <varlistentry>
4269               <term><varname>cp_title</varname></term>
4270
4271               <listitem>
4272                 <para>Titel des Ansprechpartners</para>
4273               </listitem>
4274             </varlistentry>
4275
4276             <varlistentry>
4277               <term><varname>creditlimit</varname></term>
4278
4279               <listitem>
4280                 <para>Kreditlimit</para>
4281               </listitem>
4282             </varlistentry>
4283
4284             <varlistentry>
4285               <term><varname>customeremail</varname></term>
4286
4287               <listitem>
4288                 <para>Email des Kunden; nur für Kunden</para>
4289               </listitem>
4290             </varlistentry>
4291
4292             <varlistentry>
4293               <term><varname>customerfax</varname></term>
4294
4295               <listitem>
4296                 <para>Faxnummer des Kunden; nur für Kunden</para>
4297               </listitem>
4298             </varlistentry>
4299
4300             <varlistentry>
4301               <term><varname>customernotes</varname></term>
4302
4303               <listitem>
4304                 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4305               </listitem>
4306             </varlistentry>
4307
4308             <varlistentry>
4309               <term><varname>customernumber</varname></term>
4310
4311               <listitem>
4312                 <para>Kundennummer; nur für Kunden</para>
4313               </listitem>
4314             </varlistentry>
4315
4316             <varlistentry>
4317               <term><varname>customerphone</varname></term>
4318
4319               <listitem>
4320                 <para>Telefonnummer des Kunden; nur für Kunden</para>
4321               </listitem>
4322             </varlistentry>
4323
4324             <varlistentry>
4325               <term><varname>discount</varname></term>
4326
4327               <listitem>
4328                 <para>Rabatt</para>
4329               </listitem>
4330             </varlistentry>
4331
4332             <varlistentry>
4333               <term><varname>email</varname></term>
4334
4335               <listitem>
4336                 <para>Emailadresse</para>
4337               </listitem>
4338             </varlistentry>
4339
4340             <varlistentry>
4341               <term><varname>fax</varname></term>
4342
4343               <listitem>
4344                 <para>Faxnummer</para>
4345               </listitem>
4346             </varlistentry>
4347
4348             <varlistentry>
4349               <term><varname>gln</varname></term>
4350
4351               <listitem>
4352                 <para>GLN (Globale Lokationsnummer)</para>
4353               </listitem>
4354             </varlistentry>
4355
4356             <varlistentry>
4357               <term><varname>greeting</varname></term>
4358
4359               <listitem>
4360                 <para>Anrede</para>
4361               </listitem>
4362             </varlistentry>
4363
4364             <varlistentry>
4365               <term><varname>homepage</varname></term>
4366
4367               <listitem>
4368                 <para>Homepage</para>
4369               </listitem>
4370             </varlistentry>
4371
4372             <varlistentry>
4373               <term><varname>iban</varname></term>
4374
4375               <listitem>
4376                 <para>Internationale Kontonummer (International Bank Account
4377                 Number, IBAN)</para>
4378               </listitem>
4379             </varlistentry>
4380
4381             <varlistentry>
4382               <term><varname>language</varname></term>
4383
4384               <listitem>
4385                 <para>Sprache</para>
4386               </listitem>
4387             </varlistentry>
4388
4389             <varlistentry>
4390               <term><varname>name</varname></term>
4391
4392               <listitem>
4393                 <para>Firmenname</para>
4394               </listitem>
4395             </varlistentry>
4396
4397             <varlistentry>
4398               <term><varname>natural_person</varname></term>
4399
4400               <listitem>
4401                 <para>Flag "natürliche Person"; Siehe auch
4402                 <xref linkend="dokumentenvorlagen-und-variablen.anrede"/></para>
4403               </listitem>
4404             </varlistentry>
4405
4406             <varlistentry>
4407               <term><varname>payment_description</varname></term>
4408
4409               <listitem>
4410                 <para>Name der Zahlart</para>
4411               </listitem>
4412             </varlistentry>
4413
4414             <varlistentry>
4415               <term><varname>payment_terms</varname></term>
4416
4417               <listitem>
4418                 <para>Zahlungskonditionen</para>
4419               </listitem>
4420             </varlistentry>
4421
4422             <varlistentry>
4423               <term><varname>phone</varname></term>
4424
4425               <listitem>
4426                 <para>Telefonnummer</para>
4427               </listitem>
4428             </varlistentry>
4429
4430             <varlistentry>
4431               <term><varname>shiptocity</varname></term>
4432
4433               <listitem>
4434                 <para>Stadt (Lieferadresse) <link
4435                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4436               </listitem>
4437             </varlistentry>
4438
4439             <varlistentry>
4440               <term><varname>shiptocontact</varname></term>
4441
4442               <listitem>
4443                 <para>Kontakt (Lieferadresse) <link
4444                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4445               </listitem>
4446             </varlistentry>
4447
4448             <varlistentry>
4449               <term><varname>shiptocountry</varname></term>
4450
4451               <listitem>
4452                 <para>Land (Lieferadresse) <link
4453                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4454               </listitem>
4455             </varlistentry>
4456
4457             <varlistentry>
4458               <term><varname>shiptodepartment_1</varname></term>
4459
4460               <listitem>
4461                 <para>Abteilung 1 (Lieferadresse) <link
4462                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4463               </listitem>
4464             </varlistentry>
4465
4466             <varlistentry>
4467               <term><varname>shiptodepartment_2</varname></term>
4468
4469               <listitem>
4470                 <para>Abteilung 2 (Lieferadresse) <link
4471                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4472               </listitem>
4473             </varlistentry>
4474
4475             <varlistentry>
4476               <term><varname>shiptoemail</varname></term>
4477
4478               <listitem>
4479                 <para>Email (Lieferadresse) <link
4480                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4481               </listitem>
4482             </varlistentry>
4483
4484             <varlistentry>
4485               <term><varname>shiptofax</varname></term>
4486
4487               <listitem>
4488                 <para>Fax (Lieferadresse) <link
4489                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4490               </listitem>
4491             </varlistentry>
4492
4493             <varlistentry>
4494               <term><varname>shiptogln</varname></term>
4495
4496               <listitem>
4497                 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4498                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4499               </listitem>
4500             </varlistentry>
4501
4502             <varlistentry>
4503               <term><varname>shiptoname</varname></term>
4504
4505               <listitem>
4506                 <para>Firmenname (Lieferadresse) <link
4507                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4508               </listitem>
4509             </varlistentry>
4510
4511             <varlistentry>
4512               <term><varname>shiptophone</varname></term>
4513
4514               <listitem>
4515                 <para>Telefonnummer (Lieferadresse) <link
4516                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4517               </listitem>
4518             </varlistentry>
4519
4520             <varlistentry>
4521               <term><varname>shiptostreet</varname></term>
4522
4523               <listitem>
4524                 <para>Straße und Hausnummer (Lieferadresse) <link
4525                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4526               </listitem>
4527             </varlistentry>
4528
4529             <varlistentry>
4530               <term><varname>shiptozipcode</varname></term>
4531
4532               <listitem>
4533                 <para>Postleitzahl (Lieferadresse) <link
4534                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4535               </listitem>
4536             </varlistentry>
4537
4538             <varlistentry>
4539               <term><varname>street</varname></term>
4540
4541               <listitem>
4542                 <para>Straße und Hausnummer</para>
4543               </listitem>
4544             </varlistentry>
4545
4546             <varlistentry>
4547               <term><varname>taxnumber</varname></term>
4548
4549               <listitem>
4550                 <para>Steuernummer</para>
4551               </listitem>
4552             </varlistentry>
4553
4554             <varlistentry>
4555               <term><varname>ustid</varname></term>
4556
4557               <listitem>
4558                 <para>Umsatzsteuer-Identifikationsnummer</para>
4559               </listitem>
4560             </varlistentry>
4561
4562             <varlistentry>
4563               <term><varname>vendoremail</varname></term>
4564
4565               <listitem>
4566                 <para>Email des Lieferanten; nur für Lieferanten</para>
4567               </listitem>
4568             </varlistentry>
4569
4570             <varlistentry>
4571               <term><varname>vendorfax</varname></term>
4572
4573               <listitem>
4574                 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4575               </listitem>
4576             </varlistentry>
4577
4578             <varlistentry>
4579               <term><varname>vendornotes</varname></term>
4580
4581               <listitem>
4582                 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4583               </listitem>
4584             </varlistentry>
4585
4586             <varlistentry>
4587               <term><varname>vendornumber</varname></term>
4588
4589               <listitem>
4590                 <para>Lieferantennummer; nur für Lieferanten</para>
4591               </listitem>
4592             </varlistentry>
4593
4594             <varlistentry>
4595               <term><varname>vendorphone</varname></term>
4596
4597               <listitem>
4598                 <para>Telefonnummer des Lieferanten; nur für
4599                 Lieferanten</para>
4600               </listitem>
4601             </varlistentry>
4602
4603             <varlistentry>
4604               <term><varname>zipcode</varname></term>
4605
4606               <listitem>
4607                 <para>Postleitzahl</para>
4608               </listitem>
4609             </varlistentry>
4610           </variablelist>
4611
4612           <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4613             <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4614             Stammdaten nicht eingetragen, so haben die Variablen
4615             <varname>shipto*</varname> den gleichen Wert wie die die
4616             entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4617             einige <varname>shipto*</varname>-Variablen so nicht in den
4618             Stammdaten wiederfinden sondern schlicht Kopien der
4619             Lieferdatenvariablen sind (z.B.
4620             <varname>shiptocontact</varname>).</para>
4621           </note>
4622         </sect3>
4623
4624         <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4625           <title>Informationen über den Bearbeiter</title>
4626
4627           <variablelist>
4628             <varlistentry>
4629               <term><varname>employee_address</varname></term>
4630
4631               <listitem>
4632                 <para>Adressfeld</para>
4633               </listitem>
4634             </varlistentry>
4635
4636             <varlistentry>
4637               <term><varname>employee_businessnumber</varname></term>
4638
4639               <listitem>
4640                 <para>Firmennummer</para>
4641               </listitem>
4642             </varlistentry>
4643
4644             <varlistentry>
4645               <term><varname>employee_company</varname></term>
4646
4647               <listitem>
4648                 <para>Firmenname</para>
4649               </listitem>
4650             </varlistentry>
4651
4652             <varlistentry>
4653               <term><varname>employee_co_ustid</varname></term>
4654
4655               <listitem>
4656                 <para>Usatzsteuer-Identifikationsnummer</para>
4657               </listitem>
4658             </varlistentry>
4659
4660             <varlistentry>
4661               <term><varname>employee_duns</varname></term>
4662
4663               <listitem>
4664                 <para>DUNS-Nummer</para>
4665               </listitem>
4666             </varlistentry>
4667
4668             <varlistentry>
4669               <term><varname>employee_email</varname></term>
4670
4671               <listitem>
4672                 <para>Email</para>
4673               </listitem>
4674             </varlistentry>
4675
4676             <varlistentry>
4677               <term><varname>employee_fax</varname></term>
4678
4679               <listitem>
4680                 <para>Fax</para>
4681               </listitem>
4682             </varlistentry>
4683
4684             <varlistentry>
4685               <term><varname>employee_name</varname></term>
4686
4687               <listitem>
4688                 <para>voller Name</para>
4689               </listitem>
4690             </varlistentry>
4691
4692             <varlistentry>
4693               <term><varname>employee_signature</varname></term>
4694
4695               <listitem>
4696                 <para>Signatur</para>
4697               </listitem>
4698             </varlistentry>
4699
4700             <varlistentry>
4701               <term><varname>employee_taxnumber</varname></term>
4702
4703               <listitem>
4704                 <para>Steuernummer</para>
4705               </listitem>
4706             </varlistentry>
4707
4708             <varlistentry>
4709               <term><varname>employee_tel</varname></term>
4710
4711               <listitem>
4712                 <para>Telefonnummer</para>
4713               </listitem>
4714             </varlistentry>
4715           </variablelist>
4716         </sect3>
4717
4718         <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4719           <title>Informationen über den Verkäufer</title>
4720
4721           <variablelist>
4722             <varlistentry>
4723               <term><varname>salesman_address</varname></term>
4724
4725               <listitem>
4726                 <para>Adressfeld</para>
4727               </listitem>
4728             </varlistentry>
4729
4730             <varlistentry>
4731               <term><varname>salesman_businessnumber</varname></term>
4732
4733               <listitem>
4734                 <para>Firmennummer</para>
4735               </listitem>
4736             </varlistentry>
4737
4738             <varlistentry>
4739               <term><varname>salesman_company</varname></term>
4740
4741               <listitem>
4742                 <para>Firmenname</para>
4743               </listitem>
4744             </varlistentry>
4745
4746             <varlistentry>
4747               <term><varname>salesman_co_ustid</varname></term>
4748
4749               <listitem>
4750                 <para>Usatzsteuer-Identifikationsnummer</para>
4751               </listitem>
4752             </varlistentry>
4753
4754             <varlistentry>
4755               <term><varname>salesman_duns</varname></term>
4756
4757               <listitem>
4758                 <para>DUNS-Nummer</para>
4759               </listitem>
4760             </varlistentry>
4761
4762             <varlistentry>
4763               <term><varname>salesman_email</varname></term>
4764
4765               <listitem>
4766                 <para>Email</para>
4767               </listitem>
4768             </varlistentry>
4769
4770             <varlistentry>
4771               <term><varname>salesman_fax</varname></term>
4772
4773               <listitem>
4774                 <para>Fax</para>
4775               </listitem>
4776             </varlistentry>
4777
4778             <varlistentry>
4779               <term><varname>salesman_name</varname></term>
4780
4781               <listitem>
4782                 <para>voller Name</para>
4783               </listitem>
4784             </varlistentry>
4785
4786             <varlistentry>
4787               <term><varname>salesman_signature</varname></term>
4788
4789               <listitem>
4790                 <para>Signatur</para>
4791               </listitem>
4792             </varlistentry>
4793
4794             <varlistentry>
4795               <term><varname>salesman_taxnumber</varname></term>
4796
4797               <listitem>
4798                 <para>Steuernummer</para>
4799               </listitem>
4800             </varlistentry>
4801
4802             <varlistentry>
4803               <term><varname>salesman_tel</varname></term>
4804
4805               <listitem>
4806                 <para>Telefonnummer</para>
4807               </listitem>
4808             </varlistentry>
4809           </variablelist>
4810         </sect3>
4811
4812         <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
4813           <title>Variablen für die einzelnen Steuern</title>
4814
4815           <variablelist>
4816             <varlistentry>
4817               <term><varname>tax</varname></term>
4818
4819               <listitem>
4820                 <para>Steuer</para>
4821               </listitem>
4822             </varlistentry>
4823
4824             <varlistentry>
4825               <term><varname>taxbase</varname></term>
4826
4827               <listitem>
4828                 <para>zu versteuernder Betrag</para>
4829               </listitem>
4830             </varlistentry>
4831
4832             <varlistentry>
4833               <term><varname>taxdescription</varname></term>
4834
4835               <listitem>
4836                 <para>Name der Steuer</para>
4837               </listitem>
4838             </varlistentry>
4839
4840             <varlistentry>
4841               <term><varname>taxrate</varname></term>
4842
4843               <listitem>
4844                 <para>Steuersatz</para>
4845               </listitem>
4846             </varlistentry>
4847           </variablelist>
4848         </sect3>
4849
4850         <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
4851           <title>Variablen für Lieferbedingungen</title>
4852
4853           <variablelist>
4854             <varlistentry>
4855               <term><varname>delivery_term</varname></term>
4856
4857               <listitem>
4858                 <para>Datenbank-Objekt der Lieferbedingung</para>
4859               </listitem>
4860             </varlistentry>
4861
4862             <varlistentry>
4863               <term><varname>delivery_term.description</varname></term>
4864
4865               <listitem>
4866                 <para>Beschreibung der Lieferbedingung</para>
4867               </listitem>
4868             </varlistentry>
4869
4870             <varlistentry>
4871               <term><varname>delivery_term.description_long</varname></term>
4872
4873               <listitem>
4874                 <para>Langtext bzw. übersetzter Langtext der
4875                 Lieferbedingung</para>
4876               </listitem>
4877             </varlistentry>
4878           </variablelist>
4879         </sect3>
4880       </sect2>
4881
4882       <sect2 id="dokumentenvorlagen-und-variablen.invoice">
4883         <title>Variablen in Rechnungen</title>
4884
4885         <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
4886           <title>Allgemeine Variablen</title>
4887
4888           <variablelist>
4889             <varlistentry>
4890               <term><varname>creditremaining</varname></term>
4891
4892               <listitem>
4893                 <para>Verbleibender Kredit</para>
4894               </listitem>
4895             </varlistentry>
4896
4897             <varlistentry>
4898               <term><varname>currency</varname></term>
4899
4900               <listitem>
4901                 <para>Währung</para>
4902               </listitem>
4903             </varlistentry>
4904
4905             <varlistentry>
4906               <term><varname>cusordnumber</varname></term>
4907
4908               <listitem>
4909                 <para>Bestellnummer beim Kunden</para>
4910               </listitem>
4911             </varlistentry>
4912
4913             <varlistentry>
4914               <term><varname>deliverydate</varname></term>
4915
4916               <listitem>
4917                 <para>Lieferdatum</para>
4918               </listitem>
4919             </varlistentry>
4920
4921             <varlistentry>
4922               <term><varname>duedate</varname></term>
4923
4924               <listitem>
4925                 <para>Fälligkeitsdatum</para>
4926               </listitem>
4927             </varlistentry>
4928
4929             <varlistentry>
4930               <term><varname>globalprojectnumber</varname></term>
4931
4932               <listitem>
4933                 <para>Projektnummer des ganzen Beleges</para>
4934               </listitem>
4935             </varlistentry>
4936
4937             <varlistentry>
4938               <term><varname>globalprojectdescription</varname></term>
4939
4940               <listitem>
4941                 <para>Projekbeschreibung des ganzen Beleges</para>
4942               </listitem>
4943             </varlistentry>
4944
4945             <varlistentry>
4946               <term><varname>intnotes</varname></term>
4947
4948               <listitem>
4949                 <para>Interne Bemerkungen</para>
4950               </listitem>
4951             </varlistentry>
4952
4953             <varlistentry>
4954               <term><varname>invdate</varname></term>
4955
4956               <listitem>
4957                 <para>Rechnungsdatum</para>
4958               </listitem>
4959             </varlistentry>
4960
4961             <varlistentry>
4962               <term><varname>invnumber</varname></term>
4963
4964               <listitem>
4965                 <para>Rechnungsnummer</para>
4966               </listitem>
4967             </varlistentry>
4968
4969             <varlistentry>
4970               <term><varname>invtotal</varname></term>
4971
4972               <listitem>
4973                 <para>gesamter Rechnungsbetrag</para>
4974               </listitem>
4975             </varlistentry>
4976
4977             <varlistentry>
4978               <term><varname>notes</varname></term>
4979
4980               <listitem>
4981                 <para>Bemerkungen der Rechnung</para>
4982               </listitem>
4983             </varlistentry>
4984
4985             <varlistentry>
4986               <term><varname>orddate</varname></term>
4987
4988               <listitem>
4989                 <para>Auftragsdatum</para>
4990               </listitem>
4991             </varlistentry>
4992
4993             <varlistentry>
4994               <term><varname>ordnumber</varname></term>
4995
4996               <listitem>
4997                 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
4998                 erstellt wurde</para>
4999               </listitem>
5000             </varlistentry>
5001
5002             <varlistentry>
5003               <term><varname>payment_description</varname></term>
5004
5005               <listitem>
5006                 <para>Name der Zahlart</para>
5007               </listitem>
5008             </varlistentry>
5009
5010             <varlistentry>
5011               <term><varname>payment_terms</varname></term>
5012
5013               <listitem>
5014                 <para>Zahlungskonditionen</para>
5015               </listitem>
5016             </varlistentry>
5017
5018             <varlistentry>
5019               <term><varname>quodate</varname></term>
5020
5021               <listitem>
5022                 <para>Angebotsdatum</para>
5023               </listitem>
5024             </varlistentry>
5025
5026             <varlistentry>
5027               <term><varname>quonumber</varname></term>
5028
5029               <listitem>
5030                 <para>Angebotsnummer</para>
5031               </listitem>
5032             </varlistentry>
5033
5034             <varlistentry>
5035               <term><varname>rounding</varname></term>
5036
5037               <listitem>
5038                 <para>Betrag, um den <varname>invtotal</varname> gerundet
5039                 wurde (kann positiv oder negativ sein)</para>
5040               </listitem>
5041             </varlistentry>
5042
5043             <varlistentry>
5044               <term><varname>shippingpoint</varname></term>
5045
5046               <listitem>
5047                 <para>Versandort</para>
5048               </listitem>
5049             </varlistentry>
5050
5051             <varlistentry>
5052               <term><varname>shipvia</varname></term>
5053
5054               <listitem>
5055                 <para>Transportmittel</para>
5056               </listitem>
5057             </varlistentry>
5058
5059             <varlistentry>
5060               <term><varname>subtotal</varname></term>
5061
5062               <listitem>
5063                 <para>Zwischensumme aller Posten ohne Steuern</para>
5064               </listitem>
5065             </varlistentry>
5066
5067             <varlistentry>
5068               <term><varname>total</varname></term>
5069
5070               <listitem>
5071                 <para>Restsumme der Rechnung (Summe abzüglich bereits
5072                 bezahlter Posten)</para>
5073               </listitem>
5074             </varlistentry>
5075
5076             <varlistentry>
5077               <term><varname>transaction_description</varname></term>
5078
5079               <listitem>
5080                 <para>Vorgangsbezeichnung</para>
5081               </listitem>
5082             </varlistentry>
5083
5084             <varlistentry>
5085               <term><varname>transdate</varname></term>
5086
5087               <listitem>
5088                 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
5089                 erstellt wurde</para>
5090               </listitem>
5091             </varlistentry>
5092           </variablelist>
5093         </sect3>
5094
5095         <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
5096           <title>Variablen für jeden Posten auf der Rechnung</title>
5097
5098           <variablelist>
5099             <varlistentry>
5100               <term><varname>bin</varname></term>
5101
5102               <listitem>
5103                 <para>Stellage</para>
5104               </listitem>
5105             </varlistentry>
5106
5107             <varlistentry>
5108               <term><varname>description</varname></term>
5109
5110               <listitem>
5111                 <para>Artikelbeschreibung</para>
5112               </listitem>
5113             </varlistentry>
5114
5115             <varlistentry>
5116               <term><varname>cusordnumber_oe</varname></term>
5117
5118               <listitem>
5119                 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
5120                 Posten ursprünglich stammt (nur Verkauf)</para>
5121               </listitem>
5122             </varlistentry>
5123
5124             <varlistentry>
5125               <term><varname>discount</varname></term>
5126
5127               <listitem>
5128                 <para>Rabatt als Betrag</para>
5129               </listitem>
5130             </varlistentry>
5131
5132             <varlistentry>
5133               <term><varname>discount_sub</varname></term>
5134
5135               <listitem>
5136                 <para>Zwischensumme mit Rabatt</para>
5137               </listitem>
5138             </varlistentry>
5139
5140             <varlistentry>
5141               <term><varname>donumber_do</varname></term>
5142
5143               <listitem>
5144                 <para>Lieferscheinnummer des Lieferscheins, aus dem die
5145                 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
5146                 Workflows aus einem Lieferschein erstellt wurde.</para>
5147               </listitem>
5148             </varlistentry>
5149
5150             <varlistentry>
5151               <term><varname>drawing</varname></term>
5152
5153               <listitem>
5154                 <para>Zeichnung</para>
5155               </listitem>
5156             </varlistentry>
5157
5158             <varlistentry>
5159               <term><varname>ean</varname></term>
5160
5161               <listitem>
5162                 <para>EAN-Code</para>
5163               </listitem>
5164             </varlistentry>
5165
5166             <varlistentry>
5167               <term><varname>image</varname></term>
5168
5169               <listitem>
5170                 <para>Grafik</para>
5171               </listitem>
5172             </varlistentry>
5173
5174             <varlistentry>
5175               <term><varname>linetotal</varname></term>
5176
5177               <listitem>
5178                 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
5179               </listitem>
5180             </varlistentry>
5181
5182             <varlistentry>
5183               <term><varname>longdescription</varname></term>
5184
5185               <listitem>
5186                 <para>Langtext, vorbelegt mit dem Feld Bemerkungen der entsprechenden Ware</para>
5187               </listitem>
5188             </varlistentry>
5189
5190             <varlistentry>
5191               <term><varname>microfiche</varname></term>
5192
5193               <listitem>
5194                 <para>Mikrofilm</para>
5195               </listitem>
5196             </varlistentry>
5197
5198             <varlistentry>
5199               <term><varname>netprice</varname></term>
5200
5201               <listitem>
5202                 <para>Alternative zu <varname>sellprice</varname>, aber
5203                 <varname>netprice</varname> entspricht dem effektiven
5204                 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
5205                 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
5206                 / Menge. Diese Variable ist nützlich, wenn man den gewährten
5207                 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
5208                 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
5209                 <varname>netprice</varname> hat nichts mit Netto/Brutto im
5210                 Sinne von Steuern zu tun.</para>
5211               </listitem>
5212             </varlistentry>
5213
5214             <varlistentry>
5215               <term><varname>nodiscount_linetotal</varname></term>
5216
5217               <listitem>
5218                 <para>Zeilensumme ohne Rabatt</para>
5219               </listitem>
5220             </varlistentry>
5221
5222             <varlistentry>
5223               <term><varname>nodiscount_sub</varname></term>
5224
5225               <listitem>
5226                 <para>Zwischensumme ohne Rabatt</para>
5227               </listitem>
5228             </varlistentry>
5229
5230             <varlistentry>
5231               <term><varname>number</varname></term>
5232
5233               <listitem>
5234                 <para>Artikelnummer</para>
5235               </listitem>
5236             </varlistentry>
5237
5238             <varlistentry>
5239               <term><varname>ordnumber_oe</varname></term>
5240
5241               <listitem>
5242                 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5243                 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5244                 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5245                 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5246                 letzterem Fall wird die unsprüngliche Auftragsnummer
5247                 angezeigt.</para>
5248               </listitem>
5249             </varlistentry>
5250
5251             <varlistentry>
5252               <term><varname>p_discount</varname></term>
5253
5254               <listitem>
5255                 <para>Rabatt in Prozent</para>
5256               </listitem>
5257             </varlistentry>
5258
5259             <varlistentry>
5260               <term><varname>partnotes</varname></term>
5261
5262               <listitem>
5263                 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5264               </listitem>
5265             </varlistentry>
5266
5267             <varlistentry>
5268               <term><varname>partsgroup</varname></term>
5269
5270               <listitem>
5271                 <para>Warengruppe</para>
5272               </listitem>
5273             </varlistentry>
5274
5275             <varlistentry>
5276               <term><varname>price_factor</varname></term>
5277
5278               <listitem>
5279                 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5280                 ist</para>
5281               </listitem>
5282             </varlistentry>
5283
5284             <varlistentry>
5285               <term><varname>price_factor_name</varname></term>
5286
5287               <listitem>
5288                 <para>Der Name des Preisfaktors, sofern einer eingestellt
5289                 ist</para>
5290               </listitem>
5291             </varlistentry>
5292
5293             <varlistentry>
5294               <term><varname>projectnumber</varname></term>
5295
5296               <listitem>
5297                 <para>Projektnummer</para>
5298               </listitem>
5299             </varlistentry>
5300
5301             <varlistentry>
5302               <term><varname>projectdescription</varname></term>
5303
5304               <listitem>
5305                 <para>Projektbeschreibung</para>
5306               </listitem>
5307             </varlistentry>
5308
5309             <varlistentry>
5310               <term><varname>qty</varname></term>
5311
5312               <listitem>
5313                 <para>Anzahl</para>
5314               </listitem>
5315             </varlistentry>
5316
5317             <varlistentry>
5318               <term><varname>reqdate</varname></term>
5319
5320               <listitem>
5321                 <para>Lieferdatum</para>
5322               </listitem>
5323             </varlistentry>
5324
5325             <varlistentry>
5326               <term><varname>runningnumber</varname></term>
5327
5328               <listitem>
5329                 <para>Position auf der Rechnung (1, 2, 3...)</para>
5330               </listitem>
5331             </varlistentry>
5332
5333             <varlistentry>
5334               <term><varname>sellprice</varname></term>
5335
5336               <listitem>
5337                 <para>Verkaufspreis</para>
5338               </listitem>
5339             </varlistentry>
5340
5341             <varlistentry>
5342               <term><varname>serialnumber</varname></term>
5343
5344               <listitem>
5345                 <para>Seriennummer</para>
5346               </listitem>
5347             </varlistentry>
5348
5349             <varlistentry>
5350               <term><varname>tax_rate</varname></term>
5351
5352               <listitem>
5353                 <para>Steuersatz</para>
5354               </listitem>
5355             </varlistentry>
5356
5357             <varlistentry>
5358               <term><varname>transdate_do</varname></term>
5359
5360               <listitem>
5361                 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5362                 Workflows aus einem Lieferschein stammte.</para>
5363               </listitem>
5364             </varlistentry>
5365
5366             <varlistentry>
5367               <term><varname>transdate_oe</varname></term>
5368
5369               <listitem>
5370                 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5371                 Workflows aus einem Auftrag erstellt wurde. Wenn es
5372                 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5373                 genommen.</para>
5374               </listitem>
5375             </varlistentry>
5376
5377             <varlistentry>
5378               <term><varname>transdate_quo</varname></term>
5379
5380               <listitem>
5381                 <para>Datum des Angebots, wenn die Position im Rahmen des
5382                 Workflows aus einem Angebot stammte.</para>
5383               </listitem>
5384             </varlistentry>
5385
5386             <varlistentry>
5387               <term><varname>unit</varname></term>
5388
5389               <listitem>
5390                 <para>Einheit</para>
5391               </listitem>
5392             </varlistentry>
5393
5394             <varlistentry>
5395               <term><varname>weight</varname></term>
5396
5397               <listitem>
5398                 <para>Gewicht</para>
5399               </listitem>
5400             </varlistentry>
5401           </variablelist>
5402
5403           <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5404           über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5405           einer <function>foreach</function>-Schleife ausgegeben werden, da
5406           für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5407           können. Die Variablen dafür lauten:</para>
5408
5409           <variablelist>
5410             <varlistentry>
5411               <term><varname>make</varname></term>
5412
5413               <listitem>
5414                 <para>Lieferant</para>
5415               </listitem>
5416             </varlistentry>
5417
5418             <varlistentry>
5419               <term><varname>model</varname></term>
5420
5421               <listitem>
5422                 <para>Lieferantenartikelnummer</para>
5423               </listitem>
5424             </varlistentry>
5425           </variablelist>
5426         </sect3>
5427
5428         <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5429           <title>Variablen für die einzelnen Zahlungseingänge</title>
5430
5431           <variablelist>
5432             <varlistentry>
5433               <term><varname>payment</varname></term>
5434
5435               <listitem>
5436                 <para>Betrag</para>
5437               </listitem>
5438             </varlistentry>
5439
5440             <varlistentry>
5441               <term><varname>paymentaccount</varname></term>
5442
5443               <listitem>
5444                 <para>Konto</para>
5445               </listitem>
5446             </varlistentry>
5447
5448             <varlistentry>
5449               <term><varname>paymentdate</varname></term>
5450
5451               <listitem>
5452                 <para>Datum</para>
5453               </listitem>
5454             </varlistentry>
5455
5456             <varlistentry>
5457               <term><varname>paymentmemo</varname></term>
5458
5459               <listitem>
5460                 <para>Memo</para>
5461               </listitem>
5462             </varlistentry>
5463
5464             <varlistentry>
5465               <term><varname>paymentsource</varname></term>
5466
5467               <listitem>
5468                 <para>Beleg</para>
5469               </listitem>
5470             </varlistentry>
5471           </variablelist>
5472         </sect3>
5473
5474         <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5475           <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5476
5477           <para>Die vom Benutzer definierten Variablen für Kunden und
5478           Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5479           ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5480           <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5481           Variablennamen zusammen.</para>
5482
5483           <para>Beispiel: Der Benutzer hat eine Variable namens
5484           <varname>number_of_employees</varname> definiert, die die Anzahl der
5485           Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5486           unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5487           Verfügung.</para>
5488
5489           <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5490           unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5491           Präfix <varname>shiptocvar_</varname>.</para>
5492
5493           <para>Analog stehen die benutzerdefinierten Variablen für
5494           Ansprechpersonen mit dem Namenspräfix <varname>cp_cvar_</varname>
5495           zur Verfügung.</para>
5496         </sect3>
5497       </sect2>
5498
5499       <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5500         <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5501
5502         <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5503           <title>Namen der Vorlagen</title>
5504
5505           <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5506           eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5507           Erstellung einer Rechnung über die Mahngebühren und Zinsen
5508           aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5509           Vorlagenname für diese Mahnstufe mit dem Zusatz
5510           <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5511           für die ausgewählte Sprache und den ausgewählten Drucker
5512           angehängt.</para>
5513         </sect3>
5514
5515         <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5516           <title>Allgemeine Variablen in Mahnungen</title>
5517
5518           <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie
5519           gewohnt als <varname>employee_...</varname> bzw.
5520           <varname>salesman_...</varname> zur Verfügung. Werden mehrere
5521           Rechnungen in einer Mahnung zusammengefasst, so werden die Metadaten
5522           (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung im
5523           Ausdruck genommen.</para>
5524
5525           <para>Die Adressdaten des Kunden stehen als Variablen
5526           <varname>name</varname>, <varname>street</varname>,
5527           <varname>zipcode</varname>, <varname>city</varname>,
5528           <varname>country</varname>, <varname>department_1</varname>,
5529           <varname>department_2</varname>, und <varname>email</varname> zur
5530           Verfügung. Der Ansprechpartner <varname>cp_...</varname> steht auch
5531           zu Verfügung, wird allerdings auch nur von der ersten angemahnten
5532           Rechnung (s.o.) genommen.</para>
5533
5534           <para>Weitere Variablen beinhalten:</para>
5535
5536           <variablelist>
5537             <varlistentry>
5538               <term><varname>dunning_date</varname></term>
5539
5540               <listitem>
5541                 <para>Datum der Mahnung</para>
5542               </listitem>
5543             </varlistentry>
5544
5545             <varlistentry>
5546               <term><varname>dunning_duedate</varname></term>
5547
5548               <listitem>
5549                 <para>Fälligkeitsdatum für diese Mahhnung</para>
5550               </listitem>
5551             </varlistentry>
5552
5553             <varlistentry>
5554               <term><varname>dunning_id</varname></term>
5555
5556               <listitem>
5557                 <para>Mahnungsnummer</para>
5558               </listitem>
5559             </varlistentry>
5560
5561             <varlistentry>
5562               <term><varname>fee</varname></term>
5563
5564               <listitem>
5565                 <para>Kumulative Mahngebühren</para>
5566               </listitem>
5567             </varlistentry>
5568
5569             <varlistentry>
5570               <term><varname>interest_rate</varname></term>
5571
5572               <listitem>
5573                 <para>Zinssatz per anno in Prozent</para>
5574               </listitem>
5575             </varlistentry>
5576
5577             <varlistentry>
5578               <term><varname>total_amount</varname></term>
5579
5580               <listitem>
5581                 <para>Gesamter noch zu zahlender Betrag als
5582                 <function>fee</function> + <function>total_interest</function>
5583                 + <function>total_open_amount</function></para>
5584               </listitem>
5585             </varlistentry>
5586
5587             <varlistentry>
5588               <term><varname>total_interest</varname></term>
5589
5590               <listitem>
5591                 <para>Zinsen per anno über alle Rechnungen</para>
5592               </listitem>
5593             </varlistentry>
5594
5595             <varlistentry>
5596               <term><varname>total_open_amount</varname></term>
5597
5598               <listitem>
5599                 <para>Summe über alle offene Beträge der Rechnungen</para>
5600               </listitem>
5601             </varlistentry>
5602           </variablelist>
5603         </sect3>
5604
5605         <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5606           <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5607
5608           <variablelist>
5609             <varlistentry>
5610               <term><varname>dn_amount</varname></term>
5611
5612               <listitem>
5613                 <para>Rechnungssumme (brutto)</para>
5614               </listitem>
5615             </varlistentry>
5616
5617             <varlistentry>
5618               <term><varname>dn_duedate</varname></term>
5619
5620               <listitem>
5621                 <para>Originales Fälligkeitsdatum der Rechnung</para>
5622               </listitem>
5623             </varlistentry>
5624
5625             <varlistentry>
5626               <term><varname>dn_dunning_date</varname></term>
5627
5628               <listitem>
5629                 <para>Datum der Mahnung</para>
5630               </listitem>
5631             </varlistentry>
5632
5633             <varlistentry>
5634               <term><varname>dn_dunning_duedate</varname></term>
5635
5636               <listitem>
5637                 <para>Fälligkeitsdatum der Mahnung</para>
5638               </listitem>
5639             </varlistentry>
5640
5641             <varlistentry>
5642               <term><varname>dn_fee</varname></term>
5643
5644               <listitem>
5645                 <para>Kummulative Mahngebühr</para>
5646               </listitem>
5647             </varlistentry>
5648
5649             <varlistentry>
5650               <term><varname>dn_interest</varname></term>
5651
5652               <listitem>
5653                 <para>Zinsen per anno für diese Rechnung</para>
5654               </listitem>
5655             </varlistentry>
5656
5657             <varlistentry>
5658               <term><varname>dn_invnumber</varname></term>
5659
5660               <listitem>
5661                 <para>Rechnungsnummer</para>
5662               </listitem>
5663             </varlistentry>
5664
5665             <varlistentry>
5666               <term><varname>dn_linetotal</varname></term>
5667
5668               <listitem>
5669                 <para>Noch zu zahlender Betrag (ergibt sich aus
5670                 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5671                 + <varname>dn_interest</varname>)</para>
5672               </listitem>
5673             </varlistentry>
5674
5675             <varlistentry>
5676               <term><varname>dn_netamount</varname></term>
5677
5678               <listitem>
5679                 <para>Rechnungssumme (netto)</para>
5680               </listitem>
5681             </varlistentry>
5682
5683             <varlistentry>
5684               <term><varname>dn_open_amount</varname></term>
5685
5686               <listitem>
5687                 <para>Offener Rechnungsbetrag</para>
5688               </listitem>
5689             </varlistentry>
5690
5691             <varlistentry>
5692               <term><varname>dn_ordnumber</varname></term>
5693
5694               <listitem>
5695                 <para>Bestellnummer</para>
5696               </listitem>
5697             </varlistentry>
5698
5699             <varlistentry>
5700               <term><varname>dn_transdate</varname></term>
5701
5702               <listitem>
5703                 <para>Rechnungsdatum</para>
5704               </listitem>
5705             </varlistentry>
5706
5707             <varlistentry>
5708               <term><varname>dn_curr</varname></term>
5709
5710               <listitem>
5711                 <para>Währung, in der die Rechnung erstellt wurde. (Die
5712                 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5713               </listitem>
5714             </varlistentry>
5715           </variablelist>
5716         </sect3>
5717
5718         <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5719           <title>Variablen in automatisch erzeugten Rechnungen über
5720           Mahngebühren</title>
5721
5722           <para>Die Variablen des Verkäufers stehen wie gewohnt als
5723           <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5724           Kunden stehen als Variablen <varname>name</varname>,
5725           <varname>street</varname>, <varname>zipcode</varname>,
5726           <varname>city</varname>, <varname>country</varname>,
5727           <varname>department_1</varname>, <varname>department_2</varname>,
5728           und <varname>email</varname> zur Verfügung.</para>
5729
5730           <para>Weitere Variablen beinhalten:</para>
5731
5732           <variablelist>
5733             <varlistentry>
5734               <term><varname>duedate</varname></term>
5735
5736               <listitem>
5737                 <para>Fälligkeitsdatum der Rechnung</para>
5738               </listitem>
5739             </varlistentry>
5740
5741             <varlistentry>
5742               <term><varname>dunning_id</varname></term>
5743
5744               <listitem>
5745                 <para>Mahnungsnummer</para>
5746               </listitem>
5747             </varlistentry>
5748
5749             <varlistentry>
5750               <term><varname>fee</varname></term>
5751
5752               <listitem>
5753                 <para>Mahngebühren</para>
5754               </listitem>
5755             </varlistentry>
5756
5757             <varlistentry>
5758               <term><varname>interest</varname></term>
5759
5760               <listitem>
5761                 <para>Zinsen</para>
5762               </listitem>
5763             </varlistentry>
5764
5765             <varlistentry>
5766               <term><varname>invamount</varname></term>
5767
5768               <listitem>
5769                 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
5770                 <varname>interest</varname>)</para>
5771               </listitem>
5772             </varlistentry>
5773
5774             <varlistentry>
5775               <term><varname>invdate</varname></term>
5776
5777               <listitem>
5778                 <para>Rechnungsdatum</para>
5779               </listitem>
5780             </varlistentry>
5781
5782             <varlistentry>
5783               <term><varname>invnumber</varname></term>
5784
5785               <listitem>
5786                 <para>Rechnungsnummer</para>
5787               </listitem>
5788             </varlistentry>
5789           </variablelist>
5790         </sect3>
5791       </sect2>
5792
5793       <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
5794         <title>Variablen in anderen Vorlagen</title>
5795
5796         <sect3>
5797           <title>Einführung</title>
5798
5799           <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
5800           Rechnung. Allerdings heißen die Variablen, die mit
5801           <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
5802           fangen sie mit <varname>quo</varname> für "quotation" an:
5803           <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
5804           wiederum fangen sie mit <varname>ord</varname> für "order" an:
5805           <varname>ordnumber</varname> für Bestellnummer etc.</para>
5806
5807           <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
5808           vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
5809           sind Variablen, die vom Geschäftsablauf her in der entsprechenden
5810           Vorlage keine Bedeutung haben oder noch nicht belegt sein
5811           können.</para>
5812
5813           <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
5814           in Rechnungen aufgeführt.</para>
5815         </sect3>
5816
5817         <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
5818           <title>Angebote und Preisanfragen</title>
5819
5820           <variablelist>
5821             <varlistentry>
5822               <term><varname>quonumber</varname></term>
5823
5824               <listitem>
5825                 <para>Angebots- bzw. Anfragenummer</para>
5826               </listitem>
5827             </varlistentry>
5828
5829             <varlistentry>
5830               <term><varname>reqdate</varname></term>
5831
5832               <listitem>
5833                 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
5834                 Preisanfragen)</para>
5835               </listitem>
5836             </varlistentry>
5837
5838             <varlistentry>
5839               <term><varname>transdate</varname></term>
5840
5841               <listitem>
5842                 <para>Angebots- bzw. Anfragedatum</para>
5843               </listitem>
5844             </varlistentry>
5845           </variablelist>
5846         </sect3>
5847
5848         <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
5849           <title>Auftragsbestätigungen und Lieferantenaufträge</title>
5850
5851           <variablelist>
5852             <varlistentry>
5853               <term><varname>ordnumber</varname></term>
5854
5855               <listitem>
5856                 <para>Auftragsnummer</para>
5857               </listitem>
5858             </varlistentry>
5859
5860             <varlistentry>
5861               <term><varname>reqdate</varname></term>
5862
5863               <listitem>
5864                 <para>Lieferdatum</para>
5865               </listitem>
5866             </varlistentry>
5867
5868             <varlistentry>
5869               <term><varname>transdate</varname></term>
5870
5871               <listitem>
5872                 <para>Auftragsdatum</para>
5873               </listitem>
5874             </varlistentry>
5875           </variablelist>
5876         </sect3>
5877
5878         <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
5879           <title>Lieferscheine (Verkauf und Einkauf)</title>
5880
5881           <variablelist>
5882             <varlistentry>
5883               <term><varname>cusordnumber</varname></term>
5884
5885               <listitem>
5886                 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
5887                 des Lieferanten (im Einkauf)</para>
5888               </listitem>
5889             </varlistentry>
5890
5891             <varlistentry>
5892               <term><varname>donumber</varname></term>
5893
5894               <listitem>
5895                 <para>Lieferscheinnummer</para>
5896               </listitem>
5897             </varlistentry>
5898
5899             <varlistentry>
5900               <term><varname>transdate</varname></term>
5901
5902               <listitem>
5903                 <para>Lieferscheindatum</para>
5904               </listitem>
5905             </varlistentry>
5906           </variablelist>
5907
5908           <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
5909           mit den Informationen darüber, von welchem Lager und Lagerplatz aus
5910           die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
5911           Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
5912           <function>foreach</function>-Schleife ausgegeben werden. Diese
5913           Variablen sind:</para>
5914
5915           <variablelist>
5916             <varlistentry>
5917               <term><varname>si_bin</varname></term>
5918
5919               <listitem>
5920                 <para>Lagerplatz</para>
5921               </listitem>
5922             </varlistentry>
5923
5924             <varlistentry>
5925               <term><varname>si_chargenumber</varname></term>
5926
5927               <listitem>
5928                 <para>Chargennummer</para>
5929               </listitem>
5930             </varlistentry>
5931
5932             <varlistentry>
5933               <term><varname>si_bestbefore</varname></term>
5934
5935               <listitem>
5936                 <para>Mindesthaltbarkeit</para>
5937               </listitem>
5938             </varlistentry>
5939
5940             <varlistentry>
5941               <term><varname>si_number</varname></term>
5942
5943               <listitem>
5944                 <para>Artikelnummer</para>
5945               </listitem>
5946             </varlistentry>
5947
5948             <varlistentry>
5949               <term><varname>si_qty</varname></term>
5950
5951               <listitem>
5952                 <para>Anzahl bzw. Menge</para>
5953               </listitem>
5954             </varlistentry>
5955
5956             <varlistentry>
5957               <term><varname>si_runningnumber</varname></term>
5958
5959               <listitem>
5960                 <para>Positionsnummer (1, 2, 3 etc)</para>
5961               </listitem>
5962             </varlistentry>
5963
5964             <varlistentry>
5965               <term><varname>si_unit</varname></term>
5966
5967               <listitem>
5968                 <para>Einheit</para>
5969               </listitem>
5970             </varlistentry>
5971
5972             <varlistentry>
5973               <term><varname>si_warehouse</varname></term>
5974
5975               <listitem>
5976                 <para>Lager</para>
5977               </listitem>
5978             </varlistentry>
5979           </variablelist>
5980         </sect3>
5981
5982         <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
5983           <title>Variablen für Sammelrechnung</title>
5984
5985           <variablelist>
5986             <varlistentry>
5987               <term><varname>c0total</varname></term>
5988
5989               <listitem>
5990                 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit &lt; 30
5991                 Tage</para>
5992               </listitem>
5993             </varlistentry>
5994
5995             <varlistentry>
5996               <term><varname>c30total</varname></term>
5997
5998               <listitem>
5999                 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit &gt;= 30
6000                 und &lt; 60 Tage</para>
6001               </listitem>
6002             </varlistentry>
6003
6004             <varlistentry>
6005               <term><varname>c60total</varname></term>
6006
6007               <listitem>
6008                 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit &gt;= 60
6009                 und &lt; 90 Tage</para>
6010               </listitem>
6011             </varlistentry>
6012
6013             <varlistentry>
6014               <term><varname>c90total</varname></term>
6015
6016               <listitem>
6017                 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit &gt;= 90
6018                 Tage</para>
6019               </listitem>
6020             </varlistentry>
6021
6022             <varlistentry>
6023               <term><varname>total</varname></term>
6024
6025               <listitem>
6026                 <para>Gesamtbetrag aller Rechnungen</para>
6027               </listitem>
6028             </varlistentry>
6029           </variablelist>
6030
6031           <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
6032
6033           <variablelist>
6034             <varlistentry>
6035               <term><varname>invnumber</varname></term>
6036
6037               <listitem>
6038                 <para>Rechnungsnummer</para>
6039               </listitem>
6040             </varlistentry>
6041
6042             <varlistentry>
6043               <term><varname>invdate</varname></term>
6044
6045               <listitem>
6046                 <para>Rechnungsdatum</para>
6047               </listitem>
6048             </varlistentry>
6049
6050             <varlistentry>
6051               <term><varname>duedate</varname></term>
6052
6053               <listitem>
6054                 <para>Fälligkeitsdatum</para>
6055               </listitem>
6056             </varlistentry>
6057
6058             <varlistentry>
6059               <term><varname>amount</varname></term>
6060
6061               <listitem>
6062                 <para>Summe der Rechnung</para>
6063               </listitem>
6064             </varlistentry>
6065
6066             <varlistentry>
6067               <term><varname>open</varname></term>
6068
6069               <listitem>
6070                 <para>Noch offener Betrag der Rechnung</para>
6071               </listitem>
6072             </varlistentry>
6073
6074             <varlistentry>
6075               <term><varname>c0</varname></term>
6076
6077               <listitem>
6078                 <para>Noch offener Rechnungsbetrag mit Fälligkeit &lt; 30
6079                 Tage</para>
6080               </listitem>
6081             </varlistentry>
6082
6083             <varlistentry>
6084               <term><varname>c30</varname></term>
6085
6086               <listitem>
6087                 <para>Noch offener Rechnungsbetrag mit Fälligkeit &gt;= 30 und
6088                 &lt; 60 Tage</para>
6089               </listitem>
6090             </varlistentry>
6091
6092             <varlistentry>
6093               <term><varname>c60</varname></term>
6094
6095               <listitem>
6096                 <para>Noch offener Rechnungsbetrag mit Fälligkeit &gt;= 60 und
6097                 &lt; 90 Tage</para>
6098               </listitem>
6099             </varlistentry>
6100
6101             <varlistentry>
6102               <term><varname>c90</varname></term>
6103
6104               <listitem>
6105                 <para>Noch offener Rechnungsbetrag mit Fälligkeit &gt;= 90
6106                 Tage</para>
6107               </listitem>
6108             </varlistentry>
6109           </variablelist>
6110         </sect3>
6111       </sect2>
6112
6113       <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
6114         <title>Blöcke, bedingte Anweisungen und Schleifen</title>
6115
6116         <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
6117           <title>Einführung</title>
6118
6119           <para>Der Parser kennt neben den Variablen einige weitere
6120           Konstrukte, die gesondert behandelt werden. Diese sind wie
6121           Variablennamen in spezieller Weise markiert:
6122           <command>&lt;%anweisung%&gt; ... &lt;%end%&gt;</command></para>
6123
6124           <para>Anmerkung zum <command>&lt;%end%&gt;</command>: Der besseren
6125           Verständlichkeit halber kann man nach dem <command>end</command>
6126           noch beliebig weitere Wörter schreiben, um so zu markieren, welche
6127           Anweisung (z.B. <command>if</command> oder
6128           <command>foreach</command>) damit abgeschlossen wird.</para>
6129
6130           <para>Beispiel: Lautet der Beginn eines Blockes z.B.
6131           <command>&lt;%if type == "sales_quotation"%&gt;</command>, so könnte
6132           er mit <command>&lt;%end%&gt;</command> genauso abgeschlossen werden
6133           wie mit <command>&lt;%end if%&gt;</command> oder auch
6134           <command>&lt;%end type == "sales_quotation"%&gt;</command>.</para>
6135         </sect3>
6136
6137         <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
6138           <title>Der if-Block</title>
6139
6140           <programlisting>&lt;%if variablenname%&gt;
6141 ...
6142 &lt;%end%&gt;</programlisting>
6143
6144           <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
6145           und dem "end" werden nur ausgegeben, wenn die Variable
6146           <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
6147
6148           <para>Handelt es sich bei der benannten Variable um ein Array, also
6149           um einen Variablennamen, über den man mit <command>&lt;%foreach
6150           variablenname%&gt;</command> iteriert, so wird mit diesem Konstrukt
6151           darauf getestet, ob das Array Elemente enthält. Somit würde im
6152           folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
6153           ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
6154           welche getätigt wurden:</para>
6155
6156           <programlisting>&lt;%if payment%&gt;
6157 Zahlungseingänge:
6158  &lt;%foreach payment%&gt;
6159    Am &lt;%paymentdate%&gt;: &lt;%payment%&gt; €
6160  &lt;%end foreach%&gt;
6161 &lt;%end if%&gt;</programlisting>
6162
6163           <para>Die Bedingung kann auch negiert werden, indem das Wort
6164           <function>not</function> nach dem <filename>if</filename> verwendet
6165           wird. Beispiel:</para>
6166
6167           <programlisting>&lt;%if not cp_greeting%&gt;
6168 ...
6169 &lt;%end%&gt;</programlisting>
6170
6171           <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
6172           oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
6173           einer Variablen mit einer festen Zeichenkette oder einer anderen
6174           Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
6175           oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
6176           die rechte Seite des Vergleichsoperators in Anführungszeichen
6177           gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
6178           anderer Variablen). Zwei Beispiele, die beide Vergleiche
6179           zeigen:</para>
6180
6181           <programlisting>&lt;%if var1 == "Wert"%&gt;</programlisting>
6182
6183           <para>Testet die Variable <varname>var1</varname> auf
6184           übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
6185           Mittels <function>!=</function> anstelle von <function>==</function>
6186           würde auf Ungleichheit getestet.</para>
6187
6188           <programlisting>&lt;%if var1 == var2%&gt;</programlisting>
6189
6190           <para>Testet die Variable <varname>var1</varname> auf
6191           übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
6192           <function>!=</function> anstelle von <function>==</function> würde
6193           auf Ungleichheit getestet.</para>
6194
6195           <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
6196           auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
6197           Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
6198           dieselbe Syntax wie oben nur mit <function>=~</function> und
6199           <function>!~</function> als Vergleichsoperatoren.</para>
6200
6201           <para>Beispiel für einen Test, ob die Variable
6202           <varname>intnotes</varname> (interne Bemerkungen) das Wort
6203           <constant>schwierig</constant> enthält:</para>
6204
6205           <programlisting>&lt;%if intnotes =~ "schwierig"%&gt;</programlisting>
6206         </sect3>
6207
6208         <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
6209           <title>Der foreach-Block</title>
6210
6211           <programlisting>&lt;%foreach variablenname%&gt;
6212 ...
6213 &lt;%end%&gt;</programlisting>
6214
6215           <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
6216           wie das Perl-Array der Variablen <varname>variablenname</varname>
6217           Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
6218           Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
6219           benutzt. In jedem Durchlauf werden die <link
6220           linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
6221           Variablen</link> jeweils auf den Wert für die aktuelle Position
6222           gesetzt.</para>
6223
6224           <para>Die Syntax sieht normalerweise wie folgt aus:</para>
6225
6226           <programlisting>&lt;%foreach number%&gt;
6227 Position: &lt;%runningnumber%&gt;
6228 Anzahl: &lt;%qty%&gt;
6229 Artikelnummer: &lt;%number%&gt;
6230 Beschreibung: &lt;%description%&gt;
6231 ...
6232 &lt;%end%&gt;</programlisting>
6233
6234           <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
6235           <function>&lt;%foreach%&gt;</function>-Block innerhalb einer
6236           Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
6237           wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
6238           Inhalt zwischen <function>&lt;%foreach%&gt;</function> und
6239           <function>&lt;%end%&gt;</function> wiederholt, nicht aber die
6240           komplette Zeile, in der er steht.</para>
6241         </sect3>
6242       </sect2>
6243
6244       <sect2 id="dokumentenvorlagen-und-variablen.markup">
6245         <title>Markup-Code zur Textformatierung innerhalb von
6246         Formularen</title>
6247
6248         <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6249         anders formatiert haben möchte, so ist dies begrenzt möglich.
6250         kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6251         Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6252         Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6253         dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6254         (HTML oder PDF über LaTeX) umgesetzt.</para>
6255
6256         <para>Die unterstützen Formatierungen sind:</para>
6257
6258         <variablelist>
6259           <varlistentry>
6260             <term>&lt;b&gt;Text&lt;/b&gt;</term>
6261
6262             <listitem>
6263               <para>Text wird in Fettdruck gesetzt.</para>
6264             </listitem>
6265           </varlistentry>
6266
6267           <varlistentry>
6268             <term>&lt;i&gt;Text&lt;/i&gt;</term>
6269
6270             <listitem>
6271               <para>Text wird kursiv gesetzt.</para>
6272             </listitem>
6273           </varlistentry>
6274
6275           <varlistentry>
6276             <term>&lt;u&gt;Text&lt;/u&gt;</term>
6277
6278             <listitem>
6279               <para>Text wird unterstrichen.</para>
6280             </listitem>
6281           </varlistentry>
6282
6283           <varlistentry>
6284             <term>&lt;s&gt;Text&lt;/s&gt;</term>
6285
6286             <listitem>
6287               <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6288               bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6289             </listitem>
6290           </varlistentry>
6291
6292           <varlistentry>
6293             <term>&lt;bullet&gt;</term>
6294
6295             <listitem>
6296               <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6297               unten).</para>
6298             </listitem>
6299           </varlistentry>
6300         </variablelist>
6301
6302         <para>Der Befehl <command>&lt;bullet&gt;</command> funktioniert
6303         momentan auch nur in Latex-Vorlagen.</para>
6304       </sect2>
6305
6306       <sect2 id="dokumentenvorlagen-und-variablen.anrede"
6307              xreflabel="Hinweise zur Anrede">
6308         <title>Hinweise zur Anrede</title>
6309
6310         <para>Das Flag "natürliche Person"
6311         (<varname>natural_person</varname>) aus den Kunden- oder
6312         Lieferantenstammdaten kann in den Druckvorlagen zusammen mit
6313         dem Feld "Anrede" (<varname>greeting</varname>) z.B. dafür
6314         verwendet werden, die Anrede zwischen einer allgemeinen und
6315         einer persönlichen Anrede zu unterscheiden.
6316         <programlisting>&lt;%if natural_person%&gt;&lt;%greeting%&gt; &lt;%name%&gt;&lt;%else%&gt;Sehr geehrte Damen und Herren&lt;%end if%&gt;</programlisting>
6317         </para>
6318       </sect2>
6319
6320     </sect1>
6321
6322     <sect1 id="excel-templates">
6323       <title>Excel-Vorlagen</title>
6324
6325       <sect2 id="excel-templates.summary">
6326         <title>Zusammenfassung</title>
6327
6328         <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6329         Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6330         einhergehen.</para>
6331       </sect2>
6332
6333       <sect2 id="excel-templates.usage">
6334         <title>Bedienung</title>
6335
6336         <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6337         werden. Die Konfigurationsoption heißt <varname>excel_templates =
6338         1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6339
6340         <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6341         anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6342         werden. In den normalen Verkaufsmasken taucht nun
6343         <constant>Excel</constant> als auswählbares Format auf und kann von da
6344         an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6345
6346         <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6347         eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6348         <filename>sales_quotation.xls</filename> gespeichert.</para>
6349       </sect2>
6350
6351       <sect2 id="excel-templates.syntax">
6352         <title>Variablensyntax</title>
6353
6354         <para>Einfache Syntax:
6355         <command>&lt;&lt;varname&gt;&gt;</command></para>
6356
6357         <para>Dabei sind <constant>&lt;&lt;</constant> und
6358         <constant>&gt;&gt;</constant> die Delimiter. Da Excel auf festen
6359         Breiten besteht, kann der Tag künstlich verlängert werden, indem
6360         weitere <constant>&lt;</constant> oder <constant>&gt;</constant>
6361         eingefügt werden. Der Tag muss nicht symmetrisch sein.
6362         Beispiel:</para>
6363
6364         <programlisting>&lt;&lt;&lt;&lt;&lt;varname&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;</programlisting>
6365
6366         <para>Um die Limitierung der festen Breite zu reduzieren, können
6367         weitere Variablen in einem Block interpoliert werden. Whitespace wird
6368         dazwishen dann erhalten. Beispiel:</para>
6369
6370         <programlisting>&lt;&lt;&lt;&lt;&lt;varname1 varname2   varname3&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;</programlisting>
6371
6372         <para>Die Variablen werden interpoliert, und linksbündig mit
6373         Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6374         lang, werden überzählige Zeichen abgeschnitten.</para>
6375
6376         <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6377         der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6378
6379         <programlisting>&lt;&lt;&lt;&lt;&lt;&lt;            varname&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;</programlisting>
6380
6381         <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6382         Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6383         entfernt.</para>
6384       </sect2>
6385
6386       <sect2 id="excel-templates.limitations">
6387         <title>Einschränkungen</title>
6388
6389         <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6390         mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6391         beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6392         Text zu ersetzen.</para>
6393
6394         <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6395         <command>&lt;%if%&gt;</command> und
6396         <command>&lt;%foreach%&gt;</command> nicht vorhanden. Der Delimiter
6397         <constant>&lt;% %&gt;</constant> kommt in den Headerinformationen
6398         evtl. vor. Deshalb wurde auf den sichereren Delimiter
6399         <constant>&lt;&lt;</constant> und <constant>&gt;&gt;</constant>
6400         gewechselt.</para>
6401       </sect2>
6402     </sect1>
6403
6404     <sect1 id="features.warehouse">
6405       <title>Mandantenkonfiguration Lager</title>
6406
6407       <para>Die Lagerverwaltung in kivitendo funktioniert standardmässig wie
6408       folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6409       Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen
6410       durchzuführen. Ferner kann jede Position eines Lieferscheins ein-, bzw.
6411       ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele
6412       Lager mit beliebig vielen Lagerplätzen abgebildet werden. Die
6413       Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder
6414       Einzelposition und das Auswählen dieser Position zu einem Lager mit
6415       Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je
6416       nachdem wie die Einstellungen in der Mandatenkonfiguration gesetzt
6417       werden.</para>
6418
6419       <itemizedlist>
6420         <listitem>
6421           <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6422           ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6423           Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6424           den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6425         </listitem>
6426
6427         <listitem>
6428           <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6429           Auslagern schlägt fehl, wenn die entsprechende Menge für die
6430           Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6431           und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6432           dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6433           (Fehlbestand, o.ä.) konfiguriert sein.</para>
6434         </listitem>
6435       </itemizedlist>
6436
6437       <para>Zusätzliche Funktionshinweise:</para>
6438
6439       <itemizedlist>
6440         <listitem>
6441           <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6442           wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6443           Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6444         </listitem>
6445
6446         <listitem>
6447           <para><option>Standard-Lagerplatz verwenden, falls keiner in
6448           Stammdaten definiert</option> Wird beim 'Auslagern über
6449           Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6450           so wird mit dieser Option einfach der Standardlagerplatz
6451           verwendet.</para>
6452         </listitem>
6453       </itemizedlist>
6454     </sect1>
6455
6456     <sect1 id="features.swiss-charts-of-accounts">
6457       <title>Schweizer Kontenpläne</title>
6458
6459       <para>Seit der Version 3.5 stehen in kivitendo 3 Kontenpläne für den
6460       Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6461       Organisationen, die nicht mehrwertsteuerpflichtig sind, einer für
6462       Firmen, die mehrwertsteuerpflichtig sind und einer speziell für
6463       Vereine.</para>
6464
6465       <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6466       verwendeten KMU-Kontenrahmen und sind mit der Revision des
6467       Schweizerischen Obligationenrechts (OR) vom 1.1.2013 kompatibel,
6468       insbesondere <literal>Art.957a Abs.2</literal>.</para>
6469
6470       <para>Beim Vereinskontenplan sind standardmässig nur die Konten 1100
6471       (Debitoren CHF) und 1101 (Debitoren EUR) als Buchungskonten im Verkauf
6472       sowie die Konten 2000 (Kreditoren CHF) und 2001 (Kreditoren EUR) als
6473       Buchungskonten im Einkauf vorgesehen. Weitere Konten können bei Bedarf
6474       in den Konto-Detaileinstellungen als Einkaufs- oder Verkaufskonten
6475       konfiguriert werden.</para>
6476
6477       <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der
6478       aktuellen Version von kivitendo noch nicht integriert.</para>
6479
6480       <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6481       Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6482       Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen alle
6483       Aufwandskonten editiert werden und dort der Steuersatz auf 0% gesetzt
6484       werden.</para>
6485
6486       <para>So werden bei Kreditorenbuchungen keine Vorsteuern
6487       verbucht.</para>
6488
6489       <para>Bezugssteuern für aus dem Ausland bezogene Dienstleistungen müssen
6490       manuell verbucht werden.</para>
6491
6492       <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6493       Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne bitte an
6494       <literal>empfang@revamp-it.ch</literal> senden.</para>
6495     </sect1>
6496
6497     <sect1 id="features.part_classification">
6498       <title>Artikelklassifizierung</title>
6499
6500       <sect2>
6501         <title>Übersicht</title>
6502
6503         <para>Die Klassifizierung von Artikeln dient einer weiteren
6504         Gliederung, um zum Beispiel den Einkauf vom Verkauf zu trennen,
6505         gekennzeichnet durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel
6506         (z.B. "E"). Für jede Klassifizierung besteht eine Beschreibung und
6507         eine Abkürzung die normalerweise aus einem Zeichen besteht, kann aber
6508         auf mehrere Zeichen erweitert werden, falls zur Unterscheidung
6509         notwendig. Sinnvoll sind jedoch nur maximal 2 Zeichen.</para>
6510       </sect2>
6511
6512       <sect2>
6513         <title>Basisklassifizierung</title>
6514
6515         <para>Als Basisklassifizierungen gibt es</para>
6516
6517         <itemizedlist>
6518           <listitem>
6519             <para>Einkauf</para>
6520           </listitem>
6521
6522           <listitem>
6523             <para>Verkauf</para>
6524           </listitem>
6525
6526           <listitem>
6527             <para>Handelsware</para>
6528           </listitem>
6529
6530           <listitem>
6531             <para>Produktion</para>
6532           </listitem>
6533
6534           <listitem>
6535             <para>- keine - (diese wird bei einer Aktualisierung für alle
6536             existierenden Artikel verwendet und ist gültig für Verkauf und
6537             Einkauf)</para>
6538           </listitem>
6539         </itemizedlist>
6540
6541         <para>Es können weitere Klassifizierungen angelegt werden. So kann es
6542         z.B. für separat auszuweisende Artikel folgende Klassen geben:</para>
6543
6544         <itemizedlist>
6545           <listitem>
6546             <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
6547           </listitem>
6548
6549           <listitem>
6550             <para>Material (Verpackungsmaterial) mit Kürzel M</para>
6551           </listitem>
6552         </itemizedlist>
6553       </sect2>
6554
6555       <sect2>
6556         <title>Attribute</title>
6557
6558         <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
6559         alle gleichzeitg gültig sein können</para>
6560
6561         <itemizedlist>
6562           <listitem>
6563             <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
6564             werden</para>
6565           </listitem>
6566
6567           <listitem>
6568             <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
6569             werden</para>
6570           </listitem>
6571
6572           <listitem>
6573             <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
6574             (LaTeX) eine zusätzliche Variable</para>
6575           </listitem>
6576         </itemizedlist>
6577
6578         <para>Für das Attribut "separat ausweisen" stehen in den
6579         LaTeX-Vorlagen die Variable <emphasis
6580         role="bold">&lt;%non_separate_subtotal%&gt; </emphasis>zur Verfügung,
6581         die alle nicht separat auszuweisenden Artikelkosten saldiert, sowie
6582         pro separat auszuweisenden Klassifizierungen die Variable<emphasis
6583         role="bold">&lt; %separate_X_subtotal%&gt;</emphasis>, wobei X das
6584         Kürzel der Klassifizierung ist.</para>
6585
6586         <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
6587         role="bold">&lt;%separate_L_subtotal%&gt;</emphasis> und für
6588         Verpackungsmaterial <emphasis role="bold">
6589         &lt;%separate_M_subtotal%&gt;</emphasis>.</para>
6590       </sect2>
6591
6592       <sect2>
6593         <title>Zwei-Zeichen Abkürzung</title>
6594
6595         <para>Der Typ des Artikels und die Klassifizierung werden durch zwei
6596         Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
6597         Artikel-Typs ('P','A','S'), deutsch 'W', 'E', und 'D' für Ware
6598         Erzeugnis oder Dienstleistung und ggf. weiterer Typen.</para>
6599
6600         <para>Der zweite Buchstabe (und ggf. auch ein dritter, falls nötig)
6601         entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
6602
6603         <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
6604         Erleichterung mit dargestellt.</para>
6605       </sect2>
6606     </sect1>
6607
6608     <sect1 id="features.file_managment">
6609       <title>Dateiverwaltung (Mini-DMS)</title>
6610
6611       <sect2>
6612         <title>Übersicht</title>
6613
6614         <para>Parallel zum alten WebDAV gibt es ein Datei-Management-System,
6615         das Dateien verschiedenen Typs verwaltet. Dies können</para>
6616
6617         <orderedlist>
6618           <listitem>
6619             <para>aus ERP-Daten per LaTeX Template erzeugte
6620             PDF-Dokumente,</para>
6621           </listitem>
6622
6623           <listitem>
6624             <para>zu bestimmten ERP-Daten gehörende Anhangdateien
6625             unterschiedlichen Formats,</para>
6626           </listitem>
6627
6628           <listitem>
6629             <para>per Scanner eingelesene PDF-Dateien,</para>
6630           </listitem>
6631
6632           <listitem>
6633             <para>per E-Mail empfangene Dateianhänge unterschiedlichen
6634             Formats,</para>
6635           </listitem>
6636
6637           <listitem>
6638             <para>sowie speziel für Artikel hochgeladene Bilder sein.</para>
6639           </listitem>
6640         </orderedlist>
6641
6642         <screenshot>
6643           <screeninfo>Übersicht</screeninfo>
6644
6645           <mediaobject>
6646             <imageobject>
6647               <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
6648             </imageobject>
6649           </mediaobject>
6650         </screenshot>
6651       </sect2>
6652
6653       <sect2>
6654         <title>Struktur</title>
6655
6656         <para>Über eine vom Speichermedium unabhängige Zwischenschicht werden
6657         die Dateien und ihre Versionen in der Datenbank verwaltet. Darunter
6658         können verschiedene Implementierungen (Backends) gleichzeitig
6659         existieren:</para>
6660
6661         <itemizedlist>
6662           <listitem>
6663             <para>Dateisystem</para>
6664           </listitem>
6665
6666           <listitem>
6667             <para>WebDAV</para>
6668           </listitem>
6669
6670           <listitem>
6671             <para>Schnittstelle zu externen
6672             Dokumenten-Management-Systemen</para>
6673           </listitem>
6674
6675           <listitem>
6676             <para>andere Datenbank</para>
6677           </listitem>
6678
6679           <listitem>
6680             <para>etc ...</para>
6681           </listitem>
6682         </itemizedlist>
6683
6684         <para>Es gibt unterschiedliche Typen von Dateien. Jedem Typ läßt sich
6685         in der Mandantenkonfiguration ein bestimmtes Backend zuordnen.</para>
6686
6687         <itemizedlist>
6688           <listitem>
6689             <para>"document": Das sind entweder generierte, eingescannte oder
6690             hochgeladene PDF-Dateien, die zu bestimmten ERP-Daten
6691             (ERP-Objekte, wie z.B. Rechnung, Lieferschein) gehören.</para>
6692           </listitem>
6693
6694           <listitem>
6695             <para>"attachment": zusätzlich hochgeladene Dokumente, die an
6696             bestimmte ERP-Objekte angehängt werden, z.B. technische
6697             Zeichnungen, Aufmaße. Diese können auch für Artikel, Lieferanten
6698             und Kunden hinterlegt sein.</para>
6699           </listitem>
6700
6701           <listitem>
6702             <para>"image": Bilder für Artikel. Diese können auch verkleinert
6703             in einer Vorschau (Thumbnail) angezeigt werden.</para>
6704           </listitem>
6705         </itemizedlist>
6706
6707         <para>Zusätzlich werden in der Datenbank zu den Dateien neben der
6708         Zuordnung zu ERP-Objekten, Dateityp Dateinamen und Backend, in dem die
6709         Datei gespeichert ist, auch die Quelle der Datei notiert:</para>
6710
6711         <itemizedlist>
6712           <listitem>
6713             <para>"created": vom System erzeugte Dokumente"</para>
6714           </listitem>
6715
6716           <listitem>
6717             <para>"uploaded": hochgeladene Dokumente</para>
6718           </listitem>
6719
6720           <listitem>
6721             <para>"email": vom Mail-System empfangene Dateien</para>
6722           </listitem>
6723
6724           <listitem>
6725             <para>"scanner[1]": von einem oder mehreren Scannern erzeugte
6726             Dateien. Existieren mehrere Scanner, so sind diese durch
6727             unterschiedliche Quellennamen zu definieren.</para>
6728           </listitem>
6729         </itemizedlist>
6730
6731         <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es
6732         für "attachment" und "image" nur die Quelle "uploaded". Für "document"
6733         gibt es auf jeden Fall die Quelle "created". Die Quellen "scanner" und
6734         "email" müssen derzeit in der Datenbank konfiguriert werden (siehe
6735         <xref linkend="file_management.dbconfig"/>).</para>
6736       </sect2>
6737
6738       <sect2>
6739         <title>Anwendung</title>
6740
6741         <para>Die Daten werden bei den ERP-Objekten als extra Reiter
6742         dargestellt. Eine Verkaufsrechnung z.B. hat die Reiter "Dokumente" und
6743         "Dateianhänge".</para>
6744
6745         <screenshot>
6746           <screeninfo>Reiter "Dateianhänge"</screeninfo>
6747
6748           <mediaobject>
6749             <imageobject>
6750               <imagedata fileref="images/DMS-Anhaenge.png" scale="50"/>
6751             </imageobject>
6752           </mediaobject>
6753         </screenshot>
6754
6755         <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer
6756         Datei angezeigt. Wird eine Datei mit gleichem Namen hochgeladen, so
6757         wird eine neue Version der Datei erstellt. Vorher wird der Anwender
6758         durch einen Dialog gefragt, ob er eine neue Version anlegen will oder
6759         ob er die Datei umbenennen will, falls es eine neue Datei sein
6760         soll.</para>
6761
6762         <screenshot>
6763           <screeninfo>Reiter "Dateianhänge"</screeninfo>
6764
6765           <mediaobject>
6766             <imageobject>
6767               <imagedata contentwidth="40"
6768                          fileref="images/DMS-Anhaenge-hochladen.png"
6769                          width="100"/>
6770             </imageobject>
6771           </mediaobject>
6772         </screenshot>
6773
6774         <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
6775         solange in Summe die maximale Größe nicht überschritten wird (siehe
6776         <xref linkend="file_management.clientconfig"/>).</para>
6777
6778         <screenshot>
6779           <screeninfo>Reiter "Dokumente"</screeninfo>
6780
6781           <mediaobject>
6782             <imageobject>
6783               <imagedata fileref="images/DMS-Dokumente.png" width="500"/>
6784             </imageobject>
6785           </mediaobject>
6786         </screenshot>
6787
6788         <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt
6789         es nur "erzeugte Dokumente". Es werden alle Versionen der generierten
6790         Datei angezeigt. Für Verkaufsrechnungen kommen keine anderen Quellen
6791         zur Geltung. Werden entsprechend der <xref
6792         linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert,
6793         so sind diese z.B. bei Einkaufsrechnungen sichtbar:</para>
6794
6795         <screenshot>
6796           <screeninfo>Reiter "Dokumente"</screeninfo>
6797
6798           <mediaobject>
6799             <imageobject>
6800               <imagedata contentwidth="600"
6801                          fileref="images/DMS-Dokumente-Scanner.png"/>
6802             </imageobject>
6803           </mediaobject>
6804         </screenshot>
6805
6806         <para>Statt des Löschens wird hier die Datei zurück zur Quelle
6807         verschoben. Somit kann die Datei anschließend an ein anderes
6808         ERP-Objekt angehängt werden.</para>
6809
6810         <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie
6811         sind bisher nur bei Bildern relevant.</para>
6812       </sect2>
6813
6814       <sect2>
6815         <title>Konfigurierung</title>
6816
6817         <sect3 id="file_management.clientconfig"
6818                xreflabel="Mandantenkonfigurierung">
6819           <title>Mandantenkonfiguration</title>
6820
6821           <sect4>
6822             <title>Reiter "Features"</title>
6823
6824             <para>Unter dem Reiter <emphasis role="bold">Features</emphasis>
6825             im Abschnitt Dateimanagement ist neben dem "alten" WebDAV das
6826             Dateimangement generell zu- und abschaltbar, sowie die Zuordnung
6827             der Dateitypen zu Backends. Die Löschbarkeit von Dateien, sowie
6828             die maximale Uploadgröße sind Backend-unabhängig</para>
6829
6830             <screenshot>
6831               <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
6832
6833               <mediaobject>
6834                 <imageobject>
6835                   <imagedata fileref="images/DMS-ClientConfig.png" width="500"/>
6836                 </imageobject>
6837               </mediaobject>
6838             </screenshot>
6839
6840             <para>Die einzelnen Backends sind einzeln einschaltbar.
6841             Spezifische Backend-Konfigurierungen sind hier noch
6842             ergänzbar.</para>
6843           </sect4>
6844
6845           <sect4>
6846             <title>Reiter "Allgemeine Dokumentenanhänge"</title>
6847
6848             <para>Unter dem Reiter <emphasis role="bold">Allgemeine
6849             Dokumentenanhänge</emphasis> kann für alle ERP-Dokumente (
6850             Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und
6851             Einkauf ) allgemeingültige Anhänge hochgeladen werden.</para>
6852
6853             <screenshot>
6854               <screeninfo>Mandantenkonfig Reiter "Allgemeine
6855               Dokumentenanhänge"</screeninfo>
6856
6857               <mediaobject>
6858                 <imageobject>
6859                   <imagedata fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"
6860                              width="500"/>
6861                 </imageobject>
6862               </mediaobject>
6863             </screenshot>
6864
6865             <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die
6866             ERP-Dokumente angehängt, z.B. AGBs oder aktuelle Angebote. Es
6867             werden in dem Fall die Daten kopiert, sodass an den ERP-Dokumenten
6868             immer die Anhänge zum Generierungszeitpunkt eingebettet
6869             sind.</para>
6870           </sect4>
6871         </sect3>
6872
6873         <sect3 id="file_management.dbconfig"
6874                xreflabel="Datenbank-Konfigurierung">
6875           <title>Datenbank-Konfigurierung</title>
6876
6877           <para>Die zusätzlichen Quellen für "email" oder ein oder mehrere
6878           Scanner sind derzeit vom Administrator direkt in der
6879           Datenbanktabelle "user_preferences" einzurichten. Die "value" ist im
6880           JSON-Format mit den jeweiligen Werten des Verzeichnisses und der
6881           Beschreibung der Quelle.</para>
6882
6883           <programlisting>
6884  id |  login    |  namespace   | version |   key    |          value
6885 ----+-----------+--------------+---------+----------+---------------------------
6886   1 | #default# | file_sources | 0.00000 | scanner1 |
6887                              {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
6888   2 | #default# | file_sources | 0.00000 | scanner2 |
6889                              {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
6890   3 | #default# | file_sources | 0.00000 | emails   |
6891                              {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
6892           </programlisting>
6893
6894           <para>Es ist daran gedacht, statt dem Default-Eintrag später für
6895           bestimmte Benutzer ('login') bestimmte Quellen zuzulassen. Dies wird
6896           nach Bedarf implementiert.</para>
6897         </sect3>
6898
6899         <sect3 id="file_management.kiviconfig"
6900                xreflabel="kivitendo-Konfigurationsdatei">
6901           <title>kivitendo-Konfigurationsdatei</title>
6902
6903           <para>Dort ist im Abschnitt [paths] der relative oder absolute Pfad
6904           zum Dokumentenwurzelverzeichnis einzutragen. Dieser muss für den
6905           Webserver schreib- und lesbar sein, jedoch nicht ausführbar.</para>
6906
6907           <programlisting>
6908 [paths]
6909 document_path = /var/local/kivi_documents
6910           </programlisting>
6911
6912           <para>Unter diesem Wurzelverzeichnis wird pro Mandant automatisch
6913           ein Unterverzeichnis mit der ID des Mandanten angelegt.</para>
6914         </sect3>
6915       </sect2>
6916     </sect1>
6917
6918     <sect1>
6919       <title>Webshop-Api</title>
6920
6921       <para>Das Shopmodul bietet die Möglichkeit Onlineshopartikel und
6922       Onlineshopbestellungen zu verwalten und zu bearbeiten.</para>
6923
6924       <para>Es ist Multishopfähig, d.h. Artikel können mehreren oder
6925       unterschiedlichen Shops zugeordnet werden. Bestellungen können aus
6926       mehreren Shops geholt werden.</para>
6927
6928       <para>Zur Zeit bietet das Modul nur einen Connector zur REST-Api von
6929       Shopware. Weitere Connectoren können dazu programmiert und eingerichtet
6930       werden.</para>
6931
6932       <sect2>
6933         <title>Rechte für die Webshopapi</title>
6934
6935         <para>In der Administration können folgende Rechte vergeben
6936         werden</para>
6937
6938         <itemizedlist>
6939           <listitem>
6940             <para>Webshopartikel anlegen und bearbeiten</para>
6941           </listitem>
6942
6943           <listitem>
6944             <para>Shopbestellungen holen und bearbeiten</para>
6945           </listitem>
6946
6947           <listitem>
6948             <para>Shop anlegen und bearbeiten</para>
6949           </listitem>
6950         </itemizedlist>
6951       </sect2>
6952
6953       <sect2>
6954         <title>Konfiguration</title>
6955
6956         <para>Unter System-&gt;Webshops können Shops angelegt und konfiguriert
6957         werden</para>
6958
6959         <mediaobject>
6960           <imageobject>
6961             <imagedata contentdepth="500" contentwidth="700"
6962                        fileref="images/Shop_Listing.png"/>
6963           </imageobject>
6964         </mediaobject>
6965       </sect2>
6966
6967       <sect2>
6968         <title>Webshopartikel</title>
6969
6970         <sect3>
6971           <title>Shopvariablenreiter in Artikelstammdaten</title>
6972
6973           <para>Mit dem Recht "Shopartikel anlegen und bearbeiten" und des
6974           Markers <emphasis role="bold">"Shopartikel" in den Basisdaten
6975           </emphasis>zeigt sich der Reiter "Shopvariablen" in den
6976           Artikelstammdaten. Hier können jetzt die Artikel mit
6977           unterschiedlichen Beschreibung und/oder Preisen für die
6978           konfigutierten Shops angelegt und bearbeitet werden. An dieser
6979           Stelle können auch beliebig viele Bilder dem Shopartikel zugeordnet
6980           werden. Artikelbilder gelten für alle Shops.</para>
6981
6982           <mediaobject>
6983             <imageobject>
6984               <imagedata contentdepth="500" contentwidth="600"
6985                          fileref="images/Shop_Artikel.png"/>
6986             </imageobject>
6987           </mediaobject>
6988
6989           <para>Die Artikelgruppen werden direkt vom Shopsystem geholt somit
6990           ist es möglich einen Artikel auch mehreren Gruppen
6991           zuzuordenen</para>
6992         </sect3>
6993
6994         <sect3>
6995           <title>Shopartikelliste</title>
6996
6997           <para>Unter dem Menu Webshop-&gt;Webshop Artikel hat man nochmal
6998           eine Gesamtübersicht. Von hier aus ist es möglich Artikel im Stapel
6999           unter verschiedenen Kriterien &lt;alles&gt;&lt;nur Preis&gt;&lt;nur
7000           Bestand&gt;&lt;Preis und Bestand&gt; an die jeweiligen Shops
7001           hochzuladen.</para>
7002
7003           <mediaobject>
7004             <imageobject>
7005               <imagedata fileref="images/Shop_Artikel_Listing.png"/>
7006             </imageobject>
7007           </mediaobject>
7008         </sect3>
7009       </sect2>
7010
7011       <sect2>
7012         <title>Bestellimport</title>
7013
7014         <para>Unter dem Menupunkt Webshop-&gt;Webshop Import öffnet sich die
7015         Bestellimportsliste. Hier ist sind Möglichkeiten gegeben Neue
7016         Bestellungen vom Shop abzuholen, geholte Bestellungen im Stapel oder
7017         einzeln als Auftrag zu transferieren. Die Liste kann nach
7018         verschiedenen Kriterien gefiltert werden.</para>
7019
7020         <mediaobject>
7021           <imageobject>
7022             <imagedata fileref="images/Shop_Bestell.png"/>
7023           </imageobject>
7024         </mediaobject>
7025
7026         <para>Bei Einträgen in der Liste.</para>
7027
7028         <itemizedlist>
7029           <listitem>
7030             <para>keine Kundennummer: Es gibt ähnliche Kundendatensätze und
7031             der Datensatz konnte nicht eindeutig zugewiesen werden.</para>
7032           </listitem>
7033
7034           <listitem>
7035             <para>Kundennummer und Rechnungen rot hinterlegt: Der Kunde hat
7036             offene Posten und kann deswegen nicht im Stapel übernommen
7037             werden.</para>
7038           </listitem>
7039
7040           <listitem>
7041             <para>Rechnungsadresse grün hinterlegt: Der Kunde konnte eindeutig
7042             einem Datensatz zugeordnet werden. Die Shopbestellung kann im
7043             Stapel mit dem Button "Anwenden" und wenn markiert als Auftrag
7044             übernommen werden.</para>
7045           </listitem>
7046
7047           <listitem>
7048             <para>Kundennummer vorhanden, aber die Checkbox "Auftrag
7049             erstellen" fehlt. Der Kunde hat vermutlich eine
7050             Shopauftragssperre.</para>
7051           </listitem>
7052
7053           <listitem>
7054             <para>Lieferadresse grau hinterlegt: Optische Anzeige, dass es
7055             sich um eine unterschiedliche Lieferadresse handelt.
7056             Lieferadressen werden aber grundsätzlich beim Transferieren zu
7057             Aufträgen mit übernommen.</para>
7058           </listitem>
7059
7060           <listitem>
7061             <para>In der Spalte Positionen/Betrag/Versandkosten zeigt sich ein
7062             tooltip zu den Positionen.</para>
7063           </listitem>
7064         </itemizedlist>
7065
7066         <para>Maske Auftrag erstellen</para>
7067
7068         <para>Viele Shopsysteme haben drei verschieden Adresstypen Kunden-,
7069         Rechnungs-, und Lieferadresse, die sich auch alle unterscheiden
7070         können. Diese werden im oberen Bereich angezeigt. Es ist möglich jede
7071         dieser Adresse einzeln in kivitendo als Kunde zu übernehmen. Es werden
7072         die Werte Formulareingabe übernommen. Es wird bei einer Änderung
7073         allerdings nur diese in die kivitendo Kundenstammdaten übernommen, die
7074         Shopbestellung bleibt bestehen.</para>
7075
7076         <para>Mit der mittleren Adresse(Rechnungsadresse) im oberen Bereich,
7077         kann ich den ausgewählten kivitendodatensatz des mittleren Bereich
7078         überschreiben. Das ist sinnvoll, wenn ich erkenne, das der Kunde z.B.
7079         umgezogen ist.</para>
7080
7081         <para>Im mittleren Bereich das Adresslisting zeigt:</para>
7082
7083         <itemizedlist>
7084           <listitem>
7085             <para>Rot hinterlegt: Kunde hat eine Shopauftragssperre, diese
7086             muss zuerst deaktiviert werden bevor ich diesem Kunden eine
7087             Shopbestellung zuordnen kann.</para>
7088           </listitem>
7089
7090           <listitem>
7091             <para>Kundenname fett und rot: Hier hat der Kunde eine Bemerkung
7092             in den Stammdaten. Ein Tooltip zeigt diese Bemerkung. Das kann dan
7093             auch der Grund für die Auftragssperre sein.</para>
7094           </listitem>
7095
7096           <listitem>
7097             <para>Die Buttons "Auftrag erstellen" und "Kunde mit
7098             Rechnungsadresse überschreiben" zeigen sich erst, wenn ein Kunde
7099             aus dem Listing ausgewählt ist.</para>
7100           </listitem>
7101
7102           <listitem>
7103             <para>Es ist aber möglich die Shopbestellung zu löschen.</para>
7104           </listitem>
7105
7106           <listitem>
7107             <para>Ist eine Bestellung schon übernommen, zeigen sich an dieser
7108             Stelle, die dazugehörigen Belegverknüpfungen.</para>
7109           </listitem>
7110         </itemizedlist>
7111       </sect2>
7112
7113       <sect2>
7114         <title>Mapping der Daten</title>
7115
7116         <para>Das Mapping der kivitendo Daten mit den Shopdaten geschieht in
7117         der Datei SL/ShopConnector/&lt;SHOPCONNECTORNAME&gt;.pm
7118         z.B.:SL/ShopConnector/Shopware.pm</para>
7119
7120         <para>In dieser Datei gibt es einen Bereich wo die Bestellpostionen,
7121         die Bestellkopfdaten und die Artikeldaten gemapt werden. In dieser
7122         Datei kann ein individelles Mapping dann gemacht werden. Zu Shopware
7123         gibt es hier eine sehr gute Dokumentation: <ulink
7124         url="https://developers.shopware.com/developers-guide/rest-api/">https://developers.shopware.com/developers-guide/rest-api/</ulink></para>
7125       </sect2>
7126     </sect1>
7127         <sect1 id="features.zugferd">
7128                 <title>ZUGFeRD Rechnungen</title>
7129                 <sect2 id="features.zugferd.preamble">
7130                         <title>Vorbedingung</title>
7131          <para>
7132           Für die Erstellung von ZUGFeRD PDFs wird TexLive2018 oder höher benötigt.
7133          </para>
7134         <note>
7135          <para>
7136           Wer kein TexLive2018 oder höher installieren kann, kann eine lokale Umgebung nur für kivitendo wie folgt erzeugen:
7137          </para>
7138         <programlisting>
7139         1. Download des offiziellen Installers von https://www.tug.org/texlive/quickinstall.html
7140
7141         2. Installer ausführen, Standard-Ort für Installation belassen, evtl. ein paar Pakete abwählen, installieren lassen
7142
7143         3. Ein kleine Script »run_pdflatex.sh« anlegen, das den PATH auf das  Installationsverezichnis setzt und pdflatex ausführt:
7144
7145         ------------------------------------------------------------
7146         #!/bin/bash
7147
7148         export PATH=/usr/local/texlive/2020/bin/x86_64-linux:$PATH
7149         hash -r
7150
7151         exec pdflatex &quot;$@&quot;
7152         ------------------------------------------------------------
7153
7154         4. In config/kivitendo.conf den Parameter »latex« auf den Pfad zu »run_pdflatex.sh« setzen
7155
7156         5. Webserver neu starten
7157         </programlisting>
7158       </note>
7159     </sect2>
7160                 <sect2 id="features.zugferd.summary">
7161                         <title>Übersicht</title>
7162
7163                         <para>Mit der Version 3.5.6 bietet kivitendo die Möglichkeit ZUGFeRD
7164                         Rechnungen zu erstellen, sowie auch  ZUGFeRD Rechnungen direkt in
7165                         kivitendo einzulesen. </para>
7166
7167                         <para>Bei  ZUGFeRD Rechnungen handelt es sich um eine PDF Datei in
7168                         der eine XML-Datei eingebettet ist. Der Aufbau der XML-Datei ist
7169                         standardisiert und ermöglicht so den Austausch zwischen
7170                         den verschiedenen Softwareprodukten. Kivitendo setzt mit der
7171                         Version 3.5.6 den ZUGFeRD 2.1 Standard um.</para>
7172
7173                         <para>Weiter Details zu ZUGFeRD sind unter diesem Link zu finden:
7174                         <ulink>https://www.ferd-net.de/standards/was-ist-zugferd/index.html</ulink>
7175       </para>
7176                 </sect2>
7177
7178                 <sect2 id="features.zugferd.create_zugferd_bills">
7179
7180                         <title>Erstellen von ZUGFeRD Rechnungen in Kivitendo</title>
7181                         <para>Für die Erstellung von ZUGFeRD Rechnungen bedarf es in
7182                         kivitendo zwei Dinge:</para>
7183
7184                         <orderedlist>
7185
7186                                 <listitem>
7187                                         <para>Die Erstellung muss in der Mandantenkonfiguration
7188                                         aktiviert sein</para>
7189                                 </listitem>
7190
7191                                 <listitem>
7192                                         <para>Beim mindestens einem Bankkonto muss die Option
7193                                         „Nutzung von ZUGFeRD“ aktiviert sein</para>
7194                                 </listitem>
7195
7196                         </orderedlist>
7197                         <sect3>
7198                                 <title>Mandantenkonfiguration</title>
7199
7200                                 <para>Die Einstellung für die Erstellung von ZUGFeRD Rechnungen
7201                                 erfolgt unter „System“ → „Mandatenkonfiguration“ → „Features“.
7202                                 Im Abschnitt „Einkauf und Verkauf“ finden Sie die Einstellung
7203                                 „Verkaufsrechnungen mit ZUGFeRD-Daten erzeugen“.
7204                                 Hier besteht die Auswahl zwischen:</para>
7205
7206                                 <itemizedlist>
7207                                         <listitem>
7208                                                 <para>ZUGFeRD-Rechnungen erzeugen</para>
7209                                         </listitem>
7210
7211                                         <listitem>
7212                                                 <para>ZUGFeRD-Rechnungen im Testmodus erzeugen</para>
7213                                         </listitem>
7214
7215                                         <listitem>
7216                                                 <para>Keine ZUGFeRD Rechnungen erzeugen</para>
7217                                         </listitem>
7218
7219                                 </itemizedlist>
7220
7221                                 <para>Rechnungen die als PDF erzeugt werden, werden je nach
7222                                 Einstellung nun im ZUGFeRD Format ausgegeben.</para>
7223
7224                         </sect3>
7225
7226                         <sect3>
7227                                 <title>Konfiguration der Bankkonten</title>
7228
7229                                 <para>Unter „System → Bankkonten“ muss bei mindestens einem
7230                                 Bankkonto die Option „Nutzung mit ZUGFeRD“ auf „Ja“ gestellt
7231                                 werden.</para>
7232                         </sect3>
7233
7234                 </sect2>
7235
7236                 <sect2 id="features.zugferd.read_zugferd_bills">
7237
7238                         <title>Einlesen von ZUGFeRD Rechnungen in Kivitendo</title>
7239
7240                         <para>Es lassen sich auch Rechnungen von Kreditoren, die im
7241                         ZUGFeRD Format erstellt wurden, nach Kivitendo importieren.
7242                         Hierfür müssen auch zwei Voraussetzungen erfüllt werden:
7243                         </para>
7244
7245                         <orderedlist>
7246
7247                                 <listitem>
7248                                         <para>Beim Lieferanten muss die Umsatzsteuer-ID und das
7249                                         Bankkonto hinterlegt sein</para>
7250                                 </listitem>
7251
7252                                 <listitem>
7253                                         <para>Für den Kreditoren muss eine Buchungsvorlage existieren.</para>
7254                                 </listitem>
7255
7256                         </orderedlist>
7257
7258                         <para>Wenn diese Voraussetzungen erfüllt sind, kann die Rechnung
7259                         über „Finanzbuchhaltung“ → „ZUGFeRD Import“ über die „Durchsuchen“
7260                         Schaltfläche ausgewählt werden und über die Schaltfläche „Import“
7261                         eingeladen werden. Es öffnet sich daraufhin die Kreditorenbuchung.
7262                         Die auslesbaren Daten aus dem eingebetteten XML der PDF Datei
7263                         werden in der Kreditorenbuchung ergänzt.</para>
7264
7265                 </sect2>
7266
7267         </sect1>
7268
7269   </chapter>
7270
7271   <chapter>
7272     <title>Entwicklerdokumentation</title>
7273
7274     <sect1 id="devel.globals" xreflabel="Globale Variablen">
7275       <title>Globale Variablen</title>
7276
7277       <sect2>
7278         <title>Wie sehen globale Variablen in Perl aus?</title>
7279
7280         <para>Globale Variablen liegen in einem speziellen namespace namens
7281         "main", der von überall erreichbar ist. Darüber hinaus sind bareword
7282         globs global und die meisten speziellen Variablen sind...
7283         speziell.</para>
7284
7285         <para>Daraus ergeben sich folgende Formen:</para>
7286
7287         <variablelist>
7288           <varlistentry>
7289             <term><literal>$main::form</literal></term>
7290
7291             <listitem>
7292               <para>expliziter Namespace "main"</para>
7293             </listitem>
7294           </varlistentry>
7295
7296           <varlistentry>
7297             <term><literal>$::form</literal></term>
7298
7299             <listitem>
7300               <para>impliziter Namespace "main"</para>
7301             </listitem>
7302           </varlistentry>
7303
7304           <varlistentry>
7305             <term><literal>open FILE, "file.txt"</literal></term>
7306
7307             <listitem>
7308               <para><varname>FILE</varname> ist global</para>
7309             </listitem>
7310           </varlistentry>
7311
7312           <varlistentry>
7313             <term><literal>$_</literal></term>
7314
7315             <listitem>
7316               <para>speziell</para>
7317             </listitem>
7318           </varlistentry>
7319         </variablelist>
7320
7321         <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
7322         Schlüsselwort wie "<function>global</function>", mit dem man
7323         importieren kann. <function>my</function>, <function>our</function>
7324         und <function>local</function> machen was anderes.</para>
7325
7326         <variablelist>
7327           <varlistentry>
7328             <term><literal>my $form</literal></term>
7329
7330             <listitem>
7331               <para>lexikalische Variable, gültig bis zum Ende des
7332               Scopes</para>
7333             </listitem>
7334           </varlistentry>
7335
7336           <varlistentry>
7337             <term><literal>our $form</literal></term>
7338
7339             <listitem>
7340               <para><varname>$form</varname> referenziert ab hier
7341               <varname>$PACKAGE::form</varname>.</para>
7342             </listitem>
7343           </varlistentry>
7344
7345           <varlistentry>
7346             <term><literal>local $form</literal></term>
7347
7348             <listitem>
7349               <para>Alle Änderungen an <varname>$form</varname> werden am Ende
7350               des scopes zurückgesetzt</para>
7351             </listitem>
7352           </varlistentry>
7353         </variablelist>
7354       </sect2>
7355
7356       <sect2>
7357         <title>Warum sind globale Variablen ein Problem?</title>
7358
7359         <para>Das erste Problem ist <productname>FCGI</productname>.</para>
7360
7361         <para><productname>SQL-Ledger</productname> hat fast alles im globalen
7362         namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
7363         Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
7364         aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
7365         Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
7366         Datenbankverbindungen, weil die sehr lange zum Initialisieren
7367         brauchen.</para>
7368
7369         <para>Das zweite Problem ist <function>strict</function>. Unter
7370         <function>strict</function> werden alle Variablen die nicht explizit
7371         mit <function>Package</function>, <function>my</function> oder
7372         <function>our</function> angegeben werden als Tippfehler angemarkert,
7373         dies hat, seit der Einführung, u.a. schon so manche langwierige
7374         Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
7375         angegeben werden, werden die nicht geprüft, und somit kann sich
7376         schnell ein Tippfehler einschleichen.</para>
7377       </sect2>
7378
7379       <sect2>
7380         <title>Kanonische globale Variablen</title>
7381
7382         <para>Um dieses Problem im Griff zu halten gibt es einige wenige
7383         globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
7384         vorgegebenen Eigenschaften, und alles andere sollte anderweitig
7385         umhergereicht werden.</para>
7386
7387         <para>Diese Variablen sind im Moment die folgenden neun:</para>
7388
7389         <itemizedlist>
7390           <listitem>
7391             <para><varname>$::form</varname></para>
7392           </listitem>
7393
7394           <listitem>
7395             <para><varname>%::myconfig</varname></para>
7396           </listitem>
7397
7398           <listitem>
7399             <para><varname>$::locale</varname></para>
7400           </listitem>
7401
7402           <listitem>
7403             <para><varname>$::lxdebug</varname></para>
7404           </listitem>
7405
7406           <listitem>
7407             <para><varname>$::auth</varname></para>
7408           </listitem>
7409
7410           <listitem>
7411             <para><varname>$::lx_office_conf</varname></para>
7412           </listitem>
7413
7414           <listitem>
7415             <para><varname>$::instance_conf</varname></para>
7416           </listitem>
7417
7418           <listitem>
7419             <para><varname>$::dispatcher</varname></para>
7420           </listitem>
7421
7422           <listitem>
7423             <para><varname>$::request</varname></para>
7424           </listitem>
7425         </itemizedlist>
7426
7427         <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
7428         Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
7429         Eigenschaften (Konventionen):</para>
7430
7431         <sect3>
7432           <title>$::form</title>
7433
7434           <itemizedlist>
7435             <listitem>
7436               <para>Ist ein Objekt der Klasse
7437               "<classname>Form</classname>"</para>
7438             </listitem>
7439
7440             <listitem>
7441               <para>Wird nach jedem Request gelöscht</para>
7442             </listitem>
7443
7444             <listitem>
7445               <para>Muss auch in Tests und Konsolenscripts vorhanden
7446               sein.</para>
7447             </listitem>
7448
7449             <listitem>
7450               <para>Enthält am Anfang eines Requests die Requestparameter vom
7451               User</para>
7452             </listitem>
7453
7454             <listitem>
7455               <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
7456               cachen, das wird aber momentan absichtlich zerstört</para>
7457             </listitem>
7458           </itemizedlist>
7459
7460           <para><varname>$::form</varname> wurde unter <productname>SQL
7461           Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
7462           alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
7463           heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
7464           gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
7465           <function>IS-&gt;retrieve_customer()</function> in Sicherheit
7466           bringen.</para>
7467
7468           <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
7469           Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
7470           3552, Stand version 2.7beta), um dies hinterher wieder auf den
7471           richtigen Wert zu setzen:</para>
7472
7473           <programlisting>  my $saved_numberformat    = $::myconfig{numberformat};
7474   $::myconfig{numberformat} = $numberformat;
7475   # (...) div Berechnungen
7476   $::myconfig{numberformat} = $saved_numberformat;</programlisting>
7477
7478           <para>Das Objekt der Klasse Form hat leider im Moment noch viele
7479           zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
7480           nie einfach zerstören oder überschreiben (zumindestens nicht kurz
7481           vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
7482           Es geht ziemlich sicher etwas kaputt.</para>
7483
7484           <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
7485           in den <productname>Template::Toolkit</productname> Templates
7486           außerhalb der Controller: der Ausdruck <function>[% var
7487           %]</function> greift auf <varname>$::form-&gt;{var}</varname> zu.
7488           Unter Controllern ist der Standard Scope anders, da lautet der
7489           Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
7490           normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
7491           <function>&lt;%var%&gt;</function> zeigt auf
7492           <varname>$::form-&gt;{var}</varname>. Nochmal von der anderen Seite
7493           erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
7494           Konstrukte:</para>
7495
7496           <programlisting>[%- IF business %]
7497 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
7498 [%- END %]</programlisting>
7499
7500           <para>Entweder wird hier dann $::form-&gt;{business} ausgewertet
7501           oder aber der Funktion
7502           <function>$form-&gt;parse_html_template</function> wird explizit
7503           noch ein zusätzlicher Hash übergeben, der dann auch in den
7504           (Web-)Templates zu Verfügung steht, bspw. so:</para>
7505
7506           <programlisting>$form-&gt;parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
7507
7508           <para>Innerhalb von Schleifen wird
7509           <varname>$::form-&gt;{TEMPLATE_ARRAYS}{var}[$index]</varname>
7510           bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
7511           welches über alle Positionen eines Lieferscheins in Schleife
7512           läuft:</para>
7513
7514           <programlisting>for $i (1 .. $form-&gt;{rowcount}) {
7515   # ...
7516   push @{ $form-&gt;{TEMPLATE_ARRAYS}{runningnumber} },   $position;
7517   push @{ $form-&gt;{TEMPLATE_ARRAYS}{number} },          $form-&gt;{"partnumber_$i"};
7518   push @{ $form-&gt;{TEMPLATE_ARRAYS}{description} },     $form-&gt;{"description_$i"};
7519   # ...
7520 }</programlisting>
7521         </sect3>
7522
7523         <sect3>
7524           <title>%::myconfig</title>
7525
7526           <itemizedlist>
7527             <listitem>
7528               <para>Das einzige Hash unter den globalen Variablen</para>
7529             </listitem>
7530
7531             <listitem>
7532               <para>Wird spätestens benötigt wenn auf die Datenbank
7533               zugegriffen wird</para>
7534             </listitem>
7535
7536             <listitem>
7537               <para>Wird bei jedem Request neu erstellt.</para>
7538             </listitem>
7539
7540             <listitem>
7541               <para>Enthält die Userdaten des aktuellen Logins</para>
7542             </listitem>
7543
7544             <listitem>
7545               <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
7546               extern serialisiert werden, weil da auch der Datenbankzugriff
7547               für diesen user drinsteht.</para>
7548             </listitem>
7549
7550             <listitem>
7551               <para>Enthält unter anderem Datumsformat dateformat und
7552               Nummernformat numberformat</para>
7553             </listitem>
7554
7555             <listitem>
7556               <para>Enthält Datenbankzugriffinformationen</para>
7557             </listitem>
7558           </itemizedlist>
7559
7560           <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
7561           ein Userobjekt. Die meisten Funktionen, die etwas anhand des
7562           aktuellen Users entscheiden müssen, befragen
7563           <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
7564           überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
7565           -&gt; <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
7566           Informationen über den Benutzer die über die
7567           Administrator-Schnittstelle eingegeben wurden.</para>
7568         </sect3>
7569
7570         <sect3>
7571           <title>$::locale</title>
7572
7573           <itemizedlist>
7574             <listitem>
7575               <para>Objekt der Klasse "Locale"</para>
7576             </listitem>
7577
7578             <listitem>
7579               <para>Wird pro Request erstellt</para>
7580             </listitem>
7581
7582             <listitem>
7583               <para>Muss auch für Tests und Scripte immer verfügbar
7584               sein.</para>
7585             </listitem>
7586
7587             <listitem>
7588               <para>Cached intern über Requestgrenzen hinweg benutzte
7589               Locales</para>
7590             </listitem>
7591           </itemizedlist>
7592
7593           <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
7594           Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
7595         </sect3>
7596
7597         <sect3>
7598           <title>$::lxdebug</title>
7599
7600           <itemizedlist>
7601             <listitem>
7602               <para>Objekt der Klasse "LXDebug"</para>
7603             </listitem>
7604
7605             <listitem>
7606               <para>Wird global gecached</para>
7607             </listitem>
7608
7609             <listitem>
7610               <para>Muss immer verfügbar sein, in nahezu allen
7611               Funktionen</para>
7612             </listitem>
7613           </itemizedlist>
7614
7615           <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
7616           bereit, wie "<function>enter_sub</function>" und
7617           "<function>leave_sub</function>", mit denen in den alten Modulen ein
7618           brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
7619           der man die Wallclockzeit seit Requeststart loggen kann, sowie
7620           "<function>message</function>" und "<function>dump</function>" mit
7621           denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
7622           packen kann.</para>
7623
7624           <para>Beispielsweise so:</para>
7625
7626           <programlisting>$main::lxdebug-&gt;message(0, 'Meine Konfig:' . Dumper (%::myconfig));
7627 $main::lxdebug-&gt;message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form-&gt;{vc});</programlisting>
7628         </sect3>
7629
7630         <sect3>
7631           <title>$::auth</title>
7632
7633           <itemizedlist>
7634             <listitem>
7635               <para>Objekt der Klasse "SL::Auth"</para>
7636             </listitem>
7637
7638             <listitem>
7639               <para>Wird global gecached</para>
7640             </listitem>
7641
7642             <listitem>
7643               <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
7644             </listitem>
7645
7646             <listitem>
7647               <para>Wird nach jedem Request resettet.</para>
7648             </listitem>
7649           </itemizedlist>
7650
7651           <para><varname>$::auth</varname> stellt Funktionen bereit um die
7652           Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
7653           vom aktuellen User abhängen wird das Objekt aus
7654           Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
7655           Request kurz resettet.</para>
7656
7657           <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
7658           Dessen Einstellungen können über
7659           <literal>$::auth-&gt;client</literal> abgefragt werden; Rückgabewert
7660           ist ein Hash mit den Werten aus der Tabelle
7661           <literal>auth.clients</literal>.</para>
7662         </sect3>
7663
7664         <sect3>
7665           <title>$::lx_office_conf</title>
7666
7667           <itemizedlist>
7668             <listitem>
7669               <para>Objekt der Klasse
7670               "<classname>SL::LxOfficeConf</classname>"</para>
7671             </listitem>
7672
7673             <listitem>
7674               <para>Global gecached</para>
7675             </listitem>
7676
7677             <listitem>
7678               <para>Repräsentation der
7679               <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
7680             </listitem>
7681           </itemizedlist>
7682
7683           <para>Globale Konfiguration. Configdateien werden zum Start gelesen
7684           und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
7685           das Programm die Konfiguration ändern kann oder sollte.</para>
7686
7687           <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
7688           Debug- und Trace-Log-Datei wie folgt konfiguriert und
7689           verfügbar:</para>
7690
7691           <programlisting>[debug]
7692 file_name = /tmp/kivitendo-debug.log</programlisting>
7693
7694           <para>ist der Key <varname>file</varname> im Programm als
7695           <varname>$::lx_office_conf-&gt;{debug}{file}</varname>
7696           erreichbar.</para>
7697
7698           <warning>
7699             <para>Zugriff auf die Konfiguration erfolgt im Moment über
7700             Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
7701           </warning>
7702         </sect3>
7703
7704         <sect3>
7705           <title>$::instance_conf</title>
7706
7707           <itemizedlist>
7708             <listitem>
7709               <para>Objekt der Klasse
7710               "<classname>SL::InstanceConfiguration</classname>"</para>
7711             </listitem>
7712
7713             <listitem>
7714               <para>wird pro Request neu erstellt</para>
7715             </listitem>
7716           </itemizedlist>
7717
7718           <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
7719           speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
7720           ist hier eine Mandantendatenbank. Beispielsweise überprüft
7721           <programlisting>$::instance_conf-&gt;get_inventory_system eq 'perpetual'</programlisting>
7722           ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
7723         </sect3>
7724
7725         <sect3>
7726           <title>$::dispatcher</title>
7727
7728           <itemizedlist>
7729             <listitem>
7730               <para>Objekt der Klasse
7731               "<varname>SL::Dispatcher</varname>"</para>
7732             </listitem>
7733
7734             <listitem>
7735               <para>wird pro Serverprozess erstellt.</para>
7736             </listitem>
7737
7738             <listitem>
7739               <para>enthält Informationen über die technische Verbindung zum
7740               Server</para>
7741             </listitem>
7742           </itemizedlist>
7743
7744           <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
7745           global gespeichert wird. Wird vermutlich irgendwann in einem anderen
7746           Objekt untergebracht.</para>
7747         </sect3>
7748
7749         <sect3>
7750           <title>$::request</title>
7751
7752           <itemizedlist>
7753             <listitem>
7754               <para>Hashref (evtl später Objekt)</para>
7755             </listitem>
7756
7757             <listitem>
7758               <para>Wird pro Request neu initialisiert.</para>
7759             </listitem>
7760
7761             <listitem>
7762               <para>Keine Unterstruktur garantiert.</para>
7763             </listitem>
7764           </itemizedlist>
7765
7766           <para><varname>$::request</varname> ist ein generischer Platz um
7767           Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
7768           at a distance benutzt werden, sondern um lokales memoizing zu
7769           ermöglichen, das garantiert am Ende des Requests zerstört
7770           wird.</para>
7771
7772           <para>Vieles von dem, was im moment in <varname>$::form</varname>
7773           liegt, sollte eigentlich hier liegen. Die groben
7774           Differentialkriterien sind:</para>
7775
7776           <itemizedlist>
7777             <listitem>
7778               <para>Kommt es vom User, und soll unverändert wieder an den
7779               User? Dann <varname>$::form</varname>, steht da eh schon</para>
7780             </listitem>
7781
7782             <listitem>
7783               <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
7784               Requests gebraucht werden? Dann
7785               <varname>$::request</varname></para>
7786             </listitem>
7787
7788             <listitem>
7789               <para>Muss ich von anderen Teilen des Programms lesend drauf
7790               zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
7791               Wrappermethode</para>
7792             </listitem>
7793           </itemizedlist>
7794         </sect3>
7795       </sect2>
7796
7797       <sect2>
7798         <title>Ehemalige globale Variablen</title>
7799
7800         <para>Die folgenden Variablen waren einmal im Programm, und wurden
7801         entfernt.</para>
7802
7803         <sect3>
7804           <title>$::cgi</title>
7805
7806           <itemizedlist>
7807             <listitem>
7808               <para>war nötig, weil cookie Methoden nicht als
7809               Klassenfunktionen funktionieren</para>
7810             </listitem>
7811
7812             <listitem>
7813               <para>Aufruf als Klasse erzeugt Dummyobjekt was im
7814               Klassennamespace gehalten wird und über Requestgrenzen
7815               leaked</para>
7816             </listitem>
7817
7818             <listitem>
7819               <para>liegt jetzt unter
7820               <varname>$::request-&gt;{cgi}</varname></para>
7821             </listitem>
7822           </itemizedlist>
7823         </sect3>
7824
7825         <sect3>
7826           <title>$::all_units</title>
7827
7828           <itemizedlist>
7829             <listitem>
7830               <para>war nötig, weil einige Funktionen in Schleifen zum Teil
7831               ein paar hundert mal pro Request eine Liste der Einheiten
7832               brauchen, und de als Parameter durch einen Riesenstack von
7833               Funktionen geschleift werden müssten.</para>
7834             </listitem>
7835
7836             <listitem>
7837               <para>Liegt jetzt unter
7838               <varname>$::request-&gt;{cache}{all_units}</varname></para>
7839             </listitem>
7840
7841             <listitem>
7842               <para>Wird nur in
7843               <function>AM-&gt;retrieve_all_units()</function> gesetzt oder
7844               gelesen.</para>
7845             </listitem>
7846           </itemizedlist>
7847         </sect3>
7848
7849         <sect3>
7850           <title>%::called_subs</title>
7851
7852           <itemizedlist>
7853             <listitem>
7854               <para>wurde benutzt um callsub deep recursions
7855               abzufangen.</para>
7856             </listitem>
7857
7858             <listitem>
7859               <para>Wurde entfernt, weil callsub nur einen Bruchteil der
7860               möglichen Rekursioenen darstellt, und da nie welche
7861               auftreten.</para>
7862             </listitem>
7863
7864             <listitem>
7865               <para>komplette recursion protection wurde entfernt.</para>
7866             </listitem>
7867           </itemizedlist>
7868         </sect3>
7869       </sect2>
7870     </sect1>
7871
7872     <sect1 id="devel.fcgi">
7873       <title>Entwicklung unter FastCGI</title>
7874
7875       <sect2 id="devel.fcgi.general">
7876         <title>Allgemeines</title>
7877
7878         <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
7879         werden, muss der Webserver neu gestartet werden.</para>
7880
7881         <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
7882         achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
7883         müssen folgende Aspekte beachtet werden.</para>
7884       </sect2>
7885
7886       <sect2 id="devel.fcgi.exiting">
7887         <title>Programmende und Ausnahmen</title>
7888
7889         <para>Betrifft die Funktionen <function>warn</function>,
7890         <function>die</function>, <function>exit</function>,
7891         <function>carp</function> und <function>confess</function>.</para>
7892
7893         <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
7894         Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
7895         am Laufen zu halten. Man kann mit <function>die</function>,
7896         <function>confess</function> oder <function>carp</function> Fehler
7897         ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
7898         eigene <function>$::form-</function>error()&gt; tut im Prinzip das
7899         Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
7900         <function>exit</function> hingegen werden nicht abgefangen.
7901         <function>warn</function> wird direkt nach STDERR, also in Server Log
7902         eine Nachricht schreiben (sofern in der Konfiguration nicht die
7903         Warnungen in das kivitendo Log umgeleitet wurden), und
7904         <function>exit</function> wird die Ausführung beenden.</para>
7905
7906         <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
7907         beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
7908         Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
7909         benutzen, alle anderen Exceptionmechanismen sind ok.</para>
7910       </sect2>
7911
7912       <sect2 id="devel.fcgi.globals">
7913         <title>Globale Variablen</title>
7914
7915         <para>Um zu vermeiden, dass Informationen von einem Request in einen
7916         anderen gelangen, müssen alle globalen Variablen vor einem Request
7917         sauber initialisiert werden. Das ist besonders wichtig im
7918         <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
7919         diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
7920         werden.</para>
7921
7922         <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
7923         abgetrennten Block, der alle kanonischen globalen Variablen listet und
7924         erklärt. Bitte keine anderen einführen ohne das sauber zu
7925         dokumentieren.</para>
7926
7927         <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
7928         man sicher geht, dass man die richtige erwischt.</para>
7929       </sect2>
7930
7931       <sect2 id="devel.fcgi.performance">
7932         <title>Performance und Statistiken</title>
7933
7934         <para>Die kritischen Pfade des Programms sind die Belegmasken, und
7935         unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
7936         Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
7937         4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
7938         sind es je nach Menge der definierten Variablen 1-2s. Ab der
7939         Moose/Rose::DB Version sind es 5-6s.</para>
7940
7941         <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
7942         den kritischen Pfaden, unter 0,15 sonst.</para>
7943       </sect2>
7944     </sect1>
7945
7946     <sect1 id="dev-programmatic-api-calls" xreflabel="Programmatische API-Aufrufe">
7947       <title>Programmatische API-Aufrufe</title>
7948
7949       <sect2 id="dev-programmatic-api-calls.introduction" xreflabel="Einführung in programmatische API-Aufrufe">
7950         <title>Einführung</title>
7951
7952         <para>
7953          Es ist möglich, Funktionen in kivitendo programmatisch aus anderen Programmen aufzurufen. Dazu ist nötig, dass
7954          Authentifizierungsinformationen in jedem Aufruf mitgegeben werden. Dafür gibt es zwei Methoden: die HTTP-»Basic«-Authentifizierung
7955          oder die Übergabe als spziell benannte GET-Parameter. Neben den Authentifizierungsinformationen muss auch der zu verwendende Mandant
7956          übergeben werden.
7957         </para>
7958       </sect2>
7959
7960       <sect2 id="dev-programmatic-api-calls.client_selection" xreflabel="Mandantenauswahl bei programmatischen API-Aufrufen">
7961         <title>Wahl des Mandanten</title>
7962
7963         <para>
7964          Der zu verwendende Mandant kann als Parameter <varname>{AUTH}client_id</varname> mit jedem Request mitgeschickt werden. Der Wert
7965          muss dabei die Datenbank-ID des Mandanten sein. kivitendo prüft, ob der Account, der über die Authentifizierungsinformationen
7966          übergeben wurde, Zugriff auf den angegebenen Mandanten hat.
7967         </para>
7968
7969         <para>
7970          Wird in einem Request kein Mandant mitgegeben, so wird derjenige Mandant genommen, wer als Standardmandant markiert wurde. Gibt es
7971          keinen solchen, kommt es zu einer Fehlermeldung.
7972         </para>
7973       </sect2>
7974
7975       <sect2 id="dev-programmatic-api-calls.http_basic_authentication" xreflabel="Programmatische API-Aufrufe mit HTTP-»Basic« authentifizieren">
7976         <title>HTTP-»Basic«-Authentifizierung</title>
7977
7978         <para>
7979          Für diese Methode muss jedem Request der bekannte HTTP-Header <constant>Authorization</constant> mitgeschickt werden (siehe <ulink
7980          url="https://tools.ietf.org/html/rfc7617">RFC 7617</ulink>). Unterstützt wird ausschließlich die »Basic«-Methode. Loginname und
7981          Passwort werden bei dieser Methode durch einen Doppelpunkt getrennt und Base64-encodiert im genannten HTTP-Header übertragen.
7982         </para>
7983
7984         <para>
7985          Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei Benutzung über den Webbrowser, ob
7986          dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
7987         </para>
7988
7989         <para>
7990          Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
7991          erfolgen.
7992         </para>
7993       </sect2>
7994
7995       <sect2 id="dev-programmatic-api-calls.authentication_via_parameters" xreflabel="Programmatische API-Aufrufe mit Parametern authentifizieren">
7996         <title>Authentifizierung mit Parametern</title>
7997
7998         <para>
7999          Für diese Methode müssen jedem Request zwei Parameter mitgegeben werden: <varname>{AUTH}login</varname> und
8000          <varname>{AUTH}password</varname>. Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei
8001          Benutzung über den Webbrowser, ob dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
8002         </para>
8003
8004         <para>
8005          Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
8006          erfolgen.
8007         </para>
8008
8009         <note>
8010          <para>
8011           Die Verwendung dieser Methode ist veraltet. Statt dessen sollte die oben erwähnte HTTP-»Basic«-Authentifizierung verwendet werden.
8012          </para>
8013         </note>
8014       </sect2>
8015
8016       <sect2 id="dev-programmatic-api-calls.examples">
8017         <title>Beispiele</title>
8018
8019         <para>
8020          Das folgende Beispiel nutzt das Kommandozeilenprogramm »curl« und ruft die Funktion auf, die eine vorhandene Telefonnummer in den
8021          Ansprechpersonen sucht und dazu Informationen zurückliefert. Dabei wird die HTTP-»Basic«-Authentifizierung genutzt.
8022         </para>
8023
8024         <programlisting>$ curl --silent --user 'jdoe:SecretPassword!' \
8025   'https://…/controller.pl?action=PhoneNumber/look_up&amp;number=053147110815'</programlisting>
8026       </sect2>
8027     </sect1>
8028
8029     <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
8030       <title>SQL-Upgradedateien</title>
8031
8032       <sect2 id="db-upgrade-files.introduction"
8033              xreflabel="Einführung in die Datenbank-Upgradedateien">
8034         <title>Einführung</title>
8035
8036         <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
8037         gesteuert, die sich im Verzeichnis
8038         <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
8039         muss pro Datenbankupgrade eine Datei existieren, die neben den
8040         eigentlich auszuführenden SQL- oder Perl-Befehlen einige
8041         Kontrollinformationen enthält.</para>
8042
8043         <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
8044         sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
8045         werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
8046         werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
8047         wurde), diese Reihenfolge aber so flexibel ist, dass man keine
8048         Versionsnummern braucht.</para>
8049
8050         <para>kivitendo merkt sich dabei, welches der Upgradescripte in
8051         <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
8052         führt diese nicht erneut aus. Dazu dient die Tabelle
8053         "<literal>schema_info</literal>", die bei der Anmeldung automatisch
8054         angelegt wird.</para>
8055       </sect2>
8056
8057       <sect2 id="db-upgrade-files.format"
8058              xreflabel="Format der Upgradedateien">
8059         <title>Format der Kontrollinformationen</title>
8060
8061         <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
8062         Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
8063         hat dabei das folgende Format:</para>
8064
8065         <para>Für SQL-Upgradedateien:</para>
8066
8067         <programlisting>-- @key: value</programlisting>
8068
8069         <para>Für Perl-Upgradedateien:</para>
8070
8071         <programlisting># @key: value</programlisting>
8072
8073         <para>Leerzeichen vor "<varname>value</varname>" werden
8074         entfernt.</para>
8075
8076         <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
8077
8078         <variablelist>
8079           <varlistentry>
8080             <term><varname>tag</varname></term>
8081
8082             <listitem>
8083               <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
8084               Dieser "tag" kann von anderen Kontrolldateien in ihren
8085               Abhängigkeiten verwendet werden (Schlüsselwort
8086               "<varname>depends</varname>"). Der "tag" ist auch der Name, der
8087               in der Datenbank eingetragen wird.</para>
8088
8089               <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
8090               der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
8091
8092               <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
8093               Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
8094               erlaubt und sollten stattdessen mit Unterstrichen ersetzt
8095               werden.</para>
8096             </listitem>
8097           </varlistentry>
8098
8099           <varlistentry>
8100             <term><varname>charset</varname></term>
8101
8102             <listitem>
8103               <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
8104               geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
8105               Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
8106               Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
8107               "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
8108               hingegen müssen immer in UTF-8 encodiert sein und sollten
8109               demnach auch ein "<literal>use utf8;</literal>"
8110               enthalten.</para>
8111             </listitem>
8112           </varlistentry>
8113
8114           <varlistentry>
8115             <term><varname>description</varname></term>
8116
8117             <listitem>
8118               <para>Benötigt. Eine Beschreibung, was in diesem Update
8119               passiert. Diese wird dem Benutzer beim eigentlichen
8120               Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
8121               sein sollte, sollte die Beschreibung auf Deutsch
8122               erfolgen.</para>
8123             </listitem>
8124           </varlistentry>
8125
8126           <varlistentry>
8127             <term><varname>depends</varname></term>
8128
8129             <listitem>
8130               <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
8131               von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
8132               dass die in dieser Liste aufgeführten Scripte bereits
8133               durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
8134
8135               <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
8136               Script "b" existiert, das von Änderungen in "a" abhängt, und
8137               eine neue Kontrolldatei für "c" erstellt wird, die von
8138               Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
8139               Tag "b" als Abhängigkeit zu definieren.</para>
8140
8141               <para>Es ist nicht erlaubt, sich selbst referenzierende
8142               Abhängigkeiten zu definieren (z.B. "a" -&gt; "b", "b" -&gt; "c"
8143               und "c" -&gt; "a").</para>
8144             </listitem>
8145           </varlistentry>
8146
8147           <varlistentry>
8148             <term><varname>priority</varname></term>
8149
8150             <listitem>
8151               <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
8152               der Scripte ausgeführt werden, die die gleichen
8153               Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
8154               der Wert 1000 benutzt.</para>
8155
8156               <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
8157               "depends" benutzt werden. kivitendo sortiert die auszuführenden
8158               Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
8159               abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
8160               2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
8161               dann "y", dann "z"), dann nach der Priorität und bei gleicher
8162               Priorität alphabetisch nach dem "tag".</para>
8163             </listitem>
8164           </varlistentry>
8165
8166           <varlistentry>
8167             <term><varname>ignore</varname></term>
8168
8169             <listitem>
8170               <para>Optional. Falls der Wert auf 1 (true) steht, wird das
8171               Skript bei der Anmeldung ignoriert und entsprechend nicht
8172               ausgeführt.</para>
8173             </listitem>
8174           </varlistentry>
8175         </variablelist>
8176       </sect2>
8177
8178       <sect2 id="db-upgrade-files.format-perl-files"
8179              xreflabel="Format von Perl-Upgradedateien">
8180         <title>Format von in Perl geschriebenen
8181         Datenbankupgradescripten</title>
8182
8183         <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
8184         ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
8185         bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
8186
8187         <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
8188         dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
8189         erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
8190         stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
8191         Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
8192         aufgerufen wird.</para>
8193
8194         <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
8195         für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
8196         in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
8197         ersetzt. Insgesamt sieht der Paketname wie folgt aus:
8198         "<literal>SL::DBUpgrade2::tag</literal>".</para>
8199
8200         <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
8201         der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
8202         "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
8203
8204         <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
8205         folgt aus:</para>
8206
8207         <programlisting># @tag: beispiel-upgrade-file42
8208 # @description: Ein schönes Beispielscript
8209 # @depends: release_3_1_0
8210 package SL::DBUpgrade2::beispiel_upgrade_file42;
8211
8212 use strict;
8213 use utf8;
8214
8215 use parent qw(SL::DBUpgrade2::Base);
8216
8217 sub run {
8218   my ($self) = @_;
8219
8220   # hier Aktionen ausführen
8221
8222   return 1;
8223 }
8224
8225 1;
8226 </programlisting>
8227       </sect2>
8228
8229       <sect2 id="db-upgrade-files.dbupgrade-tool"
8230              xreflabel="Hilfsscript dbupgrade2_tool.pl">
8231         <title>Hilfsscript dbupgrade2_tool.pl</title>
8232
8233         <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
8234         existiert ein Hilfsscript namens
8235         "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
8236         kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
8237         liest alle Datenbankupgradescripte aus dem Verzeichnis
8238         <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
8239         gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
8240         von der Kommandozeile überprüft werden können.</para>
8241
8242         <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
8243         eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
8244         sich aber auch Informationen auf verschiedene Art ausgeben
8245         lassen:</para>
8246
8247         <itemizedlist>
8248           <listitem>
8249             <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
8250             --list</command>"</para>
8251
8252             <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
8253             Reihenfolge sortiert, in der kivitendo die Scripte ausführen
8254             würde. Es werden neben der Listenposition der Tag, die
8255             Abhängigkeitstiefe und die Priorität ausgegeben.</para>
8256           </listitem>
8257
8258           <listitem>
8259             <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
8260             --tree</command>"</para>
8261
8262             <para>Listet alle Tags in Baumform basierend auf den
8263             Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
8264             denen keine anderen abhängen. Die Unterknoten sind Scripte, die
8265             beim übergeordneten Script als Abhängigkeit eingetragen
8266             sind.</para>
8267           </listitem>
8268
8269           <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
8270             <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
8271             --rtree</command>"</para>
8272
8273             <para>Listet alle Tags in Baumform basierend auf den
8274             Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
8275             der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
8276             die das übergeordnete Script als Abhängigkeit eingetragen
8277             haben.</para>
8278           </listitem>
8279
8280           <listitem>
8281             <para>Baumform mit Postscriptausgabe:
8282             "<command>./scripts/dbupgrade2_tool.pl
8283             --graphviz</command>"</para>
8284
8285             <para>Benötigt das Tool "<command>graphviz</command>", um mit
8286             seiner Hilfe die <link
8287             linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
8288             Baumform</link> in eine Postscriptdatei namens
8289             "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
8290             vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
8291             nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
8292             können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
8293             werden.</para>
8294           </listitem>
8295
8296           <listitem>
8297             <para>Scripte, von denen kein anderes Script abhängt:
8298             "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
8299
8300             <para>Listet die Tags aller Scripte auf, von denen keine anderen
8301             Scripte abhängen.</para>
8302           </listitem>
8303         </itemizedlist>
8304       </sect2>
8305     </sect1>
8306
8307     <sect1 id="translations-languages" xreflabel="Translations and languages">
8308       <title>Translations and languages</title>
8309
8310       <sect2 id="translations-languages.introduction"
8311              xreflabel="Introduction to translations and languages">
8312         <title>Introduction</title>
8313
8314         <note>
8315           <para>Dieser Abschnitt ist in Englisch geschrieben, um
8316           internationalen Übersetzern die Arbeit zu erleichtern.</para>
8317         </note>
8318
8319         <para>This section describes how localization packages in kivitendo
8320         are built. Currently the only language fully supported is German, and
8321         since most of the internal messages are held in English the English
8322         version is usable too.</para>
8323       </sect2>
8324
8325       <sect2 id="translations-languages.character-set"
8326              xreflabel="Character set">
8327         <title>Character set</title>
8328
8329         <para>All files included in a language pack must use UTF-8 as their
8330         encoding.</para>
8331       </sect2>
8332
8333       <sect2 id="translations-languages.file-structure"
8334              xreflabel="File structure">
8335         <title>File structure</title>
8336
8337         <para>The structure of locales in kivitendo is:</para>
8338
8339         <programlisting>kivitendo/locale/&lt;langcode&gt;/</programlisting>
8340
8341         <para>where &lt;langcode&gt; stands for an abbreviation of the
8342         language package. The builtin packages use two letter <ulink
8343         url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
8344         but the actual name is not relevant for the program and can easily be
8345         extended to <ulink
8346         url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
8347         tags</ulink> (i.e. "en_GB"). In fact the original language packages
8348         from SQL Ledger are named in this way.</para>
8349
8350         <para>In such a language directory the following files are
8351         recognized:</para>
8352
8353         <variablelist>
8354           <varlistentry>
8355             <term>LANGUAGE</term>
8356
8357             <listitem>
8358               <para>This file is mandatory.</para>
8359
8360               <para>The <filename>LANGUAGE</filename> file contains the self
8361               descripted name of the language. It should contain a native
8362               representation first, and in parenthesis an english translation
8363               after that. Example:</para>
8364
8365               <programlisting>Deutsch (German)</programlisting>
8366             </listitem>
8367           </varlistentry>
8368
8369           <varlistentry>
8370             <term>all</term>
8371
8372             <listitem>
8373               <para>This file is mandatory.</para>
8374
8375               <para>The central translation file. It is essentially an inline
8376               Perl script autogenerated by <command>locales.pl</command>. To
8377               generate it, generate the directory and the two files mentioned
8378               above, and execute the following command:</para>
8379
8380               <programlisting>scripts/locales.pl &lt;langcode&gt;</programlisting>
8381
8382               <para>Otherwise you can simply copy one of the other languages.
8383               You will be told how many are missing like this:</para>
8384
8385               <programlisting>$ scripts/locales.pl en
8386 English - 0.6% - 2015/2028 missing</programlisting>
8387
8388               <para>A file named "<filename>missing</filename>" will be
8389               generated and can be edited. You can also edit the
8390               "<filename>all</filename>" file directly. Edit everything you
8391               like to fit the target language and execute
8392               <command>locales.pl</command> again. See how the missing words
8393               get fewer.</para>
8394             </listitem>
8395           </varlistentry>
8396
8397           <varlistentry>
8398             <term>Num2text</term>
8399
8400             <listitem>
8401               <para>Legacy code from SQL Ledger. It provides a means for
8402               numbers to be converted into natural language, like
8403               <literal>1523 =&gt; one thousand five hundred twenty
8404               three</literal>. If you want to provide it, it must be inlinable
8405               Perl code which provides a <function>num2text</function> sub. If
8406               an <function>init</function> sub exists it will be executed
8407               first.</para>
8408
8409               <para>Only used in the check and receipt printing module.</para>
8410             </listitem>
8411           </varlistentry>
8412
8413           <varlistentry>
8414             <term>special_chars</term>
8415
8416             <listitem>
8417               <para>kivitendo comes with a lot of interfaces to different
8418               formats, some of which are rather picky with their accepted
8419               charset. The <filename>special_chars</filename> file contains a
8420               listing of chars not suited for different file format and
8421               provides substitutions. It is written in "Simple Ini" style,
8422               containing a block for every file format.</para>
8423
8424               <para>First entry should be the order of substitution for
8425               entries as a whitespace separated list. All entries are
8426               interpolated, so <literal>\n</literal>, <literal>\x20</literal>
8427               and <literal>\\</literal> all work.</para>
8428
8429               <para>After that every entry is a special char that should be
8430               translated when writing text into such a file.</para>
8431
8432               <para>Example:</para>
8433
8434               <programlisting>[Template/XML]
8435 order=&amp; &lt; &gt; \n
8436 &amp;=&amp;amp;
8437 &lt;=&amp;lt;
8438 &gt;=&amp;gt;
8439 \n=&lt;br&gt;</programlisting>
8440
8441               <para>Note the importance of the order in this example.
8442               Substituting &lt; and &gt; befor &amp; would lead to $gt; become
8443               &amp;amp;gt;</para>
8444
8445               <para>For a list of valid formats, see the German
8446               <filename>special_chars</filename> entry. As of this writing the
8447               following are recognized:</para>
8448
8449               <programlisting>HTML
8450 URL@HTML
8451 Template/HTML
8452 Template/XML
8453 Template/LaTeX
8454 Template/OpenDocument
8455 filenames</programlisting>
8456
8457               <para>The last of which is very machine dependent. Remember that
8458               a lot of characters are forbidden by some filesystems, for
8459               example MS Windows doesn't like ':' in its files where Linux
8460               doesn't mind that. If you want the files created with your
8461               language pack to be portable, find all chars that could cause
8462               trouble.</para>
8463             </listitem>
8464           </varlistentry>
8465
8466           <varlistentry>
8467             <term>missing</term>
8468
8469             <listitem>
8470               <para>This file is not a part of the language package
8471               itself.</para>
8472
8473               <para>This is a file generated by
8474               <command>scripts/locales.pl</command> while processing your
8475               locales. It's only to have the missing entries singled out and
8476               does not belong to a language package.</para>
8477             </listitem>
8478           </varlistentry>
8479
8480           <varlistentry>
8481             <term>lost</term>
8482
8483             <listitem>
8484               <para>This file is not a part of the language package
8485               itself.</para>
8486
8487               <para>Another file generated by
8488               <command>scripts/locales.pl</command>. If for any reason a
8489               translation does not appear anymore and can be deleted, it gets
8490               moved here. The last 50 or so entries deleted are saved here in
8491               case you made a typo, so that you don't have to translate
8492               everything again. If a tranlsation is missing, the lost file is
8493               checked first. If you maintain a language package, you might
8494               want to keep this safe somewhere.</para>
8495             </listitem>
8496           </varlistentry>
8497
8498           <varlistentry>
8499             <term>more/all</term>
8500
8501             <listitem>
8502               <para>This subdir and file is not a part of the language package
8503               itself.</para>
8504
8505               <para>If the directory more exists and contains a file called
8506               all it will be parsed in addition to the mandatory all (see
8507               above). The file is useful if you want to change some
8508               translations for the current installation without conflicting
8509               further upgrades. The file is not autogenerated and has the same
8510               format as the all, but needs another key (more_texts). See the
8511               german translation for an example or copy the following code:
8512               <programlisting>
8513 #!/usr/bin/perl
8514 # -*- coding: utf-8; -*-
8515 # vim: fenc=utf-8
8516
8517 use utf8;
8518
8519 # These are additional texts for custom translations.
8520 # The format is the same as for the normal file all, only
8521 # with another key (more_texts instead of texts).
8522 # The file has the form of 'english text'  =&gt; 'foreign text',
8523
8524 $self-&gt;{more_texts} = {
8525
8526   'Ship via'                    =&gt; 'Terms of delivery',
8527   'Shipping Point'              =&gt; 'Delivery time',
8528 }
8529               </programlisting></para>
8530             </listitem>
8531           </varlistentry>
8532         </variablelist>
8533       </sect2>
8534     </sect1>
8535
8536     <sect1 id="devel.testsuite">
8537       <title>Die kivitendo-Test-Suite</title>
8538
8539       <sect2 id="devel.testsuite.intro">
8540         <title>Einführung</title>
8541
8542         <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
8543         basiert auf dem Standard-Perl-Modul
8544         <literal>Test::More</literal>.</para>
8545
8546         <para>Die grundlegenden Fakten sind:</para>
8547
8548         <itemizedlist>
8549           <listitem>
8550             <para>Alle Tests liegen im Unterverzeichnis
8551             <filename>t/</filename>.</para>
8552           </listitem>
8553
8554           <listitem>
8555             <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
8556             enthält einen oder mehrere Testfälle.</para>
8557           </listitem>
8558
8559           <listitem>
8560             <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
8561             Es sind selbstständig ausführbare Perl-Scripte.</para>
8562           </listitem>
8563
8564           <listitem>
8565             <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
8566             sprich aller Scripte in <filename>t/</filename>, deren Dateiname
8567             auf <literal>.t</literal> endet.</para>
8568           </listitem>
8569         </itemizedlist>
8570       </sect2>
8571
8572       <sect2 id="devel.testsuite.prerequisites">
8573         <title>Voraussetzungen</title>
8574
8575         <para>Für die Ausführung werden neben den für kivitendo eh schon
8576         benötigten Module noch weitere Perl-Module benötigt. Diese
8577         sind:</para>
8578
8579         <itemizedlist>
8580           <listitem>
8581             <para><literal>Test::Deep</literal> (Debian-Paketname:
8582             <literal>libtest-deep-perl</literal>; Fedora:
8583             <literal>perl-Test-Deep</literal>; openSUSE:
8584             <literal>perl-Test-Deep</literal>)</para>
8585           </listitem>
8586
8587           <listitem>
8588             <para><literal>Test::Exception</literal> (Debian-Paketname:
8589             <literal>libtest-exception-perl</literal>; Fedora:
8590             <literal>perl-Test-Exception</literal>; openSUSE:
8591             <literal>perl-Test-Exception</literal>)</para>
8592           </listitem>
8593
8594           <listitem>
8595             <para><literal>Test::Output</literal> (Debian-Paketname:
8596             <literal>libtest-output-perl</literal>; Fedora:
8597             <literal>perl-Test-Output</literal>; openSUSE:
8598             <literal>perl-Test-Output</literal>)</para>
8599           </listitem>
8600
8601           <listitem>
8602             <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
8603             Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
8604             kann für frühere Versionen aus dem <ulink
8605             url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
8606           </listitem>
8607
8608           <listitem>
8609             <para><literal>LWP::Simple</literal> aus dem Paket
8610             <literal>libwww-perl</literal> (Debian-Panetname:
8611             <literal>libwww-perl</literal>; Fedora:
8612             <literal>perl-libwww-perl</literal>; openSUSE:
8613             <literal>perl-libwww-perl</literal>)</para>
8614           </listitem>
8615
8616           <listitem>
8617             <para><literal>URI::Find</literal> (Debian-Panetname:
8618             <literal>liburi-find-perl</literal>; Fedora:
8619             <literal>perl-URI-Find</literal>; openSUSE:
8620             <literal>perl-URI-Find</literal>)</para>
8621           </listitem>
8622
8623           <listitem>
8624             <para><literal>Sys::CPU</literal> (Debian-Panetname:
8625             <literal>libsys-cpu-perl</literal>; Fedora und openSUSE: nicht
8626             vorhanden)</para>
8627           </listitem>
8628
8629           <listitem>
8630             <para><literal>Thread::Pool::Simple</literal> (Debian-Panetname:
8631             <literal>libthread-pool-simple-perl</literal>; Fedora und
8632             openSUSE: nicht vorhanden)</para>
8633           </listitem>
8634         </itemizedlist>
8635
8636         <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
8637         Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
8638         müssen in der Konfigurationsdatei im Abschnit
8639         <literal>testing/database</literal> Datenbankverbindungsparameter
8640         angegeben werden. Der hier angegebene Benutzer muss weiterhin das
8641         Recht haben, Datenbanken anzulegen und zu löschen.</para>
8642
8643         <para>Der so angegebene Benutzer muss nicht zwingend über
8644         Super-User-Rechte verfügen. Allerdings gibt es einige
8645         Datenbank-Upgrades, die genau diese Rechte benötigen. Für den Fall
8646         kann man in diesem Konfigurationsabschnitt einen weiteren
8647         Benutzeraccount angeben, der dann über Super-User-Rechte verfügt, und
8648         mit dem die betroffenen Upgrades durchgeführt werden. In der
8649         Beispiel-Konfigurationsdatei finden Sie die benötigten
8650         Parameter.</para>
8651       </sect2>
8652
8653       <sect2 id="devel.testsuite.execution">
8654         <title>Existierende Tests ausführen</title>
8655
8656         <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
8657         man lässt alle Tests auf einmal ausführen, oder man führt gezielt
8658         einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
8659         <filename>t/test.pl</filename>.</para>
8660
8661         <para>Will man die komplette Test-Suite ausführen, so muss man einfach
8662         nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
8663         kivitendo-Basisverzeichnis heraus ausführen.</para>
8664
8665         <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
8666         an <filename>t/test.pl</filename>. Beispielsweise:</para>
8667
8668         <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
8669       </sect2>
8670
8671       <sect2 id="devel.testsuite.meaning_of_scripts">
8672         <title>Bedeutung der verschiedenen Test-Scripte</title>
8673
8674         <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
8675         Programmierstil. Einige besonders zu erwähnende, weil auch während der
8676         Entwicklung nützliche Tests sind:</para>
8677
8678         <itemizedlist>
8679           <listitem>
8680             <para><filename>t/001compile.t</filename> -- compiliert alle
8681             Quelldateien und bricht bei Fehlern sofort ab</para>
8682           </listitem>
8683
8684           <listitem>
8685             <para><filename>t/002goodperl.t</filename> -- überprüft alle
8686             Perl-Dateien auf Anwesenheit von '<literal>use
8687             strict</literal>'-Anweisungen</para>
8688           </listitem>
8689
8690           <listitem>
8691             <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
8692             <function>system()</function> und <function>exec()</function> auf
8693             Gültigkeit</para>
8694           </listitem>
8695
8696           <listitem>
8697             <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
8698             Tab-Zeichen enthalten</para>
8699           </listitem>
8700
8701           <listitem>
8702             <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
8703             Rechtschreibfehlern</para>
8704           </listitem>
8705
8706           <listitem>
8707             <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
8708             Dokumentation im POD-Format auf Gültigkeit</para>
8709           </listitem>
8710         </itemizedlist>
8711
8712         <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
8713         einzelner Funktionen und Module.</para>
8714       </sect2>
8715
8716       <sect2 id="devel.testsuite.create_new">
8717         <title>Neue Test-Scripte erstellen</title>
8718
8719         <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
8720         mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
8721         und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
8722         werden.</para>
8723
8724         <sect3 id="devel.testsuite.ideas_for_non_function_tests">
8725           <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
8726           testen</title>
8727
8728           <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
8729           wurden:</para>
8730
8731           <itemizedlist>
8732             <listitem>
8733               <para>Überprüfung auf fehlende symbolische Links</para>
8734             </listitem>
8735
8736             <listitem>
8737               <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
8738               gewissen Einschränkungen wie das Erlauben von deutschen
8739               Umlauten)</para>
8740             </listitem>
8741
8742             <listitem>
8743               <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
8744             </listitem>
8745
8746             <listitem>
8747               <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
8748             </listitem>
8749
8750             <listitem>
8751               <para>Test, ob alle zu übersetzenden Strings in
8752               <filename>locale/de/all</filename> vorhanden sind</para>
8753             </listitem>
8754
8755             <listitem>
8756               <para>Test, ob alle Webseiten-Templates in
8757               <filename>templates/webpages</filename> mit vom Perl-Modul
8758               <literal>Template</literal> compiliert werden können</para>
8759             </listitem>
8760           </itemizedlist>
8761         </sect3>
8762
8763         <sect3 id="devel.testsuite.directory_and_test_names">
8764           <title>Konvention für Verzeichnis- und Dateinamen</title>
8765
8766           <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
8767           benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
8768           und ihnen soweit es geht folgen:</para>
8769
8770           <itemizedlist>
8771             <listitem>
8772               <para>Die Dateiendung muss <filename>.t</filename>
8773               lauten.</para>
8774             </listitem>
8775
8776             <listitem>
8777               <para>Namen sind englisch, komplett klein geschrieben und
8778               einzelne Wörter mit Unterstrichten getrennt (beispielsweise
8779               <filename>bad_function_params.t</filename>).</para>
8780             </listitem>
8781
8782             <listitem>
8783               <para>Unterverzeichnisse sollten grob nach dem Themenbereich
8784               benannt sein, mit dem sich die Scripte darin befassen
8785               (beispielsweise <filename>background_jobs</filename> für Tests
8786               rund um Hintergrund-Jobs).</para>
8787             </listitem>
8788
8789             <listitem>
8790               <para>Test-Scripte sollten einen überschaubaren Bereich von
8791               Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
8792               Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
8793               Test-Scripte schreiben.</para>
8794             </listitem>
8795           </itemizedlist>
8796         </sect3>
8797
8798         <sect3 id="devel.testsuite.minimal_example">
8799           <title>Minimales Skelett für eigene Scripte</title>
8800
8801           <para>Der folgenden Programmcode enthält das kleinstmögliche
8802           Testscript und kann als Ausgangspunkt für eigene Tests verwendet
8803           werden:</para>
8804
8805           <programlisting>use Test::More tests =&gt; 0;
8806
8807 use lib 't';
8808
8809 use Support::TestSetup;
8810
8811 Support::TestSetup::login();</programlisting>
8812
8813           <para>Wird eine vollständig initialisierte kivitendo-Umgebung
8814           benötigt (Stichwort: alle globalen Variablen wie
8815           <varname>$::auth</varname>, <varname>$::form</varname> oder
8816           <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
8817           <filename>config/kivitendo.conf</filename> im Abschnitt
8818           <literal>testing.login</literal> ein gültiger Login-Name eingetragen
8819           sein. Dieser wird für die Datenbankverbindung benötigt.</para>
8820
8821           <para>Wir keine vollständig initialisierte Umgebung benötigt, so
8822           kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
8823           weggelassen werden, was die Ausführungszeit des Scripts leicht
8824           verringert.</para>
8825         </sect3>
8826       </sect2>
8827     </sect1>
8828
8829     <sect1 id="devel.style-guide">
8830       <title>Stil-Richtlinien</title>
8831
8832       <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
8833       und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
8834       eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
8835       wird (Stichworte "Klammern" oder "Hash-Keys").</para>
8836
8837       <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
8838       Leben!</para>
8839
8840       <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
8841       überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
8842       nicht.</para>
8843
8844       <orderedlist>
8845         <listitem>
8846           <para>Es werden keine echten Tabs sondern Leerzeichen
8847           verwendet.</para>
8848         </listitem>
8849
8850         <listitem>
8851           <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
8852
8853           <programlisting>foreach my $row (@data) {
8854   if ($flag) {
8855     # do something with $row
8856   }
8857
8858   if ($use_modules) {
8859     $row-&gt;{modules} = MODULE-&gt;retrieve(
8860       id   =&gt; $row-&gt;{id},
8861       date =&gt; $use_now ? localtime() : $row-&gt;{time},
8862     );
8863   }
8864
8865   $report-&gt;add($row);
8866 }</programlisting>
8867         </listitem>
8868
8869         <listitem>
8870           <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
8871           Zeile wie der letzte Befehl. Beispiele:</para>
8872
8873           <programlisting>sub debug {
8874   ...
8875 }</programlisting>
8876
8877           <para>oder</para>
8878
8879           <programlisting>if ($form-&gt;{item_rows} &gt; 0) {
8880   ...
8881 }</programlisting>
8882         </listitem>
8883
8884         <listitem>
8885           <para>Schließende geschweifte Klammern sind so weit eingerückt wie
8886           der Befehl / die öffnende schließende Klammer, die den Block
8887           gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
8888           Beispiele wie bei 3. gelten.</para>
8889         </listitem>
8890
8891         <listitem>
8892           <para>Die Wörter "<function>else</function>",
8893           "<function>elsif</function>", "<function>while</function>" befinden
8894           sich auf der gleichen Zeile wie schließende geschweifte Klammern.
8895           Beispiele:</para>
8896
8897           <programlisting>if ($form-&gt;{sum} &gt; 1000) {
8898   ...
8899 } elsif ($form-&gt;{sum} &gt; 0) {
8900   ...
8901 } else {
8902   ...
8903 }
8904
8905 do {
8906   ...
8907 } until ($a &gt; 0);</programlisting>
8908         </listitem>
8909
8910         <listitem>
8911           <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
8912           versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
8913           und grep-ähnliche Operatoren. Beispiel:</para>
8914
8915           <programlisting>$main::lxdebug-&gt;message("Could not find file.");
8916 %options = map { $_ =&gt; 1 } grep { !/^#/ } @config_file;</programlisting>
8917         </listitem>
8918
8919         <listitem>
8920           <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
8921
8922           <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
8923           Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
8924           Blöcke schon. Beispiel:</para>
8925
8926           <programlisting>if (($form-&gt;{debug} == 1) &amp;&amp; ($form-&gt;{sum} - 100 &lt; 0)) {
8927   ...
8928 }
8929
8930 $array[$i + 1]             = 4;
8931 $form-&gt;{sum}              += $form-&gt;{"row_$i"};
8932 $form-&gt;{ $form-&gt;{index} } += 1;
8933
8934 map { $form-&gt;{sum} += $form-&gt;{"row_$_"} } 1..$rowcount;</programlisting>
8935         </listitem>
8936
8937         <listitem>
8938           <para>Mehrzeilige Befehle</para>
8939
8940           <orderedlist>
8941             <listitem>
8942               <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
8943               Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
8944               werden, in der die ersten Funktionsparameter in der ersten Zeile
8945               stehen. Beispiel:</para>
8946
8947               <programlisting>$sth = $dbh-&gt;prepare("SELECT * FROM some_table WHERE col = ?",
8948                     $form-&gt;{some_col_value});</programlisting>
8949             </listitem>
8950
8951             <listitem>
8952               <para>Ein Spezialfall ist der ternäre Operator "?:", der am
8953               besten in einer übersichtlichen Tabellenstruktur organisiert
8954               wird. Beispiel:</para>
8955
8956               <programlisting>my $rowcount = $form-&gt;{"row_$i"} ? $i
8957              : $form-&gt;{oldcount} ? $form-&gt;{oldcount} + 1
8958              :                     $form-&gt;{rowcount} - $form-&gt;{rowbase};</programlisting>
8959             </listitem>
8960           </orderedlist>
8961         </listitem>
8962
8963         <listitem>
8964           <para>Kommentare</para>
8965
8966           <orderedlist>
8967             <listitem>
8968               <para>Kommentare, die alleine in einer Zeile stehen, sollten
8969               soweit wie der Code eingerückt sein.</para>
8970             </listitem>
8971
8972             <listitem>
8973               <para>Seitliche hängende Kommentare sollten einheitlich
8974               formatiert werden.</para>
8975             </listitem>
8976
8977             <listitem>
8978               <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
8979               auf Englisch zu verfassen. So wie ich keine Lust habe,
8980               französischen Quelltext zu lesen, sollte auch der kivitendo
8981               Quelltext für nicht-Deutschsprachige lesbar sein.
8982               Beispiel:</para>
8983
8984               <programlisting>my $found = 0;
8985 while (1) {
8986   last if $found;
8987
8988   # complicated check
8989   $found = 1 if //
8990 }
8991
8992 $i  = 0        # initialize $i
8993 $n  = $i;      # save $i
8994 $i *= $const;  # do something crazy
8995 $i  = $n;      # recover $i</programlisting>
8996             </listitem>
8997           </orderedlist>
8998         </listitem>
8999
9000         <listitem>
9001           <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
9002           Interpolation gewünscht ist. Beispiel:</para>
9003
9004           <programlisting>$form-&gt;{sum}      = 0;
9005 $form-&gt;{"row_$i"} = $form-&gt;{"row_$i"} - 5;
9006 $some_hash{42}    = 54;</programlisting>
9007         </listitem>
9008
9009         <listitem>
9010           <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
9011           unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
9012           wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
9013           grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
9014
9015           <para>Als Beispiel sei die Funktion
9016           <function>print_options</function> aus
9017           <filename>bin/mozilla/io.pl</filename> angeführt.</para>
9018         </listitem>
9019
9020         <listitem>
9021           <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
9022           unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
9023           verfälschen.</para>
9024
9025           <para>Emacs und vim haben beide recht einfache Methoden zur
9026           Entfernung von trailing whitespace. Emacs kennt das Kommande
9027           <command>nuke-trailing-whitespace</command>, vim macht das gleiche
9028           manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
9029           BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
9030           gebunden.</para>
9031         </listitem>
9032
9033         <listitem>
9034           <para>Es wird kein <command>perltidy</command> verwendet.</para>
9035
9036           <para>In der Vergangenheit wurde versucht,
9037           <command>perltidy</command> zu verwenden, um einen einheitlichen
9038           Stil zu erlangen. Es hat sich aber gezeigt, dass
9039           <command>perltidy</command>s sehr eigenwilliges Verhalten, was
9040           Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
9041           den Interessierten sind hier die
9042           <command>perltidy</command>-Optionen, die grob den beschriebenen
9043           Richtlinien entsprechen:</para>
9044
9045           <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
9046 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
9047 -lp -vt=1 -vtc=1</programlisting>
9048         </listitem>
9049
9050         <listitem>
9051           <para><varname>STDERR</varname> ist tabu. Unkonditionale
9052           Debugmeldungen auch.</para>
9053
9054           <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
9055           einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
9056           Grund, nach <varname>STDERR</varname> zu schreiben.</para>
9057
9058           <para>Die <classname>LXDebug</classname>-Methode
9059           "<function>message</function>" nimmt als ersten Paramter außerdem
9060           eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
9061           angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
9062           und werden in den meisten Fällen auch vom Repository
9063           zurückgewiesen.</para>
9064         </listitem>
9065
9066         <listitem>
9067           <para>Alle neuen Module müssen use strict verwenden.</para>
9068
9069           <para><varname>$form</varname>, <varname>$auth</varname>,
9070           <varname>$locale</varname>, <varname>$lxdebug</varname> und
9071           <varname>%myconfig</varname> werden derzeit aus dem main package
9072           importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
9073           Konstrukte sollten lexikalisch lokal gehalten werden.</para>
9074         </listitem>
9075       </orderedlist>
9076     </sect1>
9077
9078     <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
9079       <title>Dokumentation erstellen</title>
9080
9081       <sect2 id="devel.build-doc.introduction">
9082         <title>Einführung</title>
9083
9084         <para>Diese Dokumentation ist in <productname>DocBook</productname>
9085         XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
9086         Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
9087         Editor nutzt, der spezielle Unterstützung für
9088         <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
9089         <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
9090         Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
9091         ist.</para>
9092       </sect2>
9093
9094       <sect2 id="devel.build-doc.required-software">
9095         <title>Benötigte Software</title>
9096
9097         <para>Bei <productname>DocBook</productname> ist Prinzip, dass
9098         ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
9099         dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
9100         erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
9101         <command>scripts/build_doc.sh</command>.</para>
9102
9103         <para>Das Script benötigt zur Konvertierung verschiedene
9104         Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
9105         werden:</para>
9106
9107         <itemizedlist>
9108           <listitem>
9109             <para><ulink
9110             url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
9111             in einer halbwegs aktuellen Version</para>
9112           </listitem>
9113
9114           <listitem>
9115             <para>Das Java-Build-System <ulink
9116             url="http://ant.apache.org/">Apache Ant</ulink></para>
9117           </listitem>
9118
9119           <listitem>
9120             <para>Das Dokumentations-System Dobudish für
9121             <productname>DocBook</productname> 4.5, eine Zusammenstellung
9122             diverser Stylesheets und Grafiken zur Konvertierung von
9123             <productname>DocBook</productname> XML in andere Formate. Das
9124             Paket, das benötigt wird, ist zum Zeitpunkt der
9125             Dokumentationserstellung
9126             <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
9127             url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
9128             bereitsteht.</para>
9129           </listitem>
9130         </itemizedlist>
9131
9132         <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
9133         sind auf allen gängigen Plattformen verfügbar. Beispiel für
9134         Debian/Ubuntu:</para>
9135
9136         <programlisting>apt-get install ant openjdk-7-jre</programlisting>
9137
9138         <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
9139         <filename>doc/build</filename> entpackt werden. Beispiel unter der
9140         Annahme, das <productname>Dobudish</productname> in
9141         <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
9142
9143         <programlisting>cd doc/build
9144 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
9145       </sect2>
9146
9147       <sect2 id="devel.build-doc.build">
9148         <title>PDFs und HTML-Seiten erstellen</title>
9149
9150         <para>Die eigentliche Konvertierung erfolgt nach Installation der
9151         benötigten Software mit einem einfachen Aufruf direkt aus dem
9152         kivitendo-Installationsverzeichnis heraus:</para>
9153
9154         <programlisting>./scripts/build_doc.sh</programlisting>
9155       </sect2>
9156
9157       <sect2 id="devel.build-doc.repository">
9158         <title>Einchecken in das Git-Repository</title>
9159
9160         <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
9161         HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
9162         nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
9163         und alles zusammen in einem Commit eingecheckt werden sollten.</para>
9164
9165         <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
9166         symbolischen Links gehören hingegen nicht in das Repository.</para>
9167       </sect2>
9168     </sect1>
9169   </chapter>
9170 </book>