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