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