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>Die Adressen müssen inklusive Land angegeben werden. Akzeptiert
2877           werden Ländername oder Ländercode, also z.B. "Schweiz" oder "CH".
2878           </para>
2879
2880           <para>Diese können in der Vorlage mit den jeweiligen Variablen
2881           eingetragen werden. Siehe auch: <xref
2882           linkend="dokumentenvorlagen-und-variablen"/></para>
2883
2884           <para>Der erzeugte QR-Code verwendet Adress-Typ "K" (Kombinierte
2885           Adressfelder, 2 Zeilen).</para>
2886         </sect3>
2887
2888         <sect3>
2889           <title>Referenznummer</title>
2890
2891           <para>Die Referenznummer wird in Kivitendo erzeugt und setzt sich
2892           wiefolgt zusammen:</para>
2893
2894           <itemizedlist>
2895             <listitem>
2896               <para>Bankkonto Identifikationsnummer (6-stellig)</para>
2897             </listitem>
2898
2899             <listitem>
2900               <para>Kundennummer (6-stellig, mit führenden Nullen
2901               aufgefüllt)</para>
2902             </listitem>
2903
2904             <listitem>
2905               <para>Auftragsnummer (7-stellig, mit führenden Nullen
2906               aufgefüllt)</para>
2907             </listitem>
2908
2909             <listitem>
2910               <para>Rechnungsnummer (7-stellig, mit führenden Nullen
2911               aufgefüllt)</para>
2912             </listitem>
2913
2914             <listitem>
2915               <para>Prüfziffer (1-stellig, berechnet mittels modulo 10,
2916               rekursiv)</para>
2917             </listitem>
2918           </itemizedlist>
2919
2920           <para>Es sind lediglich Ziffern erlaubt. Allfällige Prefixe mit
2921           Buchstaben werden entfernt und fehlende Stellen werden mit führenden
2922           Nullen aufgefüllt.</para>
2923         </sect3>
2924
2925         <sect3>
2926           <title>Zusätzliche Variablen für Vorlage</title>
2927
2928           <para>Zusätzlich zu den in der Vorlage standardmässig verfügbaren
2929           Variablen (siehe <xref linkend="dokumentenvorlagen-und-variablen"/>),
2930           werden die folgenden Variablen erzeugt:</para>
2931
2932           <variablelist>
2933             <varlistentry>
2934               <term>ref_number_formatted</term>
2935
2936               <listitem>
2937                 <para>Referenznummer formatiert mit Leerzeichen, z.B.: 21 00000
2938                 00003 13947 14300 09017</para>
2939               </listitem>
2940             </varlistentry>
2941
2942             <varlistentry>
2943               <term>iban_formatted</term>
2944
2945               <listitem>
2946                 <para>IBAN formatiert mit Leerzeichen</para>
2947               </listitem>
2948             </varlistentry>
2949
2950             <varlistentry>
2951               <term>amount_formatted</term>
2952
2953               <listitem>
2954                 <para>Betrag formatiert mit Tausendertrennzeichen Leerschlag,
2955                 z.B.: 1 005.55</para>
2956               </listitem>
2957             </varlistentry>
2958           </variablelist>
2959         </sect3>
2960       </sect2>
2961     </sect1>
2962
2963     <sect1 id="nomenclature">
2964       <title>Nomenklatur</title>
2965
2966       <sect2 id="booking.dates">
2967         <title>Datum bei Buchungen</title>
2968
2969         <para>Seit der Version 3.5 werden für Buchungen in kivitendo
2970         einheitlich folgende Bezeichnungen verwendet:</para>
2971
2972         <itemizedlist>
2973           <listitem>
2974             <para><option>Erfassungsdatum</option> (en: <option>Entry
2975             Date</option>, code: <option>Gldate</option>)</para>
2976
2977             <para>bezeichnet das Datum, an dem die Buchung in kivitendo
2978             erfasst wurde.</para>
2979           </listitem>
2980
2981           <listitem>
2982             <para><option>Buchungsdatum</option> (en: <option>Booking
2983             Date</option>, code: <option>Transdate</option>)</para>
2984
2985             <para>bezeichnet das buchhaltungstechnisch für eine Buchung
2986             relevante Datum</para>
2987
2988             <para>Das <option>Rechnungsdatum</option> bei Verkaufs- und
2989             Einkaufsrechnungen entspricht dem Buchungsdatum. Das heisst, in
2990             Berichten wie dem Buchungsjournal, in denen eine Spalte
2991             <option>Buchungsdatum</option> angezeigt werden kann, erscheint
2992             hier im Fall von Rechnungen das Rechnungsdatum.</para>
2993           </listitem>
2994
2995           <listitem>
2996             <para>Bezieht sich ein verbuchter Beleg auf einen Zeitpunkt, der
2997             nicht mit dem Buchungsdatum übereinstimmt, so kann dieses Datum
2998             momentan in kivitendo nur unter Bemerkungen erfasst werden.</para>
2999
3000             <para>Möglicherweise wird für solche Fälle in einer späteren
3001             Version von kivitendo ein dritter Datumswert für Buchungen
3002             erstellt. (Beispiel: Einkaufsbeleg stammt aus einem früheren Jahr,
3003             das bereits buchhaltungstechnisch abgeschlossen wurde, und muss
3004             deshalb später verbucht werden.)</para>
3005           </listitem>
3006         </itemizedlist>
3007       </sect2>
3008     </sect1>
3009
3010     <sect1 id="config.eur">
3011       <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
3012       EUR</title>
3013
3014       <sect2 id="config.eur.introduction"
3015              xreflabel="Einführung in die Konfiguration zur EUR">
3016         <title>Einführung</title>
3017
3018         <para>kivitendo besaß bis inklusive Version 2.6.3 einen
3019         Konfigurationsparameter namens <varname>eur</varname>, der sich in der
3020         Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
3021         noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
3022         für alle Mandanten, die in dieser Installation benutzt wurden.</para>
3023
3024         <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
3025         die Mandantendatenbank verschoben und dabei auch gleich in drei
3026         Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
3027         steuern lässt.</para>
3028       </sect2>
3029
3030       <sect2 id="config.eur.parameters"
3031              xreflabel="Konfigurationsparameter für EUR">
3032         <title>Konfigurationsparameter</title>
3033
3034         <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
3035         Versteuerungsart und die Warenbuchungsmethode regeln:</para>
3036
3037         <variablelist>
3038           <varlistentry>
3039             <term><varname>profit_determination</varname></term>
3040
3041             <listitem>
3042               <para>Dieser Parameter legt die Berechnungsmethode für die
3043               Gewinnermittlung fest. Er enthält entweder
3044               <literal>balance</literal> für
3045               Betriebsvermögensvergleich/Bilanzierung oder
3046               <literal>income</literal> für die
3047               Einnahmen-Überschuss-Rechnung.</para>
3048             </listitem>
3049           </varlistentry>
3050
3051           <varlistentry>
3052             <term><varname>accounting_method</varname></term>
3053
3054             <listitem>
3055               <para>Dieser Parameter steuert die Buchungs- und
3056               Berechnungsmethoden für die Versteuerungsart. Er enthält
3057               entweder <literal>accrual</literal> für die Soll-Versteuerung
3058               oder <literal>cash</literal> für die Ist-Versteuerung.</para>
3059             </listitem>
3060           </varlistentry>
3061
3062           <varlistentry>
3063             <term><varname>inventory_system</varname></term>
3064
3065             <listitem>
3066               <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
3067               enthält entweder <literal>perpetual</literal> für die
3068               Bestandsmethode oder <literal>periodic</literal> für die
3069               Aufwandsmethode.</para>
3070             </listitem>
3071           </varlistentry>
3072         </variablelist>
3073
3074         <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
3075         <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
3076         Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
3077         bedeutete hingegen Bilanzierung, Soll-Versteuerung und
3078         Bestandsmethode.</para>
3079
3080         <para>Die Konfiguration "<varname>eur</varname>" unter
3081         <varname>[system]</varname> in der <link
3082         linkend="config.config-file">Konfigurationsdatei</link>
3083         <filename>config/kivitendo.conf</filename> wird nun nicht mehr
3084         benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
3085       </sect2>
3086
3087       <sect2 id="config.eur.setting-parameters">
3088         <title>Festlegen der Parameter</title>
3089
3090         <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
3091         der Admininstration können diese Optionen nun unabhängig voneinander
3092         eingestellt werden.</para>
3093
3094         <para>Für die Schweiz sind folgende Einstellungen üblich:
3095         <itemizedlist>
3096             <listitem>
3097               <para>Sollversteuerung</para>
3098             </listitem>
3099
3100             <listitem>
3101               <para>Aufwandsmethode</para>
3102             </listitem>
3103
3104             <listitem>
3105               <para>Bilanzierung</para>
3106             </listitem>
3107           </itemizedlist> Diese Einstellungen werden automatisch beim
3108         Erstellen einer neuen Datenbank vorausgewählt, wenn in
3109         <filename>config/kivitendo.conf</filename> unter
3110         <varname>[system]</varname> <literal>default_manager = swiss</literal>
3111         eingestellt ist.</para>
3112
3113         <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
3114         Variablen werden so gesetzt, daß sich an der Funktionalität nichts
3115         ändert.</para>
3116
3117         <para>Die aktuelle Konfiguration wird unter Nummernkreise und
3118         Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
3119         angezeigt. Unter <guimenu>System</guimenu> →
3120         <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
3121         Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
3122         Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
3123         verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
3124         auch <link linkend="config.eur.inventory-system-perpetual">
3125         Bemerkungen zur Bestandsmethode</link>).</para>
3126       </sect2>
3127
3128       <sect2 id="config.eur.inventory-system-perpetual">
3129         <title>Bemerkungen zur Bestandsmethode</title>
3130
3131         <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
3132         funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
3133         Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
3134         werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
3135         anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
3136         der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
3137         Einkaufsrechnungen berechnet wird.</para>
3138
3139         <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
3140         wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
3141         im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
3142         wechseln.</para>
3143       </sect2>
3144
3145       <sect2 id="config.eur.knonw-issues">
3146         <title>Bekannte Probleme</title>
3147
3148         <para>Bei bestimmten Berichten kann man derzeit noch inviduell
3149         einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
3150         werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
3151         Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
3152         die Konfigurationsvariable
3153         <varname>$::lx_office_conf{system}-&gt;{eur}</varname> ausgewertet
3154         wurde.</para>
3155
3156         <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
3157         Optionen bewirken, z.B. mit zwei Standardfällen.</para>
3158       </sect2>
3159     </sect1>
3160
3161     <sect1 id="config.skr04-update-3804">
3162       <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
3163
3164       <sect2 id="config.skr04-update-3804.introduction">
3165         <title>Einführung</title>
3166
3167         <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
3168         Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
3169         kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
3170         erstellt und die Steuereinstellungen korrekt einstellt. Hat der
3171         Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
3172         Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
3173         Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
3174         vielleicht schon selbst geholfen hat und mit seinen Änderungen
3175         zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
3176         ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
3177         Screenshots dargestellt.</para>
3178
3179         <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
3180         USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
3181         dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
3182         und diese Buchungen sollten entsprechend kontrolliert werden.</para>
3183       </sect2>
3184
3185       <sect2 id="config.skr04-update-3804.create-chart">
3186         <title>Konto 3804 manuell anlegen</title>
3187
3188         <para>Die folgenden Schritte sind notwendig, um das Konto manuell
3189         anzulegen und zu konfigurieren. Zuerst wird in
3190         <guimenu>System</guimenu> → <guisubmenu>Kontenübersicht</guisubmenu> →
3191         <guimenuitem>Konto erfassen</guimenuitem> das Konto angelegt.</para>
3192
3193         <screenshot>
3194           <screeninfo>Konto 3804 erfassen</screeninfo>
3195
3196           <mediaobject>
3197             <imageobject>
3198               <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
3199             </imageobject>
3200           </mediaobject>
3201         </screenshot>
3202
3203         <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
3204         werden. Dazu unter <guimenu>System</guimenu> →
3205         <guisubmenu>Steuern</guisubmenu> →
3206         <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
3207         13 auswählen und ihn wie im folgenden Screenshot angezeigt
3208         anpassen.</para>
3209
3210         <screenshot>
3211           <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
3212
3213           <mediaobject>
3214             <imageobject>
3215               <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
3216             </imageobject>
3217           </mediaobject>
3218         </screenshot>
3219
3220         <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
3221         Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
3222         <guisubmenu>Steuern</guisubmenu> → <guimenuitem>Erfassen</guimenuitem>
3223         auswählen und die Werte aus dem Screenshot übernehmen.</para>
3224
3225         <screenshot>
3226           <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
3227
3228           <mediaobject>
3229             <imageobject>
3230               <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
3231             </imageobject>
3232           </mediaobject>
3233         </screenshot>
3234
3235         <para>Als Nächstes sind alle Konten anzupassen, die als
3236         Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
3237         Steuerautomatik auf 3804 bekommen. Dies betrifft in der
3238         Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
3239         müssen Sie dazu unter <guimenu>System</guimenu> →
3240         <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
3241         anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
3242         wie im Screenshot gezeigt vornehmen.</para>
3243
3244         <screenshot>
3245           <screeninfo>Konto 4315 anpassen</screeninfo>
3246
3247           <mediaobject>
3248             <imageobject>
3249               <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
3250             </imageobject>
3251           </mediaobject>
3252         </screenshot>
3253
3254         <para>Als Letztes sollte die Steuerliste unter
3255         <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
3256         <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
3257         Vergleich der Screenshot.</para>
3258
3259         <screenshot>
3260           <screeninfo>Steuerliste vergleichen</screeninfo>
3261
3262           <mediaobject>
3263             <imageobject>
3264               <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
3265             </imageobject>
3266           </mediaobject>
3267         </screenshot>
3268       </sect2>
3269     </sect1>
3270
3271     <sect1 id="config.bilanz">
3272       <title>Verhalten des Bilanzberichts</title>
3273
3274       <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
3275       Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
3276       monatsweise führt dies zu falschen Werten.</para>
3277
3278       <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
3279       einstellen indem man:</para>
3280
3281       <itemizedlist>
3282         <listitem>
3283           <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
3284           vorher)</para>
3285         </listitem>
3286
3287         <listitem>
3288           <para>immer den Jahresanfang nimmt (1.1. relativ zum
3289           Stichtag)</para>
3290         </listitem>
3291
3292         <listitem>
3293           <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
3294
3295           <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3296           gibt</para>
3297
3298           <para>- oder mit "alle Buchungen" als Alternative"</para>
3299         </listitem>
3300
3301         <listitem>
3302           <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3303           gibt</para>
3304         </listitem>
3305
3306         <listitem>
3307           <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
3308         </listitem>
3309       </itemizedlist>
3310
3311       <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
3312       ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
3313       = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
3314       Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
3315       durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
3316       sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
3317       und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
3318       den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
3319       Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
3320       Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
3321       Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
3322       Erfolgsrechnung.</para>
3323     </sect1>
3324
3325     <sect1 id="config.erfolgsrechnung">
3326       <title>Erfolgsrechnung</title>
3327
3328       <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht
3329       <emphasis role="bold"> Erfolgsrechnung</emphasis>.</para>
3330
3331       <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter
3332       Features an- oder abgeschaltet werden. Mit der Einstellung
3333       <varname>default_manager = swiss </varname> in der
3334       <filename>config/kivitendo.conf</filename> wird beim neu Erstellen einer
3335       Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü
3336       <guimenu>Berichte </guimenu> ausgewählt und ersetzt dort die GUV.</para>
3337
3338       <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche
3339       Aufwands- und Erlöskonten einzeln aufgelistet (analog zur Bilanz),
3340       sortiert nach ERTRAG und AUFWAND.</para>
3341
3342       <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der
3343       Erfolgsrechnung erscheinen soll, unter <varname>Sonstige
3344       Einstellungen/Erfolgsrechnung</varname> entweder
3345       <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal>
3346       ausgewählt werden.</para>
3347
3348       <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal>
3349       ausgewählt, so wird dieses Konto als Aufwandsminderung unter AUFWAND
3350       aufgelistet.</para>
3351
3352       <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal>
3353       ausgewählt, so wird dieses Konto als Ertragsminderung unter ERTRAG
3354       aufgelistet.</para>
3355
3356       <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft
3357       zusätzlich die Erfolgsrechnung als Bericht verwendet werden, so müssen
3358       die Einstellungen zu allen Erlös- und Aufwandskonten unter
3359       <varname>Sonstige Einstellungen/Erfolgsrechnung</varname> überprüft und
3360       allenfalls neu gesetzt werden.</para>
3361     </sect1>
3362
3363     <sect1 id="config.rounding">
3364       <title>Rundung in Verkaufsbelegen</title>
3365
3366       <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert
3367       von 5 Rappen (0.05 CHF).</para>
3368
3369       <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer
3370       Genauigkeit von 0.01 CHF verwendet werden können, ist es trotzdem nach
3371       wie vor üblich, Rechnungen mit auf 0.05 CHF gerundeten Beträgen
3372       auszustellen.</para>
3373
3374       <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine
3375       solche Rundung pro Mandant / Datenbank festgelegt werden.</para>
3376
3377       <para>Die Einstellung wird beim Erstellen der Datenbank bei
3378       <literal>Genauigkeit</literal> festgelegt. Sie kann anschliessend über
3379       das Webinterface von kivitendo nicht mehr verändert werden.</para>
3380
3381       <para>Abhängig vom Wert für <varname>default_manager</varname> in
3382       <filename>config/kivitendo.conf</filename> werden dabei folgende Werte
3383       voreingestellt:</para>
3384
3385       <itemizedlist>
3386         <listitem>
3387           <para>0.05 (default_manager = swiss)</para>
3388         </listitem>
3389
3390         <listitem>
3391           <para>0.01 (default_manager = german)</para>
3392         </listitem>
3393       </itemizedlist>
3394
3395       <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
3396       </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
3397
3398       <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
3399       und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet, wenn
3400       dieser nicht der eingestellten Genauigkeit entspricht.</para>
3401
3402       <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
3403       automatisch auf die in der Mandantenkonfiguration festgelegten
3404       Standardkonten für Rundungserträge bzw. Rundungsaufwendungen
3405       gebucht.</para>
3406
3407       <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr
3408       verändert.)</para>
3409
3410       <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
3411       <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
3412       <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
3413
3414       <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege in
3415       anderen Währungen als der Standardwährung erstellt, so muss in kivitendo
3416       ab Version 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
3417
3418       <para>Das heisst, Firmen in der Schweiz, die teilweise
3419       Verkaufsrechnungen in Euro oder anderen Währungen erstellen wollen,
3420       müssen beim Erstellen der Datenbank als Genauigkeit 0.01 wählen und
3421       können zur Zeit die 5er Rundung noch nicht nutzen.</para>
3422     </sect1>
3423
3424     <sect1 id="config.client">
3425       <title>Einstellungen pro Mandant</title>
3426
3427       <para>Einige Einstellungen können von einem Benutzer mit dem <link
3428       linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
3429       der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
3430       Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3431       Die Einstellungen sind unter <guimenu>System</guimenu> →
3432       <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3433
3434       <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3435       Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3436       geändert werden (siehe auch <link
3437       linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3438       Bestandsmethode</link>).</para>
3439
3440       <para>Die Einstellungen <literal>show_bestbefore</literal> und
3441       <literal>payments_changeable</literal> aus dem Abschnitt
3442       <literal>features</literal> und die Einstellungen im Abschnitt
3443       <literal>datev_check</literal> (sofern schon vorhanden) der <link
3444       linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3445       bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3446       Diese Einträge können danach aus der Konfigurationsdatei entfernt
3447       werden.</para>
3448     </sect1>
3449
3450     <sect1 id="kivitendo-ERP-verwenden">
3451       <title>kivitendo ERP verwenden</title>
3452
3453       <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3454       folgender URL erreichbar:</para>
3455
3456       <para><ulink
3457       url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3458
3459       <para>Die Administrationsseite erreichen Sie unter:</para>
3460
3461       <para><ulink
3462       url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3463     </sect1>
3464   </chapter>
3465
3466   <chapter id="features" xreflabel="Features und Funktionen">
3467     <title>Features und Funktionen</title>
3468
3469     <sect1 id="features.periodic-invoices"
3470            xreflabel="Wiederkehrende Rechnungen">
3471       <title>Wiederkehrende Rechnungen</title>
3472
3473       <sect2 id="features.periodic-invoices.introduction"
3474              xreflabel="Einführung in wiederkehrende Rechnungen">
3475         <title>Einführung</title>
3476
3477         <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3478         und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3479         Die konfigurierten Aufträge werden später automatisch in Rechnungen
3480         umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3481         Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3482         Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3483         wiederzufinden sind.</para>
3484       </sect2>
3485
3486       <sect2 id="features.periodic-invoices.configuration"
3487              xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3488         <title>Konfiguration</title>
3489
3490         <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3491         findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3492         "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3493         Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3494         angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3495         oder nicht.</para>
3496
3497         <para>Folgende Parameter kann man konfigurieren:</para>
3498
3499         <variablelist>
3500           <varlistentry>
3501             <term>Status</term>
3502
3503             <listitem>
3504               <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3505               erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3506               eines neuen Monats).</para>
3507
3508               <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3509               wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3510               nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3511               nächsten Periodenwechsel für alle Perioden, seit der letzten
3512               aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3513               verhindern, muss man vorher das Startdatum neu setzen.</para>
3514
3515               <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3516               erstellt. Man kann sich diese Aufträge aber gesondert in den
3517               Berichten anzeigen lassen.</para>
3518             </listitem>
3519           </varlistentry>
3520
3521           <varlistentry>
3522             <term>Periodizität</term>
3523
3524             <listitem>
3525               <para>Ob monatlich, quartalsweise oder jährlich auf neue
3526               Rechnungen überprüft werden soll. Für jede Periode seit dem
3527               Startdatum wird überprüft, ob für die Periode (beginnend immer
3528               mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3529               wurde. Unter Umständen können bei einem Startdatum in der
3530               Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3531             </listitem>
3532           </varlistentry>
3533
3534           <varlistentry>
3535             <term>Buchen auf</term>
3536
3537             <listitem>
3538               <para>Das Forderungskonto, in der Regel "Forderungen aus
3539               Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3540               Buchungsgruppen der betreffenden Waren.</para>
3541             </listitem>
3542           </varlistentry>
3543
3544           <varlistentry>
3545             <term>Startdatum</term>
3546
3547             <listitem>
3548               <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3549               soll</para>
3550             </listitem>
3551           </varlistentry>
3552
3553           <varlistentry>
3554             <term>Enddatum</term>
3555
3556             <listitem>
3557               <para>ab wann keine Rechnungen mehr erstellt werden
3558               sollen</para>
3559             </listitem>
3560           </varlistentry>
3561
3562           <varlistentry>
3563             <term>Automatische Verlängerung um x Monate</term>
3564
3565             <listitem>
3566               <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3567               eingetragenen Enddatums weiterhin erstellt werden, so kann man
3568               hier die Anzahl der Monate eingeben, um die das Enddatum
3569               automatisch nach hinten geschoben wird.</para>
3570             </listitem>
3571           </varlistentry>
3572
3573           <varlistentry>
3574             <term>Drucken</term>
3575
3576             <listitem>
3577               <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3578               Rechnungen auch gleich ausdrucken lassen.</para>
3579             </listitem>
3580           </varlistentry>
3581         </variablelist>
3582
3583         <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3584         Informationen zu den erstellten Rechnungen verschickt werden.
3585         Konfiguriert wird dies in der <link
3586         linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3587         <filename>config/kivitendo.conf</filename> im Abschnitt
3588         <varname>[periodic_invoices]</varname>.</para>
3589       </sect2>
3590
3591       <sect2 id="features.periodic-invoices.variables">
3592         <title>Spezielle Variablen</title>
3593
3594         <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3595         beim Umwandeln des Auftrags in eine Rechnung einige speziell
3596         formatierte Variablen durch für die jeweils aktuelle
3597         Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3598         den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3599         die Syntax <literal>&lt;%variablenname%&gt;</literal>.</para>
3600
3601         <para>Sofern es sich um eine Datumsvariable handelt, kann das
3602         Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3603         Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3604         <literal>&lt;%variablenname FORMAT=Formatinformation%&gt;</literal>.
3605         Die zur verfügung stehenden Formatinformationen werden unten genauer
3606         beschrieben.</para>
3607
3608         <para>Diese Variablen können auch beim automatischen Versand der
3609         erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3610         Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3611
3612         <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3613         ersetzt:</para>
3614
3615         <itemizedlist>
3616           <listitem>
3617             <para>Bemerkungen</para>
3618           </listitem>
3619
3620           <listitem>
3621             <para>Interne Bemerkungen</para>
3622           </listitem>
3623
3624           <listitem>
3625             <para>Vorgangsbezeichnung</para>
3626           </listitem>
3627
3628           <listitem>
3629             <para>In den Beschreibungs- und Langtextfeldern aller
3630             Positionen</para>
3631           </listitem>
3632         </itemizedlist>
3633
3634         <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3635
3636         <variablelist>
3637           <varlistentry>
3638             <term><varname>&lt;%current_quarter%&gt;</varname>,
3639             <varname>&lt;%previous_quarter%&gt;</varname>,
3640             <varname>&lt;%next_quarter%&gt;</varname></term>
3641
3642             <listitem>
3643               <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3644               zwischen <literal>1</literal> und <literal>4</literal>.</para>
3645             </listitem>
3646           </varlistentry>
3647
3648           <varlistentry>
3649             <term><varname>&lt;%current_month%&gt;</varname>,
3650             <varname>&lt;%previous_month%&gt;</varname>,
3651             <varname>&lt;%next_month%&gt;</varname></term>
3652
3653             <listitem>
3654               <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3655               <literal>1</literal> und <literal>12</literal>.</para>
3656             </listitem>
3657           </varlistentry>
3658
3659           <varlistentry>
3660             <term><varname>&lt;%current_month_long%&gt;</varname>,
3661             <varname>&lt;%previous_month_long%&gt;</varname>,
3662             <varname>&lt;%next_month_long%&gt;</varname></term>
3663
3664             <listitem>
3665               <para>Aktueller, vorheriger und nächster Monat als Name
3666               (<literal>Januar</literal>, <literal>Februar</literal>
3667               etc.).</para>
3668             </listitem>
3669           </varlistentry>
3670
3671           <varlistentry>
3672             <term><varname>&lt;%current_year%&gt;</varname>,
3673             <varname>&lt;%previous_year%&gt;</varname>,
3674             <varname>&lt;%next_year%&gt;</varname></term>
3675
3676             <listitem>
3677               <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3678               Jahreszahl (<literal>2013</literal> etc.).</para>
3679             </listitem>
3680           </varlistentry>
3681
3682           <varlistentry>
3683             <term><varname>&lt;%period_start_date%&gt;</varname>,
3684             <varname>&lt;%period_end_date%&gt;</varname></term>
3685
3686             <listitem>
3687               <para>Formatiertes Datum des ersten und letzten Tages im
3688               Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3689               ersten Quartal von 2013 wären dies der
3690               <literal>01.01.2013</literal> und
3691               <literal>31.03.2013</literal>).</para>
3692             </listitem>
3693           </varlistentry>
3694         </variablelist>
3695
3696         <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3697         Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3698         dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3699         durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3700         sind:</para>
3701
3702         <variablelist>
3703           <varlistentry>
3704             <term><varname>%a</varname></term>
3705
3706             <listitem>
3707               <para>Der abgekürzte Wochentagsname.</para>
3708             </listitem>
3709           </varlistentry>
3710
3711           <varlistentry>
3712             <term><varname>%A</varname></term>
3713
3714             <listitem>
3715               <para>Der ausgeschriebene Wochentagsname.</para>
3716             </listitem>
3717           </varlistentry>
3718
3719           <varlistentry>
3720             <term><varname>%b</varname></term>
3721
3722             <listitem>
3723               <para>Der abgekürzte Monatsname.</para>
3724             </listitem>
3725           </varlistentry>
3726
3727           <varlistentry>
3728             <term><varname>%B</varname></term>
3729
3730             <listitem>
3731               <para>Der ausgeschriebene Monatsname.</para>
3732             </listitem>
3733           </varlistentry>
3734
3735           <varlistentry>
3736             <term><varname>%C</varname></term>
3737
3738             <listitem>
3739               <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3740               Zahl.</para>
3741             </listitem>
3742           </varlistentry>
3743
3744           <varlistentry>
3745             <term><varname>%d</varname></term>
3746
3747             <listitem>
3748               <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3749             </listitem>
3750           </varlistentry>
3751
3752           <varlistentry>
3753             <term><varname>%D</varname></term>
3754
3755             <listitem>
3756               <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3757             </listitem>
3758           </varlistentry>
3759
3760           <varlistentry>
3761             <term><varname>%e</varname></term>
3762
3763             <listitem>
3764               <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3765               werden führende Nullen durch Leerzeichen ersetzt.</para>
3766             </listitem>
3767           </varlistentry>
3768
3769           <varlistentry>
3770             <term><varname>%F</varname></term>
3771
3772             <listitem>
3773               <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3774             </listitem>
3775           </varlistentry>
3776
3777           <varlistentry>
3778             <term><varname>%j</varname></term>
3779
3780             <listitem>
3781               <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3782               inklusive.</para>
3783             </listitem>
3784           </varlistentry>
3785
3786           <varlistentry>
3787             <term><varname>%m</varname></term>
3788
3789             <listitem>
3790               <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3791             </listitem>
3792           </varlistentry>
3793
3794           <varlistentry>
3795             <term><varname>%u</varname></term>
3796
3797             <listitem>
3798               <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3799               die 1 dem Montag entspricht.</para>
3800             </listitem>
3801           </varlistentry>
3802
3803           <varlistentry>
3804             <term><varname>%U</varname></term>
3805
3806             <listitem>
3807               <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3808               wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3809               ist.</para>
3810             </listitem>
3811           </varlistentry>
3812
3813           <varlistentry>
3814             <term><varname>%V</varname></term>
3815
3816             <listitem>
3817               <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3818               inklusive, wobei Woche 01 die erste Woche, von der mindestens
3819               vier Tage im Jahr liegen; Montag ist erster Tag der
3820               Woche.</para>
3821             </listitem>
3822           </varlistentry>
3823
3824           <varlistentry>
3825             <term><varname>%w</varname></term>
3826
3827             <listitem>
3828               <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3829               die 0 dem Sonntag entspricht.</para>
3830             </listitem>
3831           </varlistentry>
3832
3833           <varlistentry>
3834             <term><varname>%W</varname></term>
3835
3836             <listitem>
3837               <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3838               wobei der erste Montag im Jahr das Startdatum von Woche 01
3839               ist.</para>
3840             </listitem>
3841           </varlistentry>
3842
3843           <varlistentry>
3844             <term><varname>%y</varname></term>
3845
3846             <listitem>
3847               <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3848               inklusive.</para>
3849             </listitem>
3850           </varlistentry>
3851
3852           <varlistentry>
3853             <term><varname>%Y</varname></term>
3854
3855             <listitem>
3856               <para>Das Jahr als vierstellige Zahl.</para>
3857             </listitem>
3858           </varlistentry>
3859
3860           <varlistentry>
3861             <term><varname>%%</varname></term>
3862
3863             <listitem>
3864               <para>Das Prozentzeichen selber.</para>
3865             </listitem>
3866           </varlistentry>
3867         </variablelist>
3868
3869         <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3870         bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3871         <literal>Abrechnungszeitrum: &lt;%period_start_date FORMAT=%m/%Y%&gt;
3872         bis &lt;%period_end_date FORMAT=%m/%Y%&gt;</literal></para>
3873
3874         <para>Beim automatischen Versand der Rechnugen via E-Mail können neben diesen speziellen Variablen auch einige Eigenschaften der
3875         Rechnung selber als Variablen im Betreff &amp; dem Text der E-Mails genutzt werden. Beispiele sind
3876         <varname>&lt;%invnumber%&gt;</varname> für die Rechnungsnummber oder <varname>&lt;transaction_description%&gt;</varname> für die
3877         Vorgangsbezeichnung. Diese Variablen stehen beim Erzeugen der Rechnung logischerweise noch nicht zur Verfügung.</para>
3878       </sect2>
3879
3880       <sect2 id="features.periodic-invoices.reports">
3881         <title>Auflisten</title>
3882
3883         <para>Unter Verkauf-&gt;Berichte-&gt;Aufträge finden sich zwei neue
3884         Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3885         Rechnungen inaktiv", mit denen man sich einen Überglick über die
3886         wiederkehrenden Rechnungen verschaffen kann.</para>
3887       </sect2>
3888
3889       <sect2 id="features.periodic-invoices.task-server">
3890         <title>Erzeugung der eigentlichen Rechnungen</title>
3891
3892         <para>Die zeitliche und periodische Überprüfung, ob eine
3893         wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3894         durch den <link linkend="config.task-server">Task-Server</link>, einen
3895         externen Dienst, der automatisch beim Start des Servers gestartet
3896         werden sollte.</para>
3897       </sect2>
3898
3899       <sect2 id="features.periodic-invoices.create-for-current-month">
3900         <title>Erste Rechnung für aktuellen Monat erstellen</title>
3901
3902         <para>Will man im laufenden Monat eine monatlich wiederkehrende
3903         Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3904         auf den Monatsanfang und wartet ein paar Minuten, bis der Task-Server
3905         den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3906         generiert hat. Alternativ setzt man das Startdatum auf den
3907         Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3908         manuell über den Workflow.</para>
3909       </sect2>
3910     </sect1>
3911
3912     <sect1 id="features.bank" xreflabel="bankerweiterung">
3913       <title>Bankerweiterung</title>
3914
3915       <sect2 id="features.bank.introduction"
3916              xreflabel="Einführung in die Bankerweiterung">
3917         <title>Einführung</title>
3918
3919         <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3920         im Wiki und soll von dort später hierhin übernommen werden:</para>
3921
3922         <para><ulink
3923         url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3924       </sect2>
3925     </sect1>
3926
3927     <sect1 id="dokumentenvorlagen-und-variablen">
3928       <title>Dokumentenvorlagen und verfügbare Variablen</title>
3929
3930       <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3931         <title>Einführung</title>
3932
3933         <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3934         aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3935         einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3936         <function>&lt;%variablenname%&gt;</function> verwendet wird. Für
3937         LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3938         (siehe <xref
3939         linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3940
3941         <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3942         Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im Folgenden
3943         gesagte für alle Vorlagenarten.</para>
3944
3945         <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3946         verfügbar als hier aufgelistet werden. Die meisten davon können
3947         allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3948         werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3949         diese wie folgt erhalten werden:</para>
3950
3951         <itemizedlist>
3952           <listitem>
3953             <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3954             Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3955           </listitem>
3956
3957           <listitem>
3958             <para>In <filename>Form.pm</filename> die Funktion
3959             <function>parse_template</function> suchen und hier die Zeile
3960             <command>print(STDERR Dumper($self));</command> einfügen.</para>
3961           </listitem>
3962
3963           <listitem>
3964             <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3965             ein PDF für eine Rechnung erzeugen.</para>
3966           </listitem>
3967
3968           <listitem>
3969             <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3970             der Variablen <varname>$self</varname> in der Form <varname>'key'
3971             =&gt; 'value',</varname>. Alle <varname>key</varname>s sind
3972             verfügbar.</para>
3973           </listitem>
3974         </itemizedlist>
3975       </sect2>
3976
3977       <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3978         <title>Variablen ausgeben</title>
3979
3980         <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3981         Tags geschrieben werden, also z.B.
3982         <varname>&lt;%variablenname%&gt;</varname>.</para>
3983
3984         <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3985         die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3986         <varname>&lt;%variablenname FLAG1 FLAG2%&gt;</varname>. Momentan
3987         werden die folgenden Flags unterstützt:</para>
3988
3989         <itemizedlist>
3990           <listitem>
3991             <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3992             den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3993             mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3994             damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3995           </listitem>
3996
3997           <listitem>
3998             <para><option>NOESCAPE</option> unterdrückt das Escapen von
3999             Sonderzeichen für die Vorlagensprache. Wenn also in einer
4000             Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
4001             auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
4002             ist dieses Flag sinnvoll.</para>
4003           </listitem>
4004         </itemizedlist>
4005
4006         <para>Beispiel:</para>
4007
4008         <programlisting>&lt;%quototal NOFORMAT%&gt;</programlisting>
4009       </sect2>
4010
4011       <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
4012         <title>Verwendung in Druckbefehlen</title>
4013
4014         <para>In der Admininstration können Drucker definiert werden. Auch im
4015         dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
4016         und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
4017         den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
4018         <function>`...`</function> nicht zu unerwünschtem Verhalten
4019         führen.</para>
4020
4021         <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
4022         für das die Telefonnummer eines Ansprechpartners als Teil der
4023         Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
4024         z.B. wie folgt aussehen:</para>
4025
4026         <programlisting>send_fax --number &lt;%if cp_phone2%&gt;&lt;%cp_phone2%&gt;&lt;%else%&gt;&lt;%cp_phone1%&gt;&lt;%end%&gt;</programlisting>
4027       </sect2>
4028
4029       <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
4030              xreflabel="Anfang und Ende der Tags verändern">
4031         <title>Anfang und Ende der Tags verändern</title>
4032
4033         <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
4034         Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
4035         Prozentzeichen und dem Größerzeichen endet, beispielsweise
4036         <function>&lt;%customer%&gt;</function>. Da diese Form aber z.B. in
4037         LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
4038         Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
4039         Stil umgestellt werden.</para>
4040
4041         <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
4042         Format gültigen Kommentarzeichen anfangen, dann
4043         <function>config:</function> enthalten, die entsprechende Option
4044         setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
4045         enden. Beispiel für LaTeX:</para>
4046
4047         <programlisting>% config: tag-style=($ $)</programlisting>
4048
4049         <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
4050         wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
4051         äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
4052
4053         <programlisting>&lt;!-- config: tag-style=($ $) --&gt;</programlisting>
4054       </sect2>
4055
4056       <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
4057         <title>Zuordnung von den Dateinamen zu den Funktionen</title>
4058
4059         <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
4060         welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
4061         "<filename>.ext</filename>" geeignet zu ersetzen:
4062         "<filename>.tex</filename>" für LaTeX-Vorlagen und
4063         "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
4064
4065         <variablelist>
4066           <varlistentry>
4067             <term><filename>bin_list.ext</filename></term>
4068
4069             <listitem>
4070               <para>Lagerliste</para>
4071             </listitem>
4072           </varlistentry>
4073
4074           <varlistentry>
4075             <term><filename>check.ext</filename></term>
4076
4077             <listitem>
4078               <para>?</para>
4079             </listitem>
4080           </varlistentry>
4081
4082           <varlistentry>
4083             <term><filename>invoice.ext</filename></term>
4084
4085             <listitem>
4086               <para>Rechnung</para>
4087             </listitem>
4088           </varlistentry>
4089
4090           <varlistentry>
4091             <term><filename>packing_list.ext</filename></term>
4092
4093             <listitem>
4094               <para>Packliste</para>
4095             </listitem>
4096           </varlistentry>
4097
4098           <varlistentry>
4099             <term><filename>pick_list.ext</filename></term>
4100
4101             <listitem>
4102               <para>Sammelliste</para>
4103             </listitem>
4104           </varlistentry>
4105
4106           <varlistentry>
4107             <term><filename>purchase_delivery_order.ext</filename></term>
4108
4109             <listitem>
4110               <para>Lieferschein (Einkauf)</para>
4111             </listitem>
4112           </varlistentry>
4113
4114           <varlistentry>
4115             <term><filename>purcharse_order.ext</filename></term>
4116
4117             <listitem>
4118               <para>Bestellung an Lieferanten</para>
4119             </listitem>
4120           </varlistentry>
4121
4122           <varlistentry>
4123             <term><filename>request_quotation.ext</filename></term>
4124
4125             <listitem>
4126               <para>Anfrage an Lieferanten</para>
4127             </listitem>
4128           </varlistentry>
4129
4130           <varlistentry>
4131             <term><filename>sales_delivery_order.ext</filename></term>
4132
4133             <listitem>
4134               <para>Lieferschein (Verkauf)</para>
4135             </listitem>
4136           </varlistentry>
4137
4138           <varlistentry>
4139             <term><filename>sales_order.ext</filename></term>
4140
4141             <listitem>
4142               <para>Bestellung</para>
4143             </listitem>
4144           </varlistentry>
4145
4146           <varlistentry>
4147             <term><filename>sales_quotation.ext</filename></term>
4148
4149             <listitem>
4150               <para>Angebot an Kunden</para>
4151             </listitem>
4152           </varlistentry>
4153
4154           <varlistentry>
4155             <term><filename>zahlungserinnerung.ext</filename></term>
4156
4157             <listitem>
4158               <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
4159             </listitem>
4160           </varlistentry>
4161
4162           <varlistentry>
4163             <term><filename>zahlungserinnerung_invoice.ext</filename></term>
4164
4165             <listitem>
4166               <para>Rechnung über Mahngebühren (Dateiname im Programm
4167               konfigurierbar)</para>
4168             </listitem>
4169           </varlistentry>
4170         </variablelist>
4171       </sect2>
4172
4173       <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
4174         <title>Sprache, Drucker und E-Mail</title>
4175
4176         <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
4177         eingearbeitet. So wird aus der Vorlage
4178         <filename>sales_order.ext</filename> bei Sprache
4179         <function>de</function> und Druckerkürzel <function>lpr2</function>
4180         der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
4181         Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
4182         bekommen dann noch das Kürzel <filename>_email</filename>, der
4183         vollständige Vorlagenname wäre dann
4184         <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
4185         kann eine Standarddatei <filename>default.ext</filename> hinterlegt
4186         werden. Diese wird verwendet, wenn keine der anderen Varianten
4187         gefunden wird.</para>
4188
4189         <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
4190         der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
4191         verschickt wird, ist:</para>
4192
4193         <orderedlist>
4194           <listitem>
4195             <para><filename>sales_order_email_de_lpr2.tex</filename></para>
4196           </listitem>
4197
4198           <listitem>
4199             <para><filename>sales_order_de_lpr2.tex</filename></para>
4200           </listitem>
4201
4202           <listitem>
4203             <para><filename>sales_order.tex</filename></para>
4204           </listitem>
4205
4206           <listitem>
4207             <para><filename>default.tex</filename></para>
4208           </listitem>
4209         </orderedlist>
4210
4211         <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
4212         Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
4213         siehe dazu <xref
4214         linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
4215       </sect2>
4216
4217       <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
4218         <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
4219         sind</title>
4220
4221         <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
4222                xreflabel="Metainformationen zur angeforderten Vorlage">
4223           <title>Metainformationen zur angeforderten Vorlage</title>
4224
4225           <para>Diese Variablen liefern Informationen darüber welche Variante
4226           einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
4227           Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
4228           Formulare einbinden möchten.</para>
4229
4230           <variablelist>
4231             <varlistentry>
4232               <term><varname>template_meta.formname</varname></term>
4233
4234               <listitem>
4235                 <para>Basisname der Vorlage. Identisch mit der <link
4236                 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
4237                 zu den Dateinamen</link> ohne die Erweiterung. Ein
4238                 Verkaufsauftrag enthält hier
4239                 <constant>sales_order</constant>.</para>
4240               </listitem>
4241             </varlistentry>
4242
4243             <varlistentry>
4244               <term><varname>template_meta.language.description</varname></term>
4245
4246               <listitem>
4247                 <para>Beschreibung der verwendeten Sprache</para>
4248               </listitem>
4249             </varlistentry>
4250
4251             <varlistentry>
4252               <term><varname>template_meta.language.template_code</varname></term>
4253
4254               <listitem>
4255                 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
4256                 dem Kürzel das im Dateinamen verwendetet wird.</para>
4257               </listitem>
4258             </varlistentry>
4259
4260             <varlistentry>
4261               <term><varname>template_meta.language.output_numberformat</varname></term>
4262
4263               <listitem>
4264                 <para>Zahlenformat der verwendeten Sprache in der Form
4265                 "<constant>1.000,00</constant>". Experimentell! Nur
4266                 interessant für Vorlagen die mit unformatierten Werten
4267                 arbeiten.</para>
4268               </listitem>
4269             </varlistentry>
4270
4271             <varlistentry>
4272               <term><varname>template_meta.language.output_dateformat</varname></term>
4273
4274               <listitem>
4275                 <para>Datumsformat der verwendeten Sprache in der Form
4276                 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
4277                 interessant für Vorlagen die mit unformatierten Werten
4278                 arbeiten.</para>
4279               </listitem>
4280             </varlistentry>
4281
4282             <varlistentry>
4283               <term><varname>template_meta.format</varname></term>
4284
4285               <listitem>
4286                 <para>Das angeforderte Format. Kann im Moment die Werte
4287                 <constant>pdf</constant>, <constant>postscript</constant>,
4288                 <constant>html</constant>, <constant>opendocument</constant>,
4289                 <constant>opendocument_pdf</constant> und
4290                 <constant>excel</constant> enthalten.</para>
4291               </listitem>
4292             </varlistentry>
4293
4294             <varlistentry>
4295               <term><varname>template_meta.extension</varname></term>
4296
4297               <listitem>
4298                 <para>Dateierweiterung, wie im Dateinamen. Wird aus
4299                 <constant>format</constant> entschieden.</para>
4300               </listitem>
4301             </varlistentry>
4302
4303             <varlistentry>
4304               <term><varname>template_meta.media</varname></term>
4305
4306               <listitem>
4307                 <para>Ausgabemedium. Kann zur Zeit die Werte
4308                 <constant>screen</constant> für Bildschirm,
4309                 <constant>email</constant> für E-Mail (triggert das
4310                 <constant>_email</constant> Kürzel im Dateinamen),
4311                 <constant>printer</constant> für Drucker, und
4312                 <constant>queue</constant> für Warteschlange enthalten.</para>
4313               </listitem>
4314             </varlistentry>
4315
4316             <varlistentry>
4317               <term><varname>template_meta.printer.description</varname></term>
4318
4319               <listitem>
4320                 <para>Beschreibung des ausgewählten Druckers</para>
4321               </listitem>
4322             </varlistentry>
4323
4324             <varlistentry>
4325               <term><varname>template_meta.printer.template_code</varname></term>
4326
4327               <listitem>
4328                 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
4329                 dem Kürzel das im Dateinamen verwendetet wird.</para>
4330               </listitem>
4331             </varlistentry>
4332
4333             <varlistentry>
4334               <term><varname>template_meta.tmpfile</varname></term>
4335
4336               <listitem>
4337                 <para>Datei-Prefix für temporäre Dateien.</para>
4338               </listitem>
4339             </varlistentry>
4340           </variablelist>
4341         </sect3>
4342
4343         <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
4344           <title>Stammdaten von Kunden und Lieferanten</title>
4345
4346           <variablelist>
4347             <varlistentry>
4348               <term><varname>account_number</varname></term>
4349
4350               <listitem>
4351                 <para>Kontonummer</para>
4352               </listitem>
4353             </varlistentry>
4354
4355             <varlistentry>
4356               <term><varname>bank</varname></term>
4357
4358               <listitem>
4359                 <para>Name der Bank</para>
4360               </listitem>
4361             </varlistentry>
4362
4363             <varlistentry>
4364               <term><varname>bank_code</varname></term>
4365
4366               <listitem>
4367                 <para>Bankleitzahl</para>
4368               </listitem>
4369             </varlistentry>
4370
4371             <varlistentry>
4372               <term><varname>bic</varname></term>
4373
4374               <listitem>
4375                 <para>Bank-Identifikations-Code (Bank Identifier Code,
4376                 BIC)</para>
4377               </listitem>
4378             </varlistentry>
4379
4380             <varlistentry>
4381               <term><varname>business</varname></term>
4382
4383               <listitem>
4384                 <para>Kunden-/Lieferantentyp</para>
4385               </listitem>
4386             </varlistentry>
4387
4388             <varlistentry>
4389               <term><varname>city</varname></term>
4390
4391               <listitem>
4392                 <para>Stadt</para>
4393               </listitem>
4394             </varlistentry>
4395
4396             <varlistentry>
4397               <term><varname>contact</varname></term>
4398
4399               <listitem>
4400                 <para>Kontakt</para>
4401               </listitem>
4402             </varlistentry>
4403
4404             <varlistentry>
4405               <term><varname>country</varname></term>
4406
4407               <listitem>
4408                 <para>Land</para>
4409               </listitem>
4410             </varlistentry>
4411
4412             <varlistentry>
4413               <term><varname>c_vendor_id</varname></term>
4414
4415               <listitem>
4416                 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
4417               </listitem>
4418             </varlistentry>
4419
4420             <varlistentry>
4421               <term><varname>v_customer_id</varname></term>
4422
4423               <listitem>
4424                 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
4425               </listitem>
4426             </varlistentry>
4427
4428             <varlistentry>
4429               <term><varname>cp_email</varname></term>
4430
4431               <listitem>
4432                 <para>Email des Ansprechpartners</para>
4433               </listitem>
4434             </varlistentry>
4435
4436             <varlistentry>
4437               <term><varname>cp_givenname</varname></term>
4438
4439               <listitem>
4440                 <para>Vorname des Ansprechpartners</para>
4441               </listitem>
4442             </varlistentry>
4443
4444             <varlistentry>
4445               <term><varname>cp_greeting</varname></term>
4446
4447               <listitem>
4448                 <para>Anrede des Ansprechpartners</para>
4449               </listitem>
4450             </varlistentry>
4451
4452             <varlistentry>
4453               <term><varname>cp_name</varname></term>
4454
4455               <listitem>
4456                 <para>Name des Ansprechpartners</para>
4457               </listitem>
4458             </varlistentry>
4459
4460             <varlistentry>
4461               <term><varname>cp_phone1</varname></term>
4462
4463               <listitem>
4464                 <para>Telefonnummer 1 des Ansprechpartners</para>
4465               </listitem>
4466             </varlistentry>
4467
4468             <varlistentry>
4469               <term><varname>cp_phone2</varname></term>
4470
4471               <listitem>
4472                 <para>Telefonnummer 2 des Ansprechpartners</para>
4473               </listitem>
4474             </varlistentry>
4475
4476             <varlistentry>
4477               <term><varname>cp_title</varname></term>
4478
4479               <listitem>
4480                 <para>Titel des Ansprechpartners</para>
4481               </listitem>
4482             </varlistentry>
4483
4484             <varlistentry>
4485               <term><varname>creditlimit</varname></term>
4486
4487               <listitem>
4488                 <para>Kreditlimit</para>
4489               </listitem>
4490             </varlistentry>
4491
4492             <varlistentry>
4493               <term><varname>customeremail</varname></term>
4494
4495               <listitem>
4496                 <para>Email des Kunden; nur für Kunden</para>
4497               </listitem>
4498             </varlistentry>
4499
4500             <varlistentry>
4501               <term><varname>customerfax</varname></term>
4502
4503               <listitem>
4504                 <para>Faxnummer des Kunden; nur für Kunden</para>
4505               </listitem>
4506             </varlistentry>
4507
4508             <varlistentry>
4509               <term><varname>customernotes</varname></term>
4510
4511               <listitem>
4512                 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4513               </listitem>
4514             </varlistentry>
4515
4516             <varlistentry>
4517               <term><varname>customernumber</varname></term>
4518
4519               <listitem>
4520                 <para>Kundennummer; nur für Kunden</para>
4521               </listitem>
4522             </varlistentry>
4523
4524             <varlistentry>
4525               <term><varname>customerphone</varname></term>
4526
4527               <listitem>
4528                 <para>Telefonnummer des Kunden; nur für Kunden</para>
4529               </listitem>
4530             </varlistentry>
4531
4532             <varlistentry>
4533               <term><varname>discount</varname></term>
4534
4535               <listitem>
4536                 <para>Rabatt</para>
4537               </listitem>
4538             </varlistentry>
4539
4540             <varlistentry>
4541               <term><varname>email</varname></term>
4542
4543               <listitem>
4544                 <para>Emailadresse</para>
4545               </listitem>
4546             </varlistentry>
4547
4548             <varlistentry>
4549               <term><varname>fax</varname></term>
4550
4551               <listitem>
4552                 <para>Faxnummer</para>
4553               </listitem>
4554             </varlistentry>
4555
4556             <varlistentry>
4557               <term><varname>gln</varname></term>
4558
4559               <listitem>
4560                 <para>GLN (Globale Lokationsnummer)</para>
4561               </listitem>
4562             </varlistentry>
4563
4564             <varlistentry>
4565               <term><varname>greeting</varname></term>
4566
4567               <listitem>
4568                 <para>Anrede</para>
4569               </listitem>
4570             </varlistentry>
4571
4572             <varlistentry>
4573               <term><varname>homepage</varname></term>
4574
4575               <listitem>
4576                 <para>Homepage</para>
4577               </listitem>
4578             </varlistentry>
4579
4580             <varlistentry>
4581               <term><varname>iban</varname></term>
4582
4583               <listitem>
4584                 <para>Internationale Kontonummer (International Bank Account
4585                 Number, IBAN)</para>
4586               </listitem>
4587             </varlistentry>
4588
4589             <varlistentry>
4590               <term><varname>language</varname></term>
4591
4592               <listitem>
4593                 <para>Sprache</para>
4594               </listitem>
4595             </varlistentry>
4596
4597             <varlistentry>
4598               <term><varname>name</varname></term>
4599
4600               <listitem>
4601                 <para>Firmenname</para>
4602               </listitem>
4603             </varlistentry>
4604
4605             <varlistentry>
4606               <term><varname>natural_person</varname></term>
4607
4608               <listitem>
4609                 <para>Flag "natürliche Person"; Siehe auch
4610                 <xref linkend="dokumentenvorlagen-und-variablen.anrede"/></para>
4611               </listitem>
4612             </varlistentry>
4613
4614             <varlistentry>
4615               <term><varname>payment_description</varname></term>
4616
4617               <listitem>
4618                 <para>Name der Zahlart</para>
4619               </listitem>
4620             </varlistentry>
4621
4622             <varlistentry>
4623               <term><varname>payment_terms</varname></term>
4624
4625               <listitem>
4626                 <para>Zahlungskonditionen</para>
4627               </listitem>
4628             </varlistentry>
4629
4630             <varlistentry>
4631               <term><varname>phone</varname></term>
4632
4633               <listitem>
4634                 <para>Telefonnummer</para>
4635               </listitem>
4636             </varlistentry>
4637
4638             <varlistentry>
4639               <term><varname>shiptocity</varname></term>
4640
4641               <listitem>
4642                 <para>Stadt (Lieferadresse) <link
4643                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4644               </listitem>
4645             </varlistentry>
4646
4647             <varlistentry>
4648               <term><varname>shiptocontact</varname></term>
4649
4650               <listitem>
4651                 <para>Kontakt (Lieferadresse) <link
4652                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4653               </listitem>
4654             </varlistentry>
4655
4656             <varlistentry>
4657               <term><varname>shiptocountry</varname></term>
4658
4659               <listitem>
4660                 <para>Land (Lieferadresse) <link
4661                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4662               </listitem>
4663             </varlistentry>
4664
4665             <varlistentry>
4666               <term><varname>shiptodepartment_1</varname></term>
4667
4668               <listitem>
4669                 <para>Abteilung 1 (Lieferadresse) <link
4670                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4671               </listitem>
4672             </varlistentry>
4673
4674             <varlistentry>
4675               <term><varname>shiptodepartment_2</varname></term>
4676
4677               <listitem>
4678                 <para>Abteilung 2 (Lieferadresse) <link
4679                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4680               </listitem>
4681             </varlistentry>
4682
4683             <varlistentry>
4684               <term><varname>shiptoemail</varname></term>
4685
4686               <listitem>
4687                 <para>Email (Lieferadresse) <link
4688                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4689               </listitem>
4690             </varlistentry>
4691
4692             <varlistentry>
4693               <term><varname>shiptofax</varname></term>
4694
4695               <listitem>
4696                 <para>Fax (Lieferadresse) <link
4697                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4698               </listitem>
4699             </varlistentry>
4700
4701             <varlistentry>
4702               <term><varname>shiptogln</varname></term>
4703
4704               <listitem>
4705                 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4706                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4707               </listitem>
4708             </varlistentry>
4709
4710             <varlistentry>
4711               <term><varname>shiptoname</varname></term>
4712
4713               <listitem>
4714                 <para>Firmenname (Lieferadresse) <link
4715                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4716               </listitem>
4717             </varlistentry>
4718
4719             <varlistentry>
4720               <term><varname>shiptophone</varname></term>
4721
4722               <listitem>
4723                 <para>Telefonnummer (Lieferadresse) <link
4724                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4725               </listitem>
4726             </varlistentry>
4727
4728             <varlistentry>
4729               <term><varname>shiptostreet</varname></term>
4730
4731               <listitem>
4732                 <para>Straße und Hausnummer (Lieferadresse) <link
4733                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4734               </listitem>
4735             </varlistentry>
4736
4737             <varlistentry>
4738               <term><varname>shiptozipcode</varname></term>
4739
4740               <listitem>
4741                 <para>Postleitzahl (Lieferadresse) <link
4742                 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4743               </listitem>
4744             </varlistentry>
4745
4746             <varlistentry>
4747               <term><varname>street</varname></term>
4748
4749               <listitem>
4750                 <para>Straße und Hausnummer</para>
4751               </listitem>
4752             </varlistentry>
4753
4754             <varlistentry>
4755               <term><varname>taxnumber</varname></term>
4756
4757               <listitem>
4758                 <para>Steuernummer</para>
4759               </listitem>
4760             </varlistentry>
4761
4762             <varlistentry>
4763               <term><varname>ustid</varname></term>
4764
4765               <listitem>
4766                 <para>Umsatzsteuer-Identifikationsnummer</para>
4767               </listitem>
4768             </varlistentry>
4769
4770             <varlistentry>
4771               <term><varname>vendoremail</varname></term>
4772
4773               <listitem>
4774                 <para>Email des Lieferanten; nur für Lieferanten</para>
4775               </listitem>
4776             </varlistentry>
4777
4778             <varlistentry>
4779               <term><varname>vendorfax</varname></term>
4780
4781               <listitem>
4782                 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4783               </listitem>
4784             </varlistentry>
4785
4786             <varlistentry>
4787               <term><varname>vendornotes</varname></term>
4788
4789               <listitem>
4790                 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4791               </listitem>
4792             </varlistentry>
4793
4794             <varlistentry>
4795               <term><varname>vendornumber</varname></term>
4796
4797               <listitem>
4798                 <para>Lieferantennummer; nur für Lieferanten</para>
4799               </listitem>
4800             </varlistentry>
4801
4802             <varlistentry>
4803               <term><varname>vendorphone</varname></term>
4804
4805               <listitem>
4806                 <para>Telefonnummer des Lieferanten; nur für
4807                 Lieferanten</para>
4808               </listitem>
4809             </varlistentry>
4810
4811             <varlistentry>
4812               <term><varname>zipcode</varname></term>
4813
4814               <listitem>
4815                 <para>Postleitzahl</para>
4816               </listitem>
4817             </varlistentry>
4818           </variablelist>
4819
4820           <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4821             <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4822             Stammdaten nicht eingetragen, so haben die Variablen
4823             <varname>shipto*</varname> den gleichen Wert wie die die
4824             entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4825             einige <varname>shipto*</varname>-Variablen so nicht in den
4826             Stammdaten wiederfinden sondern schlicht Kopien der
4827             Lieferdatenvariablen sind (z.B.
4828             <varname>shiptocontact</varname>).</para>
4829           </note>
4830         </sect3>
4831
4832         <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4833           <title>Informationen über den Bearbeiter</title>
4834
4835           <variablelist>
4836             <varlistentry>
4837               <term><varname>employee_address</varname></term>
4838
4839               <listitem>
4840                 <para>Adressfeld</para>
4841               </listitem>
4842             </varlistentry>
4843
4844             <varlistentry>
4845               <term><varname>employee_businessnumber</varname></term>
4846
4847               <listitem>
4848                 <para>Firmennummer</para>
4849               </listitem>
4850             </varlistentry>
4851
4852             <varlistentry>
4853               <term><varname>employee_company</varname></term>
4854
4855               <listitem>
4856                 <para>Firmenname</para>
4857               </listitem>
4858             </varlistentry>
4859
4860             <varlistentry>
4861               <term><varname>employee_co_ustid</varname></term>
4862
4863               <listitem>
4864                 <para>Usatzsteuer-Identifikationsnummer</para>
4865               </listitem>
4866             </varlistentry>
4867
4868             <varlistentry>
4869               <term><varname>employee_duns</varname></term>
4870
4871               <listitem>
4872                 <para>DUNS-Nummer</para>
4873               </listitem>
4874             </varlistentry>
4875
4876             <varlistentry>
4877               <term><varname>employee_email</varname></term>
4878
4879               <listitem>
4880                 <para>Email</para>
4881               </listitem>
4882             </varlistentry>
4883
4884             <varlistentry>
4885               <term><varname>employee_fax</varname></term>
4886
4887               <listitem>
4888                 <para>Fax</para>
4889               </listitem>
4890             </varlistentry>
4891
4892             <varlistentry>
4893               <term><varname>employee_name</varname></term>
4894
4895               <listitem>
4896                 <para>voller Name</para>
4897               </listitem>
4898             </varlistentry>
4899
4900             <varlistentry>
4901               <term><varname>employee_signature</varname></term>
4902
4903               <listitem>
4904                 <para>Signatur</para>
4905               </listitem>
4906             </varlistentry>
4907
4908             <varlistentry>
4909               <term><varname>employee_taxnumber</varname></term>
4910
4911               <listitem>
4912                 <para>Steuernummer</para>
4913               </listitem>
4914             </varlistentry>
4915
4916             <varlistentry>
4917               <term><varname>employee_tel</varname></term>
4918
4919               <listitem>
4920                 <para>Telefonnummer</para>
4921               </listitem>
4922             </varlistentry>
4923           </variablelist>
4924         </sect3>
4925
4926         <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4927           <title>Informationen über den Verkäufer</title>
4928
4929           <variablelist>
4930             <varlistentry>
4931               <term><varname>salesman_address</varname></term>
4932
4933               <listitem>
4934                 <para>Adressfeld</para>
4935               </listitem>
4936             </varlistentry>
4937
4938             <varlistentry>
4939               <term><varname>salesman_businessnumber</varname></term>
4940
4941               <listitem>
4942                 <para>Firmennummer</para>
4943               </listitem>
4944             </varlistentry>
4945
4946             <varlistentry>
4947               <term><varname>salesman_company</varname></term>
4948
4949               <listitem>
4950                 <para>Firmenname</para>
4951               </listitem>
4952             </varlistentry>
4953
4954             <varlistentry>
4955               <term><varname>salesman_co_ustid</varname></term>
4956
4957               <listitem>
4958                 <para>Usatzsteuer-Identifikationsnummer</para>
4959               </listitem>
4960             </varlistentry>
4961
4962             <varlistentry>
4963               <term><varname>salesman_duns</varname></term>
4964
4965               <listitem>
4966                 <para>DUNS-Nummer</para>
4967               </listitem>
4968             </varlistentry>
4969
4970             <varlistentry>
4971               <term><varname>salesman_email</varname></term>
4972
4973               <listitem>
4974                 <para>Email</para>
4975               </listitem>
4976             </varlistentry>
4977
4978             <varlistentry>
4979               <term><varname>salesman_fax</varname></term>
4980
4981               <listitem>
4982                 <para>Fax</para>
4983               </listitem>
4984             </varlistentry>
4985
4986             <varlistentry>
4987               <term><varname>salesman_name</varname></term>
4988
4989               <listitem>
4990                 <para>voller Name</para>
4991               </listitem>
4992             </varlistentry>
4993
4994             <varlistentry>
4995               <term><varname>salesman_signature</varname></term>
4996
4997               <listitem>
4998                 <para>Signatur</para>
4999               </listitem>
5000             </varlistentry>
5001
5002             <varlistentry>
5003               <term><varname>salesman_taxnumber</varname></term>
5004
5005               <listitem>
5006                 <para>Steuernummer</para>
5007               </listitem>
5008             </varlistentry>
5009
5010             <varlistentry>
5011               <term><varname>salesman_tel</varname></term>
5012
5013               <listitem>
5014                 <para>Telefonnummer</para>
5015               </listitem>
5016             </varlistentry>
5017           </variablelist>
5018         </sect3>
5019
5020         <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
5021           <title>Variablen für die einzelnen Steuern</title>
5022
5023           <variablelist>
5024             <varlistentry>
5025               <term><varname>tax</varname></term>
5026
5027               <listitem>
5028                 <para>Steuer</para>
5029               </listitem>
5030             </varlistentry>
5031
5032             <varlistentry>
5033               <term><varname>taxbase</varname></term>
5034
5035               <listitem>
5036                 <para>zu versteuernder Betrag</para>
5037               </listitem>
5038             </varlistentry>
5039
5040             <varlistentry>
5041               <term><varname>taxdescription</varname></term>
5042
5043               <listitem>
5044                 <para>Name der Steuer</para>
5045               </listitem>
5046             </varlistentry>
5047
5048             <varlistentry>
5049               <term><varname>taxrate</varname></term>
5050
5051               <listitem>
5052                 <para>Steuersatz</para>
5053               </listitem>
5054             </varlistentry>
5055           </variablelist>
5056         </sect3>
5057
5058         <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
5059           <title>Variablen für Lieferbedingungen</title>
5060
5061           <variablelist>
5062             <varlistentry>
5063               <term><varname>delivery_term</varname></term>
5064
5065               <listitem>
5066                 <para>Datenbank-Objekt der Lieferbedingung</para>
5067               </listitem>
5068             </varlistentry>
5069
5070             <varlistentry>
5071               <term><varname>delivery_term.description</varname></term>
5072
5073               <listitem>
5074                 <para>Beschreibung der Lieferbedingung</para>
5075               </listitem>
5076             </varlistentry>
5077
5078             <varlistentry>
5079               <term><varname>delivery_term.description_long</varname></term>
5080
5081               <listitem>
5082                 <para>Langtext bzw. übersetzter Langtext der
5083                 Lieferbedingung</para>
5084               </listitem>
5085             </varlistentry>
5086           </variablelist>
5087         </sect3>
5088
5089         <sect3 id="dokumentenvorlagen-und-variablen.abweichende-rechnungsadresse">
5090           <title>Informationen über abweichende Rechnungsadressen (nur Verkaufsbelege)</title>
5091
5092           <para>
5093             Abweichende Rechnungsadressen gibt es nur in Verkaufsbelegen. Die entsprechenden Variablen sind nur dann mit Inhalt gefüllt,
5094             wenn im Beleg eine abweichende Rechnungsadresse ausgewählt wurde. Ob eine Adresse überhaupt ausgewählt wurde, kann über die
5095             Variable <literal>billing_address_id</literal> getestet werden, die die Datenbank-ID der abweichenden Rechnungsadresse enthält,
5096             wenn eine ausgewählt ist.
5097           </para>
5098
5099           <para>
5100             Die Variablennamen starten alle mit dem Präfix <literal>billing_address_</literal> und heißen anschließend so, wie ihre Pendants
5101             aus der Standard-Rechnungsadresse des Kunden. Beispiel: die Postleitzahl, die in der normalen Rechnungsadresse in
5102             <literal>zipcode</literal> steht, steht für die abweichende Rechnungsadresse in <literal>billing_address_zipcode</literal>.
5103           </para>
5104
5105           <para>
5106             Die folgenden Variablen stehen so zur Verfügung: <literal>billing_address_name</literal>,
5107             <literal>billing_address_department_1</literal>, <literal>billing_address_department_2</literal>,
5108             <literal>billing_address_contact</literal>, <literal>billing_address_street</literal>,
5109             <literal>billing_address_zipcode</literal>, <literal>billing_address_city</literal>, <literal>billing_address_country</literal>,
5110             <literal>billing_address_gln</literal>, <literal>billing_address_email</literal>, <literal>billing_address_phone</literal> und
5111             <literal>billing_address_fax</literal>.
5112           </para>
5113         </sect3>
5114       </sect2>
5115
5116       <sect2 id="dokumentenvorlagen-und-variablen.invoice">
5117         <title>Variablen in Rechnungen</title>
5118
5119         <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
5120           <title>Allgemeine Variablen</title>
5121
5122           <variablelist>
5123             <varlistentry>
5124               <term><varname>creditremaining</varname></term>
5125
5126               <listitem>
5127                 <para>Verbleibender Kredit</para>
5128               </listitem>
5129             </varlistentry>
5130
5131             <varlistentry>
5132               <term><varname>currency</varname></term>
5133
5134               <listitem>
5135                 <para>Währung</para>
5136               </listitem>
5137             </varlistentry>
5138
5139             <varlistentry>
5140               <term><varname>cusordnumber</varname></term>
5141
5142               <listitem>
5143                 <para>Bestellnummer beim Kunden</para>
5144               </listitem>
5145             </varlistentry>
5146
5147             <varlistentry>
5148               <term><varname>deliverydate</varname></term>
5149
5150               <listitem>
5151                 <para>Lieferdatum</para>
5152               </listitem>
5153             </varlistentry>
5154
5155             <varlistentry>
5156               <term><varname>duedate</varname></term>
5157
5158               <listitem>
5159                 <para>Fälligkeitsdatum</para>
5160               </listitem>
5161             </varlistentry>
5162
5163             <varlistentry>
5164               <term><varname>globalprojectnumber</varname></term>
5165
5166               <listitem>
5167                 <para>Projektnummer des ganzen Beleges</para>
5168               </listitem>
5169             </varlistentry>
5170
5171             <varlistentry>
5172               <term><varname>globalprojectdescription</varname></term>
5173
5174               <listitem>
5175                 <para>Projekbeschreibung des ganzen Beleges</para>
5176               </listitem>
5177             </varlistentry>
5178
5179             <varlistentry>
5180               <term><varname>intnotes</varname></term>
5181
5182               <listitem>
5183                 <para>Interne Bemerkungen</para>
5184               </listitem>
5185             </varlistentry>
5186
5187             <varlistentry>
5188               <term><varname>invdate</varname></term>
5189
5190               <listitem>
5191                 <para>Rechnungsdatum</para>
5192               </listitem>
5193             </varlistentry>
5194
5195             <varlistentry>
5196               <term><varname>invnumber</varname></term>
5197
5198               <listitem>
5199                 <para>Rechnungsnummer</para>
5200               </listitem>
5201             </varlistentry>
5202
5203             <varlistentry>
5204               <term><varname>invtotal</varname></term>
5205
5206               <listitem>
5207                 <para>gesamter Rechnungsbetrag</para>
5208               </listitem>
5209             </varlistentry>
5210
5211             <varlistentry>
5212               <term><varname>notes</varname></term>
5213
5214               <listitem>
5215                 <para>Bemerkungen der Rechnung</para>
5216               </listitem>
5217             </varlistentry>
5218
5219             <varlistentry>
5220               <term><varname>orddate</varname></term>
5221
5222               <listitem>
5223                 <para>Auftragsdatum</para>
5224               </listitem>
5225             </varlistentry>
5226
5227             <varlistentry>
5228               <term><varname>ordnumber</varname></term>
5229
5230               <listitem>
5231                 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
5232                 erstellt wurde</para>
5233               </listitem>
5234             </varlistentry>
5235
5236             <varlistentry>
5237               <term><varname>payment_description</varname></term>
5238
5239               <listitem>
5240                 <para>Name der Zahlart</para>
5241               </listitem>
5242             </varlistentry>
5243
5244             <varlistentry>
5245               <term><varname>payment_terms</varname></term>
5246
5247               <listitem>
5248                 <para>Zahlungskonditionen</para>
5249               </listitem>
5250             </varlistentry>
5251
5252             <varlistentry>
5253               <term><varname>quodate</varname></term>
5254
5255               <listitem>
5256                 <para>Angebotsdatum</para>
5257               </listitem>
5258             </varlistentry>
5259
5260             <varlistentry>
5261               <term><varname>quonumber</varname></term>
5262
5263               <listitem>
5264                 <para>Angebotsnummer</para>
5265               </listitem>
5266             </varlistentry>
5267
5268             <varlistentry>
5269               <term><varname>rounding</varname></term>
5270
5271               <listitem>
5272                 <para>Betrag, um den <varname>invtotal</varname> gerundet
5273                 wurde (kann positiv oder negativ sein)</para>
5274               </listitem>
5275             </varlistentry>
5276
5277             <varlistentry>
5278               <term><varname>shippingpoint</varname></term>
5279
5280               <listitem>
5281                 <para>Versandort</para>
5282               </listitem>
5283             </varlistentry>
5284
5285             <varlistentry>
5286               <term><varname>shipvia</varname></term>
5287
5288               <listitem>
5289                 <para>Transportmittel</para>
5290               </listitem>
5291             </varlistentry>
5292
5293             <varlistentry>
5294               <term><varname>subtotal</varname></term>
5295
5296               <listitem>
5297                 <para>Zwischensumme aller Posten ohne Steuern</para>
5298               </listitem>
5299             </varlistentry>
5300
5301             <varlistentry>
5302               <term><varname>total</varname></term>
5303
5304               <listitem>
5305                 <para>Restsumme der Rechnung (Summe abzüglich bereits
5306                 bezahlter Posten)</para>
5307               </listitem>
5308             </varlistentry>
5309
5310             <varlistentry>
5311               <term><varname>transaction_description</varname></term>
5312
5313               <listitem>
5314                 <para>Vorgangsbezeichnung</para>
5315               </listitem>
5316             </varlistentry>
5317
5318             <varlistentry>
5319               <term><varname>transdate</varname></term>
5320
5321               <listitem>
5322                 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
5323                 erstellt wurde</para>
5324               </listitem>
5325             </varlistentry>
5326           </variablelist>
5327         </sect3>
5328
5329         <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
5330           <title>Variablen für jeden Posten auf der Rechnung</title>
5331
5332           <variablelist>
5333             <varlistentry>
5334               <term><varname>bin</varname></term>
5335
5336               <listitem>
5337                 <para>Stellage</para>
5338               </listitem>
5339             </varlistentry>
5340
5341             <varlistentry>
5342               <term><varname>description</varname></term>
5343
5344               <listitem>
5345                 <para>Artikelbeschreibung</para>
5346               </listitem>
5347             </varlistentry>
5348
5349             <varlistentry>
5350               <term><varname>cusordnumber_oe</varname></term>
5351
5352               <listitem>
5353                 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
5354                 Posten ursprünglich stammt (nur Verkauf)</para>
5355               </listitem>
5356             </varlistentry>
5357
5358             <varlistentry>
5359               <term><varname>discount</varname></term>
5360
5361               <listitem>
5362                 <para>Rabatt als Betrag</para>
5363               </listitem>
5364             </varlistentry>
5365
5366             <varlistentry>
5367               <term><varname>discount_sub</varname></term>
5368
5369               <listitem>
5370                 <para>Zwischensumme mit Rabatt</para>
5371               </listitem>
5372             </varlistentry>
5373
5374             <varlistentry>
5375               <term><varname>donumber_do</varname></term>
5376
5377               <listitem>
5378                 <para>Lieferscheinnummer des Lieferscheins, aus dem die
5379                 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
5380                 Workflows aus einem Lieferschein erstellt wurde.</para>
5381               </listitem>
5382             </varlistentry>
5383
5384             <varlistentry>
5385               <term><varname>drawing</varname></term>
5386
5387               <listitem>
5388                 <para>Zeichnung</para>
5389               </listitem>
5390             </varlistentry>
5391
5392             <varlistentry>
5393               <term><varname>ean</varname></term>
5394
5395               <listitem>
5396                 <para>EAN-Code</para>
5397               </listitem>
5398             </varlistentry>
5399
5400             <varlistentry>
5401               <term><varname>image</varname></term>
5402
5403               <listitem>
5404                 <para>Grafik</para>
5405               </listitem>
5406             </varlistentry>
5407
5408             <varlistentry>
5409               <term><varname>linetotal</varname></term>
5410
5411               <listitem>
5412                 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
5413               </listitem>
5414             </varlistentry>
5415
5416             <varlistentry>
5417               <term><varname>longdescription</varname></term>
5418
5419               <listitem>
5420                 <para>Langtext, vorbelegt mit dem Feld Bemerkungen der entsprechenden Ware</para>
5421               </listitem>
5422             </varlistentry>
5423
5424             <varlistentry>
5425               <term><varname>microfiche</varname></term>
5426
5427               <listitem>
5428                 <para>Mikrofilm</para>
5429               </listitem>
5430             </varlistentry>
5431
5432             <varlistentry>
5433               <term><varname>netprice</varname></term>
5434
5435               <listitem>
5436                 <para>Alternative zu <varname>sellprice</varname>, aber
5437                 <varname>netprice</varname> entspricht dem effektiven
5438                 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
5439                 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
5440                 / Menge. Diese Variable ist nützlich, wenn man den gewährten
5441                 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
5442                 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
5443                 <varname>netprice</varname> hat nichts mit Netto/Brutto im
5444                 Sinne von Steuern zu tun.</para>
5445               </listitem>
5446             </varlistentry>
5447
5448             <varlistentry>
5449               <term><varname>nodiscount_linetotal</varname></term>
5450
5451               <listitem>
5452                 <para>Zeilensumme ohne Rabatt</para>
5453               </listitem>
5454             </varlistentry>
5455
5456             <varlistentry>
5457               <term><varname>nodiscount_sub</varname></term>
5458
5459               <listitem>
5460                 <para>Zwischensumme ohne Rabatt</para>
5461               </listitem>
5462             </varlistentry>
5463
5464             <varlistentry>
5465               <term><varname>number</varname></term>
5466
5467               <listitem>
5468                 <para>Artikelnummer</para>
5469               </listitem>
5470             </varlistentry>
5471
5472             <varlistentry>
5473               <term><varname>ordnumber_oe</varname></term>
5474
5475               <listitem>
5476                 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5477                 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5478                 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5479                 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5480                 letzterem Fall wird die unsprüngliche Auftragsnummer
5481                 angezeigt.</para>
5482               </listitem>
5483             </varlistentry>
5484
5485             <varlistentry>
5486               <term><varname>p_discount</varname></term>
5487
5488               <listitem>
5489                 <para>Rabatt in Prozent</para>
5490               </listitem>
5491             </varlistentry>
5492
5493             <varlistentry>
5494               <term><varname>partnotes</varname></term>
5495
5496               <listitem>
5497                 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5498               </listitem>
5499             </varlistentry>
5500
5501             <varlistentry>
5502               <term><varname>partsgroup</varname></term>
5503
5504               <listitem>
5505                 <para>Warengruppe</para>
5506               </listitem>
5507             </varlistentry>
5508
5509             <varlistentry>
5510               <term><varname>price_factor</varname></term>
5511
5512               <listitem>
5513                 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5514                 ist</para>
5515               </listitem>
5516             </varlistentry>
5517
5518             <varlistentry>
5519               <term><varname>price_factor_name</varname></term>
5520
5521               <listitem>
5522                 <para>Der Name des Preisfaktors, sofern einer eingestellt
5523                 ist</para>
5524               </listitem>
5525             </varlistentry>
5526
5527             <varlistentry>
5528               <term><varname>projectnumber</varname></term>
5529
5530               <listitem>
5531                 <para>Projektnummer</para>
5532               </listitem>
5533             </varlistentry>
5534
5535             <varlistentry>
5536               <term><varname>projectdescription</varname></term>
5537
5538               <listitem>
5539                 <para>Projektbeschreibung</para>
5540               </listitem>
5541             </varlistentry>
5542
5543             <varlistentry>
5544               <term><varname>qty</varname></term>
5545
5546               <listitem>
5547                 <para>Anzahl</para>
5548               </listitem>
5549             </varlistentry>
5550
5551             <varlistentry>
5552               <term><varname>reqdate</varname></term>
5553
5554               <listitem>
5555                 <para>Lieferdatum</para>
5556               </listitem>
5557             </varlistentry>
5558
5559             <varlistentry>
5560               <term><varname>runningnumber</varname></term>
5561
5562               <listitem>
5563                 <para>Position auf der Rechnung (1, 2, 3...)</para>
5564               </listitem>
5565             </varlistentry>
5566
5567             <varlistentry>
5568               <term><varname>sellprice</varname></term>
5569
5570               <listitem>
5571                 <para>Verkaufspreis</para>
5572               </listitem>
5573             </varlistentry>
5574
5575             <varlistentry>
5576               <term><varname>serialnumber</varname></term>
5577
5578               <listitem>
5579                 <para>Seriennummer</para>
5580               </listitem>
5581             </varlistentry>
5582
5583             <varlistentry>
5584               <term><varname>tax_rate</varname></term>
5585
5586               <listitem>
5587                 <para>Steuersatz</para>
5588               </listitem>
5589             </varlistentry>
5590
5591             <varlistentry>
5592               <term><varname>transdate_do</varname></term>
5593
5594               <listitem>
5595                 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5596                 Workflows aus einem Lieferschein stammte.</para>
5597               </listitem>
5598             </varlistentry>
5599
5600             <varlistentry>
5601               <term><varname>transdate_oe</varname></term>
5602
5603               <listitem>
5604                 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5605                 Workflows aus einem Auftrag erstellt wurde. Wenn es
5606                 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5607                 genommen.</para>
5608               </listitem>
5609             </varlistentry>
5610
5611             <varlistentry>
5612               <term><varname>transdate_quo</varname></term>
5613
5614               <listitem>
5615                 <para>Datum des Angebots, wenn die Position im Rahmen des
5616                 Workflows aus einem Angebot stammte.</para>
5617               </listitem>
5618             </varlistentry>
5619
5620             <varlistentry>
5621               <term><varname>unit</varname></term>
5622
5623               <listitem>
5624                 <para>Einheit</para>
5625               </listitem>
5626             </varlistentry>
5627
5628             <varlistentry>
5629               <term><varname>weight</varname></term>
5630
5631               <listitem>
5632                 <para>Gewicht</para>
5633               </listitem>
5634             </varlistentry>
5635           </variablelist>
5636
5637           <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5638           über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5639           einer <function>foreach</function>-Schleife ausgegeben werden, da
5640           für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5641           können. Die Variablen dafür lauten:</para>
5642
5643           <variablelist>
5644             <varlistentry>
5645               <term><varname>make</varname></term>
5646
5647               <listitem>
5648                 <para>Lieferant</para>
5649               </listitem>
5650             </varlistentry>
5651
5652             <varlistentry>
5653               <term><varname>model</varname></term>
5654
5655               <listitem>
5656                 <para>Lieferantenartikelnummer</para>
5657               </listitem>
5658             </varlistentry>
5659           </variablelist>
5660         </sect3>
5661
5662         <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5663           <title>Variablen für die einzelnen Zahlungseingänge</title>
5664
5665           <variablelist>
5666             <varlistentry>
5667               <term><varname>payment</varname></term>
5668
5669               <listitem>
5670                 <para>Betrag</para>
5671               </listitem>
5672             </varlistentry>
5673
5674             <varlistentry>
5675               <term><varname>paymentaccount</varname></term>
5676
5677               <listitem>
5678                 <para>Konto</para>
5679               </listitem>
5680             </varlistentry>
5681
5682             <varlistentry>
5683               <term><varname>paymentdate</varname></term>
5684
5685               <listitem>
5686                 <para>Datum</para>
5687               </listitem>
5688             </varlistentry>
5689
5690             <varlistentry>
5691               <term><varname>paymentmemo</varname></term>
5692
5693               <listitem>
5694                 <para>Memo</para>
5695               </listitem>
5696             </varlistentry>
5697
5698             <varlistentry>
5699               <term><varname>paymentsource</varname></term>
5700
5701               <listitem>
5702                 <para>Beleg</para>
5703               </listitem>
5704             </varlistentry>
5705           </variablelist>
5706         </sect3>
5707
5708         <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5709           <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5710
5711           <para>Die vom Benutzer definierten Variablen für Kunden und
5712           Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5713           ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5714           <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5715           Variablennamen zusammen.</para>
5716
5717           <para>Beispiel: Der Benutzer hat eine Variable namens
5718           <varname>number_of_employees</varname> definiert, die die Anzahl der
5719           Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5720           unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5721           Verfügung.</para>
5722
5723           <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5724           unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5725           Präfix <varname>shiptocvar_</varname>.</para>
5726
5727           <para>Analog stehen die benutzerdefinierten Variablen für
5728           Ansprechpersonen mit dem Namenspräfix <varname>cp_cvar_</varname>
5729           zur Verfügung.</para>
5730         </sect3>
5731       </sect2>
5732
5733       <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5734         <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5735
5736         <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5737           <title>Namen der Vorlagen</title>
5738
5739           <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5740           eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5741           Erstellung einer Rechnung über die Mahngebühren und Zinsen
5742           aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5743           Vorlagenname für diese Mahnstufe mit dem Zusatz
5744           <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5745           für die ausgewählte Sprache und den ausgewählten Drucker
5746           angehängt.</para>
5747         </sect3>
5748
5749         <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5750           <title>Allgemeine Variablen in Mahnungen</title>
5751
5752           <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie
5753           gewohnt als <varname>employee_...</varname> bzw.
5754           <varname>salesman_...</varname> zur Verfügung. Werden mehrere
5755           Rechnungen in einer Mahnung zusammengefasst, so werden die Metadaten
5756           (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung im
5757           Ausdruck genommen.</para>
5758
5759           <para>Die Adressdaten des Kunden stehen als Variablen
5760           <varname>name</varname>, <varname>street</varname>,
5761           <varname>zipcode</varname>, <varname>city</varname>,
5762           <varname>country</varname>, <varname>department_1</varname>,
5763           <varname>department_2</varname>, und <varname>email</varname> zur
5764           Verfügung. Der Ansprechpartner <varname>cp_...</varname> steht auch
5765           zu Verfügung, wird allerdings auch nur von der ersten angemahnten
5766           Rechnung (s.o.) genommen.</para>
5767
5768           <para>Weitere Variablen beinhalten:</para>
5769
5770           <variablelist>
5771             <varlistentry>
5772               <term><varname>dunning_date</varname></term>
5773
5774               <listitem>
5775                 <para>Datum der Mahnung</para>
5776               </listitem>
5777             </varlistentry>
5778
5779             <varlistentry>
5780               <term><varname>dunning_duedate</varname></term>
5781
5782               <listitem>
5783                 <para>Fälligkeitsdatum für diese Mahhnung</para>
5784               </listitem>
5785             </varlistentry>
5786
5787             <varlistentry>
5788               <term><varname>dunning_id</varname></term>
5789
5790               <listitem>
5791                 <para>Mahnungsnummer</para>
5792               </listitem>
5793             </varlistentry>
5794
5795             <varlistentry>
5796               <term><varname>fee</varname></term>
5797
5798               <listitem>
5799                 <para>Kumulative Mahngebühren</para>
5800               </listitem>
5801             </varlistentry>
5802
5803             <varlistentry>
5804               <term><varname>interest_rate</varname></term>
5805
5806               <listitem>
5807                 <para>Zinssatz per anno in Prozent</para>
5808               </listitem>
5809             </varlistentry>
5810
5811             <varlistentry>
5812               <term><varname>total_amount</varname></term>
5813
5814               <listitem>
5815                 <para>Gesamter noch zu zahlender Betrag als
5816                 <function>fee</function> + <function>total_interest</function>
5817                 + <function>total_open_amount</function></para>
5818               </listitem>
5819             </varlistentry>
5820
5821             <varlistentry>
5822               <term><varname>total_interest</varname></term>
5823
5824               <listitem>
5825                 <para>Zinsen per anno über alle Rechnungen</para>
5826               </listitem>
5827             </varlistentry>
5828
5829             <varlistentry>
5830               <term><varname>total_open_amount</varname></term>
5831
5832               <listitem>
5833                 <para>Summe über alle offene Beträge der Rechnungen</para>
5834               </listitem>
5835             </varlistentry>
5836           </variablelist>
5837         </sect3>
5838
5839         <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5840           <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5841
5842           <variablelist>
5843             <varlistentry>
5844               <term><varname>dn_amount</varname></term>
5845
5846               <listitem>
5847                 <para>Rechnungssumme (brutto)</para>
5848               </listitem>
5849             </varlistentry>
5850
5851             <varlistentry>
5852               <term><varname>dn_duedate</varname></term>
5853
5854               <listitem>
5855                 <para>Originales Fälligkeitsdatum der Rechnung</para>
5856               </listitem>
5857             </varlistentry>
5858
5859             <varlistentry>
5860               <term><varname>dn_dunning_date</varname></term>
5861
5862               <listitem>
5863                 <para>Datum der Mahnung</para>
5864               </listitem>
5865             </varlistentry>
5866
5867             <varlistentry>
5868               <term><varname>dn_dunning_duedate</varname></term>
5869
5870               <listitem>
5871                 <para>Fälligkeitsdatum der Mahnung</para>
5872               </listitem>
5873             </varlistentry>
5874
5875             <varlistentry>
5876               <term><varname>dn_fee</varname></term>
5877
5878               <listitem>
5879                 <para>Kummulative Mahngebühr</para>
5880               </listitem>
5881             </varlistentry>
5882
5883             <varlistentry>
5884               <term><varname>dn_interest</varname></term>
5885
5886               <listitem>
5887                 <para>Zinsen per anno für diese Rechnung</para>
5888               </listitem>
5889             </varlistentry>
5890
5891             <varlistentry>
5892               <term><varname>dn_invnumber</varname></term>
5893
5894               <listitem>
5895                 <para>Rechnungsnummer</para>
5896               </listitem>
5897             </varlistentry>
5898
5899             <varlistentry>
5900               <term><varname>dn_linetotal</varname></term>
5901
5902               <listitem>
5903                 <para>Noch zu zahlender Betrag (ergibt sich aus
5904                 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5905                 + <varname>dn_interest</varname>)</para>
5906               </listitem>
5907             </varlistentry>
5908
5909             <varlistentry>
5910               <term><varname>dn_netamount</varname></term>
5911
5912               <listitem>
5913                 <para>Rechnungssumme (netto)</para>
5914               </listitem>
5915             </varlistentry>
5916
5917             <varlistentry>
5918               <term><varname>dn_open_amount</varname></term>
5919
5920               <listitem>
5921                 <para>Offener Rechnungsbetrag</para>
5922               </listitem>
5923             </varlistentry>
5924
5925             <varlistentry>
5926               <term><varname>dn_ordnumber</varname></term>
5927
5928               <listitem>
5929                 <para>Bestellnummer</para>
5930               </listitem>
5931             </varlistentry>
5932
5933             <varlistentry>
5934               <term><varname>dn_transdate</varname></term>
5935
5936               <listitem>
5937                 <para>Rechnungsdatum</para>
5938               </listitem>
5939             </varlistentry>
5940
5941             <varlistentry>
5942               <term><varname>dn_curr</varname></term>
5943
5944               <listitem>
5945                 <para>Währung, in der die Rechnung erstellt wurde. (Die
5946                 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5947               </listitem>
5948             </varlistentry>
5949           </variablelist>
5950         </sect3>
5951
5952         <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5953           <title>Variablen in automatisch erzeugten Rechnungen über
5954           Mahngebühren</title>
5955
5956           <para>Die Variablen des Verkäufers stehen wie gewohnt als
5957           <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5958           Kunden stehen als Variablen <varname>name</varname>,
5959           <varname>street</varname>, <varname>zipcode</varname>,
5960           <varname>city</varname>, <varname>country</varname>,
5961           <varname>department_1</varname>, <varname>department_2</varname>,
5962           und <varname>email</varname> zur Verfügung.</para>
5963
5964           <para>Weitere Variablen beinhalten:</para>
5965
5966           <variablelist>
5967             <varlistentry>
5968               <term><varname>duedate</varname></term>
5969
5970               <listitem>
5971                 <para>Fälligkeitsdatum der Rechnung</para>
5972               </listitem>
5973             </varlistentry>
5974
5975             <varlistentry>
5976               <term><varname>dunning_id</varname></term>
5977
5978               <listitem>
5979                 <para>Mahnungsnummer</para>
5980               </listitem>
5981             </varlistentry>
5982
5983             <varlistentry>
5984               <term><varname>fee</varname></term>
5985
5986               <listitem>
5987                 <para>Mahngebühren</para>
5988               </listitem>
5989             </varlistentry>
5990
5991             <varlistentry>
5992               <term><varname>interest</varname></term>
5993
5994               <listitem>
5995                 <para>Zinsen</para>
5996               </listitem>
5997             </varlistentry>
5998
5999             <varlistentry>
6000               <term><varname>invamount</varname></term>
6001
6002               <listitem>
6003                 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
6004                 <varname>interest</varname>)</para>
6005               </listitem>
6006             </varlistentry>
6007
6008             <varlistentry>
6009               <term><varname>invdate</varname></term>
6010
6011               <listitem>
6012                 <para>Rechnungsdatum</para>
6013               </listitem>
6014             </varlistentry>
6015
6016             <varlistentry>
6017               <term><varname>invnumber</varname></term>
6018
6019               <listitem>
6020                 <para>Rechnungsnummer</para>
6021               </listitem>
6022             </varlistentry>
6023           </variablelist>
6024         </sect3>
6025       </sect2>
6026
6027       <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
6028         <title>Variablen in anderen Vorlagen</title>
6029
6030         <sect3>
6031           <title>Einführung</title>
6032
6033           <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
6034           Rechnung. Allerdings heißen die Variablen, die mit
6035           <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
6036           fangen sie mit <varname>quo</varname> für "quotation" an:
6037           <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
6038           wiederum fangen sie mit <varname>ord</varname> für "order" an:
6039           <varname>ordnumber</varname> für Bestellnummer etc.</para>
6040
6041           <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
6042           vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
6043           sind Variablen, die vom Geschäftsablauf her in der entsprechenden
6044           Vorlage keine Bedeutung haben oder noch nicht belegt sein
6045           können.</para>
6046
6047           <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
6048           in Rechnungen aufgeführt.</para>
6049         </sect3>
6050
6051         <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
6052           <title>Angebote und Preisanfragen</title>
6053
6054           <variablelist>
6055             <varlistentry>
6056               <term><varname>quonumber</varname></term>
6057
6058               <listitem>
6059                 <para>Angebots- bzw. Anfragenummer</para>
6060               </listitem>
6061             </varlistentry>
6062
6063             <varlistentry>
6064               <term><varname>reqdate</varname></term>
6065
6066               <listitem>
6067                 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
6068                 Preisanfragen)</para>
6069               </listitem>
6070             </varlistentry>
6071
6072             <varlistentry>
6073               <term><varname>transdate</varname></term>
6074
6075               <listitem>
6076                 <para>Angebots- bzw. Anfragedatum</para>
6077               </listitem>
6078             </varlistentry>
6079           </variablelist>
6080         </sect3>
6081
6082         <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
6083           <title>Auftragsbestätigungen und Lieferantenaufträge</title>
6084
6085           <variablelist>
6086             <varlistentry>
6087               <term><varname>ordnumber</varname></term>
6088
6089               <listitem>
6090                 <para>Auftragsnummer</para>
6091               </listitem>
6092             </varlistentry>
6093
6094             <varlistentry>
6095               <term><varname>reqdate</varname></term>
6096
6097               <listitem>
6098                 <para>Lieferdatum</para>
6099               </listitem>
6100             </varlistentry>
6101
6102             <varlistentry>
6103               <term><varname>transdate</varname></term>
6104
6105               <listitem>
6106                 <para>Auftragsdatum</para>
6107               </listitem>
6108             </varlistentry>
6109           </variablelist>
6110         </sect3>
6111
6112         <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
6113           <title>Lieferscheine (Verkauf und Einkauf)</title>
6114
6115           <variablelist>
6116             <varlistentry>
6117               <term><varname>cusordnumber</varname></term>
6118
6119               <listitem>
6120                 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
6121                 des Lieferanten (im Einkauf)</para>
6122               </listitem>
6123             </varlistentry>
6124
6125             <varlistentry>
6126               <term><varname>donumber</varname></term>
6127
6128               <listitem>
6129                 <para>Lieferscheinnummer</para>
6130               </listitem>
6131             </varlistentry>
6132
6133             <varlistentry>
6134               <term><varname>transdate</varname></term>
6135
6136               <listitem>
6137                 <para>Lieferscheindatum</para>
6138               </listitem>
6139             </varlistentry>
6140           </variablelist>
6141
6142           <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
6143           mit den Informationen darüber, von welchem Lager und Lagerplatz aus
6144           die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
6145           Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
6146           <function>foreach</function>-Schleife ausgegeben werden. Diese
6147           Variablen sind:</para>
6148
6149           <variablelist>
6150             <varlistentry>
6151               <term><varname>si_bin</varname></term>
6152
6153               <listitem>
6154                 <para>Lagerplatz</para>
6155               </listitem>
6156             </varlistentry>
6157
6158             <varlistentry>
6159               <term><varname>si_chargenumber</varname></term>
6160
6161               <listitem>
6162                 <para>Chargennummer</para>
6163               </listitem>
6164             </varlistentry>
6165
6166             <varlistentry>
6167               <term><varname>si_bestbefore</varname></term>
6168
6169               <listitem>
6170                 <para>Mindesthaltbarkeit</para>
6171               </listitem>
6172             </varlistentry>
6173
6174             <varlistentry>
6175               <term><varname>si_number</varname></term>
6176
6177               <listitem>
6178                 <para>Artikelnummer</para>
6179               </listitem>
6180             </varlistentry>
6181
6182             <varlistentry>
6183               <term><varname>si_qty</varname></term>
6184
6185               <listitem>
6186                 <para>Anzahl bzw. Menge</para>
6187               </listitem>
6188             </varlistentry>
6189
6190             <varlistentry>
6191               <term><varname>si_runningnumber</varname></term>
6192
6193               <listitem>
6194                 <para>Positionsnummer (1, 2, 3 etc)</para>
6195               </listitem>
6196             </varlistentry>
6197
6198             <varlistentry>
6199               <term><varname>si_unit</varname></term>
6200
6201               <listitem>
6202                 <para>Einheit</para>
6203               </listitem>
6204             </varlistentry>
6205
6206             <varlistentry>
6207               <term><varname>si_warehouse</varname></term>
6208
6209               <listitem>
6210                 <para>Lager</para>
6211               </listitem>
6212             </varlistentry>
6213           </variablelist>
6214         </sect3>
6215
6216         <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
6217           <title>Variablen für Sammelrechnung</title>
6218
6219           <variablelist>
6220             <varlistentry>
6221               <term><varname>c0total</varname></term>
6222
6223               <listitem>
6224                 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit &lt; 30
6225                 Tage</para>
6226               </listitem>
6227             </varlistentry>
6228
6229             <varlistentry>
6230               <term><varname>c30total</varname></term>
6231
6232               <listitem>
6233                 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit &gt;= 30
6234                 und &lt; 60 Tage</para>
6235               </listitem>
6236             </varlistentry>
6237
6238             <varlistentry>
6239               <term><varname>c60total</varname></term>
6240
6241               <listitem>
6242                 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit &gt;= 60
6243                 und &lt; 90 Tage</para>
6244               </listitem>
6245             </varlistentry>
6246
6247             <varlistentry>
6248               <term><varname>c90total</varname></term>
6249
6250               <listitem>
6251                 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit &gt;= 90
6252                 Tage</para>
6253               </listitem>
6254             </varlistentry>
6255
6256             <varlistentry>
6257               <term><varname>total</varname></term>
6258
6259               <listitem>
6260                 <para>Gesamtbetrag aller Rechnungen</para>
6261               </listitem>
6262             </varlistentry>
6263           </variablelist>
6264
6265           <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
6266
6267           <variablelist>
6268             <varlistentry>
6269               <term><varname>invnumber</varname></term>
6270
6271               <listitem>
6272                 <para>Rechnungsnummer</para>
6273               </listitem>
6274             </varlistentry>
6275
6276             <varlistentry>
6277               <term><varname>invdate</varname></term>
6278
6279               <listitem>
6280                 <para>Rechnungsdatum</para>
6281               </listitem>
6282             </varlistentry>
6283
6284             <varlistentry>
6285               <term><varname>duedate</varname></term>
6286
6287               <listitem>
6288                 <para>Fälligkeitsdatum</para>
6289               </listitem>
6290             </varlistentry>
6291
6292             <varlistentry>
6293               <term><varname>amount</varname></term>
6294
6295               <listitem>
6296                 <para>Summe der Rechnung</para>
6297               </listitem>
6298             </varlistentry>
6299
6300             <varlistentry>
6301               <term><varname>open</varname></term>
6302
6303               <listitem>
6304                 <para>Noch offener Betrag der Rechnung</para>
6305               </listitem>
6306             </varlistentry>
6307
6308             <varlistentry>
6309               <term><varname>c0</varname></term>
6310
6311               <listitem>
6312                 <para>Noch offener Rechnungsbetrag mit Fälligkeit &lt; 30
6313                 Tage</para>
6314               </listitem>
6315             </varlistentry>
6316
6317             <varlistentry>
6318               <term><varname>c30</varname></term>
6319
6320               <listitem>
6321                 <para>Noch offener Rechnungsbetrag mit Fälligkeit &gt;= 30 und
6322                 &lt; 60 Tage</para>
6323               </listitem>
6324             </varlistentry>
6325
6326             <varlistentry>
6327               <term><varname>c60</varname></term>
6328
6329               <listitem>
6330                 <para>Noch offener Rechnungsbetrag mit Fälligkeit &gt;= 60 und
6331                 &lt; 90 Tage</para>
6332               </listitem>
6333             </varlistentry>
6334
6335             <varlistentry>
6336               <term><varname>c90</varname></term>
6337
6338               <listitem>
6339                 <para>Noch offener Rechnungsbetrag mit Fälligkeit &gt;= 90
6340                 Tage</para>
6341               </listitem>
6342             </varlistentry>
6343           </variablelist>
6344         </sect3>
6345       </sect2>
6346
6347       <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
6348         <title>Blöcke, bedingte Anweisungen und Schleifen</title>
6349
6350         <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
6351           <title>Einführung</title>
6352
6353           <para>Der Parser kennt neben den Variablen einige weitere
6354           Konstrukte, die gesondert behandelt werden. Diese sind wie
6355           Variablennamen in spezieller Weise markiert:
6356           <command>&lt;%anweisung%&gt; ... &lt;%end%&gt;</command></para>
6357
6358           <para>Anmerkung zum <command>&lt;%end%&gt;</command>: Der besseren
6359           Verständlichkeit halber kann man nach dem <command>end</command>
6360           noch beliebig weitere Wörter schreiben, um so zu markieren, welche
6361           Anweisung (z.B. <command>if</command> oder
6362           <command>foreach</command>) damit abgeschlossen wird.</para>
6363
6364           <para>Beispiel: Lautet der Beginn eines Blockes z.B.
6365           <command>&lt;%if type == "sales_quotation"%&gt;</command>, so könnte
6366           er mit <command>&lt;%end%&gt;</command> genauso abgeschlossen werden
6367           wie mit <command>&lt;%end if%&gt;</command> oder auch
6368           <command>&lt;%end type == "sales_quotation"%&gt;</command>.</para>
6369         </sect3>
6370
6371         <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
6372           <title>Der if-Block</title>
6373
6374           <programlisting>&lt;%if variablenname%&gt;
6375 ...
6376 &lt;%end%&gt;</programlisting>
6377
6378           <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
6379           und dem "end" werden nur ausgegeben, wenn die Variable
6380           <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
6381
6382           <para>Handelt es sich bei der benannten Variable um ein Array, also
6383           um einen Variablennamen, über den man mit <command>&lt;%foreach
6384           variablenname%&gt;</command> iteriert, so wird mit diesem Konstrukt
6385           darauf getestet, ob das Array Elemente enthält. Somit würde im
6386           folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
6387           ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
6388           welche getätigt wurden:</para>
6389
6390           <programlisting>&lt;%if payment%&gt;
6391 Zahlungseingänge:
6392  &lt;%foreach payment%&gt;
6393    Am &lt;%paymentdate%&gt;: &lt;%payment%&gt; €
6394  &lt;%end foreach%&gt;
6395 &lt;%end if%&gt;</programlisting>
6396
6397           <para>Die Bedingung kann auch negiert werden, indem das Wort
6398           <function>not</function> nach dem <filename>if</filename> verwendet
6399           wird. Beispiel:</para>
6400
6401           <programlisting>&lt;%if not cp_greeting%&gt;
6402 ...
6403 &lt;%end%&gt;</programlisting>
6404
6405           <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
6406           oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
6407           einer Variablen mit einer festen Zeichenkette oder einer anderen
6408           Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
6409           oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
6410           die rechte Seite des Vergleichsoperators in Anführungszeichen
6411           gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
6412           anderer Variablen). Zwei Beispiele, die beide Vergleiche
6413           zeigen:</para>
6414
6415           <programlisting>&lt;%if var1 == "Wert"%&gt;</programlisting>
6416
6417           <para>Testet die Variable <varname>var1</varname> auf
6418           übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
6419           Mittels <function>!=</function> anstelle von <function>==</function>
6420           würde auf Ungleichheit getestet.</para>
6421
6422           <programlisting>&lt;%if var1 == var2%&gt;</programlisting>
6423
6424           <para>Testet die Variable <varname>var1</varname> auf
6425           übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
6426           <function>!=</function> anstelle von <function>==</function> würde
6427           auf Ungleichheit getestet.</para>
6428
6429           <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
6430           auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
6431           Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
6432           dieselbe Syntax wie oben nur mit <function>=~</function> und
6433           <function>!~</function> als Vergleichsoperatoren.</para>
6434
6435           <para>Beispiel für einen Test, ob die Variable
6436           <varname>intnotes</varname> (interne Bemerkungen) das Wort
6437           <constant>schwierig</constant> enthält:</para>
6438
6439           <programlisting>&lt;%if intnotes =~ "schwierig"%&gt;</programlisting>
6440         </sect3>
6441
6442         <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
6443           <title>Der foreach-Block</title>
6444
6445           <programlisting>&lt;%foreach variablenname%&gt;
6446 ...
6447 &lt;%end%&gt;</programlisting>
6448
6449           <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
6450           wie das Perl-Array der Variablen <varname>variablenname</varname>
6451           Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
6452           Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
6453           benutzt. In jedem Durchlauf werden die <link
6454           linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
6455           Variablen</link> jeweils auf den Wert für die aktuelle Position
6456           gesetzt.</para>
6457
6458           <para>Die Syntax sieht normalerweise wie folgt aus:</para>
6459
6460           <programlisting>&lt;%foreach number%&gt;
6461 Position: &lt;%runningnumber%&gt;
6462 Anzahl: &lt;%qty%&gt;
6463 Artikelnummer: &lt;%number%&gt;
6464 Beschreibung: &lt;%description%&gt;
6465 ...
6466 &lt;%end%&gt;</programlisting>
6467
6468           <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
6469           <function>&lt;%foreach%&gt;</function>-Block innerhalb einer
6470           Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
6471           wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
6472           Inhalt zwischen <function>&lt;%foreach%&gt;</function> und
6473           <function>&lt;%end%&gt;</function> wiederholt, nicht aber die
6474           komplette Zeile, in der er steht.</para>
6475         </sect3>
6476       </sect2>
6477
6478       <sect2 id="dokumentenvorlagen-und-variablen.markup">
6479         <title>Markup-Code zur Textformatierung innerhalb von
6480         Formularen</title>
6481
6482         <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6483         anders formatiert haben möchte, so ist dies begrenzt möglich.
6484         kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6485         Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6486         Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6487         dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6488         (HTML oder PDF über LaTeX) umgesetzt.</para>
6489
6490         <para>Die unterstützen Formatierungen sind:</para>
6491
6492         <variablelist>
6493           <varlistentry>
6494             <term>&lt;b&gt;Text&lt;/b&gt;</term>
6495
6496             <listitem>
6497               <para>Text wird in Fettdruck gesetzt.</para>
6498             </listitem>
6499           </varlistentry>
6500
6501           <varlistentry>
6502             <term>&lt;i&gt;Text&lt;/i&gt;</term>
6503
6504             <listitem>
6505               <para>Text wird kursiv gesetzt.</para>
6506             </listitem>
6507           </varlistentry>
6508
6509           <varlistentry>
6510             <term>&lt;u&gt;Text&lt;/u&gt;</term>
6511
6512             <listitem>
6513               <para>Text wird unterstrichen.</para>
6514             </listitem>
6515           </varlistentry>
6516
6517           <varlistentry>
6518             <term>&lt;s&gt;Text&lt;/s&gt;</term>
6519
6520             <listitem>
6521               <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6522               bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6523             </listitem>
6524           </varlistentry>
6525
6526           <varlistentry>
6527             <term>&lt;bullet&gt;</term>
6528
6529             <listitem>
6530               <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6531               unten).</para>
6532             </listitem>
6533           </varlistentry>
6534         </variablelist>
6535
6536         <para>Der Befehl <command>&lt;bullet&gt;</command> funktioniert
6537         momentan auch nur in Latex-Vorlagen.</para>
6538       </sect2>
6539
6540       <sect2 id="dokumentenvorlagen-und-variablen.anrede"
6541              xreflabel="Hinweise zur Anrede">
6542         <title>Hinweise zur Anrede</title>
6543
6544         <para>Das Flag "natürliche Person"
6545         (<varname>natural_person</varname>) aus den Kunden- oder
6546         Lieferantenstammdaten kann in den Druckvorlagen zusammen mit
6547         dem Feld "Anrede" (<varname>greeting</varname>) z.B. dafür
6548         verwendet werden, die Anrede zwischen einer allgemeinen und
6549         einer persönlichen Anrede zu unterscheiden.
6550         <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>
6551         </para>
6552       </sect2>
6553
6554     </sect1>
6555
6556     <sect1 id="excel-templates">
6557       <title>Excel-Vorlagen</title>
6558
6559       <sect2 id="excel-templates.summary">
6560         <title>Zusammenfassung</title>
6561
6562         <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6563         Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6564         einhergehen.</para>
6565       </sect2>
6566
6567       <sect2 id="excel-templates.usage">
6568         <title>Bedienung</title>
6569
6570         <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6571         werden. Die Konfigurationsoption heißt <varname>excel_templates =
6572         1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6573
6574         <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6575         anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6576         werden. In den normalen Verkaufsmasken taucht nun
6577         <constant>Excel</constant> als auswählbares Format auf und kann von da
6578         an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6579
6580         <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6581         eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6582         <filename>sales_quotation.xls</filename> gespeichert.</para>
6583       </sect2>
6584
6585       <sect2 id="excel-templates.syntax">
6586         <title>Variablensyntax</title>
6587
6588         <para>Einfache Syntax:
6589         <command>&lt;&lt;varname&gt;&gt;</command></para>
6590
6591         <para>Dabei sind <constant>&lt;&lt;</constant> und
6592         <constant>&gt;&gt;</constant> die Delimiter. Da Excel auf festen
6593         Breiten besteht, kann der Tag künstlich verlängert werden, indem
6594         weitere <constant>&lt;</constant> oder <constant>&gt;</constant>
6595         eingefügt werden. Der Tag muss nicht symmetrisch sein.
6596         Beispiel:</para>
6597
6598         <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>
6599
6600         <para>Um die Limitierung der festen Breite zu reduzieren, können
6601         weitere Variablen in einem Block interpoliert werden. Whitespace wird
6602         dazwishen dann erhalten. Beispiel:</para>
6603
6604         <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>
6605
6606         <para>Die Variablen werden interpoliert, und linksbündig mit
6607         Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6608         lang, werden überzählige Zeichen abgeschnitten.</para>
6609
6610         <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6611         der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6612
6613         <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>
6614
6615         <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6616         Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6617         entfernt.</para>
6618       </sect2>
6619
6620       <sect2 id="excel-templates.limitations">
6621         <title>Einschränkungen</title>
6622
6623         <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6624         mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6625         beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6626         Text zu ersetzen.</para>
6627
6628         <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6629         <command>&lt;%if%&gt;</command> und
6630         <command>&lt;%foreach%&gt;</command> nicht vorhanden. Der Delimiter
6631         <constant>&lt;% %&gt;</constant> kommt in den Headerinformationen
6632         evtl. vor. Deshalb wurde auf den sichereren Delimiter
6633         <constant>&lt;&lt;</constant> und <constant>&gt;&gt;</constant>
6634         gewechselt.</para>
6635       </sect2>
6636     </sect1>
6637
6638     <sect1 id="features.warehouse">
6639       <title>Mandantenkonfiguration Lager</title>
6640
6641       <para>Die Lagerverwaltung in kivitendo funktioniert standardmässig wie
6642       folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6643       Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen
6644       durchzuführen. Ferner kann jede Position eines Lieferscheins ein-, bzw.
6645       ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele
6646       Lager mit beliebig vielen Lagerplätzen abgebildet werden. Die
6647       Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder
6648       Einzelposition und das Auswählen dieser Position zu einem Lager mit
6649       Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je
6650       nachdem wie die Einstellungen in der Mandatenkonfiguration gesetzt
6651       werden.</para>
6652
6653       <itemizedlist>
6654         <listitem>
6655           <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6656           ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6657           Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6658           den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6659         </listitem>
6660
6661         <listitem>
6662           <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6663           Auslagern schlägt fehl, wenn die entsprechende Menge für die
6664           Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6665           und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6666           dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6667           (Fehlbestand, o.ä.) konfiguriert sein.</para>
6668         </listitem>
6669       </itemizedlist>
6670
6671       <para>Zusätzliche Funktionshinweise:</para>
6672
6673       <itemizedlist>
6674         <listitem>
6675           <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6676           wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6677           Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6678         </listitem>
6679
6680         <listitem>
6681           <para><option>Standard-Lagerplatz verwenden, falls keiner in
6682           Stammdaten definiert</option> Wird beim 'Auslagern über
6683           Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6684           so wird mit dieser Option einfach der Standardlagerplatz
6685           verwendet.</para>
6686         </listitem>
6687       </itemizedlist>
6688     </sect1>
6689
6690     <sect1 id="features.swiss-charts-of-accounts">
6691       <title>Schweizer Kontenpläne</title>
6692
6693       <para>Seit der Version 3.5 stehen in kivitendo 3 Kontenpläne für den
6694       Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6695       Organisationen, die nicht mehrwertsteuerpflichtig sind, einer für
6696       Firmen, die mehrwertsteuerpflichtig sind und einer speziell für
6697       Vereine.</para>
6698
6699       <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6700       verwendeten KMU-Kontenrahmen und sind mit der Revision des
6701       Schweizerischen Obligationenrechts (OR) vom 1.1.2013 kompatibel,
6702       insbesondere <literal>Art.957a Abs.2</literal>.</para>
6703
6704       <para>Beim Vereinskontenplan sind standardmässig nur die Konten 1100
6705       (Debitoren CHF) und 1101 (Debitoren EUR) als Buchungskonten im Verkauf
6706       sowie die Konten 2000 (Kreditoren CHF) und 2001 (Kreditoren EUR) als
6707       Buchungskonten im Einkauf vorgesehen. Weitere Konten können bei Bedarf
6708       in den Konto-Detaileinstellungen als Einkaufs- oder Verkaufskonten
6709       konfiguriert werden.</para>
6710
6711       <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der
6712       aktuellen Version von kivitendo noch nicht integriert.</para>
6713
6714       <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6715       Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6716       Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen alle
6717       Aufwandskonten editiert werden und dort der Steuersatz auf 0% gesetzt
6718       werden.</para>
6719
6720       <para>So werden bei Kreditorenbuchungen keine Vorsteuern
6721       verbucht.</para>
6722
6723       <para>Bezugssteuern für aus dem Ausland bezogene Dienstleistungen müssen
6724       manuell verbucht werden.</para>
6725
6726       <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6727       Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne bitte an
6728       <literal>empfang@revamp-it.ch</literal> senden.</para>
6729     </sect1>
6730
6731     <sect1 id="features.part_classification">
6732       <title>Artikelklassifizierung</title>
6733
6734       <sect2>
6735         <title>Übersicht</title>
6736
6737         <para>Die Klassifizierung von Artikeln dient einer weiteren
6738         Gliederung, um zum Beispiel den Einkauf vom Verkauf zu trennen,
6739         gekennzeichnet durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel
6740         (z.B. "E"). Für jede Klassifizierung besteht eine Beschreibung und
6741         eine Abkürzung die normalerweise aus einem Zeichen besteht, kann aber
6742         auf mehrere Zeichen erweitert werden, falls zur Unterscheidung
6743         notwendig. Sinnvoll sind jedoch nur maximal 2 Zeichen.</para>
6744       </sect2>
6745
6746       <sect2>
6747         <title>Basisklassifizierung</title>
6748
6749         <para>Als Basisklassifizierungen gibt es</para>
6750
6751         <itemizedlist>
6752           <listitem>
6753             <para>Einkauf</para>
6754           </listitem>
6755
6756           <listitem>
6757             <para>Verkauf</para>
6758           </listitem>
6759
6760           <listitem>
6761             <para>Handelsware</para>
6762           </listitem>
6763
6764           <listitem>
6765             <para>Produktion</para>
6766           </listitem>
6767
6768           <listitem>
6769             <para>- keine - (diese wird bei einer Aktualisierung für alle
6770             existierenden Artikel verwendet und ist gültig für Verkauf und
6771             Einkauf)</para>
6772           </listitem>
6773         </itemizedlist>
6774
6775         <para>Es können weitere Klassifizierungen angelegt werden. So kann es
6776         z.B. für separat auszuweisende Artikel folgende Klassen geben:</para>
6777
6778         <itemizedlist>
6779           <listitem>
6780             <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
6781           </listitem>
6782
6783           <listitem>
6784             <para>Material (Verpackungsmaterial) mit Kürzel M</para>
6785           </listitem>
6786         </itemizedlist>
6787       </sect2>
6788
6789       <sect2>
6790         <title>Attribute</title>
6791
6792         <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
6793         alle gleichzeitg gültig sein können</para>
6794
6795         <itemizedlist>
6796           <listitem>
6797             <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
6798             werden</para>
6799           </listitem>
6800
6801           <listitem>
6802             <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
6803             werden</para>
6804           </listitem>
6805
6806           <listitem>
6807             <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
6808             (LaTeX) eine zusätzliche Variable</para>
6809           </listitem>
6810         </itemizedlist>
6811
6812         <para>Für das Attribut "separat ausweisen" stehen in den
6813         LaTeX-Vorlagen die Variable <emphasis
6814         role="bold">&lt;%non_separate_subtotal%&gt; </emphasis>zur Verfügung,
6815         die alle nicht separat auszuweisenden Artikelkosten saldiert, sowie
6816         pro separat auszuweisenden Klassifizierungen die Variable<emphasis
6817         role="bold">&lt; %separate_X_subtotal%&gt;</emphasis>, wobei X das
6818         Kürzel der Klassifizierung ist.</para>
6819
6820         <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
6821         role="bold">&lt;%separate_L_subtotal%&gt;</emphasis> und für
6822         Verpackungsmaterial <emphasis role="bold">
6823         &lt;%separate_M_subtotal%&gt;</emphasis>.</para>
6824       </sect2>
6825
6826       <sect2>
6827         <title>Zwei-Zeichen Abkürzung</title>
6828
6829         <para>Der Typ des Artikels und die Klassifizierung werden durch zwei
6830         Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
6831         Artikel-Typs ('P','A','S'), deutsch 'W', 'E', und 'D' für Ware
6832         Erzeugnis oder Dienstleistung und ggf. weiterer Typen.</para>
6833
6834         <para>Der zweite Buchstabe (und ggf. auch ein dritter, falls nötig)
6835         entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
6836
6837         <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
6838         Erleichterung mit dargestellt.</para>
6839       </sect2>
6840     </sect1>
6841
6842     <sect1 id="features.file_managment">
6843       <title>Dateiverwaltung (Mini-DMS)</title>
6844
6845       <sect2>
6846         <title>Übersicht</title>
6847
6848         <para>Parallel zum alten WebDAV gibt es ein Datei-Management-System,
6849         das Dateien verschiedenen Typs verwaltet. Dies können</para>
6850
6851         <orderedlist>
6852           <listitem>
6853             <para>aus ERP-Daten per LaTeX Template erzeugte
6854             PDF-Dokumente,</para>
6855           </listitem>
6856
6857           <listitem>
6858             <para>zu bestimmten ERP-Daten gehörende Anhangdateien
6859             unterschiedlichen Formats,</para>
6860           </listitem>
6861
6862           <listitem>
6863             <para>per Scanner eingelesene PDF-Dateien,</para>
6864           </listitem>
6865
6866           <listitem>
6867             <para>per E-Mail empfangene Dateianhänge unterschiedlichen
6868             Formats,</para>
6869           </listitem>
6870
6871           <listitem>
6872             <para>sowie speziel für Artikel hochgeladene Bilder sein.</para>
6873           </listitem>
6874         </orderedlist>
6875
6876         <screenshot>
6877           <screeninfo>Übersicht</screeninfo>
6878
6879           <mediaobject>
6880             <imageobject>
6881               <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
6882             </imageobject>
6883           </mediaobject>
6884         </screenshot>
6885       </sect2>
6886
6887       <sect2>
6888         <title>Struktur</title>
6889
6890         <para>Über eine vom Speichermedium unabhängige Zwischenschicht werden
6891         die Dateien und ihre Versionen in der Datenbank verwaltet. Darunter
6892         können verschiedene Implementierungen (Backends) gleichzeitig
6893         existieren:</para>
6894
6895         <itemizedlist>
6896           <listitem>
6897             <para>Dateisystem</para>
6898           </listitem>
6899
6900           <listitem>
6901             <para>WebDAV</para>
6902           </listitem>
6903
6904           <listitem>
6905             <para>Schnittstelle zu externen
6906             Dokumenten-Management-Systemen</para>
6907           </listitem>
6908
6909           <listitem>
6910             <para>andere Datenbank</para>
6911           </listitem>
6912
6913           <listitem>
6914             <para>etc ...</para>
6915           </listitem>
6916         </itemizedlist>
6917
6918         <para>Es gibt unterschiedliche Typen von Dateien. Jedem Typ läßt sich
6919         in der Mandantenkonfiguration ein bestimmtes Backend zuordnen.</para>
6920
6921         <itemizedlist>
6922           <listitem>
6923             <para>"document": Das sind entweder generierte, eingescannte oder
6924             hochgeladene PDF-Dateien, die zu bestimmten ERP-Daten
6925             (ERP-Objekte, wie z.B. Rechnung, Lieferschein) gehören.</para>
6926           </listitem>
6927
6928           <listitem>
6929             <para>"attachment": zusätzlich hochgeladene Dokumente, die an
6930             bestimmte ERP-Objekte angehängt werden, z.B. technische
6931             Zeichnungen, Aufmaße. Diese können auch für Artikel, Lieferanten
6932             und Kunden hinterlegt sein.</para>
6933           </listitem>
6934
6935           <listitem>
6936             <para>"image": Bilder für Artikel. Diese können auch verkleinert
6937             in einer Vorschau (Thumbnail) angezeigt werden.</para>
6938           </listitem>
6939         </itemizedlist>
6940
6941         <para>Zusätzlich werden in der Datenbank zu den Dateien neben der
6942         Zuordnung zu ERP-Objekten, Dateityp Dateinamen und Backend, in dem die
6943         Datei gespeichert ist, auch die Quelle der Datei notiert:</para>
6944
6945         <itemizedlist>
6946           <listitem>
6947             <para>"created": vom System erzeugte Dokumente"</para>
6948           </listitem>
6949
6950           <listitem>
6951             <para>"uploaded": hochgeladene Dokumente</para>
6952           </listitem>
6953
6954           <listitem>
6955             <para>"email": vom Mail-System empfangene Dateien</para>
6956           </listitem>
6957
6958           <listitem>
6959             <para>"scanner[1]": von einem oder mehreren Scannern erzeugte
6960             Dateien. Existieren mehrere Scanner, so sind diese durch
6961             unterschiedliche Quellennamen zu definieren.</para>
6962           </listitem>
6963         </itemizedlist>
6964
6965         <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es
6966         für "attachment" und "image" nur die Quelle "uploaded". Für "document"
6967         gibt es auf jeden Fall die Quelle "created". Die Quellen "scanner" und
6968         "email" müssen derzeit in der Datenbank konfiguriert werden (siehe
6969         <xref linkend="file_management.dbconfig"/>).</para>
6970       </sect2>
6971
6972       <sect2>
6973         <title>Anwendung</title>
6974
6975         <para>Die Daten werden bei den ERP-Objekten als extra Reiter
6976         dargestellt. Eine Verkaufsrechnung z.B. hat die Reiter "Dokumente" und
6977         "Dateianhänge".</para>
6978
6979         <screenshot>
6980           <screeninfo>Reiter "Dateianhänge"</screeninfo>
6981
6982           <mediaobject>
6983             <imageobject>
6984               <imagedata fileref="images/DMS-Anhaenge.png" scale="50"/>
6985             </imageobject>
6986           </mediaobject>
6987         </screenshot>
6988
6989         <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer
6990         Datei angezeigt. Wird eine Datei mit gleichem Namen hochgeladen, so
6991         wird eine neue Version der Datei erstellt. Vorher wird der Anwender
6992         durch einen Dialog gefragt, ob er eine neue Version anlegen will oder
6993         ob er die Datei umbenennen will, falls es eine neue Datei sein
6994         soll.</para>
6995
6996         <screenshot>
6997           <screeninfo>Reiter "Dateianhänge"</screeninfo>
6998
6999           <mediaobject>
7000             <imageobject>
7001               <imagedata contentwidth="40"
7002                          fileref="images/DMS-Anhaenge-hochladen.png"
7003                          width="100"/>
7004             </imageobject>
7005           </mediaobject>
7006         </screenshot>
7007
7008         <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
7009         solange in Summe die maximale Größe nicht überschritten wird (siehe
7010         <xref linkend="file_management.clientconfig"/>).</para>
7011
7012         <screenshot>
7013           <screeninfo>Reiter "Dokumente"</screeninfo>
7014
7015           <mediaobject>
7016             <imageobject>
7017               <imagedata fileref="images/DMS-Dokumente.png" width="500"/>
7018             </imageobject>
7019           </mediaobject>
7020         </screenshot>
7021
7022         <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt
7023         es nur "erzeugte Dokumente". Es werden alle Versionen der generierten
7024         Datei angezeigt. Für Verkaufsrechnungen kommen keine anderen Quellen
7025         zur Geltung. Werden entsprechend der <xref
7026         linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert,
7027         so sind diese z.B. bei Einkaufsrechnungen sichtbar:</para>
7028
7029         <screenshot>
7030           <screeninfo>Reiter "Dokumente"</screeninfo>
7031
7032           <mediaobject>
7033             <imageobject>
7034               <imagedata contentwidth="600"
7035                          fileref="images/DMS-Dokumente-Scanner.png"/>
7036             </imageobject>
7037           </mediaobject>
7038         </screenshot>
7039
7040         <para>Statt des Löschens wird hier die Datei zurück zur Quelle
7041         verschoben. Somit kann die Datei anschließend an ein anderes
7042         ERP-Objekt angehängt werden.</para>
7043
7044         <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie
7045         sind bisher nur bei Bildern relevant.</para>
7046       </sect2>
7047
7048       <sect2>
7049         <title>Konfigurierung</title>
7050
7051         <sect3 id="file_management.clientconfig"
7052                xreflabel="Mandantenkonfigurierung">
7053           <title>Mandantenkonfiguration</title>
7054
7055           <sect4>
7056             <title>Reiter "Features"</title>
7057
7058             <para>Unter dem Reiter <emphasis role="bold">Features</emphasis>
7059             im Abschnitt Dateimanagement ist neben dem "alten" WebDAV das
7060             Dateimangement generell zu- und abschaltbar, sowie die Zuordnung
7061             der Dateitypen zu Backends. Die Löschbarkeit von Dateien, sowie
7062             die maximale Uploadgröße sind Backend-unabhängig</para>
7063
7064             <screenshot>
7065               <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
7066
7067               <mediaobject>
7068                 <imageobject>
7069                   <imagedata fileref="images/DMS-ClientConfig.png" width="500"/>
7070                 </imageobject>
7071               </mediaobject>
7072             </screenshot>
7073
7074             <para>Die einzelnen Backends sind einzeln einschaltbar.
7075             Spezifische Backend-Konfigurierungen sind hier noch
7076             ergänzbar.</para>
7077           </sect4>
7078
7079           <sect4>
7080             <title>Reiter "Allgemeine Dokumentenanhänge"</title>
7081
7082             <para>Unter dem Reiter <emphasis role="bold">Allgemeine
7083             Dokumentenanhänge</emphasis> kann für alle ERP-Dokumente (
7084             Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und
7085             Einkauf ) allgemeingültige Anhänge hochgeladen werden.</para>
7086
7087             <screenshot>
7088               <screeninfo>Mandantenkonfig Reiter "Allgemeine
7089               Dokumentenanhänge"</screeninfo>
7090
7091               <mediaobject>
7092                 <imageobject>
7093                   <imagedata fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"
7094                              width="500"/>
7095                 </imageobject>
7096               </mediaobject>
7097             </screenshot>
7098
7099             <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die
7100             ERP-Dokumente angehängt, z.B. AGBs oder aktuelle Angebote. Es
7101             werden in dem Fall die Daten kopiert, sodass an den ERP-Dokumenten
7102             immer die Anhänge zum Generierungszeitpunkt eingebettet
7103             sind.</para>
7104           </sect4>
7105         </sect3>
7106
7107         <sect3 id="file_management.dbconfig"
7108                xreflabel="Datenbank-Konfigurierung">
7109           <title>Datenbank-Konfigurierung</title>
7110
7111           <para>Die zusätzlichen Quellen für "email" oder ein oder mehrere
7112           Scanner sind derzeit vom Administrator direkt in der
7113           Datenbanktabelle "user_preferences" einzurichten. Die "value" ist im
7114           JSON-Format mit den jeweiligen Werten des Verzeichnisses und der
7115           Beschreibung der Quelle.</para>
7116
7117           <programlisting>
7118  id |  login    |  namespace   | version |   key    |          value
7119 ----+-----------+--------------+---------+----------+---------------------------
7120   1 | #default# | file_sources | 0.00000 | scanner1 |
7121                              {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
7122   2 | #default# | file_sources | 0.00000 | scanner2 |
7123                              {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
7124   3 | #default# | file_sources | 0.00000 | emails   |
7125                              {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
7126           </programlisting>
7127
7128           <para>Es ist daran gedacht, statt dem Default-Eintrag später für
7129           bestimmte Benutzer ('login') bestimmte Quellen zuzulassen. Dies wird
7130           nach Bedarf implementiert.</para>
7131         </sect3>
7132
7133         <sect3 id="file_management.kiviconfig"
7134                xreflabel="kivitendo-Konfigurationsdatei">
7135           <title>kivitendo-Konfigurationsdatei</title>
7136
7137           <para>Dort ist im Abschnitt [paths] der relative oder absolute Pfad
7138           zum Dokumentenwurzelverzeichnis einzutragen. Dieser muss für den
7139           Webserver schreib- und lesbar sein, jedoch nicht ausführbar.</para>
7140
7141           <programlisting>
7142 [paths]
7143 document_path = /var/local/kivi_documents
7144           </programlisting>
7145
7146           <para>Unter diesem Wurzelverzeichnis wird pro Mandant automatisch
7147           ein Unterverzeichnis mit der ID des Mandanten angelegt.</para>
7148         </sect3>
7149       </sect2>
7150     </sect1>
7151
7152     <sect1>
7153       <title>Webshop-Api</title>
7154
7155       <para>Das Shopmodul bietet die Möglichkeit Onlineshopartikel und
7156       Onlineshopbestellungen zu verwalten und zu bearbeiten.</para>
7157
7158       <para>Es ist Multishopfähig, d.h. Artikel können mehreren oder
7159       unterschiedlichen Shops zugeordnet werden. Bestellungen können aus
7160       mehreren Shops geholt werden.</para>
7161
7162       <para>Zur Zeit bietet das Modul nur einen Connector zur REST-Api von
7163       Shopware. Weitere Connectoren können dazu programmiert und eingerichtet
7164       werden.</para>
7165
7166       <sect2>
7167         <title>Rechte für die Webshopapi</title>
7168
7169         <para>In der Administration können folgende Rechte vergeben
7170         werden</para>
7171
7172         <itemizedlist>
7173           <listitem>
7174             <para>Webshopartikel anlegen und bearbeiten</para>
7175           </listitem>
7176
7177           <listitem>
7178             <para>Shopbestellungen holen und bearbeiten</para>
7179           </listitem>
7180
7181           <listitem>
7182             <para>Shop anlegen und bearbeiten</para>
7183           </listitem>
7184         </itemizedlist>
7185       </sect2>
7186
7187       <sect2>
7188         <title>Konfiguration</title>
7189
7190         <para>Unter System-&gt;Webshops können Shops angelegt und konfiguriert
7191         werden</para>
7192
7193         <mediaobject>
7194           <imageobject>
7195             <imagedata contentdepth="500" contentwidth="700"
7196                        fileref="images/Shop_Listing.png"/>
7197           </imageobject>
7198         </mediaobject>
7199       </sect2>
7200
7201       <sect2>
7202         <title>Webshopartikel</title>
7203
7204         <sect3>
7205           <title>Shopvariablenreiter in Artikelstammdaten</title>
7206
7207           <para>Mit dem Recht "Shopartikel anlegen und bearbeiten" und des
7208           Markers <emphasis role="bold">"Shopartikel" in den Basisdaten
7209           </emphasis>zeigt sich der Reiter "Shopvariablen" in den
7210           Artikelstammdaten. Hier können jetzt die Artikel mit
7211           unterschiedlichen Beschreibung und/oder Preisen für die
7212           konfigutierten Shops angelegt und bearbeitet werden. An dieser
7213           Stelle können auch beliebig viele Bilder dem Shopartikel zugeordnet
7214           werden. Artikelbilder gelten für alle Shops.</para>
7215
7216           <mediaobject>
7217             <imageobject>
7218               <imagedata contentdepth="500" contentwidth="600"
7219                          fileref="images/Shop_Artikel.png"/>
7220             </imageobject>
7221           </mediaobject>
7222
7223           <para>Die Artikelgruppen werden direkt vom Shopsystem geholt somit
7224           ist es möglich einen Artikel auch mehreren Gruppen
7225           zuzuordenen</para>
7226         </sect3>
7227
7228         <sect3>
7229           <title>Shopartikelliste</title>
7230
7231           <para>Unter dem Menu Webshop-&gt;Webshop Artikel hat man nochmal
7232           eine Gesamtübersicht. Von hier aus ist es möglich Artikel im Stapel
7233           unter verschiedenen Kriterien &lt;alles&gt;&lt;nur Preis&gt;&lt;nur
7234           Bestand&gt;&lt;Preis und Bestand&gt; an die jeweiligen Shops
7235           hochzuladen.</para>
7236
7237           <mediaobject>
7238             <imageobject>
7239               <imagedata fileref="images/Shop_Artikel_Listing.png"/>
7240             </imageobject>
7241           </mediaobject>
7242         </sect3>
7243       </sect2>
7244
7245       <sect2>
7246         <title>Bestellimport</title>
7247
7248         <para>Unter dem Menupunkt Webshop-&gt;Webshop Import öffnet sich die
7249         Bestellimportsliste. Hier ist sind Möglichkeiten gegeben Neue
7250         Bestellungen vom Shop abzuholen, geholte Bestellungen im Stapel oder
7251         einzeln als Auftrag zu transferieren. Die Liste kann nach
7252         verschiedenen Kriterien gefiltert werden.</para>
7253
7254         <mediaobject>
7255           <imageobject>
7256             <imagedata fileref="images/Shop_Bestell.png"/>
7257           </imageobject>
7258         </mediaobject>
7259
7260         <para>Bei Einträgen in der Liste.</para>
7261
7262         <itemizedlist>
7263           <listitem>
7264             <para>keine Kundennummer: Es gibt ähnliche Kundendatensätze und
7265             der Datensatz konnte nicht eindeutig zugewiesen werden.</para>
7266           </listitem>
7267
7268           <listitem>
7269             <para>Kundennummer und Rechnungen rot hinterlegt: Der Kunde hat
7270             offene Posten und kann deswegen nicht im Stapel übernommen
7271             werden.</para>
7272           </listitem>
7273
7274           <listitem>
7275             <para>Rechnungsadresse grün hinterlegt: Der Kunde konnte eindeutig
7276             einem Datensatz zugeordnet werden. Die Shopbestellung kann im
7277             Stapel mit dem Button "Anwenden" und wenn markiert als Auftrag
7278             übernommen werden.</para>
7279           </listitem>
7280
7281           <listitem>
7282             <para>Kundennummer vorhanden, aber die Checkbox "Auftrag
7283             erstellen" fehlt. Der Kunde hat vermutlich eine
7284             Shopauftragssperre.</para>
7285           </listitem>
7286
7287           <listitem>
7288             <para>Lieferadresse grau hinterlegt: Optische Anzeige, dass es
7289             sich um eine unterschiedliche Lieferadresse handelt.
7290             Lieferadressen werden aber grundsätzlich beim Transferieren zu
7291             Aufträgen mit übernommen.</para>
7292           </listitem>
7293
7294           <listitem>
7295             <para>In der Spalte Positionen/Betrag/Versandkosten zeigt sich ein
7296             tooltip zu den Positionen.</para>
7297           </listitem>
7298         </itemizedlist>
7299
7300         <para>Maske Auftrag erstellen</para>
7301
7302         <para>Viele Shopsysteme haben drei verschieden Adresstypen Kunden-,
7303         Rechnungs-, und Lieferadresse, die sich auch alle unterscheiden
7304         können. Diese werden im oberen Bereich angezeigt. Es ist möglich jede
7305         dieser Adresse einzeln in kivitendo als Kunde zu übernehmen. Es werden
7306         die Werte Formulareingabe übernommen. Es wird bei einer Änderung
7307         allerdings nur diese in die kivitendo Kundenstammdaten übernommen, die
7308         Shopbestellung bleibt bestehen.</para>
7309
7310         <para>Mit der mittleren Adresse(Rechnungsadresse) im oberen Bereich,
7311         kann ich den ausgewählten kivitendodatensatz des mittleren Bereich
7312         überschreiben. Das ist sinnvoll, wenn ich erkenne, das der Kunde z.B.
7313         umgezogen ist.</para>
7314
7315         <para>Im mittleren Bereich das Adresslisting zeigt:</para>
7316
7317         <itemizedlist>
7318           <listitem>
7319             <para>Rot hinterlegt: Kunde hat eine Shopauftragssperre, diese
7320             muss zuerst deaktiviert werden bevor ich diesem Kunden eine
7321             Shopbestellung zuordnen kann.</para>
7322           </listitem>
7323
7324           <listitem>
7325             <para>Kundenname fett und rot: Hier hat der Kunde eine Bemerkung
7326             in den Stammdaten. Ein Tooltip zeigt diese Bemerkung. Das kann dan
7327             auch der Grund für die Auftragssperre sein.</para>
7328           </listitem>
7329
7330           <listitem>
7331             <para>Die Buttons "Auftrag erstellen" und "Kunde mit
7332             Rechnungsadresse überschreiben" zeigen sich erst, wenn ein Kunde
7333             aus dem Listing ausgewählt ist.</para>
7334           </listitem>
7335
7336           <listitem>
7337             <para>Es ist aber möglich die Shopbestellung zu löschen.</para>
7338           </listitem>
7339
7340           <listitem>
7341             <para>Ist eine Bestellung schon übernommen, zeigen sich an dieser
7342             Stelle, die dazugehörigen Belegverknüpfungen.</para>
7343           </listitem>
7344         </itemizedlist>
7345       </sect2>
7346
7347       <sect2>
7348         <title>Mapping der Daten</title>
7349
7350         <para>Das Mapping der kivitendo Daten mit den Shopdaten geschieht in
7351         der Datei SL/ShopConnector/&lt;SHOPCONNECTORNAME&gt;.pm
7352         z.B.:SL/ShopConnector/Shopware.pm</para>
7353
7354         <para>In dieser Datei gibt es einen Bereich wo die Bestellpostionen,
7355         die Bestellkopfdaten und die Artikeldaten gemapt werden. In dieser
7356         Datei kann ein individelles Mapping dann gemacht werden. Zu Shopware
7357         gibt es hier eine sehr gute Dokumentation: <ulink
7358         url="https://developers.shopware.com/developers-guide/rest-api/">https://developers.shopware.com/developers-guide/rest-api/</ulink></para>
7359       </sect2>
7360     </sect1>
7361         <sect1 id="features.zugferd">
7362                 <title>ZUGFeRD Rechnungen</title>
7363                 <sect2 id="features.zugferd.preamble">
7364                         <title>Vorbedingung</title>
7365          <para>
7366           Für die Erstellung von ZUGFeRD PDFs wird TexLive2018 oder höher benötigt.
7367          </para>
7368         <note>
7369          <para>
7370           Wer kein TexLive2018 oder höher installieren kann, kann eine lokale Umgebung nur für kivitendo wie folgt erzeugen:
7371          </para>
7372         <programlisting>
7373         1. Download des offiziellen Installers von https://www.tug.org/texlive/quickinstall.html
7374
7375         2. Installer ausführen, Standard-Ort für Installation belassen, evtl. ein paar Pakete abwählen, installieren lassen
7376
7377         3. Ein kleine Script »run_pdflatex.sh« anlegen, das den PATH auf das  Installationsverezichnis setzt und pdflatex ausführt:
7378
7379         ------------------------------------------------------------
7380         #!/bin/bash
7381
7382         export PATH=/usr/local/texlive/2020/bin/x86_64-linux:$PATH
7383         hash -r
7384
7385         exec pdflatex &quot;$@&quot;
7386         ------------------------------------------------------------
7387
7388         4. In config/kivitendo.conf den Parameter »latex« auf den Pfad zu »run_pdflatex.sh« setzen
7389
7390         5. Webserver neu starten
7391         </programlisting>
7392       </note>
7393     </sect2>
7394                 <sect2 id="features.zugferd.summary">
7395                         <title>Übersicht</title>
7396
7397                         <para>Mit der Version 3.5.6 bietet kivitendo die Möglichkeit ZUGFeRD
7398                         Rechnungen zu erstellen, sowie auch  ZUGFeRD Rechnungen direkt in
7399                         kivitendo einzulesen. </para>
7400
7401                         <para>Bei  ZUGFeRD Rechnungen handelt es sich um eine PDF Datei in
7402                         der eine XML-Datei eingebettet ist. Der Aufbau der XML-Datei ist
7403                         standardisiert und ermöglicht so den Austausch zwischen
7404                         den verschiedenen Softwareprodukten. Kivitendo setzt mit der
7405                         Version 3.5.6 den ZUGFeRD 2.1 Standard um.</para>
7406
7407                         <para>Weiter Details zu ZUGFeRD sind unter diesem Link zu finden:
7408                         <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>
7409       </para>
7410                 </sect2>
7411
7412                 <sect2 id="features.zugferd.create_zugferd_bills">
7413
7414                         <title>Erstellen von ZUGFeRD Rechnungen in Kivitendo</title>
7415                         <para>Für die Erstellung von ZUGFeRD Rechnungen bedarf es in
7416                         kivitendo zwei Dinge:</para>
7417
7418                         <orderedlist>
7419
7420                                 <listitem>
7421                                         <para>Die Erstellung muss in der Mandantenkonfiguration
7422                                         aktiviert sein</para>
7423                                 </listitem>
7424
7425                                 <listitem>
7426                                         <para>Beim mindestens einem Bankkonto muss die Option
7427                                         „Nutzung von ZUGFeRD“ aktiviert sein</para>
7428                                 </listitem>
7429
7430                         </orderedlist>
7431                         <sect3>
7432                                 <title>Mandantenkonfiguration</title>
7433
7434                                 <para>Die Einstellung für die Erstellung von ZUGFeRD Rechnungen
7435                                 erfolgt unter „System“ → „Mandatenkonfiguration“ → „Features“.
7436                                 Im Abschnitt „Einkauf und Verkauf“ finden Sie die Einstellung
7437                                 „Verkaufsrechnungen mit ZUGFeRD-Daten erzeugen“.
7438                                 Hier besteht die Auswahl zwischen:</para>
7439
7440                                 <itemizedlist>
7441                                         <listitem>
7442                                                 <para>ZUGFeRD-Rechnungen erzeugen</para>
7443                                         </listitem>
7444
7445                                         <listitem>
7446                                                 <para>ZUGFeRD-Rechnungen im Testmodus erzeugen</para>
7447                                         </listitem>
7448
7449                                         <listitem>
7450                                                 <para>Keine ZUGFeRD Rechnungen erzeugen</para>
7451                                         </listitem>
7452
7453                                 </itemizedlist>
7454
7455                                 <para>Rechnungen die als PDF erzeugt werden, werden je nach
7456                                 Einstellung nun im ZUGFeRD Format ausgegeben.</para>
7457
7458                         </sect3>
7459
7460                         <sect3>
7461                                 <title>Konfiguration der Bankkonten</title>
7462
7463                                 <para>Unter „System → Bankkonten“ muss bei mindestens einem
7464                                 Bankkonto die Option „Nutzung mit ZUGFeRD“ auf „Ja“ gestellt
7465                                 werden.</para>
7466                         </sect3>
7467
7468                 </sect2>
7469
7470                 <sect2 id="features.zugferd.read_zugferd_bills">
7471
7472                         <title>Einlesen von ZUGFeRD Rechnungen in Kivitendo</title>
7473
7474                         <para>Es lassen sich auch Rechnungen von Kreditoren, die im
7475                         ZUGFeRD Format erstellt wurden, nach Kivitendo importieren.
7476                         Hierfür müssen auch zwei Voraussetzungen erfüllt werden:
7477                         </para>
7478
7479                         <orderedlist>
7480
7481                                 <listitem>
7482                                         <para>Beim Lieferanten muss die Umsatzsteuer-ID und das
7483                                         Bankkonto hinterlegt sein</para>
7484                                 </listitem>
7485
7486                                 <listitem>
7487                                         <para>Für den Kreditoren muss eine Buchungsvorlage existieren.</para>
7488                                 </listitem>
7489
7490                         </orderedlist>
7491
7492                         <para>Wenn diese Voraussetzungen erfüllt sind, kann die Rechnung
7493                         über „Finanzbuchhaltung“ → „Factur-X-/ZUGFeRD-Import“ über die „Durchsuchen“
7494                         Schaltfläche ausgewählt werden und über die Schaltfläche „Import“
7495                         eingeladen werden. Es öffnet sich daraufhin die Kreditorenbuchung.
7496                         Die auslesbaren Daten aus dem eingebetteten XML der PDF Datei
7497                         werden in der Kreditorenbuchung ergänzt.</para>
7498
7499                 </sect2>
7500
7501         </sect1>
7502
7503   </chapter>
7504
7505   <chapter>
7506     <title>Entwicklerdokumentation</title>
7507
7508     <sect1 id="devel.globals" xreflabel="Globale Variablen">
7509       <title>Globale Variablen</title>
7510
7511       <sect2>
7512         <title>Wie sehen globale Variablen in Perl aus?</title>
7513
7514         <para>Globale Variablen liegen in einem speziellen namespace namens
7515         "main", der von überall erreichbar ist. Darüber hinaus sind bareword
7516         globs global und die meisten speziellen Variablen sind...
7517         speziell.</para>
7518
7519         <para>Daraus ergeben sich folgende Formen:</para>
7520
7521         <variablelist>
7522           <varlistentry>
7523             <term><literal>$main::form</literal></term>
7524
7525             <listitem>
7526               <para>expliziter Namespace "main"</para>
7527             </listitem>
7528           </varlistentry>
7529
7530           <varlistentry>
7531             <term><literal>$::form</literal></term>
7532
7533             <listitem>
7534               <para>impliziter Namespace "main"</para>
7535             </listitem>
7536           </varlistentry>
7537
7538           <varlistentry>
7539             <term><literal>open FILE, "file.txt"</literal></term>
7540
7541             <listitem>
7542               <para><varname>FILE</varname> ist global</para>
7543             </listitem>
7544           </varlistentry>
7545
7546           <varlistentry>
7547             <term><literal>$_</literal></term>
7548
7549             <listitem>
7550               <para>speziell</para>
7551             </listitem>
7552           </varlistentry>
7553         </variablelist>
7554
7555         <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
7556         Schlüsselwort wie "<function>global</function>", mit dem man
7557         importieren kann. <function>my</function>, <function>our</function>
7558         und <function>local</function> machen was anderes.</para>
7559
7560         <variablelist>
7561           <varlistentry>
7562             <term><literal>my $form</literal></term>
7563
7564             <listitem>
7565               <para>lexikalische Variable, gültig bis zum Ende des
7566               Scopes</para>
7567             </listitem>
7568           </varlistentry>
7569
7570           <varlistentry>
7571             <term><literal>our $form</literal></term>
7572
7573             <listitem>
7574               <para><varname>$form</varname> referenziert ab hier
7575               <varname>$PACKAGE::form</varname>.</para>
7576             </listitem>
7577           </varlistentry>
7578
7579           <varlistentry>
7580             <term><literal>local $form</literal></term>
7581
7582             <listitem>
7583               <para>Alle Änderungen an <varname>$form</varname> werden am Ende
7584               des scopes zurückgesetzt</para>
7585             </listitem>
7586           </varlistentry>
7587         </variablelist>
7588       </sect2>
7589
7590       <sect2>
7591         <title>Warum sind globale Variablen ein Problem?</title>
7592
7593         <para>Das erste Problem ist <productname>FCGI</productname>.</para>
7594
7595         <para><productname>SQL-Ledger</productname> hat fast alles im globalen
7596         namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
7597         Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
7598         aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
7599         Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
7600         Datenbankverbindungen, weil die sehr lange zum Initialisieren
7601         brauchen.</para>
7602
7603         <para>Das zweite Problem ist <function>strict</function>. Unter
7604         <function>strict</function> werden alle Variablen die nicht explizit
7605         mit <function>Package</function>, <function>my</function> oder
7606         <function>our</function> angegeben werden als Tippfehler angemarkert,
7607         dies hat, seit der Einführung, u.a. schon so manche langwierige
7608         Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
7609         angegeben werden, werden die nicht geprüft, und somit kann sich
7610         schnell ein Tippfehler einschleichen.</para>
7611       </sect2>
7612
7613       <sect2>
7614         <title>Kanonische globale Variablen</title>
7615
7616         <para>Um dieses Problem im Griff zu halten gibt es einige wenige
7617         globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
7618         vorgegebenen Eigenschaften, und alles andere sollte anderweitig
7619         umhergereicht werden.</para>
7620
7621         <para>Diese Variablen sind im Moment die folgenden neun:</para>
7622
7623         <itemizedlist>
7624           <listitem>
7625             <para><varname>$::form</varname></para>
7626           </listitem>
7627
7628           <listitem>
7629             <para><varname>%::myconfig</varname></para>
7630           </listitem>
7631
7632           <listitem>
7633             <para><varname>$::locale</varname></para>
7634           </listitem>
7635
7636           <listitem>
7637             <para><varname>$::lxdebug</varname></para>
7638           </listitem>
7639
7640           <listitem>
7641             <para><varname>$::auth</varname></para>
7642           </listitem>
7643
7644           <listitem>
7645             <para><varname>$::lx_office_conf</varname></para>
7646           </listitem>
7647
7648           <listitem>
7649             <para><varname>$::instance_conf</varname></para>
7650           </listitem>
7651
7652           <listitem>
7653             <para><varname>$::dispatcher</varname></para>
7654           </listitem>
7655
7656           <listitem>
7657             <para><varname>$::request</varname></para>
7658           </listitem>
7659         </itemizedlist>
7660
7661         <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
7662         Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
7663         Eigenschaften (Konventionen):</para>
7664
7665         <sect3>
7666           <title>$::form</title>
7667
7668           <itemizedlist>
7669             <listitem>
7670               <para>Ist ein Objekt der Klasse
7671               "<classname>Form</classname>"</para>
7672             </listitem>
7673
7674             <listitem>
7675               <para>Wird nach jedem Request gelöscht</para>
7676             </listitem>
7677
7678             <listitem>
7679               <para>Muss auch in Tests und Konsolenscripts vorhanden
7680               sein.</para>
7681             </listitem>
7682
7683             <listitem>
7684               <para>Enthält am Anfang eines Requests die Requestparameter vom
7685               User</para>
7686             </listitem>
7687
7688             <listitem>
7689               <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
7690               cachen, das wird aber momentan absichtlich zerstört</para>
7691             </listitem>
7692           </itemizedlist>
7693
7694           <para><varname>$::form</varname> wurde unter <productname>SQL
7695           Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
7696           alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
7697           heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
7698           gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
7699           <function>IS-&gt;retrieve_customer()</function> in Sicherheit
7700           bringen.</para>
7701
7702           <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
7703           Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
7704           3552, Stand version 2.7beta), um dies hinterher wieder auf den
7705           richtigen Wert zu setzen:</para>
7706
7707           <programlisting>  my $saved_numberformat    = $::myconfig{numberformat};
7708   $::myconfig{numberformat} = $numberformat;
7709   # (...) div Berechnungen
7710   $::myconfig{numberformat} = $saved_numberformat;</programlisting>
7711
7712           <para>Das Objekt der Klasse Form hat leider im Moment noch viele
7713           zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
7714           nie einfach zerstören oder überschreiben (zumindestens nicht kurz
7715           vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
7716           Es geht ziemlich sicher etwas kaputt.</para>
7717
7718           <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
7719           in den <productname>Template::Toolkit</productname> Templates
7720           außerhalb der Controller: der Ausdruck <function>[% var
7721           %]</function> greift auf <varname>$::form-&gt;{var}</varname> zu.
7722           Unter Controllern ist der Standard Scope anders, da lautet der
7723           Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
7724           normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
7725           <function>&lt;%var%&gt;</function> zeigt auf
7726           <varname>$::form-&gt;{var}</varname>. Nochmal von der anderen Seite
7727           erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
7728           Konstrukte:</para>
7729
7730           <programlisting>[%- IF business %]
7731 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
7732 [%- END %]</programlisting>
7733
7734           <para>Entweder wird hier dann $::form-&gt;{business} ausgewertet
7735           oder aber der Funktion
7736           <function>$form-&gt;parse_html_template</function> wird explizit
7737           noch ein zusätzlicher Hash übergeben, der dann auch in den
7738           (Web-)Templates zu Verfügung steht, bspw. so:</para>
7739
7740           <programlisting>$form-&gt;parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
7741
7742           <para>Innerhalb von Schleifen wird
7743           <varname>$::form-&gt;{TEMPLATE_ARRAYS}{var}[$index]</varname>
7744           bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
7745           welches über alle Positionen eines Lieferscheins in Schleife
7746           läuft:</para>
7747
7748           <programlisting>for $i (1 .. $form-&gt;{rowcount}) {
7749   # ...
7750   push @{ $form-&gt;{TEMPLATE_ARRAYS}{runningnumber} },   $position;
7751   push @{ $form-&gt;{TEMPLATE_ARRAYS}{number} },          $form-&gt;{"partnumber_$i"};
7752   push @{ $form-&gt;{TEMPLATE_ARRAYS}{description} },     $form-&gt;{"description_$i"};
7753   # ...
7754 }</programlisting>
7755         </sect3>
7756
7757         <sect3>
7758           <title>%::myconfig</title>
7759
7760           <itemizedlist>
7761             <listitem>
7762               <para>Das einzige Hash unter den globalen Variablen</para>
7763             </listitem>
7764
7765             <listitem>
7766               <para>Wird spätestens benötigt wenn auf die Datenbank
7767               zugegriffen wird</para>
7768             </listitem>
7769
7770             <listitem>
7771               <para>Wird bei jedem Request neu erstellt.</para>
7772             </listitem>
7773
7774             <listitem>
7775               <para>Enthält die Userdaten des aktuellen Logins</para>
7776             </listitem>
7777
7778             <listitem>
7779               <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
7780               extern serialisiert werden, weil da auch der Datenbankzugriff
7781               für diesen user drinsteht.</para>
7782             </listitem>
7783
7784             <listitem>
7785               <para>Enthält unter anderem Datumsformat dateformat und
7786               Nummernformat numberformat</para>
7787             </listitem>
7788
7789             <listitem>
7790               <para>Enthält Datenbankzugriffinformationen</para>
7791             </listitem>
7792           </itemizedlist>
7793
7794           <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
7795           ein Userobjekt. Die meisten Funktionen, die etwas anhand des
7796           aktuellen Users entscheiden müssen, befragen
7797           <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
7798           überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
7799           -&gt; <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
7800           Informationen über den Benutzer die über die
7801           Administrator-Schnittstelle eingegeben wurden.</para>
7802         </sect3>
7803
7804         <sect3>
7805           <title>$::locale</title>
7806
7807           <itemizedlist>
7808             <listitem>
7809               <para>Objekt der Klasse "Locale"</para>
7810             </listitem>
7811
7812             <listitem>
7813               <para>Wird pro Request erstellt</para>
7814             </listitem>
7815
7816             <listitem>
7817               <para>Muss auch für Tests und Scripte immer verfügbar
7818               sein.</para>
7819             </listitem>
7820
7821             <listitem>
7822               <para>Cached intern über Requestgrenzen hinweg benutzte
7823               Locales</para>
7824             </listitem>
7825           </itemizedlist>
7826
7827           <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
7828           Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
7829         </sect3>
7830
7831         <sect3>
7832           <title>$::lxdebug</title>
7833
7834           <itemizedlist>
7835             <listitem>
7836               <para>Objekt der Klasse "LXDebug"</para>
7837             </listitem>
7838
7839             <listitem>
7840               <para>Wird global gecached</para>
7841             </listitem>
7842
7843             <listitem>
7844               <para>Muss immer verfügbar sein, in nahezu allen
7845               Funktionen</para>
7846             </listitem>
7847           </itemizedlist>
7848
7849           <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
7850           bereit, wie "<function>enter_sub</function>" und
7851           "<function>leave_sub</function>", mit denen in den alten Modulen ein
7852           brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
7853           der man die Wallclockzeit seit Requeststart loggen kann, sowie
7854           "<function>message</function>" und "<function>dump</function>" mit
7855           denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
7856           packen kann.</para>
7857
7858           <para>Beispielsweise so:</para>
7859
7860           <programlisting>$main::lxdebug-&gt;message(0, 'Meine Konfig:' . Dumper (%::myconfig));
7861 $main::lxdebug-&gt;message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form-&gt;{vc});</programlisting>
7862         </sect3>
7863
7864         <sect3>
7865           <title>$::auth</title>
7866
7867           <itemizedlist>
7868             <listitem>
7869               <para>Objekt der Klasse "SL::Auth"</para>
7870             </listitem>
7871
7872             <listitem>
7873               <para>Wird global gecached</para>
7874             </listitem>
7875
7876             <listitem>
7877               <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
7878             </listitem>
7879
7880             <listitem>
7881               <para>Wird nach jedem Request resettet.</para>
7882             </listitem>
7883           </itemizedlist>
7884
7885           <para><varname>$::auth</varname> stellt Funktionen bereit um die
7886           Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
7887           vom aktuellen User abhängen wird das Objekt aus
7888           Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
7889           Request kurz resettet.</para>
7890
7891           <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
7892           Dessen Einstellungen können über
7893           <literal>$::auth-&gt;client</literal> abgefragt werden; Rückgabewert
7894           ist ein Hash mit den Werten aus der Tabelle
7895           <literal>auth.clients</literal>.</para>
7896         </sect3>
7897
7898         <sect3>
7899           <title>$::lx_office_conf</title>
7900
7901           <itemizedlist>
7902             <listitem>
7903               <para>Objekt der Klasse
7904               "<classname>SL::LxOfficeConf</classname>"</para>
7905             </listitem>
7906
7907             <listitem>
7908               <para>Global gecached</para>
7909             </listitem>
7910
7911             <listitem>
7912               <para>Repräsentation der
7913               <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
7914             </listitem>
7915           </itemizedlist>
7916
7917           <para>Globale Konfiguration. Configdateien werden zum Start gelesen
7918           und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
7919           das Programm die Konfiguration ändern kann oder sollte.</para>
7920
7921           <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
7922           Debug- und Trace-Log-Datei wie folgt konfiguriert und
7923           verfügbar:</para>
7924
7925           <programlisting>[debug]
7926 file_name = /tmp/kivitendo-debug.log</programlisting>
7927
7928           <para>ist der Key <varname>file</varname> im Programm als
7929           <varname>$::lx_office_conf-&gt;{debug}{file}</varname>
7930           erreichbar.</para>
7931
7932           <warning>
7933             <para>Zugriff auf die Konfiguration erfolgt im Moment über
7934             Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
7935           </warning>
7936         </sect3>
7937
7938         <sect3>
7939           <title>$::instance_conf</title>
7940
7941           <itemizedlist>
7942             <listitem>
7943               <para>Objekt der Klasse
7944               "<classname>SL::InstanceConfiguration</classname>"</para>
7945             </listitem>
7946
7947             <listitem>
7948               <para>wird pro Request neu erstellt</para>
7949             </listitem>
7950           </itemizedlist>
7951
7952           <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
7953           speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
7954           ist hier eine Mandantendatenbank. Beispielsweise überprüft
7955           <programlisting>$::instance_conf-&gt;get_inventory_system eq 'perpetual'</programlisting>
7956           ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
7957         </sect3>
7958
7959         <sect3>
7960           <title>$::dispatcher</title>
7961
7962           <itemizedlist>
7963             <listitem>
7964               <para>Objekt der Klasse
7965               "<varname>SL::Dispatcher</varname>"</para>
7966             </listitem>
7967
7968             <listitem>
7969               <para>wird pro Serverprozess erstellt.</para>
7970             </listitem>
7971
7972             <listitem>
7973               <para>enthält Informationen über die technische Verbindung zum
7974               Server</para>
7975             </listitem>
7976           </itemizedlist>
7977
7978           <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
7979           global gespeichert wird. Wird vermutlich irgendwann in einem anderen
7980           Objekt untergebracht.</para>
7981         </sect3>
7982
7983         <sect3>
7984           <title>$::request</title>
7985
7986           <itemizedlist>
7987             <listitem>
7988               <para>Hashref (evtl später Objekt)</para>
7989             </listitem>
7990
7991             <listitem>
7992               <para>Wird pro Request neu initialisiert.</para>
7993             </listitem>
7994
7995             <listitem>
7996               <para>Keine Unterstruktur garantiert.</para>
7997             </listitem>
7998           </itemizedlist>
7999
8000           <para><varname>$::request</varname> ist ein generischer Platz um
8001           Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
8002           at a distance benutzt werden, sondern um lokales memoizing zu
8003           ermöglichen, das garantiert am Ende des Requests zerstört
8004           wird.</para>
8005
8006           <para>Vieles von dem, was im moment in <varname>$::form</varname>
8007           liegt, sollte eigentlich hier liegen. Die groben
8008           Differentialkriterien sind:</para>
8009
8010           <itemizedlist>
8011             <listitem>
8012               <para>Kommt es vom User, und soll unverändert wieder an den
8013               User? Dann <varname>$::form</varname>, steht da eh schon</para>
8014             </listitem>
8015
8016             <listitem>
8017               <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
8018               Requests gebraucht werden? Dann
8019               <varname>$::request</varname></para>
8020             </listitem>
8021
8022             <listitem>
8023               <para>Muss ich von anderen Teilen des Programms lesend drauf
8024               zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
8025               Wrappermethode</para>
8026             </listitem>
8027           </itemizedlist>
8028         </sect3>
8029       </sect2>
8030
8031       <sect2>
8032         <title>Ehemalige globale Variablen</title>
8033
8034         <para>Die folgenden Variablen waren einmal im Programm, und wurden
8035         entfernt.</para>
8036
8037         <sect3>
8038           <title>$::cgi</title>
8039
8040           <itemizedlist>
8041             <listitem>
8042               <para>war nötig, weil cookie Methoden nicht als
8043               Klassenfunktionen funktionieren</para>
8044             </listitem>
8045
8046             <listitem>
8047               <para>Aufruf als Klasse erzeugt Dummyobjekt was im
8048               Klassennamespace gehalten wird und über Requestgrenzen
8049               leaked</para>
8050             </listitem>
8051
8052             <listitem>
8053               <para>liegt jetzt unter
8054               <varname>$::request-&gt;{cgi}</varname></para>
8055             </listitem>
8056           </itemizedlist>
8057         </sect3>
8058
8059         <sect3>
8060           <title>$::all_units</title>
8061
8062           <itemizedlist>
8063             <listitem>
8064               <para>war nötig, weil einige Funktionen in Schleifen zum Teil
8065               ein paar hundert mal pro Request eine Liste der Einheiten
8066               brauchen, und de als Parameter durch einen Riesenstack von
8067               Funktionen geschleift werden müssten.</para>
8068             </listitem>
8069
8070             <listitem>
8071               <para>Liegt jetzt unter
8072               <varname>$::request-&gt;{cache}{all_units}</varname></para>
8073             </listitem>
8074
8075             <listitem>
8076               <para>Wird nur in
8077               <function>AM-&gt;retrieve_all_units()</function> gesetzt oder
8078               gelesen.</para>
8079             </listitem>
8080           </itemizedlist>
8081         </sect3>
8082
8083         <sect3>
8084           <title>%::called_subs</title>
8085
8086           <itemizedlist>
8087             <listitem>
8088               <para>wurde benutzt um callsub deep recursions
8089               abzufangen.</para>
8090             </listitem>
8091
8092             <listitem>
8093               <para>Wurde entfernt, weil callsub nur einen Bruchteil der
8094               möglichen Rekursioenen darstellt, und da nie welche
8095               auftreten.</para>
8096             </listitem>
8097
8098             <listitem>
8099               <para>komplette recursion protection wurde entfernt.</para>
8100             </listitem>
8101           </itemizedlist>
8102         </sect3>
8103       </sect2>
8104     </sect1>
8105
8106     <sect1 id="devel.fcgi">
8107       <title>Entwicklung unter FastCGI</title>
8108
8109       <sect2 id="devel.fcgi.general">
8110         <title>Allgemeines</title>
8111
8112         <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
8113         werden, muss der Webserver neu gestartet werden.</para>
8114
8115         <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
8116         achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
8117         müssen folgende Aspekte beachtet werden.</para>
8118       </sect2>
8119
8120       <sect2 id="devel.fcgi.exiting">
8121         <title>Programmende und Ausnahmen</title>
8122
8123         <para>Betrifft die Funktionen <function>warn</function>,
8124         <function>die</function>, <function>exit</function>,
8125         <function>carp</function> und <function>confess</function>.</para>
8126
8127         <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
8128         Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
8129         am Laufen zu halten. Man kann mit <function>die</function>,
8130         <function>confess</function> oder <function>carp</function> Fehler
8131         ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
8132         eigene <function>$::form-</function>error()&gt; tut im Prinzip das
8133         Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
8134         <function>exit</function> hingegen werden nicht abgefangen.
8135         <function>warn</function> wird direkt nach STDERR, also in Server Log
8136         eine Nachricht schreiben (sofern in der Konfiguration nicht die
8137         Warnungen in das kivitendo Log umgeleitet wurden), und
8138         <function>exit</function> wird die Ausführung beenden.</para>
8139
8140         <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
8141         beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
8142         Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
8143         benutzen, alle anderen Exceptionmechanismen sind ok.</para>
8144       </sect2>
8145
8146       <sect2 id="devel.fcgi.globals">
8147         <title>Globale Variablen</title>
8148
8149         <para>Um zu vermeiden, dass Informationen von einem Request in einen
8150         anderen gelangen, müssen alle globalen Variablen vor einem Request
8151         sauber initialisiert werden. Das ist besonders wichtig im
8152         <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
8153         diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
8154         werden.</para>
8155
8156         <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
8157         abgetrennten Block, der alle kanonischen globalen Variablen listet und
8158         erklärt. Bitte keine anderen einführen ohne das sauber zu
8159         dokumentieren.</para>
8160
8161         <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
8162         man sicher geht, dass man die richtige erwischt.</para>
8163       </sect2>
8164
8165       <sect2 id="devel.fcgi.performance">
8166         <title>Performance und Statistiken</title>
8167
8168         <para>Die kritischen Pfade des Programms sind die Belegmasken, und
8169         unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
8170         Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
8171         4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
8172         sind es je nach Menge der definierten Variablen 1-2s. Ab der
8173         Moose/Rose::DB Version sind es 5-6s.</para>
8174
8175         <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
8176         den kritischen Pfaden, unter 0,15 sonst.</para>
8177       </sect2>
8178     </sect1>
8179
8180     <sect1 id="dev-programmatic-api-calls" xreflabel="Programmatische API-Aufrufe">
8181       <title>Programmatische API-Aufrufe</title>
8182
8183       <sect2 id="dev-programmatic-api-calls.introduction" xreflabel="Einführung in programmatische API-Aufrufe">
8184         <title>Einführung</title>
8185
8186         <para>
8187          Es ist möglich, Funktionen in kivitendo programmatisch aus anderen Programmen aufzurufen. Dazu ist nötig, dass
8188          Authentifizierungsinformationen in jedem Aufruf mitgegeben werden. Dafür gibt es zwei Methoden: die HTTP-»Basic«-Authentifizierung
8189          oder die Übergabe als spziell benannte GET-Parameter. Neben den Authentifizierungsinformationen muss auch der zu verwendende Mandant
8190          übergeben werden.
8191         </para>
8192       </sect2>
8193
8194       <sect2 id="dev-programmatic-api-calls.client_selection" xreflabel="Mandantenauswahl bei programmatischen API-Aufrufen">
8195         <title>Wahl des Mandanten</title>
8196
8197         <para>
8198          Der zu verwendende Mandant kann als Parameter <varname>{AUTH}client_id</varname> mit jedem Request mitgeschickt werden. Der Wert
8199          muss dabei die Datenbank-ID des Mandanten sein. kivitendo prüft, ob der Account, der über die Authentifizierungsinformationen
8200          übergeben wurde, Zugriff auf den angegebenen Mandanten hat.
8201         </para>
8202
8203         <para>
8204          Wird in einem Request kein Mandant mitgegeben, so wird derjenige Mandant genommen, wer als Standardmandant markiert wurde. Gibt es
8205          keinen solchen, kommt es zu einer Fehlermeldung.
8206         </para>
8207       </sect2>
8208
8209       <sect2 id="dev-programmatic-api-calls.http_basic_authentication" xreflabel="Programmatische API-Aufrufe mit HTTP-»Basic« authentifizieren">
8210         <title>HTTP-»Basic«-Authentifizierung</title>
8211
8212         <para>
8213          Für diese Methode muss jedem Request der bekannte HTTP-Header <constant>Authorization</constant> mitgeschickt werden (siehe <ulink
8214          url="https://tools.ietf.org/html/rfc7617">RFC 7617</ulink>). Unterstützt wird ausschließlich die »Basic«-Methode. Loginname und
8215          Passwort werden bei dieser Methode durch einen Doppelpunkt getrennt und Base64-encodiert im genannten HTTP-Header übertragen.
8216         </para>
8217
8218         <para>
8219          Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei Benutzung über den Webbrowser, ob
8220          dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
8221         </para>
8222
8223         <para>
8224          Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
8225          erfolgen.
8226         </para>
8227       </sect2>
8228
8229       <sect2 id="dev-programmatic-api-calls.authentication_via_parameters" xreflabel="Programmatische API-Aufrufe mit Parametern authentifizieren">
8230         <title>Authentifizierung mit Parametern</title>
8231
8232         <para>
8233          Für diese Methode müssen jedem Request zwei Parameter mitgegeben werden: <varname>{AUTH}login</varname> und
8234          <varname>{AUTH}password</varname>. Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei
8235          Benutzung über den Webbrowser, ob dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
8236         </para>
8237
8238         <para>
8239          Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
8240          erfolgen.
8241         </para>
8242
8243         <note>
8244          <para>
8245           Die Verwendung dieser Methode ist veraltet. Statt dessen sollte die oben erwähnte HTTP-»Basic«-Authentifizierung verwendet werden.
8246          </para>
8247         </note>
8248       </sect2>
8249
8250       <sect2 id="dev-programmatic-api-calls.examples">
8251         <title>Beispiele</title>
8252
8253         <para>
8254          Das folgende Beispiel nutzt das Kommandozeilenprogramm »curl« und ruft die Funktion auf, die eine vorhandene Telefonnummer in den
8255          Ansprechpersonen sucht und dazu Informationen zurückliefert. Dabei wird die HTTP-»Basic«-Authentifizierung genutzt.
8256         </para>
8257
8258         <programlisting>$ curl --silent --user 'jdoe:SecretPassword!' \
8259   'https://…/controller.pl?action=PhoneNumber/look_up&amp;number=053147110815'</programlisting>
8260       </sect2>
8261     </sect1>
8262
8263     <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
8264       <title>SQL-Upgradedateien</title>
8265
8266       <sect2 id="db-upgrade-files.introduction"
8267              xreflabel="Einführung in die Datenbank-Upgradedateien">
8268         <title>Einführung</title>
8269
8270         <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
8271         gesteuert, die sich im Verzeichnis
8272         <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
8273         muss pro Datenbankupgrade eine Datei existieren, die neben den
8274         eigentlich auszuführenden SQL- oder Perl-Befehlen einige
8275         Kontrollinformationen enthält.</para>
8276
8277         <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
8278         sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
8279         werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
8280         werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
8281         wurde), diese Reihenfolge aber so flexibel ist, dass man keine
8282         Versionsnummern braucht.</para>
8283
8284         <para>kivitendo merkt sich dabei, welches der Upgradescripte in
8285         <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
8286         führt diese nicht erneut aus. Dazu dient die Tabelle
8287         "<literal>schema_info</literal>", die bei der Anmeldung automatisch
8288         angelegt wird.</para>
8289       </sect2>
8290
8291       <sect2 id="db-upgrade-files.format"
8292              xreflabel="Format der Upgradedateien">
8293         <title>Format der Kontrollinformationen</title>
8294
8295         <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
8296         Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
8297         hat dabei das folgende Format:</para>
8298
8299         <para>Für SQL-Upgradedateien:</para>
8300
8301         <programlisting>-- @key: value</programlisting>
8302
8303         <para>Für Perl-Upgradedateien:</para>
8304
8305         <programlisting># @key: value</programlisting>
8306
8307         <para>Leerzeichen vor "<varname>value</varname>" werden
8308         entfernt.</para>
8309
8310         <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
8311
8312         <variablelist>
8313           <varlistentry>
8314             <term><varname>tag</varname></term>
8315
8316             <listitem>
8317               <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
8318               Dieser "tag" kann von anderen Kontrolldateien in ihren
8319               Abhängigkeiten verwendet werden (Schlüsselwort
8320               "<varname>depends</varname>"). Der "tag" ist auch der Name, der
8321               in der Datenbank eingetragen wird.</para>
8322
8323               <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
8324               der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
8325
8326               <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
8327               Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
8328               erlaubt und sollten stattdessen mit Unterstrichen ersetzt
8329               werden.</para>
8330             </listitem>
8331           </varlistentry>
8332
8333           <varlistentry>
8334             <term><varname>charset</varname></term>
8335
8336             <listitem>
8337               <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
8338               geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
8339               Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
8340               Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
8341               "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
8342               hingegen müssen immer in UTF-8 encodiert sein und sollten
8343               demnach auch ein "<literal>use utf8;</literal>"
8344               enthalten.</para>
8345             </listitem>
8346           </varlistentry>
8347
8348           <varlistentry>
8349             <term><varname>description</varname></term>
8350
8351             <listitem>
8352               <para>Benötigt. Eine Beschreibung, was in diesem Update
8353               passiert. Diese wird dem Benutzer beim eigentlichen
8354               Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
8355               sein sollte, sollte die Beschreibung auf Deutsch
8356               erfolgen.</para>
8357             </listitem>
8358           </varlistentry>
8359
8360           <varlistentry>
8361             <term><varname>depends</varname></term>
8362
8363             <listitem>
8364               <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
8365               von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
8366               dass die in dieser Liste aufgeführten Scripte bereits
8367               durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
8368
8369               <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
8370               Script "b" existiert, das von Änderungen in "a" abhängt, und
8371               eine neue Kontrolldatei für "c" erstellt wird, die von
8372               Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
8373               Tag "b" als Abhängigkeit zu definieren.</para>
8374
8375               <para>Es ist nicht erlaubt, sich selbst referenzierende
8376               Abhängigkeiten zu definieren (z.B. "a" -&gt; "b", "b" -&gt; "c"
8377               und "c" -&gt; "a").</para>
8378             </listitem>
8379           </varlistentry>
8380
8381           <varlistentry>
8382             <term><varname>priority</varname></term>
8383
8384             <listitem>
8385               <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
8386               der Scripte ausgeführt werden, die die gleichen
8387               Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
8388               der Wert 1000 benutzt.</para>
8389
8390               <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
8391               "depends" benutzt werden. kivitendo sortiert die auszuführenden
8392               Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
8393               abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
8394               2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
8395               dann "y", dann "z"), dann nach der Priorität und bei gleicher
8396               Priorität alphabetisch nach dem "tag".</para>
8397             </listitem>
8398           </varlistentry>
8399
8400           <varlistentry>
8401             <term><varname>ignore</varname></term>
8402
8403             <listitem>
8404               <para>Optional. Falls der Wert auf 1 (true) steht, wird das
8405               Skript bei der Anmeldung ignoriert und entsprechend nicht
8406               ausgeführt.</para>
8407             </listitem>
8408           </varlistentry>
8409         </variablelist>
8410       </sect2>
8411
8412       <sect2 id="db-upgrade-files.format-perl-files"
8413              xreflabel="Format von Perl-Upgradedateien">
8414         <title>Format von in Perl geschriebenen
8415         Datenbankupgradescripten</title>
8416
8417         <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
8418         ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
8419         bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
8420
8421         <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
8422         dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
8423         erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
8424         stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
8425         Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
8426         aufgerufen wird.</para>
8427
8428         <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
8429         für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
8430         in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
8431         ersetzt. Insgesamt sieht der Paketname wie folgt aus:
8432         "<literal>SL::DBUpgrade2::tag</literal>".</para>
8433
8434         <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
8435         der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
8436         "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
8437
8438         <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
8439         folgt aus:</para>
8440
8441         <programlisting># @tag: beispiel-upgrade-file42
8442 # @description: Ein schönes Beispielscript
8443 # @depends: release_3_1_0
8444 package SL::DBUpgrade2::beispiel_upgrade_file42;
8445
8446 use strict;
8447 use utf8;
8448
8449 use parent qw(SL::DBUpgrade2::Base);
8450
8451 sub run {
8452   my ($self) = @_;
8453
8454   # hier Aktionen ausführen
8455
8456   return 1;
8457 }
8458
8459 1;
8460 </programlisting>
8461       </sect2>
8462
8463       <sect2 id="db-upgrade-files.dbupgrade-tool"
8464              xreflabel="Hilfsscript dbupgrade2_tool.pl">
8465         <title>Hilfsscript dbupgrade2_tool.pl</title>
8466
8467         <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
8468         existiert ein Hilfsscript namens
8469         "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
8470         kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
8471         liest alle Datenbankupgradescripte aus dem Verzeichnis
8472         <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
8473         gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
8474         von der Kommandozeile überprüft werden können.</para>
8475
8476         <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
8477         eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
8478         sich aber auch Informationen auf verschiedene Art ausgeben
8479         lassen:</para>
8480
8481         <itemizedlist>
8482           <listitem>
8483             <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
8484             --list</command>"</para>
8485
8486             <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
8487             Reihenfolge sortiert, in der kivitendo die Scripte ausführen
8488             würde. Es werden neben der Listenposition der Tag, die
8489             Abhängigkeitstiefe und die Priorität ausgegeben.</para>
8490           </listitem>
8491
8492           <listitem>
8493             <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
8494             --tree</command>"</para>
8495
8496             <para>Listet alle Tags in Baumform basierend auf den
8497             Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
8498             denen keine anderen abhängen. Die Unterknoten sind Scripte, die
8499             beim übergeordneten Script als Abhängigkeit eingetragen
8500             sind.</para>
8501           </listitem>
8502
8503           <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
8504             <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
8505             --rtree</command>"</para>
8506
8507             <para>Listet alle Tags in Baumform basierend auf den
8508             Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
8509             der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
8510             die das übergeordnete Script als Abhängigkeit eingetragen
8511             haben.</para>
8512           </listitem>
8513
8514           <listitem>
8515             <para>Baumform mit Postscriptausgabe:
8516             "<command>./scripts/dbupgrade2_tool.pl
8517             --graphviz</command>"</para>
8518
8519             <para>Benötigt das Tool "<command>graphviz</command>", um mit
8520             seiner Hilfe die <link
8521             linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
8522             Baumform</link> in eine Postscriptdatei namens
8523             "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
8524             vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
8525             nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
8526             können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
8527             werden.</para>
8528           </listitem>
8529
8530           <listitem>
8531             <para>Scripte, von denen kein anderes Script abhängt:
8532             "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
8533
8534             <para>Listet die Tags aller Scripte auf, von denen keine anderen
8535             Scripte abhängen.</para>
8536           </listitem>
8537         </itemizedlist>
8538       </sect2>
8539     </sect1>
8540
8541     <sect1 id="translations-languages" xreflabel="Translations and languages">
8542       <title>Translations and languages</title>
8543
8544       <sect2 id="translations-languages.introduction"
8545              xreflabel="Introduction to translations and languages">
8546         <title>Introduction</title>
8547
8548         <note>
8549           <para>Dieser Abschnitt ist in Englisch geschrieben, um
8550           internationalen Übersetzern die Arbeit zu erleichtern.</para>
8551         </note>
8552
8553         <para>This section describes how localization packages in kivitendo
8554         are built. Currently the only language fully supported is German, and
8555         since most of the internal messages are held in English the English
8556         version is usable too.</para>
8557       </sect2>
8558
8559       <sect2 id="translations-languages.character-set"
8560              xreflabel="Character set">
8561         <title>Character set</title>
8562
8563         <para>All files included in a language pack must use UTF-8 as their
8564         encoding.</para>
8565       </sect2>
8566
8567       <sect2 id="translations-languages.file-structure"
8568              xreflabel="File structure">
8569         <title>File structure</title>
8570
8571         <para>The structure of locales in kivitendo is:</para>
8572
8573         <programlisting>kivitendo/locale/&lt;langcode&gt;/</programlisting>
8574
8575         <para>where &lt;langcode&gt; stands for an abbreviation of the
8576         language package. The builtin packages use two letter <ulink
8577         url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
8578         but the actual name is not relevant for the program and can easily be
8579         extended to <ulink
8580         url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
8581         tags</ulink> (i.e. "en_GB"). In fact the original language packages
8582         from SQL Ledger are named in this way.</para>
8583
8584         <para>In such a language directory the following files are
8585         recognized:</para>
8586
8587         <variablelist>
8588           <varlistentry>
8589             <term>LANGUAGE</term>
8590
8591             <listitem>
8592               <para>This file is mandatory.</para>
8593
8594               <para>The <filename>LANGUAGE</filename> file contains the self
8595               descripted name of the language. It should contain a native
8596               representation first, and in parenthesis an english translation
8597               after that. Example:</para>
8598
8599               <programlisting>Deutsch (German)</programlisting>
8600             </listitem>
8601           </varlistentry>
8602
8603           <varlistentry>
8604             <term>all</term>
8605
8606             <listitem>
8607               <para>This file is mandatory.</para>
8608
8609               <para>The central translation file. It is essentially an inline
8610               Perl script autogenerated by <command>locales.pl</command>. To
8611               generate it, generate the directory and the two files mentioned
8612               above, and execute the following command:</para>
8613
8614               <programlisting>scripts/locales.pl &lt;langcode&gt;</programlisting>
8615
8616               <para>Otherwise you can simply copy one of the other languages.
8617               You will be told how many are missing like this:</para>
8618
8619               <programlisting>$ scripts/locales.pl en
8620 English - 0.6% - 2015/2028 missing</programlisting>
8621
8622               <para>A file named "<filename>missing</filename>" will be
8623               generated and can be edited. You can also edit the
8624               "<filename>all</filename>" file directly. Edit everything you
8625               like to fit the target language and execute
8626               <command>locales.pl</command> again. See how the missing words
8627               get fewer.</para>
8628             </listitem>
8629           </varlistentry>
8630
8631           <varlistentry>
8632             <term>Num2text</term>
8633
8634             <listitem>
8635               <para>Legacy code from SQL Ledger. It provides a means for
8636               numbers to be converted into natural language, like
8637               <literal>1523 =&gt; one thousand five hundred twenty
8638               three</literal>. If you want to provide it, it must be inlinable
8639               Perl code which provides a <function>num2text</function> sub. If
8640               an <function>init</function> sub exists it will be executed
8641               first.</para>
8642
8643               <para>Only used in the check and receipt printing module.</para>
8644             </listitem>
8645           </varlistentry>
8646
8647           <varlistentry>
8648             <term>special_chars</term>
8649
8650             <listitem>
8651               <para>kivitendo comes with a lot of interfaces to different
8652               formats, some of which are rather picky with their accepted
8653               charset. The <filename>special_chars</filename> file contains a
8654               listing of chars not suited for different file format and
8655               provides substitutions. It is written in "Simple Ini" style,
8656               containing a block for every file format.</para>
8657
8658               <para>First entry should be the order of substitution for
8659               entries as a whitespace separated list. All entries are
8660               interpolated, so <literal>\n</literal>, <literal>\x20</literal>
8661               and <literal>\\</literal> all work.</para>
8662
8663               <para>After that every entry is a special char that should be
8664               translated when writing text into such a file.</para>
8665
8666               <para>Example:</para>
8667
8668               <programlisting>[Template/XML]
8669 order=&amp; &lt; &gt; \n
8670 &amp;=&amp;amp;
8671 &lt;=&amp;lt;
8672 &gt;=&amp;gt;
8673 \n=&lt;br&gt;</programlisting>
8674
8675               <para>Note the importance of the order in this example.
8676               Substituting &lt; and &gt; befor &amp; would lead to $gt; become
8677               &amp;amp;gt;</para>
8678
8679               <para>For a list of valid formats, see the German
8680               <filename>special_chars</filename> entry. As of this writing the
8681               following are recognized:</para>
8682
8683               <programlisting>HTML
8684 URL@HTML
8685 Template/HTML
8686 Template/XML
8687 Template/LaTeX
8688 Template/OpenDocument
8689 filenames</programlisting>
8690
8691               <para>The last of which is very machine dependent. Remember that
8692               a lot of characters are forbidden by some filesystems, for
8693               example MS Windows doesn't like ':' in its files where Linux
8694               doesn't mind that. If you want the files created with your
8695               language pack to be portable, find all chars that could cause
8696               trouble.</para>
8697             </listitem>
8698           </varlistentry>
8699
8700           <varlistentry>
8701             <term>missing</term>
8702
8703             <listitem>
8704               <para>This file is not a part of the language package
8705               itself.</para>
8706
8707               <para>This is a file generated by
8708               <command>scripts/locales.pl</command> while processing your
8709               locales. It's only to have the missing entries singled out and
8710               does not belong to a language package.</para>
8711             </listitem>
8712           </varlistentry>
8713
8714           <varlistentry>
8715             <term>lost</term>
8716
8717             <listitem>
8718               <para>This file is not a part of the language package
8719               itself.</para>
8720
8721               <para>Another file generated by
8722               <command>scripts/locales.pl</command>. If for any reason a
8723               translation does not appear anymore and can be deleted, it gets
8724               moved here. The last 50 or so entries deleted are saved here in
8725               case you made a typo, so that you don't have to translate
8726               everything again. If a tranlsation is missing, the lost file is
8727               checked first. If you maintain a language package, you might
8728               want to keep this safe somewhere.</para>
8729             </listitem>
8730           </varlistentry>
8731
8732           <varlistentry>
8733             <term>more/all</term>
8734
8735             <listitem>
8736               <para>This subdir and file is not a part of the language package
8737               itself.</para>
8738
8739               <para>If the directory more exists and contains a file called
8740               all it will be parsed in addition to the mandatory all (see
8741               above). The file is useful if you want to change some
8742               translations for the current installation without conflicting
8743               further upgrades. The file is not autogenerated and has the same
8744               format as the all, but needs another key (more_texts). See the
8745               german translation for an example or copy the following code:
8746               <programlisting>
8747 #!/usr/bin/perl
8748 # -*- coding: utf-8; -*-
8749 # vim: fenc=utf-8
8750
8751 use utf8;
8752
8753 # These are additional texts for custom translations.
8754 # The format is the same as for the normal file all, only
8755 # with another key (more_texts instead of texts).
8756 # The file has the form of 'english text'  =&gt; 'foreign text',
8757
8758 $self-&gt;{more_texts} = {
8759
8760   'Ship via'                    =&gt; 'Terms of delivery',
8761   'Shipping Point'              =&gt; 'Delivery time',
8762 }
8763               </programlisting></para>
8764             </listitem>
8765           </varlistentry>
8766         </variablelist>
8767       </sect2>
8768     </sect1>
8769
8770     <sect1 id="devel.testsuite">
8771       <title>Die kivitendo-Test-Suite</title>
8772
8773       <sect2 id="devel.testsuite.intro">
8774         <title>Einführung</title>
8775
8776         <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
8777         basiert auf dem Standard-Perl-Modul
8778         <literal>Test::More</literal>.</para>
8779
8780         <para>Die grundlegenden Fakten sind:</para>
8781
8782         <itemizedlist>
8783           <listitem>
8784             <para>Alle Tests liegen im Unterverzeichnis
8785             <filename>t/</filename>.</para>
8786           </listitem>
8787
8788           <listitem>
8789             <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
8790             enthält einen oder mehrere Testfälle.</para>
8791           </listitem>
8792
8793           <listitem>
8794             <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
8795             Es sind selbstständig ausführbare Perl-Scripte.</para>
8796           </listitem>
8797
8798           <listitem>
8799             <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
8800             sprich aller Scripte in <filename>t/</filename>, deren Dateiname
8801             auf <literal>.t</literal> endet.</para>
8802           </listitem>
8803         </itemizedlist>
8804       </sect2>
8805
8806       <sect2 id="devel.testsuite.prerequisites">
8807         <title>Voraussetzungen</title>
8808
8809         <para>Für die Ausführung werden neben den für kivitendo eh schon
8810         benötigten Module noch weitere Perl-Module benötigt. Diese
8811         sind:</para>
8812
8813         <itemizedlist>
8814           <listitem>
8815             <para><literal>Test::Deep</literal> (Debian-Paketname:
8816             <literal>libtest-deep-perl</literal>; Fedora:
8817             <literal>perl-Test-Deep</literal>; openSUSE:
8818             <literal>perl-Test-Deep</literal>)</para>
8819           </listitem>
8820
8821           <listitem>
8822             <para><literal>Test::Exception</literal> (Debian-Paketname:
8823             <literal>libtest-exception-perl</literal>; Fedora:
8824             <literal>perl-Test-Exception</literal>; openSUSE:
8825             <literal>perl-Test-Exception</literal>)</para>
8826           </listitem>
8827
8828           <listitem>
8829             <para><literal>Test::Output</literal> (Debian-Paketname:
8830             <literal>libtest-output-perl</literal>; Fedora:
8831             <literal>perl-Test-Output</literal>; openSUSE:
8832             <literal>perl-Test-Output</literal>)</para>
8833           </listitem>
8834
8835           <listitem>
8836             <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
8837             Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
8838             kann für frühere Versionen aus dem <ulink
8839             url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
8840           </listitem>
8841
8842           <listitem>
8843             <para><literal>LWP::Simple</literal> aus dem Paket
8844             <literal>libwww-perl</literal> (Debian-Panetname:
8845             <literal>libwww-perl</literal>; Fedora:
8846             <literal>perl-libwww-perl</literal>; openSUSE:
8847             <literal>perl-libwww-perl</literal>)</para>
8848           </listitem>
8849
8850           <listitem>
8851             <para><literal>URI::Find</literal> (Debian-Panetname:
8852             <literal>liburi-find-perl</literal>; Fedora:
8853             <literal>perl-URI-Find</literal>; openSUSE:
8854             <literal>perl-URI-Find</literal>)</para>
8855           </listitem>
8856
8857           <listitem>
8858             <para><literal>Sys::CPU</literal> (Debian-Panetname:
8859             <literal>libsys-cpu-perl</literal>; Fedora und openSUSE: nicht
8860             vorhanden)</para>
8861           </listitem>
8862
8863           <listitem>
8864             <para><literal>Thread::Pool::Simple</literal> (Debian-Panetname:
8865             <literal>libthread-pool-simple-perl</literal>; Fedora und
8866             openSUSE: nicht vorhanden)</para>
8867           </listitem>
8868         </itemizedlist>
8869
8870         <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
8871         Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
8872         müssen in der Konfigurationsdatei im Abschnit
8873         <literal>testing/database</literal> Datenbankverbindungsparameter
8874         angegeben werden. Der hier angegebene Benutzer muss weiterhin das
8875         Recht haben, Datenbanken anzulegen und zu löschen.</para>
8876
8877         <para>Der so angegebene Benutzer muss nicht zwingend über
8878         Super-User-Rechte verfügen. Allerdings gibt es einige
8879         Datenbank-Upgrades, die genau diese Rechte benötigen. Für den Fall
8880         kann man in diesem Konfigurationsabschnitt einen weiteren
8881         Benutzeraccount angeben, der dann über Super-User-Rechte verfügt, und
8882         mit dem die betroffenen Upgrades durchgeführt werden. In der
8883         Beispiel-Konfigurationsdatei finden Sie die benötigten
8884         Parameter.</para>
8885       </sect2>
8886
8887       <sect2 id="devel.testsuite.execution">
8888         <title>Existierende Tests ausführen</title>
8889
8890         <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
8891         man lässt alle Tests auf einmal ausführen, oder man führt gezielt
8892         einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
8893         <filename>t/test.pl</filename>.</para>
8894
8895         <para>Will man die komplette Test-Suite ausführen, so muss man einfach
8896         nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
8897         kivitendo-Basisverzeichnis heraus ausführen.</para>
8898
8899         <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
8900         an <filename>t/test.pl</filename>. Beispielsweise:</para>
8901
8902         <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
8903       </sect2>
8904
8905       <sect2 id="devel.testsuite.meaning_of_scripts">
8906         <title>Bedeutung der verschiedenen Test-Scripte</title>
8907
8908         <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
8909         Programmierstil. Einige besonders zu erwähnende, weil auch während der
8910         Entwicklung nützliche Tests sind:</para>
8911
8912         <itemizedlist>
8913           <listitem>
8914             <para><filename>t/001compile.t</filename> -- compiliert alle
8915             Quelldateien und bricht bei Fehlern sofort ab</para>
8916           </listitem>
8917
8918           <listitem>
8919             <para><filename>t/002goodperl.t</filename> -- überprüft alle
8920             Perl-Dateien auf Anwesenheit von '<literal>use
8921             strict</literal>'-Anweisungen</para>
8922           </listitem>
8923
8924           <listitem>
8925             <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
8926             <function>system()</function> und <function>exec()</function> auf
8927             Gültigkeit</para>
8928           </listitem>
8929
8930           <listitem>
8931             <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
8932             Tab-Zeichen enthalten</para>
8933           </listitem>
8934
8935           <listitem>
8936             <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
8937             Rechtschreibfehlern</para>
8938           </listitem>
8939
8940           <listitem>
8941             <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
8942             Dokumentation im POD-Format auf Gültigkeit</para>
8943           </listitem>
8944         </itemizedlist>
8945
8946         <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
8947         einzelner Funktionen und Module.</para>
8948       </sect2>
8949
8950       <sect2 id="devel.testsuite.create_new">
8951         <title>Neue Test-Scripte erstellen</title>
8952
8953         <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
8954         mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
8955         und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
8956         werden.</para>
8957
8958         <sect3 id="devel.testsuite.ideas_for_non_function_tests">
8959           <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
8960           testen</title>
8961
8962           <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
8963           wurden:</para>
8964
8965           <itemizedlist>
8966             <listitem>
8967               <para>Überprüfung auf fehlende symbolische Links</para>
8968             </listitem>
8969
8970             <listitem>
8971               <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
8972               gewissen Einschränkungen wie das Erlauben von deutschen
8973               Umlauten)</para>
8974             </listitem>
8975
8976             <listitem>
8977               <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
8978             </listitem>
8979
8980             <listitem>
8981               <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
8982             </listitem>
8983
8984             <listitem>
8985               <para>Test, ob alle zu übersetzenden Strings in
8986               <filename>locale/de/all</filename> vorhanden sind</para>
8987             </listitem>
8988
8989             <listitem>
8990               <para>Test, ob alle Webseiten-Templates in
8991               <filename>templates/webpages</filename> mit vom Perl-Modul
8992               <literal>Template</literal> compiliert werden können</para>
8993             </listitem>
8994           </itemizedlist>
8995         </sect3>
8996
8997         <sect3 id="devel.testsuite.directory_and_test_names">
8998           <title>Konvention für Verzeichnis- und Dateinamen</title>
8999
9000           <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
9001           benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
9002           und ihnen soweit es geht folgen:</para>
9003
9004           <itemizedlist>
9005             <listitem>
9006               <para>Die Dateiendung muss <filename>.t</filename>
9007               lauten.</para>
9008             </listitem>
9009
9010             <listitem>
9011               <para>Namen sind englisch, komplett klein geschrieben und
9012               einzelne Wörter mit Unterstrichten getrennt (beispielsweise
9013               <filename>bad_function_params.t</filename>).</para>
9014             </listitem>
9015
9016             <listitem>
9017               <para>Unterverzeichnisse sollten grob nach dem Themenbereich
9018               benannt sein, mit dem sich die Scripte darin befassen
9019               (beispielsweise <filename>background_jobs</filename> für Tests
9020               rund um Hintergrund-Jobs).</para>
9021             </listitem>
9022
9023             <listitem>
9024               <para>Test-Scripte sollten einen überschaubaren Bereich von
9025               Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
9026               Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
9027               Test-Scripte schreiben.</para>
9028             </listitem>
9029           </itemizedlist>
9030         </sect3>
9031
9032         <sect3 id="devel.testsuite.minimal_example">
9033           <title>Minimales Skelett für eigene Scripte</title>
9034
9035           <para>Der folgenden Programmcode enthält das kleinstmögliche
9036           Testscript und kann als Ausgangspunkt für eigene Tests verwendet
9037           werden:</para>
9038
9039           <programlisting>use Test::More tests =&gt; 0;
9040
9041 use lib 't';
9042
9043 use Support::TestSetup;
9044
9045 Support::TestSetup::login();</programlisting>
9046
9047           <para>Wird eine vollständig initialisierte kivitendo-Umgebung
9048           benötigt (Stichwort: alle globalen Variablen wie
9049           <varname>$::auth</varname>, <varname>$::form</varname> oder
9050           <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
9051           <filename>config/kivitendo.conf</filename> im Abschnitt
9052           <literal>testing.login</literal> ein gültiger Login-Name eingetragen
9053           sein. Dieser wird für die Datenbankverbindung benötigt.</para>
9054
9055           <para>Wir keine vollständig initialisierte Umgebung benötigt, so
9056           kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
9057           weggelassen werden, was die Ausführungszeit des Scripts leicht
9058           verringert.</para>
9059         </sect3>
9060       </sect2>
9061     </sect1>
9062
9063     <sect1 id="devel.style-guide">
9064       <title>Stil-Richtlinien</title>
9065
9066       <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
9067       und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
9068       eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
9069       wird (Stichworte "Klammern" oder "Hash-Keys").</para>
9070
9071       <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
9072       Leben!</para>
9073
9074       <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
9075       überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
9076       nicht.</para>
9077
9078       <orderedlist>
9079         <listitem>
9080           <para>Es werden keine echten Tabs sondern Leerzeichen
9081           verwendet.</para>
9082         </listitem>
9083
9084         <listitem>
9085           <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
9086
9087           <programlisting>foreach my $row (@data) {
9088   if ($flag) {
9089     # do something with $row
9090   }
9091
9092   if ($use_modules) {
9093     $row-&gt;{modules} = MODULE-&gt;retrieve(
9094       id   =&gt; $row-&gt;{id},
9095       date =&gt; $use_now ? localtime() : $row-&gt;{time},
9096     );
9097   }
9098
9099   $report-&gt;add($row);
9100 }</programlisting>
9101         </listitem>
9102
9103         <listitem>
9104           <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
9105           Zeile wie der letzte Befehl. Beispiele:</para>
9106
9107           <programlisting>sub debug {
9108   ...
9109 }</programlisting>
9110
9111           <para>oder</para>
9112
9113           <programlisting>if ($form-&gt;{item_rows} &gt; 0) {
9114   ...
9115 }</programlisting>
9116         </listitem>
9117
9118         <listitem>
9119           <para>Schließende geschweifte Klammern sind so weit eingerückt wie
9120           der Befehl / die öffnende schließende Klammer, die den Block
9121           gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
9122           Beispiele wie bei 3. gelten.</para>
9123         </listitem>
9124
9125         <listitem>
9126           <para>Die Wörter "<function>else</function>",
9127           "<function>elsif</function>", "<function>while</function>" befinden
9128           sich auf der gleichen Zeile wie schließende geschweifte Klammern.
9129           Beispiele:</para>
9130
9131           <programlisting>if ($form-&gt;{sum} &gt; 1000) {
9132   ...
9133 } elsif ($form-&gt;{sum} &gt; 0) {
9134   ...
9135 } else {
9136   ...
9137 }
9138
9139 do {
9140   ...
9141 } until ($a &gt; 0);</programlisting>
9142         </listitem>
9143
9144         <listitem>
9145           <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
9146           versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
9147           und grep-ähnliche Operatoren. Beispiel:</para>
9148
9149           <programlisting>$main::lxdebug-&gt;message("Could not find file.");
9150 %options = map { $_ =&gt; 1 } grep { !/^#/ } @config_file;</programlisting>
9151         </listitem>
9152
9153         <listitem>
9154           <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
9155
9156           <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
9157           Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
9158           Blöcke schon. Beispiel:</para>
9159
9160           <programlisting>if (($form-&gt;{debug} == 1) &amp;&amp; ($form-&gt;{sum} - 100 &lt; 0)) {
9161   ...
9162 }
9163
9164 $array[$i + 1]             = 4;
9165 $form-&gt;{sum}              += $form-&gt;{"row_$i"};
9166 $form-&gt;{ $form-&gt;{index} } += 1;
9167
9168 map { $form-&gt;{sum} += $form-&gt;{"row_$_"} } 1..$rowcount;</programlisting>
9169         </listitem>
9170
9171         <listitem>
9172           <para>Mehrzeilige Befehle</para>
9173
9174           <orderedlist>
9175             <listitem>
9176               <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
9177               Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
9178               werden, in der die ersten Funktionsparameter in der ersten Zeile
9179               stehen. Beispiel:</para>
9180
9181               <programlisting>$sth = $dbh-&gt;prepare("SELECT * FROM some_table WHERE col = ?",
9182                     $form-&gt;{some_col_value});</programlisting>
9183             </listitem>
9184
9185             <listitem>
9186               <para>Ein Spezialfall ist der ternäre Operator "?:", der am
9187               besten in einer übersichtlichen Tabellenstruktur organisiert
9188               wird. Beispiel:</para>
9189
9190               <programlisting>my $rowcount = $form-&gt;{"row_$i"} ? $i
9191              : $form-&gt;{oldcount} ? $form-&gt;{oldcount} + 1
9192              :                     $form-&gt;{rowcount} - $form-&gt;{rowbase};</programlisting>
9193             </listitem>
9194           </orderedlist>
9195         </listitem>
9196
9197         <listitem>
9198           <para>Kommentare</para>
9199
9200           <orderedlist>
9201             <listitem>
9202               <para>Kommentare, die alleine in einer Zeile stehen, sollten
9203               soweit wie der Code eingerückt sein.</para>
9204             </listitem>
9205
9206             <listitem>
9207               <para>Seitliche hängende Kommentare sollten einheitlich
9208               formatiert werden.</para>
9209             </listitem>
9210
9211             <listitem>
9212               <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
9213               auf Englisch zu verfassen. So wie ich keine Lust habe,
9214               französischen Quelltext zu lesen, sollte auch der kivitendo
9215               Quelltext für nicht-Deutschsprachige lesbar sein.
9216               Beispiel:</para>
9217
9218               <programlisting>my $found = 0;
9219 while (1) {
9220   last if $found;
9221
9222   # complicated check
9223   $found = 1 if //
9224 }
9225
9226 $i  = 0        # initialize $i
9227 $n  = $i;      # save $i
9228 $i *= $const;  # do something crazy
9229 $i  = $n;      # recover $i</programlisting>
9230             </listitem>
9231           </orderedlist>
9232         </listitem>
9233
9234         <listitem>
9235           <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
9236           Interpolation gewünscht ist. Beispiel:</para>
9237
9238           <programlisting>$form-&gt;{sum}      = 0;
9239 $form-&gt;{"row_$i"} = $form-&gt;{"row_$i"} - 5;
9240 $some_hash{42}    = 54;</programlisting>
9241         </listitem>
9242
9243         <listitem>
9244           <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
9245           unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
9246           wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
9247           grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
9248
9249           <para>Als Beispiel sei die Funktion
9250           <function>print_options</function> aus
9251           <filename>bin/mozilla/io.pl</filename> angeführt.</para>
9252         </listitem>
9253
9254         <listitem>
9255           <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
9256           unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
9257           verfälschen.</para>
9258
9259           <para>Emacs und vim haben beide recht einfache Methoden zur
9260           Entfernung von trailing whitespace. Emacs kennt das Kommande
9261           <command>nuke-trailing-whitespace</command>, vim macht das gleiche
9262           manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
9263           BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
9264           gebunden.</para>
9265         </listitem>
9266
9267         <listitem>
9268           <para>Es wird kein <command>perltidy</command> verwendet.</para>
9269
9270           <para>In der Vergangenheit wurde versucht,
9271           <command>perltidy</command> zu verwenden, um einen einheitlichen
9272           Stil zu erlangen. Es hat sich aber gezeigt, dass
9273           <command>perltidy</command>s sehr eigenwilliges Verhalten, was
9274           Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
9275           den Interessierten sind hier die
9276           <command>perltidy</command>-Optionen, die grob den beschriebenen
9277           Richtlinien entsprechen:</para>
9278
9279           <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
9280 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
9281 -lp -vt=1 -vtc=1</programlisting>
9282         </listitem>
9283
9284         <listitem>
9285           <para><varname>STDERR</varname> ist tabu. Unkonditionale
9286           Debugmeldungen auch.</para>
9287
9288           <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
9289           einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
9290           Grund, nach <varname>STDERR</varname> zu schreiben.</para>
9291
9292           <para>Die <classname>LXDebug</classname>-Methode
9293           "<function>message</function>" nimmt als ersten Paramter außerdem
9294           eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
9295           angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
9296           und werden in den meisten Fällen auch vom Repository
9297           zurückgewiesen.</para>
9298         </listitem>
9299
9300         <listitem>
9301           <para>Alle neuen Module müssen use strict verwenden.</para>
9302
9303           <para><varname>$form</varname>, <varname>$auth</varname>,
9304           <varname>$locale</varname>, <varname>$lxdebug</varname> und
9305           <varname>%myconfig</varname> werden derzeit aus dem main package
9306           importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
9307           Konstrukte sollten lexikalisch lokal gehalten werden.</para>
9308         </listitem>
9309       </orderedlist>
9310     </sect1>
9311
9312     <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
9313       <title>Dokumentation erstellen</title>
9314
9315       <sect2 id="devel.build-doc.introduction">
9316         <title>Einführung</title>
9317
9318         <para>Diese Dokumentation ist in <productname>DocBook</productname>
9319         XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
9320         Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
9321         Editor nutzt, der spezielle Unterstützung für
9322         <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
9323         <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
9324         Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
9325         ist.</para>
9326       </sect2>
9327
9328       <sect2 id="devel.build-doc.required-software">
9329         <title>Benötigte Software</title>
9330
9331         <para>Bei <productname>DocBook</productname> ist Prinzip, dass
9332         ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
9333         dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
9334         erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
9335         <command>scripts/build_doc.sh</command>.</para>
9336
9337         <para>Das Script benötigt zur Konvertierung verschiedene
9338         Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
9339         werden:</para>
9340
9341         <itemizedlist>
9342           <listitem>
9343             <para><ulink
9344             url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
9345             in einer halbwegs aktuellen Version</para>
9346           </listitem>
9347
9348           <listitem>
9349             <para>Das Java-Build-System <ulink
9350             url="http://ant.apache.org/">Apache Ant</ulink></para>
9351           </listitem>
9352
9353           <listitem>
9354             <para>Das Dokumentations-System Dobudish für
9355             <productname>DocBook</productname> 4.5, eine Zusammenstellung
9356             diverser Stylesheets und Grafiken zur Konvertierung von
9357             <productname>DocBook</productname> XML in andere Formate. Das
9358             Paket, das benötigt wird, ist zum Zeitpunkt der
9359             Dokumentationserstellung
9360             <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
9361             url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
9362             bereitsteht.</para>
9363           </listitem>
9364         </itemizedlist>
9365
9366         <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
9367         sind auf allen gängigen Plattformen verfügbar. Beispiel für
9368         Debian/Ubuntu:</para>
9369
9370         <programlisting>apt-get install ant openjdk-7-jre</programlisting>
9371
9372         <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
9373         <filename>doc/build</filename> entpackt werden. Beispiel unter der
9374         Annahme, das <productname>Dobudish</productname> in
9375         <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
9376
9377         <programlisting>cd doc/build
9378 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
9379       </sect2>
9380
9381       <sect2 id="devel.build-doc.build">
9382         <title>PDFs und HTML-Seiten erstellen</title>
9383
9384         <para>Die eigentliche Konvertierung erfolgt nach Installation der
9385         benötigten Software mit einem einfachen Aufruf direkt aus dem
9386         kivitendo-Installationsverzeichnis heraus:</para>
9387
9388         <programlisting>./scripts/build_doc.sh</programlisting>
9389       </sect2>
9390
9391       <sect2 id="devel.build-doc.repository">
9392         <title>Einchecken in das Git-Repository</title>
9393
9394         <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
9395         HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
9396         nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
9397         und alles zusammen in einem Commit eingecheckt werden sollten.</para>
9398
9399         <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
9400         symbolischen Links gehören hingegen nicht in das Repository.</para>
9401       </sect2>
9402     </sect1>
9403   </chapter>
9404 </book>