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.3: Installation, Konfiguration,
8 <chapter id="Aktuelle-Hinweise">
9 <title>Aktuelle Hinweise</title>
11 <para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>
15 <para>im Community-Forum: <ulink
16 url="https://forum.kivitendo.de:32443">https://forum.kivitendo.de:32443</ulink></para>
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>
25 <para>in der doc/UPGRADE Datei im doc-Verzeichnis der
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>
38 <title>Installation und Grundkonfiguration</title>
40 <sect1 id="Installation-Übersicht">
41 <title>Übersicht</title>
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>
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
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>
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>
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>
80 <para><emphasis>Benutzer, Gruppen und Datenbanken
81 anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
82 linkend="Benutzer--und-Gruppenverwaltung"/>".</para>
86 <para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann
87 kann es losgehen: "<xref linkend="kivitendo-ERP-verwenden"/>"</para>
91 <para>Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls
92 wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen
96 <sect1 id="Benötigte-Software-und-Pakete">
97 <title>Benötigte Software und Pakete</title>
99 <sect2 id="Betriebssystem">
100 <title>Betriebssystem</title>
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>
109 <para>Anfang 2019 sind das folgende Systeme, von denen bekannt ist,
110 dass kivitendo auf ihnen läuft:</para>
118 <para>8.0 "Jessie"</para>
121 <para>9.0 "Stretch"</para>
124 <para>10.0 "Buster"</para>
130 <para>16.04 "Xenial Xerus" LTS und 18.04 "Bionic Beaver" LTS
135 <para>openSUSE 15.0</para>
139 <para>Fedora 29</para>
144 <sect2 id="Pakete" xreflabel="Pakete">
145 <title>Benötigte Perl-Pakete installieren</title>
147 <para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
148 Apache) und ein Datenbankserver (PostgreSQL) in einer aktuellen
149 Version (s.a. Liste der unterstützten Betriebssysteme)
152 <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht
153 Bestandteil einer Standard-Perl-Installation sind. Um zu überprüfen,
154 ob die erforderlichen Pakete installiert und aktuell genug sind, wird
155 ein Script mitgeliefert, das wie folgt aufgerufen wird:</para>
157 <programlisting>./scripts/installation_check.pl</programlisting>
159 <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
163 <para><literal>Algorithm::CheckDigits</literal></para>
167 <para><literal>Archive::Zip</literal></para>
171 <para><literal>CGI</literal></para>
175 <para><literal>Clone</literal></para>
179 <para><literal>Config::Std</literal></para>
183 <para><literal>Daemon::Generic</literal></para>
187 <para><literal>DateTime</literal></para>
191 <para><literal>DateTime::Event::Cron</literal></para>
195 <para><literal>DateTime::Format::Strptime</literal></para>
199 <para><literal>DateTime::Set</literal></para>
203 <para><literal>DBI</literal></para>
207 <para><literal>DBD::Pg</literal></para>
211 <para><literal>Email::Address</literal></para>
215 <para><literal>Email::MIME</literal></para>
219 <para><literal>Exception::Class</literal></para>
223 <para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71
224 inklusive; siehe <xref
225 linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para>
229 <para><literal>File::Copy::Recursive</literal></para>
233 <para><literal>File::Flock</literal></para>
237 <para><literal>File::MimeInfo</literal></para>
241 <para><literal>File::Slurp</literal></para>
245 <para><literal>GD</literal></para>
249 <para><literal>HTML::Parser</literal></para>
253 <para><literal>HTML::Restrict</literal></para>
257 <para><literal>Image::Info</literal></para>
261 <para><literal>JSON</literal></para>
265 <para><literal>List::MoreUtils</literal></para>
269 <para><literal>List::UtilsBy</literal></para>
273 <para>LWP::Authen::Digest</para>
277 <para>LWP::UserAgent</para>
281 <para><literal>Net::SMTP::SSL</literal> (optional, bei
282 E-Mail-Versand über SSL; siehe Abschnitt "<xref
283 linkend="config.sending-email.smtp"/>")</para>
287 <para><literal>Net::SSLGlue</literal> (optional, bei
288 E-Mail-Versand über TLS; siehe Abschnitt "<xref
289 linkend="config.sending-email.smtp"/>")</para>
293 <para><literal>Params::Validate</literal></para>
297 <para><literal>PBKDF2::Tiny</literal></para>
301 <para><literal>PDF::API2</literal></para>
305 <para><literal>Regexp::IPv6</literal></para>
309 <para><literal>Rose::Object</literal></para>
313 <para><literal>Rose::DB</literal></para>
317 <para><literal>Rose::DB::Object</literal> Version 0.788 oder
322 <para><literal>Set::Infinite</literal></para>
326 <para><literal>String::ShellQuote</literal></para>
330 <para><literal>Sort::Naturally</literal></para>
334 <para><literal>Template</literal></para>
338 <para><literal>Text::CSV_XS</literal></para>
342 <para><literal>Text::Iconv</literal></para>
346 <para><literal>Text::Unidecode</literal></para>
350 <para><literal>URI</literal></para>
354 <para><literal>XML::Writer</literal></para>
358 <para><literal>YAML::XS</literal> oder <literal>YAML</literal></para>
362 <para>Seit Version größer v3.5.3 sind die folgenden Pakete hinzugekommen: <literal>Exception::Class</literal></para>
364 <para>Seit Version größer v3.5.1 sind die folgenden Pakete hinzugekommen: <literal>Set::Infinite</literal>,
365 <literal>List::UtilsBy</literal>, <literal>DateTime::Set</literal>, <literal>DateTime::Event::Cron</literal>
366 <literal>Daemon::Generic</literal>, <literal>DateTime::Event::Cron</literal>, <literal>File::Flock</literal>,
367 <literal>File::Slurp</literal></para>
369 <para>Seit Version größer v3.5.0 sind die folgenden Pakete
370 hinzugekommen: <literal>Text::Unidecode</literal>,
371 <literal>LWP::Authen::Digest</literal>,
372 <literal>LWP::UserAgent</literal></para>
374 <para>Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen:
375 <literal>Algorithm::CheckDigits</literal>,
376 <literal>PBKDF2::Tiny</literal></para>
378 <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen:
379 <literal>GD</literal>, <literal>HTML::Restrict</literal>,
380 <literal>Image::Info</literal></para>
382 <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen:
383 <literal>File::Copy::Recursive</literal>.</para>
385 <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen:
386 <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
387 <literal>Net::SSLGlue</literal>.</para>
389 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
390 hinzugekommen, <literal>URI</literal> und
391 <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
394 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
395 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
396 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
397 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
399 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
400 hinzugekommen.</para>
402 <para><literal>Email::Address</literal> und
403 <literal>List::MoreUtils</literal> sind schon länger feste
404 Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
405 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
406 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
407 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
411 <title>Debian und Ubuntu</title>
412 <para>Für Debian und Ubuntu stehen die meisten der benötigten
413 Pakete als Debian-Pakete zur Verfügung. Sie können mit
414 folgendem Befehl installiert werden:</para>
416 <programlisting>apt install apache2 libarchive-zip-perl libclone-perl \
417 libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
418 libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
419 liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
420 libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
421 librose-db-perl librose-object-perl libsort-naturally-perl \
422 libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
423 libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
424 libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \
425 libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \
426 libcrypt-pbkdf2-perl git libcgi-pm-perl libtext-unidecode-perl libwww-perl\
427 postgresql-contrib aqbanking-tools poppler-utils libhtml-restrict-perl\
428 libdatetime-set-perl libset-infinite-perl liblist-utilsby-perl\
429 libdaemon-generic-perl libfile-flock-perl libfile-slurp-perl\
430 libfile-mimeinfo-perl libpbkdf2-tiny-perl libregexp-ipv6-perl \
431 libdatetime-event-cron-perl libexception-class-perl
433 <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>
434 <note id="ubuntu-universe">
435 <para>Die Perl Pakete für Ubuntu befinden sich im "Universe" Repository. Falls dies nicht aktiv ist, kann dies mit folgendem Aufruf aktiviert werden:
436 <programlisting>add-apt-repository universe</programlisting></para>
438 <note id="build-essential">
439 <para>Für ältere Ubuntu/Debians müßen einige Pakete per CPAN installiert werden.
440 Das geht bspw. für das benötige Paket HTML::Restrict mit:</para>
441 <programlisting>apt-get install build-essential
442 cpan HTML::Restrict</programlisting>
447 <title>Fedora</title>
449 <para>Für Fedora stehen die meisten der benötigten Perl-Pakete als
450 RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
451 installiert werden:</para>
453 <programlisting>dnf install httpd mod_fcgid postgresql-server postgresql-contrib\
454 perl-Algorithm-CheckDigits perl-Archive-Zip perl-CPAN perl-Class-XSAccessor \
455 perl-Clone perl-Config-Std perl-DBD-Pg perl-DBI perl-Daemon-Generic \
456 perl-DateTime perl-DateTime-Set perl-Email-Address perl-Email-MIME perl-FCGI \
457 perl-File-Copy-Recursive perl-File-Flock perl-File-MimeInfo perl-File-Slurp \
458 perl-GD perl-HTML-Restrict perl-JSON perl-List-MoreUtils perl-List-UtilsBy \
459 perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PBKDF2-Tiny perl-PDF-API2 \
460 perl-Params-Validate perl-Regexp-IPv6 perl-Rose-DB perl-Rose-DB-Object \
461 perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
462 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI perl-XML-Writer \
463 perl-YAML perl-libwww-perl</programlisting>
467 <title>openSUSE</title>
469 <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung.</para>
470 <para>Dies setzt voraus, das eben die erforderlichen Repositories dem System bekannt gemacht worden sind.</para>
471 <para>Um zusätzliche 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. Da wahrscheinlich für die Administration eine SSH-Verbindung zum Server benutzt wird.</para>
472 <para>Dazu geben wir folgenden Befehl ein:</para>
473 <programlisting>zypper addrepo -f \
474 http://download.opensuse.org/repositories/devel:languages:perl/openSUSE_Leap_15.0/ \
475 "devel:languages:perl"
477 <programlisting>zypper addrepo -f \
478 https://download.opensuse.org/repositories/devel:languages:haskell:lts:13/\
479 openSUSE_Leap_15.0/ "devel:languages:haskell:lts:13"
481 <programlisting>zypper addrepo -f \
482 https://download.opensuse.org/repositories/devel:languages:haskell:lts:13/\
483 openSUSE_Leap_15.0/ "devel:languages:haskell:lts:13"
485 <para>Danach geben wir noch die beiden folgenden Befehle ein:</para>
486 <programlisting>zypper clean</programlisting>
487 <programlisting>zypper refresh</programlisting>
488 <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>
489 <programlisting>zypper --help</programlisting>
491 <para>Offiziell wird von openSUSE nur noch Versionen ab 15.0 unterstützt. Die SuSE Macher haben ab Version 15.0 einen größen Umbau in der Verwaltung der Pakete vorgenommen, das heißt, der Paketumfang ist der SLES 15 als kleinsten Nenner angepasst. Dies gilt besonders der openSUE Distribution. Es gibt ja einmal die openSUSE Distri und die Professionelle SLES Version. Dadurch sind viele Pakete aus dem Repositorie enfernt worden, aber auch viele auf aktuellen Stand gehalten.</para>
493 <para>Das überprüfen wir mit YaST. Sollte openSUSE bis zur Version 15.0 zum Einsatz kommen und der Administrator bei der Installation der Distribution die KDE Oberfläche aktiviert hat, loggen wir uns am Server direkt ein, starten das Verwaltungsprogram in einer Konsole wie folgt:</para>
494 <para>yast2 return.</para>
495 <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>
496 <para>Sie können mit folgendem Befehl installiert werden:</para>
497 <para>zypper install Paketname</para>
498 <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>
500 <programlisting>zypper install perl-threads-shared ghc-pdfinfo apache2-mod_fcgid \
501 yast2-http-server postgresql-server postgresql-contrib perl-Algorithm-CheckDigits \
502 perl-Archive-Zip perl-CGI perl-CGI-Ajax perl-Clone \
503 perl-Config-Std perl-Class-XSAccessor perl-Daemon-Generic perl-DateTime \
504 perl-DateTime-Event-Cron perl-DateTime-Format-Strptime perl-DateTime-Set \
505 perl-DBI perl-DBD-Pg perl-Devel-REPL perl-FastCGI perl-Email-Address \
506 perl-Email-MIME perl-Email-MIME-ContentType perl-Email-MIME-Encodings \
507 perl-FCGI perl-File-Copy-Recursive perl-File-Flock perl-File-MimeInfo \
508 perl-File-Slurp perl-GD perl-HTML-Restrict perl-Image-Info \
509 perl-JSON perl-List-MoreUtils perl-List-UtilsBy perl-Log-Log4perl perl-Net-LDAP-Server \
510 perl-Net-SSLGlue perl-Net-SMTP-SSL perl-PBKDF2-Tiny perl-PDF-API2 \
511 perl-Params-Validate perl-Regexp-IPv6 perl-Rose-DB perl-Rose-Object \
512 perl-Rose-DB-Object perl-MooseX-Role-Cmd perl-Set-Crontab perl-Set-Infinite \
513 perl-Sort-Naturally perl-String-ShellQuote perl-Sys-CPU perl-Template-Toolkit \
514 perl-Text-CSV_XS perl-Test-Deep perl-Test-Output perl-Text-Iconv \
515 perl-Text-Unidecode perl-URI perl-URI-Find perl-XML-Writer \
516 perl-YAML perl-libwww-perl
519 <para>Für die Entwickler installiert man noch die folgenden Pakete:</para>
521 <programlisting>zypper install ghc-mtl-devel ghc-old-locale-devel \
522 ghc-process-extras-devel ghc-rpm-macros ghc-text-devel ghc-time-devel \
523 ghc-Cabal-devel ghc-time-locale-compat-devel perl-Log-Log4perl ghc-pdfinfo \
524 ghc-pdfinfo-devel perl-Devel-REPL perl-URI-Find perl-Class-Utils \
525 perl-Error-Pure perl-File-Object perl-Readonly perl-Test-Warnings \
526 perl-Test-NoWarnings perl-Test-Deep perl-Test-Output perl-Test-Strict \
527 perl-Test-LongString perl-File-Find-Rule
530 <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 plazieren, der Vollständigkeit halber hier für die Installation mit angegeben.
531 Dazu können Sie die folgenden Befehle nutzen:</para>
533 <programlisting>zypper install texlive-wallpaper texlive-colortbl \
534 texlive-scrlttr2copy texlive-eurosym \
535 texlive-geometry texlive-german texlive-graphbox texlive-hyperref \
536 texlive-xifthen texlive-luainputenc texlive-lastpage texlive-ltabptch \
537 texlive-nomentbl texlive-threeparttablex texlive-substr texlive-tabulary \
538 texlive-ulem texlive-wallpaper texlive-xcolor texlive-xstring \
539 texlive-xypic texlive-mwe texlive-mweights texlive-barcodes \
540 texlive-GS1 texlive-ean texlive-makebarcode texlive-pst-barcode \
544 <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
545 werden. Dazu können Sie die folgenden Befehle nutzen:</para>
547 <programlisting>cpan DateTime::event::Cron DateTime::Set FCGI \
548 HTML::Restrict PBKDF2::Tiny Rose::Db::Object Set::Infinite</programlisting>
553 <title>Andere Pakete installieren</title>
555 <para>Seit Version v3.4.0 wird für den Bankimport optional das Paket
556 'aqbanking-tools' benötigt.</para>
558 <para>Debian und Ubuntu: <programlisting>apt install aqbanking-tools
559 </programlisting></para>
561 <para>Fedora: <programlisting>dnf install aqbanking</programlisting></para>
563 <para>openSUSE: <programlisting>zypper install aqbanking-tools</programlisting></para>
565 <para>Seit Version v3.4.1 wird generell zum Feststellen der
566 Seitenanzahl von PDF_Dokumenten 'pdfinfo' benötigt was im Paket
567 'poppler-utils' enthalten ist.</para>
569 <para>Debian und Ubuntu: <programlisting>apt install poppler-utils
570 </programlisting></para>
572 <para>Fedora: <programlisting>dnf install poppler-utils</programlisting></para>
574 <para>openSUSE: <programlisting>zypper install poppler-tools</programlisting></para>
578 <sect1 id="Manuelle-Installation-des-Programmpaketes"
579 xreflabel="Manuelle Installation des Programmpaketes">
580 <title>Manuelle Installation des Programmpaketes</title>
582 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github
583 gehostet und kann <ulink
584 url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
585 heruntergeladen werden.</para>
587 <para>Das aktuelleste kivitendo ERP-Archiv
588 (<filename>kivitendo-erp-*.tgz</filename>) wird dann im
589 Dokumentenverzeichnis des Webservers (z.B.
590 <filename>/var/www/html/</filename>,
591 <filename>/srv/www/htdocs</filename> oder
592 <filename>/var/www/</filename>) entpackt:</para>
594 <programlisting>cd /var/www
595 tar xvzf kivitendo-erp-*.tgz</programlisting>
597 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
599 <programlisting>cd kivitendo-erp</programlisting>
601 <para>Alternativ können Sie auch einen Alias in der
602 Webserverkonfiguration benutzen, um auf das tatsächliche
603 Installationsverzeichnis zu verweisen.</para>
605 <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
606 WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
608 <programlisting>mkdir webdav</programlisting>
610 <para>Die Verzeichnisse <filename>users</filename>,
611 <filename>spool</filename> und <filename>webdav</filename> müssen für
612 den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
613 restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer-
614 und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich
615 (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
616 <constant>apache</constant> oder bei openSUSE
617 <constant>wwwrun</constant>).</para>
619 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
620 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
622 <programlisting>chown -R www-data users spool webdav</programlisting>
624 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen
625 <filename>templates</filename> und <filename>users</filename>
626 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in
627 kivitendo angelegt wird:</para>
629 <programlisting>chown www-data templates users</programlisting>
632 <para>Wir empfehlen eine Installation mittels des Versionsmanagager
633 git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr
634 viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte
635 die Pfade anpassen) bspw. wie folgt: <programlisting>cd /var/www/
636 git clone https://github.com/kivitendo/kivitendo-erp.git
638 git checkout `git tag -l | egrep -ve "(alpha|beta|rc)" | tail -1`</programlisting>
639 Erläuterung: Der Befehl wechselt zur letzten Stable-Version (git tag
640 -l listet alle Tags auf, das egrep schmeisst alle Einträge mit alpha,
641 beta oder rc raus und das tail gibt davon den obersten Treffer
642 zurück). Sehr sinnvoll ist es, direkt im Anschluss einen eigenen
643 Branch zu erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen
644 damit zu verwalten. Hierfür reicht ein simples <programlisting> git checkout -b meine_eigenen_änderungen</programlisting>
645 nach dem letzten Kommando (weiterführende Informationen <ulink
646 url="http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html">
647 Git Magic</ulink>).</para>
649 <para>Ein beispielhafter Workflow für Druckvorlagen-Anpassungen von
650 3.4.1 nach 3.5: <programlisting>
651 $ git clone https://github.com/kivitendo/kivitendo-erp.git
653 $ git checkout release-3.4.1 # das ist der aktuelle release, den wir wollen
654 $ git add templates/fullhouse # das sind unsere druckvorlagen inkl. produktbilder
655 $ git commit -m "juhu tolle ändernungen"
656 [meine_aenderungen 1d89e41] juhu tolle ändernungen
657 4 files changed, 380 insertions(+)
658 create mode 100644 templates/fullhouse/img/webdav/tesla.png
659 create mode 100644 templates/fullhouse/mahnung.tex
660 create mode 100644 templates/fullhouse/zahlungserinnerung_zwei.tex
661 create mode 100644 templates/fullhouse/zahlungserinnerung_zwei_invoice.tex
666 $ git rebase --onto release-3.5.0 release-3.4.1 meine_aenderungen
667 Zunächst wird der Branch zurückgespult, um Ihre Änderungen
668 darauf neu anzuwenden ...
669 Wende an: juhu tolle ändernungen
670 $ service apache2 restart
671 </programlisting></para>
675 <sect1 id="config.config-file">
676 <title>kivitendo-Konfigurationsdatei</title>
678 <sect2 id="config.config-file.introduction"
679 xreflabel="Einführung in die Konfigurationsdatei">
680 <title>Einführung</title>
682 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
683 benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die
684 Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von
685 kivitendo bzw. der Migration von älteren Versionen angelegt
688 <para>Als Vorlage dient die Datei
689 <filename>config/kivitendo.conf.default</filename> (kurz: "die
690 Default-Datei"):</para>
692 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
694 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
695 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
696 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
697 Abschnitte und Werte enthalten, die von denen der Default-Datei
701 <para>Vor der Umbenennung in kivitendo hieß diese Datei noch
702 <filename>config/lx_office.conf</filename>. Aus Gründen der
703 Kompatibilität wird diese Datei eingelesen, sofern die Datei
704 <filename>config/kivitendo.conf</filename> nicht existiert.</para>
707 <para>Diese Hauptkonfigurationsdatei ist dann eine
708 installationsspezifische Datei, d.h. sie enthält bspw. lokale
709 Passwörter und wird auch nicht im Versionsmanagement (git)
712 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
713 Mandaten, bzw. Datenbanken gleich.</para>
716 <sect2 id="config.config-file.sections-parameters">
717 <title>Abschnitte und Parameter</title>
719 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
720 entsprechend kommentiert sind:</para>
724 <para><literal>authentication</literal> (siehe Abschnitt "<xref
725 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
726 in diesem Kapitel)</para>
730 <para><literal>authentication/database</literal></para>
734 <para><literal>authentication/ldap</literal></para>
738 <para><literal>system</literal></para>
742 <para><literal>paths</literal></para>
746 <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
747 linkend="config.sending-email.smtp"/>)</para>
751 <para><literal>applications</literal></para>
755 <para><literal>environment</literal></para>
759 <para><literal>print_templates</literal></para>
763 <para><literal>task_server</literal></para>
767 <para><literal>periodic_invoices</literal></para>
771 <para><literal>self_tests</literal></para>
775 <para><literal>console</literal></para>
779 <para><literal>testing</literal></para>
783 <para><literal>testing/database</literal></para>
787 <para><literal>debug</literal></para>
791 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
792 einzustellen oder zu kontrollieren sind, sind:</para>
794 <programlisting>[authentication]
795 admin_password = geheim
797 [authentication/database]
805 default_manager = german</programlisting>
807 <para>Für kivitendo Installationen in der Schweiz sollte hier
808 <varname>german</varname> durch <varname>swiss</varname> ersetzt
811 <para>Die Einstellung <varname>default_manager = swiss</varname>
816 <para>Beim Erstellen einer neuen Datenbank in der kivitendo
817 Administration werden automatisch die Standard-Werte für die
818 Schweiz voreingestellt: Währung CHF, 5er-Rundung, Schweizer
819 KMU-Kontenplan, Sollversteuerung, Aufwandsmethode, Bilanzierung
820 (die Werte können aber manuell angepasst werden).</para>
824 <para>Einstellen der Standardkonten für Rundungserträge und
825 -aufwendungen (unter Mandantenkonfiguration → Standardkonten
830 <para>das verwendete Zahlenformat wird auf
831 <varname>1'000.00</varname> eingestellt (unter Programm →
832 Benutzereinstellungen veränderbar)</para>
836 <para>DATEV-Automatik und UStVA werden nicht angezeigt,
837 Erfolgsrechnung ersetzt GUV ( unter Mandantenkonfiguration →
838 Features veränderbar)</para>
842 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
843 <varname>[periodic_invoices]</varname> den Login eines Benutzers
844 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
845 mit Informationen über die erstellten Rechnungen bekommt.</para>
847 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
848 Ausführung bestimmter Aufgaben mit, den <link
849 linkend="config.task-server">Taskserver</link>. Er wird u.a. für
850 Features wie die <link
851 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
852 benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
853 daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
854 <link linkend="config.task-server">Task-Server</link> genauer
857 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
858 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
861 <sect2 id="config.config-file.prior-versions">
862 <title>Versionen vor 2.6.3</title>
864 <para>In älteren kivitendo Versionen gab es im Verzeichnis
865 <filename>config</filename> die Dateien
866 <filename>authentication.pl</filename> und
867 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
868 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
869 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
870 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
872 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
873 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
874 manuell übertragen und die alten Konfigurationsdateien anschließend
875 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
876 entsprechende Fehlermeldung an.</para>
880 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
881 <title>Anpassung der PostgreSQL-Konfiguration</title>
883 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
884 <para>Dies variert je nach eingesetzter Distribution, da distributionsabhängig unterschiedliche Strategien beim Upgrade der Postgres Version eingesetzt werden.
885 Als Hinweis einige Links zu den drei Distribution (Stand Dezember 2018):</para>
888 <para><ulink url="https://fedoraproject.org/wiki/PostgreSQL">Fedora (Postgres-Installation unter Fedora)</ulink></para>
891 <para><ulink url="https://help.ubuntu.com/lts/serverguide/postgresql.html">Ubuntu (Infos für Postgres für die aktuelle LTS Version)</ulink></para>
894 <para><ulink url="https://de.opensuse.org/PostgreSQL">OpenSuSE (aktuell nur bis Version OpenSuSE 13 verifiziert)</ulink></para>
897 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
898 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
900 <para>kivitendo setzt zwingend voraus, dass die Datenbank
901 Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
902 Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
904 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
905 Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
906 man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
908 <programlisting>su postgres
910 exit </programlisting>
912 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
913 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
914 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
917 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
919 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
920 Versionsnummer angepasst werden.</para>
922 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
924 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
925 <literal>\l</literal> geprüft werden.</para>
928 <sect2 id="Änderungen-an-Konfigurationsdateien">
929 <title>Änderungen an Konfigurationsdateien</title>
931 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
932 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
933 <filename>/var/lib/pgsql/data/</filename> oder
934 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
935 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
936 Parameter <varname>listen_address</varname> gesteuert. Laufen
937 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
938 <literal>localhost</literal> verwendet werden. Andernfalls müssen
939 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
940 was mit dem Wert <literal>*</literal> geschieht.</para>
942 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
943 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
944 sein sollte, müssen die Berechtigungen für den Zugriff geändert
945 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
946 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
947 Datenbank zum Beispiel:</para>
949 <programlisting>local all kivitendo password
950 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
953 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
954 <title>Erweiterung für servergespeicherte Prozeduren</title>
956 <para>In der Datenbank <literal>template1</literal> muss die
957 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
958 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
959 <programlisting>su - postgres
960 psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
962 <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
966 <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
967 bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
968 anzulegen. In diesen Versionen ist die Extension meist auch schon
969 vorhanden. Sollten Sie eine ältere Version von Postgres haben,
970 benutzen Sie stattdessen den folgenden Befehl.</para>
972 <programlisting>CREATE LANGUAGE 'plpgsql';
977 <sect2 id="Erweiterung-für-trigram">
978 <title>Erweiterung für Trigram Prozeduren</title>
980 <para>Ab Version 3.5.1 wird die Trigram-Index-Erweiterung benötigt.
981 Diese wird mit dem SQL-Updatescript
982 sql/Pg-upgrade2/trigram_extension.sql und Datenbank-Super-Benutzer
983 Rechten automatisch installiert. Dazu braucht der
984 DatenbankSuperbenutzer "postgres" ein Passwort.</para>
986 <programlisting>su - postgres
993 <para>Benutzername Postgres und Passwort können jetzt beim Anlegen
994 einer Datenbank bzw. bei Updatescripten, die SuperuserRechte
995 benötigen, eingegeben werden.</para>
998 <para><literal>pg_trgm</literal> ist je nach Distribution nicht im
999 Standard-Paket von Postgres enthalten. Ein <programlisting>select * from pg_available_extensions where name ='pg_trgm';</programlisting>
1000 in template1 sollte entsprechend erfolgreich sein. Andernfalls muss
1001 das Paket nachinstalliert werden, bspw. bei debian/ubuntu
1002 <programlisting>apt install postgresql-contrib</programlisting></para>
1006 <sect2 id="Datenbankbenutzer-anlegen">
1007 <title>Datenbankbenutzer anlegen</title>
1009 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
1010 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
1011 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
1014 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
1015 nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
1016 generieren nicht nötig.</para>
1018 <programlisting>su - postgres
1019 createuser -d -P kivitendo
1020 exit</programlisting>
1022 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
1023 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
1024 bzw. den hier gewählten Benutzernamen.</para>
1028 <sect1 id="Apache-Konfiguration">
1029 <title>Webserver-Konfiguration</title>
1032 <title>Grundkonfiguration mittels CGI</title>
1035 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
1036 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
1037 <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
1040 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
1041 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
1042 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
1043 anderen Datei hinzu, die beim Starten des Webservers eingelesen
1046 <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
1047 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
1049 <Directory /var/www/kivitendo-erp>
1050 AddHandler cgi-script .pl
1051 Options ExecCGI Includes FollowSymlinks
1054 <Directory /var/www/kivitendo-erp/users>
1056 </Directory></programlisting>
1058 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
1059 das kivitendo-Archiv entpacket haben.</para>
1062 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
1063 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
1065 <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
1066 noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
1067 aktiviert werden.</para>
1070 <para>Auf einigen Webservern werden manchmal die Grafiken und
1071 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
1072 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
1074 <programlisting>EnableSendfile Off</programlisting>
1077 <sect2 id="Apache-Konfiguration.FCGI"
1078 xreflabel="Konfiguration für FastCGI/FCGI">
1079 <title>Konfiguration für FastCGI/FCGI</title>
1081 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
1082 <title>Was ist FastCGI?</title>
1084 <para>Direkt aus <ulink
1085 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
1088 <para><citation> FastCGI ist ein Standard für die Einbindung
1089 externer Software zur Generierung dynamischer Webseiten in einem
1090 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
1091 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
1092 umgehen. </citation></para>
1095 <sect3 id="Apache-Konfiguration.FCGI.Warum">
1096 <title>Warum FastCGI?</title>
1098 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
1099 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
1100 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
1101 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
1102 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
1103 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
1104 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
1105 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
1106 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
1107 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
1108 deutlich länger dauert als früher, und dass davon 90% für das Laden
1109 der Module verwendet wird.</para>
1111 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
1112 wird nur die eigentliche Programmlogik ausgeführt.</para>
1115 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
1116 <title>Getestete Kombinationen aus Webservern und Plugin</title>
1118 <para>Folgende Kombinationen sind getestet:</para>
1122 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
1125 <para>Apache 2.4.18 (Ubuntu 16.04 LTS) und mod_fcgid</para>
1128 <para>Apache 2.4.29 (Ubuntu 18.04 LTS) und mod_fcgid</para>
1132 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
1136 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
1137 strict in der Behandlung von Unicode, und verweigern bestimmte
1138 Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
1139 Installation gibt, muss zwingend Version 0.68 oder aber Version
1140 0.72 und neuer eingesetzt werden.</para>
1142 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
1143 sich die Vorgängerversion wie folgt installieren:</para>
1145 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
1149 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
1150 <title>Konfiguration des Webservers</title>
1152 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
1153 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
1154 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
1155 debuggen die beim ersten aufsetzen auftreten können. Sollte die
1156 Installation schon funktionieren, lesen Sie weiter.</para>
1158 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
1159 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
1161 <programlisting>a2enmod fcgid</programlisting>
1163 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
1164 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
1165 und <function>Directory</function>-Direktiven. Dabei wird zwischen
1166 dem Installationspfad von kivitendo im Dateisystem
1167 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
1168 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
1169 ("<filename>/url/for/kivitendo-erp</filename>").</para>
1171 <para>Folgender Konfigurationsschnipsel funktioniert mit
1174 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
1175 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1177 <Directory /path/to/kivitendo-erp>
1179 Options ExecCGI Includes FollowSymlinks
1183 <DirectoryMatch /path/to/kivitendo-erp/users>
1185 </DirectoryMatch></programlisting>
1188 <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
1189 muss entsprechend die Syntax der Directorydirektiven verändert.
1192 <programlisting>Require all granted</programlisting>
1194 <para>muß man Folgendes einstellen:</para>
1198 Allow from All </programlisting>
1200 <para>und statt</para>
1202 <programlisting>Require all denied</programlisting>
1204 <para>muss stehen:</para>
1208 Deny from All </programlisting>
1211 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
1212 die maximale Größe eines Requests. Diese sollte wie folgt
1213 hochgesetzt werden:</para>
1215 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
1217 <para>Das Ganze sollte dann so aussehen:</para>
1219 <programlisting>AddHandler fcgid-script .fpl
1220 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1221 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1222 FcgidMaxRequestLen 10485760
1224 <Directory /path/to/kivitendo-erp>
1226 Options ExecCGI Includes FollowSymlinks
1230 <DirectoryMatch /path/to/kivitendo-erp/users>
1232 </DirectoryMatch></programlisting>
1234 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
1235 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
1236 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
1237 gibt es hier kleine Performance-Einbußen.</para>
1239 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
1240 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
1241 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
1243 <programlisting># Zugriff über CGI
1244 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
1246 # Zugriff mit mod_fcgid:
1247 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1248 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
1250 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
1251 die normale Version erreichbar, und unter
1252 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
1253 FastCGI-Version.</para>
1258 <title>Authentifizierung mittels HTTP Basic Authentication</title>
1261 Kivitendo unterstützt, dass Benutzerauthentifizierung über den Webserver mittels des »Basic«-HTTP-Authentifizierungs-Schema erfolgt
1262 (siehe <ulink url="https://tools.ietf.org/html/rfc7617">RFC 7617</ulink>). Dazu ist es aber nötig, dass der dabei vom Client
1263 mitgeschickte Header <constant>Authorization</constant> vom Webserver an Kivitendo über die Umgebungsvariable
1264 <constant>HTTP_AUTHORIZATION</constant> weitergegeben wird, was standardmäßig nicht der Fall ist. Für Apache kann dies über die
1265 folgende Konfigurationsoption aktiviert werden:
1268 <programlisting>SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1</programlisting>
1272 <title>Weitergehende Konfiguration</title>
1274 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
1275 von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1276 weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1277 Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1278 Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1279 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1280 (Stand Sept. 2015)</ulink> und einen aktuellen (Stand Mai 2017) <ulink
1281 url="https://mozilla.github.io/server-side-tls/ssl-config-generator/">
1282 SSL-Konfigurations-Generator</ulink>.</para>
1286 <sect1 id="config.task-server">
1287 <title>Der Task-Server</title>
1289 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1290 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1291 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1292 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1293 essenzielle Aufgaben benutzt.</para>
1295 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1296 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1297 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1299 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1300 Servers integriert werden muss, damit er automatisch gestartet wird.
1301 Dies kann kivitendo nicht für Sie erledigen.</para>
1303 <para>Da der Taskserver als Perlscript läuft, wird Arbeitsspeicher, der
1304 einmal benötigt wurde, nicht mehr an das Betriebssystem zurückgegeben,
1305 solange der Taskserver läuft. Dies kann dazu führen, dass ein länger
1306 laufender Taskserver mit der Zeit immer mehr Arbeitsspeicher für sich
1307 beansprucht. Es ist deshalb sinnvoll, dass der Taskserver in
1308 regelmässigen Abständen neu gestartet wird.</para>
1310 <sect2 id="Konfiguration-des-Task-Servers">
1311 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1313 <para>Die Konfiguration erfolgt über den Abschnitt
1314 <literal>[task_server]</literal> in der Datei
1315 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1316 Optionen sind:</para>
1320 <term><varname>run_as</varname></term>
1323 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1324 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1325 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1326 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1328 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1329 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1330 unter dem auch der Webserver läuft.</para>
1335 <term><varname>debug</varname></term>
1338 <para>Schaltet Debug-Informationen an und aus.</para>
1344 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1345 <title>Konfiguration der Mandanten für den Task-Server</title>
1347 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1348 anschließend jeder Mandant, für den der Task-Server laufen soll,
1349 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1350 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1351 ausgewählt werden, unter der der Task-Server seine Arbeit
1354 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1355 wird der Task-Server für diesen Mandanten keine Aufgaben
1359 <sect2 id="Einbinden-in-den-Boot-Prozess">
1360 <title>Automatisches Starten des Task-Servers beim Booten</title>
1362 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1363 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1364 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1366 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1367 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1368 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1369 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1370 anstelle eines symbolischen Links verwendet werden können.</para>
1373 <title>SystemV-basierende Systeme (z.B. ältere Debian, ältere
1374 openSUSE, ältere Fedora)</title>
1376 <para>Kopieren Sie die Datei
1377 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1378 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1379 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1380 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1381 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1385 <para>Debian-basierende Systeme:</para>
1387 <programlisting>update-rc.d kivitendo-task-server defaults
1388 insserv kivitendo-task-server</programlisting>
1392 <para>Ältere openSUSE und ältere Fedora:</para>
1394 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1398 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1401 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1405 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1407 <para>Kopieren Sie die Datei
1408 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1409 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1410 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1411 <literal>exec ....</literal>).</para>
1413 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1416 <programlisting>service kivitendo-task-server start</programlisting>
1420 <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1421 Fedora, neuere Ubuntu und neuere Debians)</title>
1423 <para>Kopieren Sie die Datei
1424 <filename>scripts/boot/systemd/kivitendo-task-server.service</filename>
1425 nach <filename>/etc/systemd/system/</filename>. Passen Sie in der
1426 kopierten Datei den Pfad zum Task-Server an (Zeilen
1427 <literal>ExecStart=....</literal> und
1428 <literal>ExecStop=...</literal>).</para>
1430 <para>Machen Sie anschließend das Script systemd bekannt, und binden
1431 Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden Befehl
1434 <programlisting>systemctl daemon-reload
1435 systemctl enable kivitendo-task-server.service</programlisting>
1437 <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt
1438 den Server neu zu starten, so können Sie das mit dem folgenden
1441 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1445 <sect2 id="Prozesskontrolle">
1446 <title>Wie der Task-Server gestartet und beendet wird</title>
1448 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1450 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1452 <para><literal>Befehl</literal> ist dabei eine der folgenden
1457 <para><literal>start</literal> startet eine neue Instanz des
1458 Task-Servers. Die Prozess-ID wird innerhalb des
1459 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1463 <para><literal>stop</literal> beendet einen laufenden
1468 <para><literal>restart</literal> beendet und startet ihn
1473 <para><literal>status</literal> berichtet, ob der Task-Server
1478 <para>Der Task-Server wechselt beim Starten automatisch in das
1479 kivitendo-Installationsverzeichnis.</para>
1481 <para>Dieselben Optionen können auch für die SystemV-basierenden
1482 Runlevel-Scripte benutzt werden (siehe oben).</para>
1486 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1487 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1489 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1490 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1492 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1493 <title>Grundlagen zur Benutzerauthentifizierung</title>
1495 <para>kivitendo verwaltet die Benutzerinformationen in einer
1496 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1497 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1498 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1499 können, müssen aber nicht unterschiedlich sein.</para>
1501 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1502 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1503 abgelegt werden.</para>
1505 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
1506 entweder gegen die Authentifizierungsdatenbank oder gegen einen
1507 LDAP-Server überprüft werden.</para>
1509 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1510 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1511 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1512 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1513 einer Version vor v2.6.0 angelegt werden. Eine
1514 Beispielkonfigurationsdatei
1515 <filename>config/kivitendo.conf.default</filename> existiert, die als
1516 Vorlage benutzt werden kann.</para>
1519 <sect2 id="Administratorpasswort">
1520 <title>Administratorpasswort</title>
1522 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1523 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1524 gespeichert. Es kann auch nur dort und nicht mehr im
1525 Administrationsinterface selber geändert werden. Der Parameter dazu
1526 heißt <varname>admin_password</varname> im Abschnitt
1527 <varname>[authentication]</varname>.</para>
1530 <sect2 id="Authentifizierungsdatenbank">
1531 <title>Authentifizierungsdatenbank</title>
1533 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1534 Parametern in <varname>[authentication/database]</varname>
1535 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1539 <term><literal>host</literal></term>
1542 <para>Der Rechnername oder die IP-Adresse des
1543 Datenbankservers</para>
1548 <term><literal>port</literal></term>
1551 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1556 <term><literal>db</literal></term>
1559 <para>Der Name der Authentifizierungsdatenbank</para>
1564 <term><literal>user</literal></term>
1567 <para>Der Benutzername, mit dem sich kivitendo beim
1568 Datenbankserver anmeldet (z.B.
1569 "<literal>postgres</literal>")</para>
1574 <term><literal>password</literal></term>
1577 <para>Das Passwort für den Datenbankbenutzer</para>
1582 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1583 automatisch anlegen (mehr dazu siehe unten).</para>
1586 <sect2 id="Passwortüberprüfung">
1587 <title>Passwortüberprüfung</title>
1589 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1590 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1591 Active-Directory-Server. Welche davon benutzt wird, regelt der
1592 Parameter <varname>module</varname> im Abschnitt
1593 <varname>[authentication]</varname>.</para>
1595 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1596 gespeichert werden, so muss der Parameter <varname>module</varname>
1597 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1598 der Administrator als auch die Benutzer selber ihre Passwörter in
1599 kivitendo ändern.</para>
1601 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1602 benutzt werden, so muss der Parameter <varname>module</varname> auf
1603 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1604 zusätzliche Informationen über den LDAP-Server im Abschnitt
1605 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1609 <term><literal>host</literal></term>
1612 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1613 Active-Directory-Servers. Diese Angabe ist zwingend
1614 erforderlich.</para>
1619 <term><literal>port</literal></term>
1622 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1627 <term><literal>tls</literal></term>
1630 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1631 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1632 ‘<literal>0</literal>’ belassen</para>
1637 <term><literal>attribute</literal></term>
1640 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1641 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1642 meist ‘<literal>sAMAccountName</literal>’, für andere
1643 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1644 zwingend erforderlich.</para>
1649 <term><literal>base_dn</literal></term>
1652 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1653 Diese Angabe ist zwingend erforderlich.</para>
1658 <term><literal>filter</literal></term>
1661 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1662 <literal><%login%></literal>, so wird dieses durch den vom
1663 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1664 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1665 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1670 <term><literal>bind_dn</literal> und
1671 <literal>bind_password</literal></term>
1674 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1675 durchsucht werden kann (z.B. ist dies bei
1676 Active-Directory-Servern der Fall), so kann diese hier angegeben
1677 werden. Für Active-Directory-Server kann als
1678 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1679 z.B. ‘<literal>cn=Martin
1680 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1681 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1682 also ‘<literal>Martin Mustermann</literal>’.</para>
1688 <sect2 id="Name-des-Session-Cookies">
1689 <title>Name des Session-Cookies</title>
1691 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1692 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1693 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1694 Parameter <varname>cookie_name</varname> im Abschnitt
1695 <varname>[authentication]</varname>gesetzt.</para>
1697 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1698 Server existiert.</para>
1701 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1702 <title>Anlegen der Authentifizierungsdatenbank</title>
1704 <para>Nachdem alle Einstellungen in
1705 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1706 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1707 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1708 der folgenden URL erreichbar sein sollte:</para>
1711 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1715 <sect1 id="Benutzer--und-Gruppenverwaltung">
1716 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1718 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1719 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1720 das Sie unter folgender URL finden:</para>
1723 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1725 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1726 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1728 <sect2 id="Zusammenhänge">
1729 <title>Zusammenhänge</title>
1731 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1732 in einer oder zwei Datenbanken gespeichert werden.</para>
1734 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1735 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1736 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1737 Diese Informationen werden in der Authentifizierungsdatenbank
1738 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1739 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1740 gespeichert werden.</para>
1742 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1743 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1744 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1745 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1746 einer solchen Mandantendatenbank werden im Administrationsbereich
1747 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1748 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1750 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1751 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1752 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1753 mehr als einem Mandanten, wird empfohlen, für die
1754 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1755 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1758 <sect2 id="Mandanten-Benutzer-Gruppen">
1759 <title>Mandanten, Benutzer und Gruppen</title>
1761 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1762 die sich frei zueinander zuordnen lassen.</para>
1764 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1765 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1766 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1767 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1768 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1769 Diese sollte über die <link
1770 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1773 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1774 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1775 der Administrator fest, an welchen Mandanten sich ein Benutzer
1776 anmelden kann, was beim Login verifiziert wird.</para>
1778 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1779 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1780 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1781 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1782 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1783 dann an einem Mandanten an, so erhält er alle Rechte von allen
1784 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1785 denen der Benutzer zum Anderen Mitglied ist,</para>
1787 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1788 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1789 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1791 <orderedlist numeration="arabic">
1793 <para>Datenbank anlegen</para>
1797 <para>Gruppen anlegen</para>
1801 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1805 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1810 <sect2 id="Datenbanken-anlegen">
1811 <title>Datenbanken anlegen</title>
1813 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1814 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1815 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1818 <sect2 id="Gruppen-anlegen">
1819 <title>Gruppen anlegen</title>
1821 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1822 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1823 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1824 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1826 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1827 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1828 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1829 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1830 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1831 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1832 A, B und C gültig").</para>
1834 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1835 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1836 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1837 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1838 Gruppen A, B und C").</para>
1841 <sect2 id="Benutzer-anlegen">
1842 <title>Benutzer anlegen</title>
1844 <para>Beim Anlegen von Benutzern werden für viele Parameter
1845 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1846 deutschen Raumes entsprechen.</para>
1848 <para>Zwingend anzugeben ist der Loginname. Wenn die
1849 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
1850 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
1851 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1854 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
1855 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
1856 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
1857 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
1858 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
1859 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
1860 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
1861 sind Benutzer A, B und C Mitglieder").</para>
1864 <sect2 id="Mandanten-anlegen">
1865 <title>Mandanten anlegen</title>
1867 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
1868 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
1869 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
1870 einer der eben angelegten Datenbanken eingetragen werden.</para>
1872 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
1873 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
1874 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
1875 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
1876 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
1877 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
1878 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
1879 Gruppe ist für Mandanten A, B und C gültig").</para>
1883 <sect1 id="Drucker--Systemverwaltung">
1884 <title>Drucker- und Systemverwaltung</title>
1886 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
1887 Druckeradministration und System.</para>
1889 <sect2 id="Druckeradministration">
1890 <title>Druckeradministration</title>
1892 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
1893 viele "Druckbefehle" im System verwalten. Diese Befehle werden
1894 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
1895 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
1896 angezeigt wird.</para>
1898 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
1899 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
1900 meinDrucker' oder ein kompletter Pfad zu einem Skript
1901 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
1902 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
1903 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
1904 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
1905 Ausdruck eines Angebots folgende Vorlage geparst:
1906 sales_quotation_epson_drucker.tex.</para>
1910 <title>System sperren / entsperren</title>
1912 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
1913 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
1914 gesamten kivitendo Installation gesperrt.</para>
1916 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
1917 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
1918 Wartungsarbeiten nicht zugänglich.'.</para>
1920 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
1921 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
1922 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
1923 inkonsistenten Datenbestand weitergearbeitet werden.</para>
1927 <sect1 id="config.sending-email"
1928 xreflabel="E-Mail-Versand aus kivitendo heraus">
1929 <title>E-Mail-Versand aus kivitendo heraus</title>
1931 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
1932 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
1933 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
1934 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
1935 Versand über einen lokalen E-Mail-Server (z.B. mit
1936 <productname>Postfix</productname> oder <productname>Exim</productname>,
1937 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
1938 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
1940 <para>Welche Methode und welcher Server verwendet werden, wird über die
1941 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1942 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
1943 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1945 <sect2 id="config.sending-email.sendmail"
1946 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1947 <title>Versand über lokalen E-Mail-Server</title>
1949 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
1950 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
1951 <productname>Postfix</productname>, <productname>Exim</productname>
1952 oder <productname>Sendmail</productname> läuft.</para>
1954 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1955 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1956 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1958 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
1959 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
1960 Standardwert verweist auf das Programm
1961 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1962 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1964 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
1965 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
1969 <sect2 id="config.sending-email.smtp"
1970 xreflabel="E-Mail-Versand über einen SMTP-Server">
1971 <title>Versand über einen SMTP-Server</title>
1973 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
1974 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
1977 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1978 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1979 Parameter dienen dabei der weiteren Konfiguration:</para>
1983 <term><varname>hostname</varname></term>
1986 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
1987 '<literal>localhost</literal>'</para>
1992 <term><varname>port</varname></term>
1995 <para>Portnummer. Der Standardwert hängt von der verwendeten
1996 Verschlüsselungsmethode ab. Gilt '<literal>security =
1997 none</literal>' oder '<literal>security = tls</literal>', so ist
1998 25 die Standardportnummer. Für '<literal>security =
1999 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
2000 geändert werden.</para>
2005 <term><varname>security</varname></term>
2008 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
2009 mit dem Server. Standardwert ist '<literal>none</literal>',
2010 wodurch keine Verschlüsselung verwendet wird. Mit
2011 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
2012 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
2013 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
2014 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
2015 (siehe unten).</para>
2020 <term><varname>login</varname> und
2021 <varname>password</varname></term>
2024 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
2025 so können mit diesen zwei Parametern der Benutzername und das
2026 Passwort angegeben werden. Wird Authentifizierung verwendet, so
2027 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
2028 aktiviert werden.</para>
2035 <sect1 id="Drucken-mit-kivitendo">
2036 <title>Drucken mit kivitendo</title>
2038 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
2039 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
2040 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
2041 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
2043 <para><programlisting>apt install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
2044 texlive-latex-extra texlive-lang-german texlive-generic-extra texlive-xetex ghostscript</programlisting></para>
2046 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
2048 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
2049 texlive-collection-latexrecommended texlive-collection-langgerman \
2050 texlive-collection-langenglish</programlisting></para>
2052 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
2054 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
2055 texlive-collection-latexrecommended texlive-collection-langgerman \
2056 texlive-collection-langenglish</programlisting></para>
2058 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
2070 <para>rev-odt</para>
2074 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version
2075 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
2077 <sect2 id="Vorlagenverzeichnis-anlegen"
2078 xreflabel="Vorlagenverzeichnis anlegen">
2079 <title>Vorlagenverzeichnis anlegen</title>
2081 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
2082 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
2084 <programlisting>./scripts/installation_check.pl -lv</programlisting>
2086 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
2087 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
2088 <xref linkend="Gruppen-anlegen"/>.</para>
2090 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
2091 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
2092 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
2093 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
2097 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
2098 Vorlagensatz aus, der kopiert werden soll
2099 (<filename>RB</filename>, <filename>f-tex</filename> oder
2100 <filename>odt-rev</filename>.)</para>
2104 <para><option>Neuer Name</option>: Der Verzeichnisname für den
2105 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
2106 für Verzeichnisnamen frei gewählt werden.</para>
2110 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
2111 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
2112 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
2113 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
2114 vorgenommen werden. Den Ordner findet man im Dateisystem unter
2115 <filename>./templates/[Neuer Name]</filename></para>
2118 <sect2 id="Vorlagen-RB">
2119 <title>Der Druckvorlagensatz RB</title>
2121 <para>Hierbei handelt es sich um einen vollständigen LaTeX
2122 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
2123 sind nicht gepflegt.</para>
2125 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
2126 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
2127 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
2128 eigenen Firmendaten finden sich in der Datei Readme.tex im
2129 Vorlagenverzeichnis.</para>
2131 <para>Eine kurze Übersicht der Features:</para>
2135 <para>Mehrsprachenfähig, mit Deutscher und Englischer
2140 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
2141 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
2146 <para>mehrere vordefinierte Varianten für
2147 Logos/Hintergrundbilder</para>
2151 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
2152 "Außerhalb EU"</para>
2158 <title>f-tex</title>
2160 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur
2161 Verfügung stellt.</para>
2163 <sect3 id="f-tex-Feature-Übersicht">
2164 <title>Feature-Übersicht</title>
2168 <para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage
2169 für alle briefartigen Dokumente verwendet. Also Angebot,
2170 Rechnung, Proformarechnung, Lieferschein, aber eben nicht für
2171 Paketaufkleber etc.</para>
2175 <para>Leichte Anpassung an das Firmen-Layout durch Verwendung
2176 eines Hintergrund-PDFs. Dieses kann leicht mit dem eigenen
2177 Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp,
2182 <para>Hintergrund-PDF umschaltbar auf "nur erste Seite"
2183 (Standard) oder "alle Seiten" (Option
2184 "<option>bgPdfFirstPageOnly</option>" in Datei
2185 <filename>letter.lco</filename>)</para>
2189 <para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem
2190 Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
2191 versendeten Dokumenten eingebunden (Option
2192 "<option>bgPdfEmailOnly</option>" in Datei
2193 <filename>letter.lco</filename>).</para>
2197 <para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch,
2198 Wiederholung von Kopfzeilen, Zwischensummen etc. (danke an
2199 Kai-Martin Knaak für die Vorarbeit)</para>
2203 <para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom
2204 Land des eigenen Unternehmens abweicht (also die Rechnung das
2205 Land verlässt).</para>
2209 <para>Multisprachfähig leicht um weitere Sprachen zu erweitern,
2210 alle Übersetzungen in der Datei
2211 <filename>translatinos.tex</filename>.</para>
2215 <para>Auflistung von Bruttopreisen für Endverbraucher.</para>
2220 <sect3 id="f-tex-Installation">
2221 <title>Die Installation</title>
2225 <para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref
2226 linkend="Vorlagenverzeichnis-anlegen"/>. Das Vorlagensystem
2227 funktioniert jetzt schon, hat allerdings noch einen
2228 Beispiel-Briefkopf.</para>
2232 <para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
2233 <filename>./letter_head.pdf</filename>.</para>
2237 <para>Editiere den Bereich "<option>settings</option>" in der
2238 datei <filename>letter.lco</filename>.</para>
2242 <para>oder etwas detaillierter:</para>
2244 <para>Es wird eine Datei <filename>sample.lco</filename> erstellt
2245 und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
2246 ist dies die Datei die für die firmenspezifischen Anpassungen
2247 gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist,
2248 wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle
2249 über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und
2250 <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung
2251 über eine <filename>*.lco</filename>-Datei, die letztlich auf
2252 <filename>letter.lco</filename> verlinkt ist ist aber auch
2255 <para>Es wird eine Datei <filename>sample_head.pdf</filename> mit
2256 ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
2257 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage.
2258 Schau Dir nach Abschluss der Installation die Datei
2259 <filename>sample_head.pdf</filename> an und erstelle ein
2260 entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
2261 Template Verzeichniss ablegen und statt
2262 <filename>sample_head.pdf</filename> nach
2263 <filename>letter_head.pdf</filename> verlinken.</para>
2265 <para>Letzlich muss <filename>letter_head.pdf</filename> auf das
2266 passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
2269 <para>Es wird eine Datei <filename>mydata.tex.example</filename>
2270 ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
2271 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das
2272 Land verwendet. Die Datei muss also nicht angefasst werden. Die
2273 anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit
2274 nicht im öffentlichen Zweig).</para>
2276 <para>Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
2277 sollten über die Hintergrund-PDF-Datei oder die
2278 <filename>*.lco</filename>-Datei erfolgen.</para>
2281 <sect3 id="f-tex-Funktionsübersicht">
2282 <title>f-tex Funktionsübersicht</title>
2284 <para>Das Konzept von kivitendo sieht vor, für jedes Dokument
2285 (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
2286 LaTeX-Vorlage vorzuhalten, dies ist sehr wartungsunfreundlich. Auch
2287 das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
2288 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen
2289 aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
2290 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
2291 LaTeX-Vorlage verwendet, welche über Codeweichen die Besonderheiten
2292 der jeweiligen Dokumente berücksichtigt:</para>
2296 <para>Tabellen mit oder ohne Preis</para>
2300 <para>Sprache der Tabellenüberschriften etc.</para>
2304 <para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
2305 Angebotsnummer)</para>
2309 <para>Darstellung von Brutto oder Netto-Preisen in der
2310 Auflistung (Endverbraucher versus gewerblicher Kunde)</para>
2314 <para>Nachteil:</para>
2316 <para>LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei
2317 <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
2318 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder
2319 geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch
2320 innerhalb der Tabellendarstellung gut persönliche Anpassungen
2321 vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell
2322 heftig in den Fuss schiessen.</para>
2324 <para>Wer nicht so tief in die Materie einsteigen will oder leicht
2325 zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
2326 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen,
2327 und sich an der Form der dargestellten Tabellen, wie sie
2328 ausgeliefert werden, erfreuen.</para>
2330 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine,
2331 kontinuierliche Schritte gehen.</para>
2334 <sect3 id="f-tex-Bruttopreise">
2335 <title>Bruttopreise für Endverbraucher</title>
2337 <para>Der auszuweisende Bruttopreis wird innerhalb der
2338 LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen
2339 "alle Preise Brutto" auszuwählen, aber:</para>
2343 <para>hierfür müssen die Preise auch in Brutto in der Datenbank
2344 stehen (ja - das lässt sich über die Preisgruppen und die
2345 Zuordung einer Default-Preisgruppe handhaben)</para>
2349 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses
2350 Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
2351 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche
2356 <para>Es gibt mit f-tex eine weitere Alternative. Die Information ob
2357 Brutto oder Nettorechnung wird mit den Zahlarten verknüpft.
2358 Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben
2359 werden sollen, enden mit "_E" (für Endverbraucher). Falls identische
2360 Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt
2361 man diese einfach doppelt an (einmal mit der Namensendung "_E").
2366 <para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist
2367 nicht mehr fix mit einer Preisliste verbunden.</para>
2371 <para>Die Default-Zahlart kann im Kundendatensatz hinterlegt
2372 werden, und man muss nicht mehr daran denken, "alle Preise
2373 Netto" auszuwählen.</para>
2377 <para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen
2378 werden, kann direkt beim Drucken revidiert werden, ohne dass
2379 sich der Auftragswert ändert.</para>
2384 <sect3 id="f-tex-lieferadressen">
2385 <title>Lieferadressen</title>
2387 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen
2388 im Adressfeld zum Einsatz. Wenn die
2389 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende
2390 Adressvariable eingesetzt. Wenn also die Lieferadresse in Straße,
2391 Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
2392 Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert
2393 der Hauptadresse angezeigt.</para>
2397 <sect2 id="Vorlagen-rev-odt">
2398 <title>Der Druckvorlagensatz rev-odt</title>
2400 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2401 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2402 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2403 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2404 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2405 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2406 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2408 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2409 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2410 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2411 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2412 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2413 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2415 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2416 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2417 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2418 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2419 die vom Parser nicht korrekt gelesen werden kann.</para>
2421 <para>Mahnungen können unter folgenden Einschränkungen mit den
2422 odt-Vorlagen im Vorlagensatz rev-odt erzeugt werden:</para>
2426 <para>als Druckoption steht nur 'PDF(OpenDocument/OASIS)' zur
2427 Verfügung, das heisst, die Mahnungen werden als PDF-Datei
2432 <para>für jede Rechnung muss eine eigene Mahnung erzeugt werden
2433 (auch wenn bei einzelnen KundInnen mehrere überfällige Rechnungen
2434 vorhanden sind).</para>
2438 <para>Mehrere Mahnungen für eine Kundin / einen Kunden werden zu einer
2439 PDF-Datei zusammengefasst</para>
2441 <para>Die Vorlagen zahlungserinnerung.odt sowie mahnung.odt sind für
2442 das Erstellen einer Zahlungserinnerung bzw. Mahnung selbst vorgesehen,
2443 die Vorlage mahnung_invoice.odt für das Erstellen einer Rechnung über
2444 die verrechneten Mahngebühren und Verzugszinsen.</para>
2446 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2447 odt-Vorlagen bei Briefen und Pflichtenheften einzusetzen.
2448 Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2450 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2451 empfang@revamp-it.ch</para>
2454 <sect2 id="allgemeine-hinweise-zu-latex">
2455 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2457 <para>In den allermeisten Installationen sollte das Drucken jetzt
2458 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2459 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2460 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2461 sind zum Beispiel:</para>
2465 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2466 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2467 allem bei Vorlagen aus der Community auf. Installieren Sie die
2468 entsprechenden Pakete.</para>
2472 <para>! Package inputenc Error: Unicode char \u8:... set up for
2473 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2474 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2475 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2476 diversen Tricks dazu gebracht werden andere Zeichen zu
2477 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2482 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2483 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2484 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2485 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2486 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2489 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2490 verifizieren lässt:</para>
2494 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2495 "keep_temp_files" auf 1</para>
2497 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2501 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2505 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2509 <para>wechsel in das users Verzeichnis von kivitendo</para>
2511 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2515 <para>LaTeX Suchpfad anpassen:</para>
2517 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2521 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2524 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2526 <para>Es sollte die letzte Datei ganz unten sein</para>
2530 <para>für besseren Hinweis auf Fehler texdatei nochmals
2533 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2535 <para>in der *.tex datei nach dem Fehler suchen.</para>
2541 <sect1 id="OpenDocument-Vorlagen">
2542 <title>OpenDocument-Vorlagen</title>
2544 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2545 OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2)
2546 erzeugen. kivitendo kann dabei sowohl neue OpenDocument-Dokumente als
2547 auch aus diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2548 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2549 <filename>config/kivitendo.conf</filename> die Variable
2550 <literal>opendocument</literal> im Abschnitt
2551 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2552 Dieses ist die Standardeinstellung.</para>
2554 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2555 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2556 LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt
2557 werden, so muss neben LibreOffice oder OpenOffice auch der “X virtual
2558 frame buffer” (xvfb) installiert werden. Bei Debian ist er im Paket
2559 “xvfb” enthalten. Andere Distributionen enthalten ihn in anderen
2562 <para>Nach der Installation müssen in der Datei
2563 <filename>config/kivitendo.conf</filename> im Abschnitt
2564 <literal>applications</literal> zwei weitere Variablen angepasst
2567 <para><literal>openofficeorg_writer</literal> muss den vollständigen
2568 Pfad zu LibreOffice oder OpenOffice enthalten. Dabei dürfen keine
2569 Anführungszeichen eingesetzt werden.</para>
2571 <para>Beispiel für Debian oder Ubuntu:</para>
2573 <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2575 <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2578 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2579 LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die
2580 benutzt wird, wenn die Variable <literal>$openofficeorg_daemon</literal>
2581 gesetzt ist, startet ein LibreOffice oder OpenOffice, das auch nach der
2582 Umwandlung des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen
2583 wird dann diese laufende Instanz benutzt. Der Vorteil ist, dass die Zeit
2584 zur Umwandlung deutlich reduziert wird, weil nicht für jedes Dokument
2585 ein LibreOffice bzw. OpenOffice gestartet werden muss. Der Nachteil ist,
2586 dass diese Methode Python und die Python-UNO-Bindings benötigt, die
2587 Bestandteil von LibreOffice bzw. OpenOffice sind.</para>
2590 <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2591 normalerweise der Python-Interpreter
2592 <filename>/usr/bin/python</filename> benutzt. Sollte dies nicht der
2593 richtige sein, so kann man mit zwei Konfigurationsvariablen
2594 entscheiden, welcher Python-Interpreter genutzt wird. Mit der Option
2595 <literal>python_uno</literal> aus dem Abschnitt
2596 <literal>applications</literal> wird der Interpreter selber
2597 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2598 <literal>/usr/bin/python</literal>.</para>
2600 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2601 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2602 z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2603 OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2604 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2605 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2606 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2607 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2608 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2612 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2613 wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet und
2614 die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses Makro muss
2615 in der Dokumentenvorlage enthalten sein und
2616 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2617 ‘<literal>templates/print/rev-odt/invoice.odt</literal>’ enthält ein
2618 solches Makro, das in jeder anderen Dokumentenvorlage ebenfalls
2619 enthalten sein muss.</para>
2621 <para>Als letztes muss herausgefunden werden, welchen Namen OpenOffice
2622 bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen gibt.
2623 Unter Debian ist dies momentan <literal>~/.config/libreoffice</literal>.
2624 kivitendo verwendet das Verzeichnis
2625 <literal>users/.openoffice.org2</literal>. Eventuell muss dieses
2626 Verzeichnis umbenannt werden.</para>
2628 <para>Dieses Verzeichnis, wie auch das komplette
2629 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2630 sein. Dieses wurde bereits erledigt (siehe <xref
2631 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber erneut
2632 überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.</para>
2635 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2637 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2638 Aufgaben erfüllen.</para>
2640 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2641 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2642 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2643 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2644 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2645 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2646 Anpassungen aufgeführt</emphasis>):</para>
2649 <title>Bezeichnung der Vorlagen</title>
2651 <para>Rechnung: invoice_besr.odt, Auftrag:
2652 sales_order_besr.odt</para>
2656 <title>Vorbereitungen im Adminbereich</title>
2658 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2659 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2660 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2661 ein Drucker eingerichtet werden:</para>
2665 <para>Druckeradministration → Drucker hinzufügen</para>
2669 <para>Mandant wählen</para>
2673 <para>Druckerbeschreibung → aussagekräftiger Text: wird in der
2674 Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B. mit
2675 Einzahlungsschein Bank xy)</para>
2679 <para>Druckbefehl → beliebiger Text (hat für das Erzeugen von
2680 Aufträgen oder Rechnungen als odt-Datei keine Bedeutung, darf
2681 aber nicht leer sein)</para>
2685 <para>Vorlagenkürzel → besr bzw. selbst gewähltes Vorlagensuffix
2686 (muss genau der Zeichenfolge entsprechen, die zwischen
2687 "invoice_" bzw. "sales_order_" und ".odt" steht.)</para>
2691 <para>speichern</para>
2697 <title>Benutzereinstellungen</title>
2699 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2700 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2701 dies persönlich für sich bei den Benutzereinstellungen
2702 konfigurieren:</para>
2706 <para>Programm → Benutzereinstellungen → Druckoptionen</para>
2710 <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2714 <para>Standardausgabekanal → Bildschirm</para>
2718 <para>Standarddrucker → gewünschte Druckerbeschreibung auswählen
2719 (z.B. mit Einzahlungsschein Bank xy)</para>
2723 <para>Anzahl Kopien → leer</para>
2727 <para>speichern</para>
2733 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2735 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2736 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2737 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2738 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2743 <para>Für den Einzahlungsschein ist die letzte Seite des
2744 Dokuments reserviert</para>
2748 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2749 Zeile mit folgenden Angaben (<emphasis
2750 role="bold">Bank-Konto-Identifikationsnummer und
2751 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2752 Bank angepasst werden</emphasis>):<itemizedlist>
2754 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2755 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2757 <para>erster Wert: <emphasis
2758 role="bold">Bank-Konto-Identifikation</emphasis>
2759 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2760 angepasst werden</emphasis>.</para>
2764 <para>zweiter Wert: <%customernumber%>
2765 (Kundennummer: nur Ziffern, maximal 6)</para>
2769 <para>dritter Wert: <%ordnumber%>
2770 (Auftragsnummer bei Auftragsvorlage
2771 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2772 führende Buchstaben werden vom Makro entfernt</para>
2776 <para>vierter Wert: <%invnumber%>
2777 (Rechnungsnummer bei Rechnungsvorlage
2778 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2779 führende Buchstaben werden vom Makro entfernt</para>
2781 </itemizedlist></para>
2785 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2786 Bank, muss angepasst werden</emphasis>.</para>
2790 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2791 falls Einzahlungsschein ohne Betrag</para>
2795 <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2797 </itemizedlist></para>
2801 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2802 der Name und die Adresse der Bank, die Postkonto-Nummer der
2803 Bank, sowie der eigene Firmenname und die Firmenadresse
2804 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2805 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2806 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2812 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2813 ändernde Einträge in rot</screeninfo>
2817 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2824 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2825 odt-Rechnung (analog bei Auftrag)</title>
2827 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2828 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2829 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2830 den Benutzereinstellungen als persönlicher Standard gewählt
2835 <title>Makroeinstellungen in LibreOffice anpassen</title>
2837 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2838 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2839 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2840 angepasst werden:</para>
2844 <para>Extras → Optionen → Sicherheit → Makrosicherheit</para>
2848 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2849 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2850 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2855 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2856 der entsprechenden Nachfrage "Makros ausführen"
2859 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2860 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2861 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2862 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2870 <sect1 id="nomenclature">
2871 <title>Nomenklatur</title>
2873 <sect2 id="booking.dates">
2874 <title>Datum bei Buchungen</title>
2876 <para>Seit der Version 3.5 werden für Buchungen in kivitendo
2877 einheitlich folgende Bezeichnungen verwendet:</para>
2881 <para><option>Erfassungsdatum</option> (en: <option>Entry
2882 Date</option>, code: <option>Gldate</option>)</para>
2884 <para>bezeichnet das Datum, an dem die Buchung in kivitendo
2885 erfasst wurde.</para>
2889 <para><option>Buchungsdatum</option> (en: <option>Booking
2890 Date</option>, code: <option>Transdate</option>)</para>
2892 <para>bezeichnet das buchhaltungstechnisch für eine Buchung
2893 relevante Datum</para>
2895 <para>Das <option>Rechnungsdatum</option> bei Verkaufs- und
2896 Einkaufsrechnungen entspricht dem Buchungsdatum. Das heisst, in
2897 Berichten wie dem Buchungsjournal, in denen eine Spalte
2898 <option>Buchungsdatum</option> angezeigt werden kann, erscheint
2899 hier im Fall von Rechnungen das Rechnungsdatum.</para>
2903 <para>Bezieht sich ein verbuchter Beleg auf einen Zeitpunkt, der
2904 nicht mit dem Buchungsdatum übereinstimmt, so kann dieses Datum
2905 momentan in kivitendo nur unter Bemerkungen erfasst werden.</para>
2907 <para>Möglicherweise wird für solche Fälle in einer späteren
2908 Version von kivitendo ein dritter Datumswert für Buchungen
2909 erstellt. (Beispiel: Einkaufsbeleg stammt aus einem früheren Jahr,
2910 das bereits buchhaltungstechnisch abgeschlossen wurde, und muss
2911 deshalb später verbucht werden.)</para>
2917 <sect1 id="config.eur">
2918 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
2921 <sect2 id="config.eur.introduction"
2922 xreflabel="Einführung in die Konfiguration zur EUR">
2923 <title>Einführung</title>
2925 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
2926 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
2927 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
2928 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
2929 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
2931 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
2932 die Mandantendatenbank verschoben und dabei auch gleich in drei
2933 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
2934 steuern lässt.</para>
2937 <sect2 id="config.eur.parameters"
2938 xreflabel="Konfigurationsparameter für EUR">
2939 <title>Konfigurationsparameter</title>
2941 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
2942 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
2946 <term><varname>profit_determination</varname></term>
2949 <para>Dieser Parameter legt die Berechnungsmethode für die
2950 Gewinnermittlung fest. Er enthält entweder
2951 <literal>balance</literal> für
2952 Betriebsvermögensvergleich/Bilanzierung oder
2953 <literal>income</literal> für die
2954 Einnahmen-Überschuss-Rechnung.</para>
2959 <term><varname>accounting_method</varname></term>
2962 <para>Dieser Parameter steuert die Buchungs- und
2963 Berechnungsmethoden für die Versteuerungsart. Er enthält
2964 entweder <literal>accrual</literal> für die Soll-Versteuerung
2965 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
2970 <term><varname>inventory_system</varname></term>
2973 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
2974 enthält entweder <literal>perpetual</literal> für die
2975 Bestandsmethode oder <literal>periodic</literal> für die
2976 Aufwandsmethode.</para>
2981 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
2982 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
2983 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
2984 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
2985 Bestandsmethode.</para>
2987 <para>Die Konfiguration "<varname>eur</varname>" unter
2988 <varname>[system]</varname> in der <link
2989 linkend="config.config-file">Konfigurationsdatei</link>
2990 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
2991 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
2994 <sect2 id="config.eur.setting-parameters">
2995 <title>Festlegen der Parameter</title>
2997 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
2998 der Admininstration können diese Optionen nun unabhängig voneinander
2999 eingestellt werden.</para>
3001 <para>Für die Schweiz sind folgende Einstellungen üblich:
3004 <para>Sollversteuerung</para>
3008 <para>Aufwandsmethode</para>
3012 <para>Bilanzierung</para>
3014 </itemizedlist> Diese Einstellungen werden automatisch beim
3015 Erstellen einer neuen Datenbank vorausgewählt, wenn in
3016 <filename>config/kivitendo.conf</filename> unter
3017 <varname>[system]</varname> <literal>default_manager = swiss</literal>
3018 eingestellt ist.</para>
3020 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
3021 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
3024 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
3025 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
3026 angezeigt. Unter <guimenu>System</guimenu> →
3027 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
3028 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
3029 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
3030 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
3031 auch <link linkend="config.eur.inventory-system-perpetual">
3032 Bemerkungen zur Bestandsmethode</link>).</para>
3035 <sect2 id="config.eur.inventory-system-perpetual">
3036 <title>Bemerkungen zur Bestandsmethode</title>
3038 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
3039 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
3040 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
3041 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
3042 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
3043 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
3044 Einkaufsrechnungen berechnet wird.</para>
3046 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
3047 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
3048 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
3052 <sect2 id="config.eur.knonw-issues">
3053 <title>Bekannte Probleme</title>
3055 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
3056 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
3057 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
3058 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
3059 die Konfigurationsvariable
3060 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
3063 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
3064 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
3068 <sect1 id="config.skr04-update-3804">
3069 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
3071 <sect2 id="config.skr04-update-3804.introduction">
3072 <title>Einführung</title>
3074 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
3075 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
3076 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
3077 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
3078 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
3079 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
3080 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
3081 vielleicht schon selbst geholfen hat und mit seinen Änderungen
3082 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
3083 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
3084 Screenshots dargestellt.</para>
3086 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
3087 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
3088 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
3089 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
3092 <sect2 id="config.skr04-update-3804.create-chart">
3093 <title>Konto 3804 manuell anlegen</title>
3095 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
3096 anzulegen und zu konfigurieren. Zuerst wird in
3097 <guimenu>System</guimenu> → <guisubmenu>Kontenübersicht</guisubmenu> →
3098 <guimenuitem>Konto erfassen</guimenuitem> das Konto angelegt.</para>
3101 <screeninfo>Konto 3804 erfassen</screeninfo>
3105 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
3110 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
3111 werden. Dazu unter <guimenu>System</guimenu> →
3112 <guisubmenu>Steuern</guisubmenu> →
3113 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
3114 13 auswählen und ihn wie im folgenden Screenshot angezeigt
3118 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
3122 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
3127 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
3128 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
3129 <guisubmenu>Steuern</guisubmenu> → <guimenuitem>Erfassen</guimenuitem>
3130 auswählen und die Werte aus dem Screenshot übernehmen.</para>
3133 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
3137 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
3142 <para>Als Nächstes sind alle Konten anzupassen, die als
3143 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
3144 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
3145 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
3146 müssen Sie dazu unter <guimenu>System</guimenu> →
3147 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
3148 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
3149 wie im Screenshot gezeigt vornehmen.</para>
3152 <screeninfo>Konto 4315 anpassen</screeninfo>
3156 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
3161 <para>Als Letztes sollte die Steuerliste unter
3162 <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
3163 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
3164 Vergleich der Screenshot.</para>
3167 <screeninfo>Steuerliste vergleichen</screeninfo>
3171 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
3178 <sect1 id="config.bilanz">
3179 <title>Verhalten des Bilanzberichts</title>
3181 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
3182 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
3183 monatsweise führt dies zu falschen Werten.</para>
3185 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
3186 einstellen indem man:</para>
3190 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
3195 <para>immer den Jahresanfang nimmt (1.1. relativ zum
3200 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
3202 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3205 <para>- oder mit "alle Buchungen" als Alternative"</para>
3209 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3214 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
3218 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
3219 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
3220 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
3221 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
3222 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
3223 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
3224 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
3225 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
3226 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
3227 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
3228 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
3229 Erfolgsrechnung.</para>
3232 <sect1 id="config.erfolgsrechnung">
3233 <title>Erfolgsrechnung</title>
3235 <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht
3236 <emphasis role="bold"> Erfolgsrechnung</emphasis>.</para>
3238 <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter
3239 Features an- oder abgeschaltet werden. Mit der Einstellung
3240 <varname>default_manager = swiss </varname> in der
3241 <filename>config/kivitendo.conf</filename> wird beim neu Erstellen einer
3242 Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü
3243 <guimenu>Berichte </guimenu> ausgewählt und ersetzt dort die GUV.</para>
3245 <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche
3246 Aufwands- und Erlöskonten einzeln aufgelistet (analog zur Bilanz),
3247 sortiert nach ERTRAG und AUFWAND.</para>
3249 <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der
3250 Erfolgsrechnung erscheinen soll, unter <varname>Sonstige
3251 Einstellungen/Erfolgsrechnung</varname> entweder
3252 <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal>
3253 ausgewählt werden.</para>
3255 <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal>
3256 ausgewählt, so wird dieses Konto als Aufwandsminderung unter AUFWAND
3259 <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal>
3260 ausgewählt, so wird dieses Konto als Ertragsminderung unter ERTRAG
3263 <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft
3264 zusätzlich die Erfolgsrechnung als Bericht verwendet werden, so müssen
3265 die Einstellungen zu allen Erlös- und Aufwandskonten unter
3266 <varname>Sonstige Einstellungen/Erfolgsrechnung</varname> überprüft und
3267 allenfalls neu gesetzt werden.</para>
3270 <sect1 id="config.rounding">
3271 <title>Rundung in Verkaufsbelegen</title>
3273 <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert
3274 von 5 Rappen (0.05 CHF).</para>
3276 <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer
3277 Genauigkeit von 0.01 CHF verwendet werden können, ist es trotzdem nach
3278 wie vor üblich, Rechnungen mit auf 0.05 CHF gerundeten Beträgen
3279 auszustellen.</para>
3281 <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine
3282 solche Rundung pro Mandant / Datenbank festgelegt werden.</para>
3284 <para>Die Einstellung wird beim Erstellen der Datenbank bei
3285 <literal>Genauigkeit</literal> festgelegt. Sie kann anschliessend über
3286 das Webinterface von kivitendo nicht mehr verändert werden.</para>
3288 <para>Abhängig vom Wert für <varname>default_manager</varname> in
3289 <filename>config/kivitendo.conf</filename> werden dabei folgende Werte
3290 voreingestellt:</para>
3294 <para>0.05 (default_manager = swiss)</para>
3298 <para>0.01 (default_manager = german)</para>
3302 <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
3303 </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
3305 <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
3306 und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet, wenn
3307 dieser nicht der eingestellten Genauigkeit entspricht.</para>
3309 <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
3310 automatisch auf die in der Mandantenkonfiguration festgelegten
3311 Standardkonten für Rundungserträge bzw. Rundungsaufwendungen
3314 <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr
3317 <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
3318 <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
3319 <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
3321 <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege in
3322 anderen Währungen als der Standardwährung erstellt, so muss in kivitendo
3323 ab Version 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
3325 <para>Das heisst, Firmen in der Schweiz, die teilweise
3326 Verkaufsrechnungen in Euro oder anderen Währungen erstellen wollen,
3327 müssen beim Erstellen der Datenbank als Genauigkeit 0.01 wählen und
3328 können zur Zeit die 5er Rundung noch nicht nutzen.</para>
3331 <sect1 id="config.client">
3332 <title>Einstellungen pro Mandant</title>
3334 <para>Einige Einstellungen können von einem Benutzer mit dem <link
3335 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
3336 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
3337 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3338 Die Einstellungen sind unter <guimenu>System</guimenu> →
3339 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3341 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3342 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3343 geändert werden (siehe auch <link
3344 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3345 Bestandsmethode</link>).</para>
3347 <para>Die Einstellungen <literal>show_bestbefore</literal> und
3348 <literal>payments_changeable</literal> aus dem Abschnitt
3349 <literal>features</literal> und die Einstellungen im Abschnitt
3350 <literal>datev_check</literal> (sofern schon vorhanden) der <link
3351 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3352 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3353 Diese Einträge können danach aus der Konfigurationsdatei entfernt
3357 <sect1 id="kivitendo-ERP-verwenden">
3358 <title>kivitendo ERP verwenden</title>
3360 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3361 folgender URL erreichbar:</para>
3364 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3366 <para>Die Administrationsseite erreichen Sie unter:</para>
3369 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3373 <chapter id="features" xreflabel="Features und Funktionen">
3374 <title>Features und Funktionen</title>
3376 <sect1 id="features.periodic-invoices"
3377 xreflabel="Wiederkehrende Rechnungen">
3378 <title>Wiederkehrende Rechnungen</title>
3380 <sect2 id="features.periodic-invoices.introduction"
3381 xreflabel="Einführung in wiederkehrende Rechnungen">
3382 <title>Einführung</title>
3384 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3385 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3386 Die konfigurierten Aufträge werden später automatisch in Rechnungen
3387 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3388 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3389 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3390 wiederzufinden sind.</para>
3393 <sect2 id="features.periodic-invoices.configuration"
3394 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3395 <title>Konfiguration</title>
3397 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3398 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3399 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3400 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3401 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3404 <para>Folgende Parameter kann man konfigurieren:</para>
3411 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3412 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3413 eines neuen Monats).</para>
3415 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3416 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3417 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3418 nächsten Periodenwechsel für alle Perioden, seit der letzten
3419 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3420 verhindern, muss man vorher das Startdatum neu setzen.</para>
3422 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3423 erstellt. Man kann sich diese Aufträge aber gesondert in den
3424 Berichten anzeigen lassen.</para>
3429 <term>Periodizität</term>
3432 <para>Ob monatlich, quartalsweise oder jährlich auf neue
3433 Rechnungen überprüft werden soll. Für jede Periode seit dem
3434 Startdatum wird überprüft, ob für die Periode (beginnend immer
3435 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3436 wurde. Unter Umständen können bei einem Startdatum in der
3437 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3442 <term>Buchen auf</term>
3445 <para>Das Forderungskonto, in der Regel "Forderungen aus
3446 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3447 Buchungsgruppen der betreffenden Waren.</para>
3452 <term>Startdatum</term>
3455 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3461 <term>Enddatum</term>
3464 <para>ab wann keine Rechnungen mehr erstellt werden
3470 <term>Automatische Verlängerung um x Monate</term>
3473 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3474 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3475 hier die Anzahl der Monate eingeben, um die das Enddatum
3476 automatisch nach hinten geschoben wird.</para>
3481 <term>Drucken</term>
3484 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3485 Rechnungen auch gleich ausdrucken lassen.</para>
3490 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3491 Informationen zu den erstellten Rechnungen verschickt werden.
3492 Konfiguriert wird dies in der <link
3493 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3494 <filename>config/kivitendo.conf</filename> im Abschnitt
3495 <varname>[periodic_invoices]</varname>.</para>
3498 <sect2 id="features.periodic-invoices.variables">
3499 <title>Spezielle Variablen</title>
3501 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3502 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3503 formatierte Variablen durch für die jeweils aktuelle
3504 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3505 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3506 die Syntax <literal><%variablenname%></literal>.</para>
3508 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3509 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3510 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3511 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3512 Die zur verfügung stehenden Formatinformationen werden unten genauer
3515 <para>Diese Variablen können auch beim automatischen Versand der
3516 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3517 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3519 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3524 <para>Bemerkungen</para>
3528 <para>Interne Bemerkungen</para>
3532 <para>Vorgangsbezeichnung</para>
3536 <para>In den Beschreibungs- und Langtextfeldern aller
3541 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3545 <term><varname><%current_quarter%></varname>,
3546 <varname><%previous_quarter%></varname>,
3547 <varname><%next_quarter%></varname></term>
3550 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3551 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3556 <term><varname><%current_month%></varname>,
3557 <varname><%previous_month%></varname>,
3558 <varname><%next_month%></varname></term>
3561 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3562 <literal>1</literal> und <literal>12</literal>.</para>
3567 <term><varname><%current_month_long%></varname>,
3568 <varname><%previous_month_long%></varname>,
3569 <varname><%next_month_long%></varname></term>
3572 <para>Aktueller, vorheriger und nächster Monat als Name
3573 (<literal>Januar</literal>, <literal>Februar</literal>
3579 <term><varname><%current_year%></varname>,
3580 <varname><%previous_year%></varname>,
3581 <varname><%next_year%></varname></term>
3584 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3585 Jahreszahl (<literal>2013</literal> etc.).</para>
3590 <term><varname><%period_start_date%></varname>,
3591 <varname><%period_end_date%></varname></term>
3594 <para>Formatiertes Datum des ersten und letzten Tages im
3595 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3596 ersten Quartal von 2013 wären dies der
3597 <literal>01.01.2013</literal> und
3598 <literal>31.03.2013</literal>).</para>
3603 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3604 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3605 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3606 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3611 <term><varname>%a</varname></term>
3614 <para>Der abgekürzte Wochentagsname.</para>
3619 <term><varname>%A</varname></term>
3622 <para>Der ausgeschriebene Wochentagsname.</para>
3627 <term><varname>%b</varname></term>
3630 <para>Der abgekürzte Monatsname.</para>
3635 <term><varname>%B</varname></term>
3638 <para>Der ausgeschriebene Monatsname.</para>
3643 <term><varname>%C</varname></term>
3646 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3652 <term><varname>%d</varname></term>
3655 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3660 <term><varname>%D</varname></term>
3663 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3668 <term><varname>%e</varname></term>
3671 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3672 werden führende Nullen durch Leerzeichen ersetzt.</para>
3677 <term><varname>%F</varname></term>
3680 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3685 <term><varname>%j</varname></term>
3688 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3694 <term><varname>%m</varname></term>
3697 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3702 <term><varname>%u</varname></term>
3705 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3706 die 1 dem Montag entspricht.</para>
3711 <term><varname>%U</varname></term>
3714 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3715 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3721 <term><varname>%V</varname></term>
3724 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3725 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3726 vier Tage im Jahr liegen; Montag ist erster Tag der
3732 <term><varname>%w</varname></term>
3735 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3736 die 0 dem Sonntag entspricht.</para>
3741 <term><varname>%W</varname></term>
3744 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3745 wobei der erste Montag im Jahr das Startdatum von Woche 01
3751 <term><varname>%y</varname></term>
3754 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3760 <term><varname>%Y</varname></term>
3763 <para>Das Jahr als vierstellige Zahl.</para>
3768 <term><varname>%%</varname></term>
3771 <para>Das Prozentzeichen selber.</para>
3776 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3777 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3778 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3779 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3782 <sect2 id="features.periodic-invoices.reports">
3783 <title>Auflisten</title>
3785 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3786 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3787 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3788 wiederkehrenden Rechnungen verschaffen kann.</para>
3791 <sect2 id="features.periodic-invoices.task-server">
3792 <title>Erzeugung der eigentlichen Rechnungen</title>
3794 <para>Die zeitliche und periodische Überprüfung, ob eine
3795 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3796 durch den <link linkend="config.task-server">Taskserver</link>, einen
3797 externen Dienst, der automatisch beim Start des Servers gestartet
3798 werden sollte.</para>
3801 <sect2 id="features.periodic-invoices.create-for-current-month">
3802 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3804 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3805 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3806 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
3807 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3808 generiert hat. Alternativ setzt man das Startdatum auf den
3809 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3810 manuell über den Workflow.</para>
3814 <sect1 id="features.bank" xreflabel="bankerweiterung">
3815 <title>Bankerweiterung</title>
3817 <sect2 id="features.bank.introduction"
3818 xreflabel="Einführung in die Bankerweiterung">
3819 <title>Einführung</title>
3821 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3822 im Wiki und soll von dort später hierhin übernommen werden:</para>
3825 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3829 <sect1 id="dokumentenvorlagen-und-variablen">
3830 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3832 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3833 <title>Einführung</title>
3835 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3836 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3837 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3838 <function><%variablenname%></function> verwendet wird. Für
3839 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3841 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3843 <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3844 Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im Folgenden
3845 gesagte für alle Vorlagenarten.</para>
3847 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3848 verfügbar als hier aufgelistet werden. Die meisten davon können
3849 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3850 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3851 diese wie folgt erhalten werden:</para>
3855 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3856 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3860 <para>In <filename>Form.pm</filename> die Funktion
3861 <function>parse_template</function> suchen und hier die Zeile
3862 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3866 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3867 ein PDF für eine Rechnung erzeugen.</para>
3871 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3872 der Variablen <varname>$self</varname> in der Form <varname>'key'
3873 => 'value',</varname>. Alle <varname>key</varname>s sind
3879 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3880 <title>Variablen ausgeben</title>
3882 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3883 Tags geschrieben werden, also z.B.
3884 <varname><%variablenname%></varname>.</para>
3886 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3887 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3888 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
3889 werden die folgenden Flags unterstützt:</para>
3893 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3894 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3895 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3896 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3900 <para><option>NOESCAPE</option> unterdrückt das Escapen von
3901 Sonderzeichen für die Vorlagensprache. Wenn also in einer
3902 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
3903 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
3904 ist dieses Flag sinnvoll.</para>
3908 <para>Beispiel:</para>
3910 <programlisting><%quototal NOFORMAT%></programlisting>
3913 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
3914 <title>Verwendung in Druckbefehlen</title>
3916 <para>In der Admininstration können Drucker definiert werden. Auch im
3917 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
3918 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
3919 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
3920 <function>`...`</function> nicht zu unerwünschtem Verhalten
3923 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
3924 für das die Telefonnummer eines Ansprechpartners als Teil der
3925 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
3926 z.B. wie folgt aussehen:</para>
3928 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
3931 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
3932 xreflabel="Anfang und Ende der Tags verändern">
3933 <title>Anfang und Ende der Tags verändern</title>
3935 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
3936 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
3937 Prozentzeichen und dem Größerzeichen endet, beispielsweise
3938 <function><%customer%></function>. Da diese Form aber z.B. in
3939 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
3940 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
3941 Stil umgestellt werden.</para>
3943 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
3944 Format gültigen Kommentarzeichen anfangen, dann
3945 <function>config:</function> enthalten, die entsprechende Option
3946 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
3947 enden. Beispiel für LaTeX:</para>
3949 <programlisting>% config: tag-style=($ $)</programlisting>
3951 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
3952 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
3953 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
3955 <programlisting><!-- config: tag-style=($ $) --></programlisting>
3958 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
3959 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
3961 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
3962 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
3963 "<filename>.ext</filename>" geeignet zu ersetzen:
3964 "<filename>.tex</filename>" für LaTeX-Vorlagen und
3965 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
3969 <term><filename>bin_list.ext</filename></term>
3972 <para>Lagerliste</para>
3977 <term><filename>check.ext</filename></term>
3985 <term><filename>invoice.ext</filename></term>
3988 <para>Rechnung</para>
3993 <term><filename>packing_list.ext</filename></term>
3996 <para>Packliste</para>
4001 <term><filename>pick_list.ext</filename></term>
4004 <para>Sammelliste</para>
4009 <term><filename>purchase_delivery_order.ext</filename></term>
4012 <para>Lieferschein (Einkauf)</para>
4017 <term><filename>purcharse_order.ext</filename></term>
4020 <para>Bestellung an Lieferanten</para>
4025 <term><filename>request_quotation.ext</filename></term>
4028 <para>Anfrage an Lieferanten</para>
4033 <term><filename>sales_delivery_order.ext</filename></term>
4036 <para>Lieferschein (Verkauf)</para>
4041 <term><filename>sales_order.ext</filename></term>
4044 <para>Bestellung</para>
4049 <term><filename>sales_quotation.ext</filename></term>
4052 <para>Angebot an Kunden</para>
4057 <term><filename>zahlungserinnerung.ext</filename></term>
4060 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
4065 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
4068 <para>Rechnung über Mahngebühren (Dateiname im Programm
4069 konfigurierbar)</para>
4075 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
4076 <title>Sprache, Drucker und E-Mail</title>
4078 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
4079 eingearbeitet. So wird aus der Vorlage
4080 <filename>sales_order.ext</filename> bei Sprache
4081 <function>de</function> und Druckerkürzel <function>lpr2</function>
4082 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
4083 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
4084 bekommen dann noch das Kürzel <filename>_email</filename>, der
4085 vollständige Vorlagenname wäre dann
4086 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
4087 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
4088 werden. Diese wird verwendet, wenn keine der anderen Varianten
4089 gefunden wird.</para>
4091 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
4092 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
4093 verschickt wird, ist:</para>
4097 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
4101 <para><filename>sales_order_de_lpr2.tex</filename></para>
4105 <para><filename>sales_order.tex</filename></para>
4109 <para><filename>default.tex</filename></para>
4113 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
4114 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
4116 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
4119 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
4120 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
4123 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
4124 xreflabel="Metainformationen zur angeforderten Vorlage">
4125 <title>Metainformationen zur angeforderten Vorlage</title>
4127 <para>Diese Variablen liefern Informationen darüber welche Variante
4128 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
4129 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
4130 Formulare einbinden möchten.</para>
4134 <term><varname>template_meta.formname</varname></term>
4137 <para>Basisname der Vorlage. Identisch mit der <link
4138 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
4139 zu den Dateinamen</link> ohne die Erweiterung. Ein
4140 Verkaufsauftrag enthält hier
4141 <constant>sales_order</constant>.</para>
4146 <term><varname>template_meta.language.description</varname></term>
4149 <para>Beschreibung der verwendeten Sprache</para>
4154 <term><varname>template_meta.language.template_code</varname></term>
4157 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
4158 dem Kürzel das im Dateinamen verwendetet wird.</para>
4163 <term><varname>template_meta.language.output_numberformat</varname></term>
4166 <para>Zahlenformat der verwendeten Sprache in der Form
4167 "<constant>1.000,00</constant>". Experimentell! Nur
4168 interessant für Vorlagen die mit unformatierten Werten
4174 <term><varname>template_meta.language.output_dateformat</varname></term>
4177 <para>Datumsformat der verwendeten Sprache in der Form
4178 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
4179 interessant für Vorlagen die mit unformatierten Werten
4185 <term><varname>template_meta.format</varname></term>
4188 <para>Das angeforderte Format. Kann im Moment die Werte
4189 <constant>pdf</constant>, <constant>postscript</constant>,
4190 <constant>html</constant>, <constant>opendocument</constant>,
4191 <constant>opendocument_pdf</constant> und
4192 <constant>excel</constant> enthalten.</para>
4197 <term><varname>template_meta.extension</varname></term>
4200 <para>Dateierweiterung, wie im Dateinamen. Wird aus
4201 <constant>format</constant> entschieden.</para>
4206 <term><varname>template_meta.media</varname></term>
4209 <para>Ausgabemedium. Kann zur Zeit die Werte
4210 <constant>screen</constant> für Bildschirm,
4211 <constant>email</constant> für E-Mail (triggert das
4212 <constant>_email</constant> Kürzel im Dateinamen),
4213 <constant>printer</constant> für Drucker, und
4214 <constant>queue</constant> für Warteschlange enthalten.</para>
4219 <term><varname>template_meta.printer.description</varname></term>
4222 <para>Beschreibung des ausgewählten Druckers</para>
4227 <term><varname>template_meta.printer.template_code</varname></term>
4230 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
4231 dem Kürzel das im Dateinamen verwendetet wird.</para>
4236 <term><varname>template_meta.tmpfile</varname></term>
4239 <para>Datei-Prefix für temporäre Dateien.</para>
4245 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
4246 <title>Stammdaten von Kunden und Lieferanten</title>
4250 <term><varname>account_number</varname></term>
4253 <para>Kontonummer</para>
4258 <term><varname>bank</varname></term>
4261 <para>Name der Bank</para>
4266 <term><varname>bank_code</varname></term>
4269 <para>Bankleitzahl</para>
4274 <term><varname>bic</varname></term>
4277 <para>Bank-Identifikations-Code (Bank Identifier Code,
4283 <term><varname>business</varname></term>
4286 <para>Kunden-/Lieferantentyp</para>
4291 <term><varname>city</varname></term>
4299 <term><varname>contact</varname></term>
4302 <para>Kontakt</para>
4307 <term><varname>country</varname></term>
4315 <term><varname>c_vendor_id</varname></term>
4318 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
4323 <term><varname>v_customer_id</varname></term>
4326 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
4331 <term><varname>cp_email</varname></term>
4334 <para>Email des Ansprechpartners</para>
4339 <term><varname>cp_givenname</varname></term>
4342 <para>Vorname des Ansprechpartners</para>
4347 <term><varname>cp_greeting</varname></term>
4350 <para>Anrede des Ansprechpartners</para>
4355 <term><varname>cp_name</varname></term>
4358 <para>Name des Ansprechpartners</para>
4363 <term><varname>cp_phone1</varname></term>
4366 <para>Telefonnummer 1 des Ansprechpartners</para>
4371 <term><varname>cp_phone2</varname></term>
4374 <para>Telefonnummer 2 des Ansprechpartners</para>
4379 <term><varname>cp_title</varname></term>
4382 <para>Titel des Ansprechpartners</para>
4387 <term><varname>creditlimit</varname></term>
4390 <para>Kreditlimit</para>
4395 <term><varname>customeremail</varname></term>
4398 <para>Email des Kunden; nur für Kunden</para>
4403 <term><varname>customerfax</varname></term>
4406 <para>Faxnummer des Kunden; nur für Kunden</para>
4411 <term><varname>customernotes</varname></term>
4414 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4419 <term><varname>customernumber</varname></term>
4422 <para>Kundennummer; nur für Kunden</para>
4427 <term><varname>customerphone</varname></term>
4430 <para>Telefonnummer des Kunden; nur für Kunden</para>
4435 <term><varname>discount</varname></term>
4443 <term><varname>email</varname></term>
4446 <para>Emailadresse</para>
4451 <term><varname>fax</varname></term>
4454 <para>Faxnummer</para>
4459 <term><varname>gln</varname></term>
4462 <para>GLN (Globale Lokationsnummer)</para>
4467 <term><varname>greeting</varname></term>
4475 <term><varname>homepage</varname></term>
4478 <para>Homepage</para>
4483 <term><varname>iban</varname></term>
4486 <para>Internationale Kontonummer (International Bank Account
4487 Number, IBAN)</para>
4492 <term><varname>language</varname></term>
4495 <para>Sprache</para>
4500 <term><varname>name</varname></term>
4503 <para>Firmenname</para>
4508 <term><varname>payment_description</varname></term>
4511 <para>Name der Zahlart</para>
4516 <term><varname>payment_terms</varname></term>
4519 <para>Zahlungskonditionen</para>
4524 <term><varname>phone</varname></term>
4527 <para>Telefonnummer</para>
4532 <term><varname>shiptocity</varname></term>
4535 <para>Stadt (Lieferadresse) <link
4536 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4541 <term><varname>shiptocontact</varname></term>
4544 <para>Kontakt (Lieferadresse) <link
4545 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4550 <term><varname>shiptocountry</varname></term>
4553 <para>Land (Lieferadresse) <link
4554 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4559 <term><varname>shiptodepartment_1</varname></term>
4562 <para>Abteilung 1 (Lieferadresse) <link
4563 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4568 <term><varname>shiptodepartment_2</varname></term>
4571 <para>Abteilung 2 (Lieferadresse) <link
4572 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4577 <term><varname>shiptoemail</varname></term>
4580 <para>Email (Lieferadresse) <link
4581 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4586 <term><varname>shiptofax</varname></term>
4589 <para>Fax (Lieferadresse) <link
4590 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4595 <term><varname>shiptogln</varname></term>
4598 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4599 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4604 <term><varname>shiptoname</varname></term>
4607 <para>Firmenname (Lieferadresse) <link
4608 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4613 <term><varname>shiptophone</varname></term>
4616 <para>Telefonnummer (Lieferadresse) <link
4617 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4622 <term><varname>shiptostreet</varname></term>
4625 <para>Straße und Hausnummer (Lieferadresse) <link
4626 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4631 <term><varname>shiptozipcode</varname></term>
4634 <para>Postleitzahl (Lieferadresse) <link
4635 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4640 <term><varname>street</varname></term>
4643 <para>Straße und Hausnummer</para>
4648 <term><varname>taxnumber</varname></term>
4651 <para>Steuernummer</para>
4656 <term><varname>ustid</varname></term>
4659 <para>Umsatzsteuer-Identifikationsnummer</para>
4664 <term><varname>vendoremail</varname></term>
4667 <para>Email des Lieferanten; nur für Lieferanten</para>
4672 <term><varname>vendorfax</varname></term>
4675 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4680 <term><varname>vendornotes</varname></term>
4683 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4688 <term><varname>vendornumber</varname></term>
4691 <para>Lieferantennummer; nur für Lieferanten</para>
4696 <term><varname>vendorphone</varname></term>
4699 <para>Telefonnummer des Lieferanten; nur für
4705 <term><varname>zipcode</varname></term>
4708 <para>Postleitzahl</para>
4713 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4714 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4715 Stammdaten nicht eingetragen, so haben die Variablen
4716 <varname>shipto*</varname> den gleichen Wert wie die die
4717 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4718 einige <varname>shipto*</varname>-Variablen so nicht in den
4719 Stammdaten wiederfinden sondern schlicht Kopien der
4720 Lieferdatenvariablen sind (z.B.
4721 <varname>shiptocontact</varname>).</para>
4725 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4726 <title>Informationen über den Bearbeiter</title>
4730 <term><varname>employee_address</varname></term>
4733 <para>Adressfeld</para>
4738 <term><varname>employee_businessnumber</varname></term>
4741 <para>Firmennummer</para>
4746 <term><varname>employee_company</varname></term>
4749 <para>Firmenname</para>
4754 <term><varname>employee_co_ustid</varname></term>
4757 <para>Usatzsteuer-Identifikationsnummer</para>
4762 <term><varname>employee_duns</varname></term>
4765 <para>DUNS-Nummer</para>
4770 <term><varname>employee_email</varname></term>
4778 <term><varname>employee_fax</varname></term>
4786 <term><varname>employee_name</varname></term>
4789 <para>voller Name</para>
4794 <term><varname>employee_signature</varname></term>
4797 <para>Signatur</para>
4802 <term><varname>employee_taxnumber</varname></term>
4805 <para>Steuernummer</para>
4810 <term><varname>employee_tel</varname></term>
4813 <para>Telefonnummer</para>
4819 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4820 <title>Informationen über den Verkäufer</title>
4824 <term><varname>salesman_address</varname></term>
4827 <para>Adressfeld</para>
4832 <term><varname>salesman_businessnumber</varname></term>
4835 <para>Firmennummer</para>
4840 <term><varname>salesman_company</varname></term>
4843 <para>Firmenname</para>
4848 <term><varname>salesman_co_ustid</varname></term>
4851 <para>Usatzsteuer-Identifikationsnummer</para>
4856 <term><varname>salesman_duns</varname></term>
4859 <para>DUNS-Nummer</para>
4864 <term><varname>salesman_email</varname></term>
4872 <term><varname>salesman_fax</varname></term>
4880 <term><varname>salesman_name</varname></term>
4883 <para>voller Name</para>
4888 <term><varname>salesman_signature</varname></term>
4891 <para>Signatur</para>
4896 <term><varname>salesman_taxnumber</varname></term>
4899 <para>Steuernummer</para>
4904 <term><varname>salesman_tel</varname></term>
4907 <para>Telefonnummer</para>
4913 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
4914 <title>Variablen für die einzelnen Steuern</title>
4918 <term><varname>tax</varname></term>
4926 <term><varname>taxbase</varname></term>
4929 <para>zu versteuernder Betrag</para>
4934 <term><varname>taxdescription</varname></term>
4937 <para>Name der Steuer</para>
4942 <term><varname>taxrate</varname></term>
4945 <para>Steuersatz</para>
4951 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
4952 <title>Variablen für Lieferbedingungen</title>
4956 <term><varname>delivery_term</varname></term>
4959 <para>Datenbank-Objekt der Lieferbedingung</para>
4964 <term><varname>delivery_term.description</varname></term>
4967 <para>Beschreibung der Lieferbedingung</para>
4972 <term><varname>delivery_term.description_long</varname></term>
4975 <para>Langtext bzw. übersetzter Langtext der
4976 Lieferbedingung</para>
4983 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
4984 <title>Variablen in Rechnungen</title>
4986 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
4987 <title>Allgemeine Variablen</title>
4991 <term><varname>creditremaining</varname></term>
4994 <para>Verbleibender Kredit</para>
4999 <term><varname>currency</varname></term>
5002 <para>Währung</para>
5007 <term><varname>cusordnumber</varname></term>
5010 <para>Bestellnummer beim Kunden</para>
5015 <term><varname>deliverydate</varname></term>
5018 <para>Lieferdatum</para>
5023 <term><varname>duedate</varname></term>
5026 <para>Fälligkeitsdatum</para>
5031 <term><varname>globalprojectnumber</varname></term>
5034 <para>Projektnummer des ganzen Beleges</para>
5039 <term><varname>globalprojectdescription</varname></term>
5042 <para>Projekbeschreibung des ganzen Beleges</para>
5047 <term><varname>intnotes</varname></term>
5050 <para>Interne Bemerkungen</para>
5055 <term><varname>invdate</varname></term>
5058 <para>Rechnungsdatum</para>
5063 <term><varname>invnumber</varname></term>
5066 <para>Rechnungsnummer</para>
5071 <term><varname>invtotal</varname></term>
5074 <para>gesamter Rechnungsbetrag</para>
5079 <term><varname>notes</varname></term>
5082 <para>Bemerkungen der Rechnung</para>
5087 <term><varname>orddate</varname></term>
5090 <para>Auftragsdatum</para>
5095 <term><varname>ordnumber</varname></term>
5098 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
5099 erstellt wurde</para>
5104 <term><varname>payment_description</varname></term>
5107 <para>Name der Zahlart</para>
5112 <term><varname>payment_terms</varname></term>
5115 <para>Zahlungskonditionen</para>
5120 <term><varname>quodate</varname></term>
5123 <para>Angebotsdatum</para>
5128 <term><varname>quonumber</varname></term>
5131 <para>Angebotsnummer</para>
5136 <term><varname>rounding</varname></term>
5139 <para>Betrag, um den <varname>invtotal</varname> gerundet
5140 wurde (kann positiv oder negativ sein)</para>
5145 <term><varname>shippingpoint</varname></term>
5148 <para>Versandort</para>
5153 <term><varname>shipvia</varname></term>
5156 <para>Transportmittel</para>
5161 <term><varname>subtotal</varname></term>
5164 <para>Zwischensumme aller Posten ohne Steuern</para>
5169 <term><varname>total</varname></term>
5172 <para>Restsumme der Rechnung (Summe abzüglich bereits
5173 bezahlter Posten)</para>
5178 <term><varname>transaction_description</varname></term>
5181 <para>Vorgangsbezeichnung</para>
5186 <term><varname>transdate</varname></term>
5189 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
5190 erstellt wurde</para>
5196 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
5197 <title>Variablen für jeden Posten auf der Rechnung</title>
5201 <term><varname>bin</varname></term>
5204 <para>Stellage</para>
5209 <term><varname>description</varname></term>
5212 <para>Artikelbeschreibung</para>
5217 <term><varname>cusordnumber_oe</varname></term>
5220 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
5221 Posten ursprünglich stammt (nur Verkauf)</para>
5226 <term><varname>discount</varname></term>
5229 <para>Rabatt als Betrag</para>
5234 <term><varname>discount_sub</varname></term>
5237 <para>Zwischensumme mit Rabatt</para>
5242 <term><varname>donumber_do</varname></term>
5245 <para>Lieferscheinnummer des Lieferscheins, aus dem die
5246 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
5247 Workflows aus einem Lieferschein erstellt wurde.</para>
5252 <term><varname>drawing</varname></term>
5255 <para>Zeichnung</para>
5260 <term><varname>ean</varname></term>
5263 <para>EAN-Code</para>
5268 <term><varname>image</varname></term>
5276 <term><varname>linetotal</varname></term>
5279 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
5284 <term><varname>longdescription</varname></term>
5287 <para>Langtext</para>
5292 <term><varname>microfiche</varname></term>
5295 <para>Mikrofilm</para>
5300 <term><varname>netprice</varname></term>
5303 <para>Alternative zu <varname>sellprice</varname>, aber
5304 <varname>netprice</varname> entspricht dem effektiven
5305 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
5306 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
5307 / Menge. Diese Variable ist nützlich, wenn man den gewährten
5308 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
5309 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
5310 <varname>netprice</varname> hat nichts mit Netto/Brutto im
5311 Sinne von Steuern zu tun.</para>
5316 <term><varname>nodiscount_linetotal</varname></term>
5319 <para>Zeilensumme ohne Rabatt</para>
5324 <term><varname>nodiscount_sub</varname></term>
5327 <para>Zwischensumme ohne Rabatt</para>
5332 <term><varname>number</varname></term>
5335 <para>Artikelnummer</para>
5340 <term><varname>ordnumber_oe</varname></term>
5343 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5344 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5345 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5346 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5347 letzterem Fall wird die unsprüngliche Auftragsnummer
5353 <term><varname>p_discount</varname></term>
5356 <para>Rabatt in Prozent</para>
5361 <term><varname>partnotes</varname></term>
5364 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5369 <term><varname>partsgroup</varname></term>
5372 <para>Warengruppe</para>
5377 <term><varname>price_factor</varname></term>
5380 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5386 <term><varname>price_factor_name</varname></term>
5389 <para>Der Name des Preisfaktors, sofern einer eingestellt
5395 <term><varname>projectnumber</varname></term>
5398 <para>Projektnummer</para>
5403 <term><varname>projectdescription</varname></term>
5406 <para>Projektbeschreibung</para>
5411 <term><varname>qty</varname></term>
5419 <term><varname>reqdate</varname></term>
5422 <para>Lieferdatum</para>
5427 <term><varname>runningnumber</varname></term>
5430 <para>Position auf der Rechnung (1, 2, 3...)</para>
5435 <term><varname>sellprice</varname></term>
5438 <para>Verkaufspreis</para>
5443 <term><varname>serialnumber</varname></term>
5446 <para>Seriennummer</para>
5451 <term><varname>tax_rate</varname></term>
5454 <para>Steuersatz</para>
5459 <term><varname>transdate_do</varname></term>
5462 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5463 Workflows aus einem Lieferschein stammte.</para>
5468 <term><varname>transdate_oe</varname></term>
5471 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5472 Workflows aus einem Auftrag erstellt wurde. Wenn es
5473 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5479 <term><varname>transdate_quo</varname></term>
5482 <para>Datum des Angebots, wenn die Position im Rahmen des
5483 Workflows aus einem Angebot stammte.</para>
5488 <term><varname>unit</varname></term>
5491 <para>Einheit</para>
5496 <term><varname>weight</varname></term>
5499 <para>Gewicht</para>
5504 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5505 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5506 einer <function>foreach</function>-Schleife ausgegeben werden, da
5507 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5508 können. Die Variablen dafür lauten:</para>
5512 <term><varname>make</varname></term>
5515 <para>Lieferant</para>
5520 <term><varname>model</varname></term>
5523 <para>Lieferantenartikelnummer</para>
5529 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5530 <title>Variablen für die einzelnen Zahlungseingänge</title>
5534 <term><varname>payment</varname></term>
5542 <term><varname>paymentaccount</varname></term>
5550 <term><varname>paymentdate</varname></term>
5558 <term><varname>paymentmemo</varname></term>
5566 <term><varname>paymentsource</varname></term>
5575 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5576 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5578 <para>Die vom Benutzer definierten Variablen für Kunden und
5579 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5580 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5581 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5582 Variablennamen zusammen.</para>
5584 <para>Beispiel: Der Benutzer hat eine Variable namens
5585 <varname>number_of_employees</varname> definiert, die die Anzahl der
5586 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5587 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5590 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5591 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5592 Präfix <varname>shiptocvar_</varname>.</para>
5594 <para>Analog stehen die benutzerdefinierten Variablen für
5595 Ansprechpersonen mit dem Namenspräfix <varname>cp_cvar_</varname>
5596 zur Verfügung.</para>
5600 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5601 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5603 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5604 <title>Namen der Vorlagen</title>
5606 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5607 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5608 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5609 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5610 Vorlagenname für diese Mahnstufe mit dem Zusatz
5611 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5612 für die ausgewählte Sprache und den ausgewählten Drucker
5616 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5617 <title>Allgemeine Variablen in Mahnungen</title>
5619 <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie
5620 gewohnt als <varname>employee_...</varname> bzw.
5621 <varname>salesman_...</varname> zur Verfügung. Werden mehrere
5622 Rechnungen in einer Mahnung zusammengefasst, so werden die Metadaten
5623 (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung im
5624 Ausdruck genommen.</para>
5626 <para>Die Adressdaten des Kunden stehen als Variablen
5627 <varname>name</varname>, <varname>street</varname>,
5628 <varname>zipcode</varname>, <varname>city</varname>,
5629 <varname>country</varname>, <varname>department_1</varname>,
5630 <varname>department_2</varname>, und <varname>email</varname> zur
5631 Verfügung. Der Ansprechpartner <varname>cp_...</varname> steht auch
5632 zu Verfügung, wird allerdings auch nur von der ersten angemahnten
5633 Rechnung (s.o.) genommen.</para>
5635 <para>Weitere Variablen beinhalten:</para>
5639 <term><varname>dunning_date</varname></term>
5642 <para>Datum der Mahnung</para>
5647 <term><varname>dunning_duedate</varname></term>
5650 <para>Fälligkeitsdatum für diese Mahhnung</para>
5655 <term><varname>dunning_id</varname></term>
5658 <para>Mahnungsnummer</para>
5663 <term><varname>fee</varname></term>
5666 <para>Kumulative Mahngebühren</para>
5671 <term><varname>interest_rate</varname></term>
5674 <para>Zinssatz per anno in Prozent</para>
5679 <term><varname>total_amount</varname></term>
5682 <para>Gesamter noch zu zahlender Betrag als
5683 <function>fee</function> + <function>total_interest</function>
5684 + <function>total_open_amount</function></para>
5689 <term><varname>total_interest</varname></term>
5692 <para>Zinsen per anno über alle Rechnungen</para>
5697 <term><varname>total_open_amount</varname></term>
5700 <para>Summe über alle offene Beträge der Rechnungen</para>
5706 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5707 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5711 <term><varname>dn_amount</varname></term>
5714 <para>Rechnungssumme (brutto)</para>
5719 <term><varname>dn_duedate</varname></term>
5722 <para>Originales Fälligkeitsdatum der Rechnung</para>
5727 <term><varname>dn_dunning_date</varname></term>
5730 <para>Datum der Mahnung</para>
5735 <term><varname>dn_dunning_duedate</varname></term>
5738 <para>Fälligkeitsdatum der Mahnung</para>
5743 <term><varname>dn_fee</varname></term>
5746 <para>Kummulative Mahngebühr</para>
5751 <term><varname>dn_interest</varname></term>
5754 <para>Zinsen per anno für diese Rechnung</para>
5759 <term><varname>dn_invnumber</varname></term>
5762 <para>Rechnungsnummer</para>
5767 <term><varname>dn_linetotal</varname></term>
5770 <para>Noch zu zahlender Betrag (ergibt sich aus
5771 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5772 + <varname>dn_interest</varname>)</para>
5777 <term><varname>dn_netamount</varname></term>
5780 <para>Rechnungssumme (netto)</para>
5785 <term><varname>dn_open_amount</varname></term>
5788 <para>Offener Rechnungsbetrag</para>
5793 <term><varname>dn_ordnumber</varname></term>
5796 <para>Bestellnummer</para>
5801 <term><varname>dn_transdate</varname></term>
5804 <para>Rechnungsdatum</para>
5809 <term><varname>dn_curr</varname></term>
5812 <para>Währung, in der die Rechnung erstellt wurde. (Die
5813 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5819 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5820 <title>Variablen in automatisch erzeugten Rechnungen über
5821 Mahngebühren</title>
5823 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5824 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5825 Kunden stehen als Variablen <varname>name</varname>,
5826 <varname>street</varname>, <varname>zipcode</varname>,
5827 <varname>city</varname>, <varname>country</varname>,
5828 <varname>department_1</varname>, <varname>department_2</varname>,
5829 und <varname>email</varname> zur Verfügung.</para>
5831 <para>Weitere Variablen beinhalten:</para>
5835 <term><varname>duedate</varname></term>
5838 <para>Fälligkeitsdatum der Rechnung</para>
5843 <term><varname>dunning_id</varname></term>
5846 <para>Mahnungsnummer</para>
5851 <term><varname>fee</varname></term>
5854 <para>Mahngebühren</para>
5859 <term><varname>interest</varname></term>
5867 <term><varname>invamount</varname></term>
5870 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
5871 <varname>interest</varname>)</para>
5876 <term><varname>invdate</varname></term>
5879 <para>Rechnungsdatum</para>
5884 <term><varname>invnumber</varname></term>
5887 <para>Rechnungsnummer</para>
5894 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
5895 <title>Variablen in anderen Vorlagen</title>
5898 <title>Einführung</title>
5900 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
5901 Rechnung. Allerdings heißen die Variablen, die mit
5902 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
5903 fangen sie mit <varname>quo</varname> für "quotation" an:
5904 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
5905 wiederum fangen sie mit <varname>ord</varname> für "order" an:
5906 <varname>ordnumber</varname> für Bestellnummer etc.</para>
5908 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
5909 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
5910 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
5911 Vorlage keine Bedeutung haben oder noch nicht belegt sein
5914 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
5915 in Rechnungen aufgeführt.</para>
5918 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
5919 <title>Angebote und Preisanfragen</title>
5923 <term><varname>quonumber</varname></term>
5926 <para>Angebots- bzw. Anfragenummer</para>
5931 <term><varname>reqdate</varname></term>
5934 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
5935 Preisanfragen)</para>
5940 <term><varname>transdate</varname></term>
5943 <para>Angebots- bzw. Anfragedatum</para>
5949 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
5950 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
5954 <term><varname>ordnumber</varname></term>
5957 <para>Auftragsnummer</para>
5962 <term><varname>reqdate</varname></term>
5965 <para>Lieferdatum</para>
5970 <term><varname>transdate</varname></term>
5973 <para>Auftragsdatum</para>
5979 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
5980 <title>Lieferscheine (Verkauf und Einkauf)</title>
5984 <term><varname>cusordnumber</varname></term>
5987 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
5988 des Lieferanten (im Einkauf)</para>
5993 <term><varname>donumber</varname></term>
5996 <para>Lieferscheinnummer</para>
6001 <term><varname>transdate</varname></term>
6004 <para>Lieferscheindatum</para>
6009 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
6010 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
6011 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
6012 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
6013 <function>foreach</function>-Schleife ausgegeben werden. Diese
6014 Variablen sind:</para>
6018 <term><varname>si_bin</varname></term>
6021 <para>Lagerplatz</para>
6026 <term><varname>si_chargenumber</varname></term>
6029 <para>Chargennummer</para>
6034 <term><varname>si_bestbefore</varname></term>
6037 <para>Mindesthaltbarkeit</para>
6042 <term><varname>si_number</varname></term>
6045 <para>Artikelnummer</para>
6050 <term><varname>si_qty</varname></term>
6053 <para>Anzahl bzw. Menge</para>
6058 <term><varname>si_runningnumber</varname></term>
6061 <para>Positionsnummer (1, 2, 3 etc)</para>
6066 <term><varname>si_unit</varname></term>
6069 <para>Einheit</para>
6074 <term><varname>si_warehouse</varname></term>
6083 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
6084 <title>Variablen für Sammelrechnung</title>
6088 <term><varname>c0total</varname></term>
6091 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
6097 <term><varname>c30total</varname></term>
6100 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
6101 und < 60 Tage</para>
6106 <term><varname>c60total</varname></term>
6109 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
6110 und < 90 Tage</para>
6115 <term><varname>c90total</varname></term>
6118 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
6124 <term><varname>total</varname></term>
6127 <para>Gesamtbetrag aller Rechnungen</para>
6132 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
6136 <term><varname>invnumber</varname></term>
6139 <para>Rechnungsnummer</para>
6144 <term><varname>invdate</varname></term>
6147 <para>Rechnungsdatum</para>
6152 <term><varname>duedate</varname></term>
6155 <para>Fälligkeitsdatum</para>
6160 <term><varname>amount</varname></term>
6163 <para>Summe der Rechnung</para>
6168 <term><varname>open</varname></term>
6171 <para>Noch offener Betrag der Rechnung</para>
6176 <term><varname>c0</varname></term>
6179 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
6185 <term><varname>c30</varname></term>
6188 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
6194 <term><varname>c60</varname></term>
6197 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
6203 <term><varname>c90</varname></term>
6206 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
6214 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
6215 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
6217 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
6218 <title>Einführung</title>
6220 <para>Der Parser kennt neben den Variablen einige weitere
6221 Konstrukte, die gesondert behandelt werden. Diese sind wie
6222 Variablennamen in spezieller Weise markiert:
6223 <command><%anweisung%> ... <%end%></command></para>
6225 <para>Anmerkung zum <command><%end%></command>: Der besseren
6226 Verständlichkeit halber kann man nach dem <command>end</command>
6227 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
6228 Anweisung (z.B. <command>if</command> oder
6229 <command>foreach</command>) damit abgeschlossen wird.</para>
6231 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
6232 <command><%if type == "sales_quotation"%></command>, so könnte
6233 er mit <command><%end%></command> genauso abgeschlossen werden
6234 wie mit <command><%end if%></command> oder auch
6235 <command><%end type == "sales_quotation"%></command>.</para>
6238 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
6239 <title>Der if-Block</title>
6241 <programlisting><%if variablenname%>
6243 <%end%></programlisting>
6245 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
6246 und dem "end" werden nur ausgegeben, wenn die Variable
6247 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
6249 <para>Handelt es sich bei der benannten Variable um ein Array, also
6250 um einen Variablennamen, über den man mit <command><%foreach
6251 variablenname%></command> iteriert, so wird mit diesem Konstrukt
6252 darauf getestet, ob das Array Elemente enthält. Somit würde im
6253 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
6254 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
6255 welche getätigt wurden:</para>
6257 <programlisting><%if payment%>
6259 <%foreach payment%>
6260 Am <%paymentdate%>: <%payment%> €
6261 <%end foreach%>
6262 <%end if%></programlisting>
6264 <para>Die Bedingung kann auch negiert werden, indem das Wort
6265 <function>not</function> nach dem <filename>if</filename> verwendet
6266 wird. Beispiel:</para>
6268 <programlisting><%if not cp_greeting%>
6270 <%end%></programlisting>
6272 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
6273 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
6274 einer Variablen mit einer festen Zeichenkette oder einer anderen
6275 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
6276 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
6277 die rechte Seite des Vergleichsoperators in Anführungszeichen
6278 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
6279 anderer Variablen). Zwei Beispiele, die beide Vergleiche
6282 <programlisting><%if var1 == "Wert"%></programlisting>
6284 <para>Testet die Variable <varname>var1</varname> auf
6285 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
6286 Mittels <function>!=</function> anstelle von <function>==</function>
6287 würde auf Ungleichheit getestet.</para>
6289 <programlisting><%if var1 == var2%></programlisting>
6291 <para>Testet die Variable <varname>var1</varname> auf
6292 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
6293 <function>!=</function> anstelle von <function>==</function> würde
6294 auf Ungleichheit getestet.</para>
6296 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
6297 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
6298 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
6299 dieselbe Syntax wie oben nur mit <function>=~</function> und
6300 <function>!~</function> als Vergleichsoperatoren.</para>
6302 <para>Beispiel für einen Test, ob die Variable
6303 <varname>intnotes</varname> (interne Bemerkungen) das Wort
6304 <constant>schwierig</constant> enthält:</para>
6306 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
6309 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
6310 <title>Der foreach-Block</title>
6312 <programlisting><%foreach variablenname%>
6314 <%end%></programlisting>
6316 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
6317 wie das Perl-Array der Variablen <varname>variablenname</varname>
6318 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
6319 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
6320 benutzt. In jedem Durchlauf werden die <link
6321 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
6322 Variablen</link> jeweils auf den Wert für die aktuelle Position
6325 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
6327 <programlisting><%foreach number%>
6328 Position: <%runningnumber%>
6329 Anzahl: <%qty%>
6330 Artikelnummer: <%number%>
6331 Beschreibung: <%description%>
6333 <%end%></programlisting>
6335 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
6336 <function><%foreach%></function>-Block innerhalb einer
6337 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
6338 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
6339 Inhalt zwischen <function><%foreach%></function> und
6340 <function><%end%></function> wiederholt, nicht aber die
6341 komplette Zeile, in der er steht.</para>
6345 <sect2 id="dokumentenvorlagen-und-variablen.markup">
6346 <title>Markup-Code zur Textformatierung innerhalb von
6349 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6350 anders formatiert haben möchte, so ist dies begrenzt möglich.
6351 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6352 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6353 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6354 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6355 (HTML oder PDF über LaTeX) umgesetzt.</para>
6357 <para>Die unterstützen Formatierungen sind:</para>
6361 <term><b>Text</b></term>
6364 <para>Text wird in Fettdruck gesetzt.</para>
6369 <term><i>Text</i></term>
6372 <para>Text wird kursiv gesetzt.</para>
6377 <term><u>Text</u></term>
6380 <para>Text wird unterstrichen.</para>
6385 <term><s>Text</s></term>
6388 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6389 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6394 <term><bullet></term>
6397 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6403 <para>Der Befehl <command><bullet></command> funktioniert
6404 momentan auch nur in Latex-Vorlagen.</para>
6408 <sect1 id="excel-templates">
6409 <title>Excel-Vorlagen</title>
6411 <sect2 id="excel-templates.summary">
6412 <title>Zusammenfassung</title>
6414 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6415 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6419 <sect2 id="excel-templates.usage">
6420 <title>Bedienung</title>
6422 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6423 werden. Die Konfigurationsoption heißt <varname>excel_templates =
6424 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6426 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6427 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6428 werden. In den normalen Verkaufsmasken taucht nun
6429 <constant>Excel</constant> als auswählbares Format auf und kann von da
6430 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6432 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6433 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6434 <filename>sales_quotation.xls</filename> gespeichert.</para>
6437 <sect2 id="excel-templates.syntax">
6438 <title>Variablensyntax</title>
6440 <para>Einfache Syntax:
6441 <command><<varname>></command></para>
6443 <para>Dabei sind <constant><<</constant> und
6444 <constant>>></constant> die Delimiter. Da Excel auf festen
6445 Breiten besteht, kann der Tag künstlich verlängert werden, indem
6446 weitere <constant><</constant> oder <constant>></constant>
6447 eingefügt werden. Der Tag muss nicht symmetrisch sein.
6450 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6452 <para>Um die Limitierung der festen Breite zu reduzieren, können
6453 weitere Variablen in einem Block interpoliert werden. Whitespace wird
6454 dazwishen dann erhalten. Beispiel:</para>
6456 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6458 <para>Die Variablen werden interpoliert, und linksbündig mit
6459 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6460 lang, werden überzählige Zeichen abgeschnitten.</para>
6462 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6463 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6465 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6467 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6468 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6472 <sect2 id="excel-templates.limitations">
6473 <title>Einschränkungen</title>
6475 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6476 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6477 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6478 Text zu ersetzen.</para>
6480 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6481 <command><%if%></command> und
6482 <command><%foreach%></command> nicht vorhanden. Der Delimiter
6483 <constant><% %></constant> kommt in den Headerinformationen
6484 evtl. vor. Deshalb wurde auf den sichereren Delimiter
6485 <constant><<</constant> und <constant>>></constant>
6490 <sect1 id="features.warehouse">
6491 <title>Mandantenkonfiguration Lager</title>
6493 <para>Die Lagerverwaltung in kivitendo funktioniert standardmässig wie
6494 folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6495 Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen
6496 durchzuführen. Ferner kann jede Position eines Lieferscheins ein-, bzw.
6497 ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele
6498 Lager mit beliebig vielen Lagerplätzen abgebildet werden. Die
6499 Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder
6500 Einzelposition und das Auswählen dieser Position zu einem Lager mit
6501 Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je
6502 nachdem wie die Einstellungen in der Mandatenkonfiguration gesetzt
6507 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6508 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6509 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6510 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6514 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6515 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6516 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6517 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6518 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6519 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6523 <para>Zusätzliche Funktionshinweise:</para>
6527 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6528 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6529 Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6533 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6534 Stammdaten definiert</option> Wird beim 'Auslagern über
6535 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6536 so wird mit dieser Option einfach der Standardlagerplatz
6542 <sect1 id="features.swiss-charts-of-accounts">
6543 <title>Schweizer Kontenpläne</title>
6545 <para>Seit der Version 3.5 stehen in kivitendo 3 Kontenpläne für den
6546 Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6547 Organisationen, die nicht mehrwertsteuerpflichtig sind, einer für
6548 Firmen, die mehrwertsteuerpflichtig sind und einer speziell für
6551 <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6552 verwendeten KMU-Kontenrahmen und sind mit der Revision des
6553 Schweizerischen Obligationenrechts (OR) vom 1.1.2013 kompatibel,
6554 insbesondere <literal>Art.957a Abs.2</literal>.</para>
6556 <para>Beim Vereinskontenplan sind standardmässig nur die Konten 1100
6557 (Debitoren CHF) und 1101 (Debitoren EUR) als Buchungskonten im Verkauf
6558 sowie die Konten 2000 (Kreditoren CHF) und 2001 (Kreditoren EUR) als
6559 Buchungskonten im Einkauf vorgesehen. Weitere Konten können bei Bedarf
6560 in den Konto-Detaileinstellungen als Einkaufs- oder Verkaufskonten
6561 konfiguriert werden.</para>
6563 <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der
6564 aktuellen Version von kivitendo noch nicht integriert.</para>
6566 <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6567 Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6568 Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen alle
6569 Aufwandskonten editiert werden und dort der Steuersatz auf 0% gesetzt
6572 <para>So werden bei Kreditorenbuchungen keine Vorsteuern
6575 <para>Bezugssteuern für aus dem Ausland bezogene Dienstleistungen müssen
6576 manuell verbucht werden.</para>
6578 <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6579 Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne bitte an
6580 <literal>empfang@revamp-it.ch</literal> senden.</para>
6583 <sect1 id="features.part_classification">
6584 <title>Artikelklassifizierung</title>
6587 <title>Übersicht</title>
6589 <para>Die Klassifizierung von Artikeln dient einer weiteren
6590 Gliederung, um zum Beispiel den Einkauf vom Verkauf zu trennen,
6591 gekennzeichnet durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel
6592 (z.B. "E"). Für jede Klassifizierung besteht eine Beschreibung und
6593 eine Abkürzung die normalerweise aus einem Zeichen besteht, kann aber
6594 auf mehrere Zeichen erweitert werden, falls zur Unterscheidung
6595 notwendig. Sinnvoll sind jedoch nur maximal 2 Zeichen.</para>
6599 <title>Basisklassifizierung</title>
6601 <para>Als Basisklassifizierungen gibt es</para>
6605 <para>Einkauf</para>
6609 <para>Verkauf</para>
6613 <para>Handelsware</para>
6617 <para>Produktion</para>
6621 <para>- keine - (diese wird bei einer Aktualisierung für alle
6622 existierenden Artikel verwendet und ist gültig für Verkauf und
6627 <para>Es können weitere Klassifizierungen angelegt werden. So kann es
6628 z.B. für separat auszuweisende Artikel folgende Klassen geben:</para>
6632 <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
6636 <para>Material (Verpackungsmaterial) mit Kürzel M</para>
6642 <title>Attribute</title>
6644 <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
6645 alle gleichzeitg gültig sein können</para>
6649 <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
6654 <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
6659 <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
6660 (LaTeX) eine zusätzliche Variable</para>
6664 <para>Für das Attribut "separat ausweisen" stehen in den
6665 LaTeX-Vorlagen die Variable <emphasis
6666 role="bold"><%non_separate_subtotal%> </emphasis>zur Verfügung,
6667 die alle nicht separat auszuweisenden Artikelkosten saldiert, sowie
6668 pro separat auszuweisenden Klassifizierungen die Variable<emphasis
6669 role="bold">< %separate_X_subtotal%></emphasis>, wobei X das
6670 Kürzel der Klassifizierung ist.</para>
6672 <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
6673 role="bold"><%separate_L_subtotal%></emphasis> und für
6674 Verpackungsmaterial <emphasis role="bold">
6675 <%separate_M_subtotal%></emphasis>.</para>
6679 <title>Zwei-Zeichen Abkürzung</title>
6681 <para>Der Typ des Artikels und die Klassifizierung werden durch zwei
6682 Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
6683 Artikel-Typs ('P','A','S'), deutsch 'W', 'E', und 'D' für Ware
6684 Erzeugnis oder Dienstleistung und ggf. weiterer Typen.</para>
6686 <para>Der zweite Buchstabe (und ggf. auch ein dritter, falls nötig)
6687 entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
6689 <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
6690 Erleichterung mit dargestellt.</para>
6694 <sect1 id="features.file_managment">
6695 <title>Dateiverwaltung (Mini-DMS)</title>
6698 <title>Übersicht</title>
6700 <para>Parallel zum alten WebDAV gibt es ein Datei-Management-System,
6701 das Dateien verschiedenen Typs verwaltet. Dies können</para>
6705 <para>aus ERP-Daten per LaTeX Template erzeugte
6706 PDF-Dokumente,</para>
6710 <para>zu bestimmten ERP-Daten gehörende Anhangdateien
6711 unterschiedlichen Formats,</para>
6715 <para>per Scanner eingelesene PDF-Dateien,</para>
6719 <para>per E-Mail empfangene Dateianhänge unterschiedlichen
6724 <para>sowie speziel für Artikel hochgeladene Bilder sein.</para>
6729 <screeninfo>Übersicht</screeninfo>
6733 <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
6740 <title>Struktur</title>
6742 <para>Über eine vom Speichermedium unabhängige Zwischenschicht werden
6743 die Dateien und ihre Versionen in der Datenbank verwaltet. Darunter
6744 können verschiedene Implementierungen (Backends) gleichzeitig
6749 <para>Dateisystem</para>
6757 <para>Schnittstelle zu externen
6758 Dokumenten-Management-Systemen</para>
6762 <para>andere Datenbank</para>
6766 <para>etc ...</para>
6770 <para>Es gibt unterschiedliche Typen von Dateien. Jedem Typ läßt sich
6771 in der Mandantenkonfiguration ein bestimmtes Backend zuordnen.</para>
6775 <para>"document": Das sind entweder generierte, eingescannte oder
6776 hochgeladene PDF-Dateien, die zu bestimmten ERP-Daten
6777 (ERP-Objekte, wie z.B. Rechnung, Lieferschein) gehören.</para>
6781 <para>"attachment": zusätzlich hochgeladene Dokumente, die an
6782 bestimmte ERP-Objekte angehängt werden, z.B. technische
6783 Zeichnungen, Aufmaße. Diese können auch für Artikel, Lieferanten
6784 und Kunden hinterlegt sein.</para>
6788 <para>"image": Bilder für Artikel. Diese können auch verkleinert
6789 in einer Vorschau (Thumbnail) angezeigt werden.</para>
6793 <para>Zusätzlich werden in der Datenbank zu den Dateien neben der
6794 Zuordnung zu ERP-Objekten, Dateityp Dateinamen und Backend, in dem die
6795 Datei gespeichert ist, auch die Quelle der Datei notiert:</para>
6799 <para>"created": vom System erzeugte Dokumente"</para>
6803 <para>"uploaded": hochgeladene Dokumente</para>
6807 <para>"email": vom Mail-System empfangene Dateien</para>
6811 <para>"scanner[1]": von einem oder mehreren Scannern erzeugte
6812 Dateien. Existieren mehrere Scanner, so sind diese durch
6813 unterschiedliche Quellennamen zu definieren.</para>
6817 <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es
6818 für "attachment" und "image" nur die Quelle "uploaded". Für "document"
6819 gibt es auf jeden Fall die Quelle "created". Die Quellen "scanner" und
6820 "email" müssen derzeit in der Datenbank konfiguriert werden (siehe
6821 <xref linkend="file_management.dbconfig"/>).</para>
6825 <title>Anwendung</title>
6827 <para>Die Daten werden bei den ERP-Objekten als extra Reiter
6828 dargestellt. Eine Verkaufsrechnung z.B. hat die Reiter "Dokumente" und
6829 "Dateianhänge".</para>
6832 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6836 <imagedata fileref="images/DMS-Anhaenge.png" scale="50"/>
6841 <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer
6842 Datei angezeigt. Wird eine Datei mit gleichem Namen hochgeladen, so
6843 wird eine neue Version der Datei erstellt. Vorher wird der Anwender
6844 durch einen Dialog gefragt, ob er eine neue Version anlegen will oder
6845 ob er die Datei umbenennen will, falls es eine neue Datei sein
6849 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6853 <imagedata contentwidth="40"
6854 fileref="images/DMS-Anhaenge-hochladen.png"
6860 <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
6861 solange in Summe die maximale Größe nicht überschritten wird (siehe
6862 <xref linkend="file_management.clientconfig"/>).</para>
6865 <screeninfo>Reiter "Dokumente"</screeninfo>
6869 <imagedata fileref="images/DMS-Dokumente.png" width="500"/>
6874 <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt
6875 es nur "erzeugte Dokumente". Es werden alle Versionen der generierten
6876 Datei angezeigt. Für Verkaufsrechnungen kommen keine anderen Quellen
6877 zur Geltung. Werden entsprechend der <xref
6878 linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert,
6879 so sind diese z.B. bei Einkaufsrechnungen sichtbar:</para>
6882 <screeninfo>Reiter "Dokumente"</screeninfo>
6886 <imagedata contentwidth="600"
6887 fileref="images/DMS-Dokumente-Scanner.png"/>
6892 <para>Statt des Löschens wird hier die Datei zurück zur Quelle
6893 verschoben. Somit kann die Datei anschließend an ein anderes
6894 ERP-Objekt angehängt werden.</para>
6896 <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie
6897 sind bisher nur bei Bildern relevant.</para>
6901 <title>Konfigurierung</title>
6903 <sect3 id="file_management.clientconfig"
6904 xreflabel="Mandantenkonfigurierung">
6905 <title>Mandantenkonfiguration</title>
6908 <title>Reiter "Features"</title>
6910 <para>Unter dem Reiter <emphasis role="bold">Features</emphasis>
6911 im Abschnitt Dateimanagement ist neben dem "alten" WebDAV das
6912 Dateimangement generell zu- und abschaltbar, sowie die Zuordnung
6913 der Dateitypen zu Backends. Die Löschbarkeit von Dateien, sowie
6914 die maximale Uploadgröße sind Backend-unabhängig</para>
6917 <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
6921 <imagedata fileref="images/DMS-ClientConfig.png" width="500"/>
6926 <para>Die einzelnen Backends sind einzeln einschaltbar.
6927 Spezifische Backend-Konfigurierungen sind hier noch
6932 <title>Reiter "Allgemeine Dokumentenanhänge"</title>
6934 <para>Unter dem Reiter <emphasis role="bold">Allgemeine
6935 Dokumentenanhänge</emphasis> kann für alle ERP-Dokumente (
6936 Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und
6937 Einkauf ) allgemeingültige Anhänge hochgeladen werden.</para>
6940 <screeninfo>Mandantenkonfig Reiter "Allgemeine
6941 Dokumentenanhänge"</screeninfo>
6945 <imagedata fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"
6951 <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die
6952 ERP-Dokumente angehängt, z.B. AGBs oder aktuelle Angebote. Es
6953 werden in dem Fall die Daten kopiert, sodass an den ERP-Dokumenten
6954 immer die Anhänge zum Generierungszeitpunkt eingebettet
6959 <sect3 id="file_management.dbconfig"
6960 xreflabel="Datenbank-Konfigurierung">
6961 <title>Datenbank-Konfigurierung</title>
6963 <para>Die zusätzlichen Quellen für "email" oder ein oder mehrere
6964 Scanner sind derzeit vom Administrator direkt in der
6965 Datenbanktabelle "user_preferences" einzurichten. Die "value" ist im
6966 JSON-Format mit den jeweiligen Werten des Verzeichnisses und der
6967 Beschreibung der Quelle.</para>
6970 id | login | namespace | version | key | value
6971 ----+-----------+--------------+---------+----------+---------------------------
6972 1 | #default# | file_sources | 0.00000 | scanner1 |
6973 {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
6974 2 | #default# | file_sources | 0.00000 | scanner2 |
6975 {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
6976 3 | #default# | file_sources | 0.00000 | emails |
6977 {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
6980 <para>Es ist daran gedacht, statt dem Default-Eintrag später für
6981 bestimmte Benutzer ('login') bestimmte Quellen zuzulassen. Dies wird
6982 nach Bedarf implementiert.</para>
6985 <sect3 id="file_management.kiviconfig"
6986 xreflabel="kivitendo-Konfigurationsdatei">
6987 <title>kivitendo-Konfigurationsdatei</title>
6989 <para>Dort ist im Abschnitt [paths] der relative oder absolute Pfad
6990 zum Dokumentenwurzelverzeichnis einzutragen. Dieser muss für den
6991 Webserver schreib- und lesbar sein, jedoch nicht ausführbar.</para>
6995 document_path = /var/local/kivi_documents
6998 <para>Unter diesem Wurzelverzeichnis wird pro Mandant automatisch
6999 ein Unterverzeichnis mit der ID des Mandanten angelegt.</para>
7005 <title>Webshop-Api</title>
7007 <para>Das Shopmodul bietet die Möglichkeit Onlineshopartikel und
7008 Onlineshopbestellungen zu verwalten und zu bearbeiten.</para>
7010 <para>Es ist Multishopfähig, d.h. Artikel können mehreren oder
7011 unterschiedlichen Shops zugeordnet werden. Bestellungen können aus
7012 mehreren Shops geholt werden.</para>
7014 <para>Zur Zeit bietet das Modul nur einen Connector zur REST-Api von
7015 Shopware. Weitere Connectoren können dazu programmiert und eingerichtet
7019 <title>Rechte für die Webshopapi</title>
7021 <para>In der Administration können folgende Rechte vergeben
7026 <para>Webshopartikel anlegen und bearbeiten</para>
7030 <para>Shopbestellungen holen und bearbeiten</para>
7034 <para>Shop anlegen und bearbeiten</para>
7040 <title>Konfiguration</title>
7042 <para>Unter System->Webshops können Shops angelegt und konfiguriert
7047 <imagedata contentdepth="500" contentwidth="700"
7048 fileref="images/Shop_Listing.png"/>
7054 <title>Webshopartikel</title>
7057 <title>Shopvariablenreiter in Artikelstammdaten</title>
7059 <para>Mit dem Recht "Shopartikel anlegen und bearbeiten" und des
7060 Markers <emphasis role="bold">"Shopartikel" in den Basisdaten
7061 </emphasis>zeigt sich der Reiter "Shopvariablen" in den
7062 Artikelstammdaten. Hier können jetzt die Artikel mit
7063 unterschiedlichen Beschreibung und/oder Preisen für die
7064 konfigutierten Shops angelegt und bearbeitet werden. An dieser
7065 Stelle können auch beliebig viele Bilder dem Shopartikel zugeordnet
7066 werden. Artikelbilder gelten für alle Shops.</para>
7070 <imagedata contentdepth="500" contentwidth="600"
7071 fileref="images/Shop_Artikel.png"/>
7075 <para>Die Artikelgruppen werden direkt vom Shopsystem geholt somit
7076 ist es möglich einen Artikel auch mehreren Gruppen
7081 <title>Shopartikelliste</title>
7083 <para>Unter dem Menu Webshop->Webshop Artikel hat man nochmal
7084 eine Gesamtübersicht. Von hier aus ist es möglich Artikel im Stapel
7085 unter verschiedenen Kriterien <alles><nur Preis><nur
7086 Bestand><Preis und Bestand> an die jeweiligen Shops
7091 <imagedata fileref="images/Shop_Artikel_Listing.png"/>
7098 <title>Bestellimport</title>
7100 <para>Unter dem Menupunkt Webshop->Webshop Import öffnet sich die
7101 Bestellimportsliste. Hier ist sind Möglichkeiten gegeben Neue
7102 Bestellungen vom Shop abzuholen, geholte Bestellungen im Stapel oder
7103 einzeln als Auftrag zu transferieren. Die Liste kann nach
7104 verschiedenen Kriterien gefiltert werden.</para>
7108 <imagedata fileref="images/Shop_Bestell.png"/>
7112 <para>Bei Einträgen in der Liste.</para>
7116 <para>keine Kundennummer: Es gibt ähnliche Kundendatensätze und
7117 der Datensatz konnte nicht eindeutig zugewiesen werden.</para>
7121 <para>Kundennummer und Rechnungen rot hinterlegt: Der Kunde hat
7122 offene Posten und kann deswegen nicht im Stapel übernommen
7127 <para>Rechnungsadresse grün hinterlegt: Der Kunde konnte eindeutig
7128 einem Datensatz zugeordnet werden. Die Shopbestellung kann im
7129 Stapel mit dem Button "Anwenden" und wenn markiert als Auftrag
7130 übernommen werden.</para>
7134 <para>Kundennummer vorhanden, aber die Checkbox "Auftrag
7135 erstellen" fehlt. Der Kunde hat vermutlich eine
7136 Shopauftragssperre.</para>
7140 <para>Lieferadresse grau hinterlegt: Optische Anzeige, dass es
7141 sich um eine unterschiedliche Lieferadresse handelt.
7142 Lieferadressen werden aber grundsätzlich beim Transferieren zu
7143 Aufträgen mit übernommen.</para>
7147 <para>In der Spalte Positionen/Betrag/Versandkosten zeigt sich ein
7148 tooltip zu den Positionen.</para>
7152 <para>Maske Auftrag erstellen</para>
7154 <para>Viele Shopsysteme haben drei verschieden Adresstypen Kunden-,
7155 Rechnungs-, und Lieferadresse, die sich auch alle unterscheiden
7156 können. Diese werden im oberen Bereich angezeigt. Es ist möglich jede
7157 dieser Adresse einzeln in kivitendo als Kunde zu übernehmen. Es werden
7158 die Werte Formulareingabe übernommen. Es wird bei einer Änderung
7159 allerdings nur diese in die kivitendo Kundenstammdaten übernommen, die
7160 Shopbestellung bleibt bestehen.</para>
7162 <para>Mit der mittleren Adresse(Rechnungsadresse) im oberen Bereich,
7163 kann ich den ausgewählten kivitendodatensatz des mittleren Bereich
7164 überschreiben. Das ist sinnvoll, wenn ich erkenne, das der Kunde z.B.
7165 umgezogen ist.</para>
7167 <para>Im mittleren Bereich das Adresslisting zeigt:</para>
7171 <para>Rot hinterlegt: Kunde hat eine Shopauftragssperre, diese
7172 muss zuerst deaktiviert werden bevor ich diesem Kunden eine
7173 Shopbestellung zuordnen kann.</para>
7177 <para>Kundenname fett und rot: Hier hat der Kunde eine Bemerkung
7178 in den Stammdaten. Ein Tooltip zeigt diese Bemerkung. Das kann dan
7179 auch der Grund für die Auftragssperre sein.</para>
7183 <para>Die Buttons "Auftrag erstellen" und "Kunde mit
7184 Rechnungsadresse überschreiben" zeigen sich erst, wenn ein Kunde
7185 aus dem Listing ausgewählt ist.</para>
7189 <para>Es ist aber möglich die Shopbestellung zu löschen.</para>
7193 <para>Ist eine Bestellung schon übernommen, zeigen sich an dieser
7194 Stelle, die dazugehörigen Belegverknüpfungen.</para>
7200 <title>Mapping der Daten</title>
7202 <para>Das Mapping der kivitendo Daten mit den Shopdaten geschieht in
7203 der Datei SL/ShopConnector/<SHOPCONNECTORNAME>.pm
7204 z.B.:SL/ShopConnector/Shopware.pm</para>
7206 <para>In dieser Datei gibt es einen Bereich wo die Bestellpostionen,
7207 die Bestellkopfdaten und die Artikeldaten gemapt werden. In dieser
7208 Datei kann ein individelles Mapping dann gemacht werden. Zu Shopware
7209 gibt es hier eine sehr gute Dokumentation: <ulink
7210 url="https://developers.shopware.com/developers-guide/rest-api/">https://developers.shopware.com/developers-guide/rest-api/</ulink></para>
7216 <title>Entwicklerdokumentation</title>
7218 <sect1 id="devel.globals" xreflabel="Globale Variablen">
7219 <title>Globale Variablen</title>
7222 <title>Wie sehen globale Variablen in Perl aus?</title>
7224 <para>Globale Variablen liegen in einem speziellen namespace namens
7225 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
7226 globs global und die meisten speziellen Variablen sind...
7229 <para>Daraus ergeben sich folgende Formen:</para>
7233 <term><literal>$main::form</literal></term>
7236 <para>expliziter Namespace "main"</para>
7241 <term><literal>$::form</literal></term>
7244 <para>impliziter Namespace "main"</para>
7249 <term><literal>open FILE, "file.txt"</literal></term>
7252 <para><varname>FILE</varname> ist global</para>
7257 <term><literal>$_</literal></term>
7260 <para>speziell</para>
7265 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
7266 Schlüsselwort wie "<function>global</function>", mit dem man
7267 importieren kann. <function>my</function>, <function>our</function>
7268 und <function>local</function> machen was anderes.</para>
7272 <term><literal>my $form</literal></term>
7275 <para>lexikalische Variable, gültig bis zum Ende des
7281 <term><literal>our $form</literal></term>
7284 <para><varname>$form</varname> referenziert ab hier
7285 <varname>$PACKAGE::form</varname>.</para>
7290 <term><literal>local $form</literal></term>
7293 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
7294 des scopes zurückgesetzt</para>
7301 <title>Warum sind globale Variablen ein Problem?</title>
7303 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
7305 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
7306 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
7307 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
7308 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
7309 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
7310 Datenbankverbindungen, weil die sehr lange zum Initialisieren
7313 <para>Das zweite Problem ist <function>strict</function>. Unter
7314 <function>strict</function> werden alle Variablen die nicht explizit
7315 mit <function>Package</function>, <function>my</function> oder
7316 <function>our</function> angegeben werden als Tippfehler angemarkert,
7317 dies hat, seit der Einführung, u.a. schon so manche langwierige
7318 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
7319 angegeben werden, werden die nicht geprüft, und somit kann sich
7320 schnell ein Tippfehler einschleichen.</para>
7324 <title>Kanonische globale Variablen</title>
7326 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
7327 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
7328 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
7329 umhergereicht werden.</para>
7331 <para>Diese Variablen sind im Moment die folgenden neun:</para>
7335 <para><varname>$::form</varname></para>
7339 <para><varname>%::myconfig</varname></para>
7343 <para><varname>$::locale</varname></para>
7347 <para><varname>$::lxdebug</varname></para>
7351 <para><varname>$::auth</varname></para>
7355 <para><varname>$::lx_office_conf</varname></para>
7359 <para><varname>$::instance_conf</varname></para>
7363 <para><varname>$::dispatcher</varname></para>
7367 <para><varname>$::request</varname></para>
7371 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
7372 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
7373 Eigenschaften (Konventionen):</para>
7376 <title>$::form</title>
7380 <para>Ist ein Objekt der Klasse
7381 "<classname>Form</classname>"</para>
7385 <para>Wird nach jedem Request gelöscht</para>
7389 <para>Muss auch in Tests und Konsolenscripts vorhanden
7394 <para>Enthält am Anfang eines Requests die Requestparameter vom
7399 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
7400 cachen, das wird aber momentan absichtlich zerstört</para>
7404 <para><varname>$::form</varname> wurde unter <productname>SQL
7405 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
7406 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
7407 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
7408 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
7409 <function>IS->retrieve_customer()</function> in Sicherheit
7412 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
7413 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
7414 3552, Stand version 2.7beta), um dies hinterher wieder auf den
7415 richtigen Wert zu setzen:</para>
7417 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
7418 $::myconfig{numberformat} = $numberformat;
7419 # (...) div Berechnungen
7420 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
7422 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
7423 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
7424 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
7425 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
7426 Es geht ziemlich sicher etwas kaputt.</para>
7428 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
7429 in den <productname>Template::Toolkit</productname> Templates
7430 außerhalb der Controller: der Ausdruck <function>[% var
7431 %]</function> greift auf <varname>$::form->{var}</varname> zu.
7432 Unter Controllern ist der Standard Scope anders, da lautet der
7433 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
7434 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
7435 <function><%var%></function> zeigt auf
7436 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
7437 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
7440 <programlisting>[%- IF business %]
7441 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
7442 [%- END %]</programlisting>
7444 <para>Entweder wird hier dann $::form->{business} ausgewertet
7445 oder aber der Funktion
7446 <function>$form->parse_html_template</function> wird explizit
7447 noch ein zusätzlicher Hash übergeben, der dann auch in den
7448 (Web-)Templates zu Verfügung steht, bspw. so:</para>
7450 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
7452 <para>Innerhalb von Schleifen wird
7453 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
7454 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
7455 welches über alle Positionen eines Lieferscheins in Schleife
7458 <programlisting>for $i (1 .. $form->{rowcount}) {
7460 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
7461 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
7462 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
7468 <title>%::myconfig</title>
7472 <para>Das einzige Hash unter den globalen Variablen</para>
7476 <para>Wird spätestens benötigt wenn auf die Datenbank
7477 zugegriffen wird</para>
7481 <para>Wird bei jedem Request neu erstellt.</para>
7485 <para>Enthält die Userdaten des aktuellen Logins</para>
7489 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
7490 extern serialisiert werden, weil da auch der Datenbankzugriff
7491 für diesen user drinsteht.</para>
7495 <para>Enthält unter anderem Datumsformat dateformat und
7496 Nummernformat numberformat</para>
7500 <para>Enthält Datenbankzugriffinformationen</para>
7504 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
7505 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
7506 aktuellen Users entscheiden müssen, befragen
7507 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
7508 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
7509 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
7510 Informationen über den Benutzer die über die
7511 Administrator-Schnittstelle eingegeben wurden.</para>
7515 <title>$::locale</title>
7519 <para>Objekt der Klasse "Locale"</para>
7523 <para>Wird pro Request erstellt</para>
7527 <para>Muss auch für Tests und Scripte immer verfügbar
7532 <para>Cached intern über Requestgrenzen hinweg benutzte
7537 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
7538 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
7542 <title>$::lxdebug</title>
7546 <para>Objekt der Klasse "LXDebug"</para>
7550 <para>Wird global gecached</para>
7554 <para>Muss immer verfügbar sein, in nahezu allen
7559 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
7560 bereit, wie "<function>enter_sub</function>" und
7561 "<function>leave_sub</function>", mit denen in den alten Modulen ein
7562 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
7563 der man die Wallclockzeit seit Requeststart loggen kann, sowie
7564 "<function>message</function>" und "<function>dump</function>" mit
7565 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
7568 <para>Beispielsweise so:</para>
7570 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
7571 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
7575 <title>$::auth</title>
7579 <para>Objekt der Klasse "SL::Auth"</para>
7583 <para>Wird global gecached</para>
7587 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
7591 <para>Wird nach jedem Request resettet.</para>
7595 <para><varname>$::auth</varname> stellt Funktionen bereit um die
7596 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
7597 vom aktuellen User abhängen wird das Objekt aus
7598 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
7599 Request kurz resettet.</para>
7601 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
7602 Dessen Einstellungen können über
7603 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
7604 ist ein Hash mit den Werten aus der Tabelle
7605 <literal>auth.clients</literal>.</para>
7609 <title>$::lx_office_conf</title>
7613 <para>Objekt der Klasse
7614 "<classname>SL::LxOfficeConf</classname>"</para>
7618 <para>Global gecached</para>
7622 <para>Repräsentation der
7623 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
7627 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
7628 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
7629 das Programm die Konfiguration ändern kann oder sollte.</para>
7631 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
7632 Debug- und Trace-Log-Datei wie folgt konfiguriert und
7635 <programlisting>[debug]
7636 file_name = /tmp/kivitendo-debug.log</programlisting>
7638 <para>ist der Key <varname>file</varname> im Programm als
7639 <varname>$::lx_office_conf->{debug}{file}</varname>
7643 <para>Zugriff auf die Konfiguration erfolgt im Moment über
7644 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
7649 <title>$::instance_conf</title>
7653 <para>Objekt der Klasse
7654 "<classname>SL::InstanceConfiguration</classname>"</para>
7658 <para>wird pro Request neu erstellt</para>
7662 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
7663 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
7664 ist hier eine Mandantendatenbank. Beispielsweise überprüft
7665 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
7666 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
7670 <title>$::dispatcher</title>
7674 <para>Objekt der Klasse
7675 "<varname>SL::Dispatcher</varname>"</para>
7679 <para>wird pro Serverprozess erstellt.</para>
7683 <para>enthält Informationen über die technische Verbindung zum
7688 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
7689 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
7690 Objekt untergebracht.</para>
7694 <title>$::request</title>
7698 <para>Hashref (evtl später Objekt)</para>
7702 <para>Wird pro Request neu initialisiert.</para>
7706 <para>Keine Unterstruktur garantiert.</para>
7710 <para><varname>$::request</varname> ist ein generischer Platz um
7711 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
7712 at a distance benutzt werden, sondern um lokales memoizing zu
7713 ermöglichen, das garantiert am Ende des Requests zerstört
7716 <para>Vieles von dem, was im moment in <varname>$::form</varname>
7717 liegt, sollte eigentlich hier liegen. Die groben
7718 Differentialkriterien sind:</para>
7722 <para>Kommt es vom User, und soll unverändert wieder an den
7723 User? Dann <varname>$::form</varname>, steht da eh schon</para>
7727 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
7728 Requests gebraucht werden? Dann
7729 <varname>$::request</varname></para>
7733 <para>Muss ich von anderen Teilen des Programms lesend drauf
7734 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
7735 Wrappermethode</para>
7742 <title>Ehemalige globale Variablen</title>
7744 <para>Die folgenden Variablen waren einmal im Programm, und wurden
7748 <title>$::cgi</title>
7752 <para>war nötig, weil cookie Methoden nicht als
7753 Klassenfunktionen funktionieren</para>
7757 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
7758 Klassennamespace gehalten wird und über Requestgrenzen
7763 <para>liegt jetzt unter
7764 <varname>$::request->{cgi}</varname></para>
7770 <title>$::all_units</title>
7774 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
7775 ein paar hundert mal pro Request eine Liste der Einheiten
7776 brauchen, und de als Parameter durch einen Riesenstack von
7777 Funktionen geschleift werden müssten.</para>
7781 <para>Liegt jetzt unter
7782 <varname>$::request->{cache}{all_units}</varname></para>
7787 <function>AM->retrieve_all_units()</function> gesetzt oder
7794 <title>%::called_subs</title>
7798 <para>wurde benutzt um callsub deep recursions
7803 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
7804 möglichen Rekursioenen darstellt, und da nie welche
7809 <para>komplette recursion protection wurde entfernt.</para>
7816 <sect1 id="devel.fcgi">
7817 <title>Entwicklung unter FastCGI</title>
7819 <sect2 id="devel.fcgi.general">
7820 <title>Allgemeines</title>
7822 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
7823 werden, muss der Webserver neu gestartet werden.</para>
7825 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
7826 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
7827 müssen folgende Aspekte beachtet werden.</para>
7830 <sect2 id="devel.fcgi.exiting">
7831 <title>Programmende und Ausnahmen</title>
7833 <para>Betrifft die Funktionen <function>warn</function>,
7834 <function>die</function>, <function>exit</function>,
7835 <function>carp</function> und <function>confess</function>.</para>
7837 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
7838 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
7839 am Laufen zu halten. Man kann mit <function>die</function>,
7840 <function>confess</function> oder <function>carp</function> Fehler
7841 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
7842 eigene <function>$::form-</function>error()> tut im Prinzip das
7843 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
7844 <function>exit</function> hingegen werden nicht abgefangen.
7845 <function>warn</function> wird direkt nach STDERR, also in Server Log
7846 eine Nachricht schreiben (sofern in der Konfiguration nicht die
7847 Warnungen in das kivitendo Log umgeleitet wurden), und
7848 <function>exit</function> wird die Ausführung beenden.</para>
7850 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
7851 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
7852 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
7853 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
7856 <sect2 id="devel.fcgi.globals">
7857 <title>Globale Variablen</title>
7859 <para>Um zu vermeiden, dass Informationen von einem Request in einen
7860 anderen gelangen, müssen alle globalen Variablen vor einem Request
7861 sauber initialisiert werden. Das ist besonders wichtig im
7862 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
7863 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
7866 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
7867 abgetrennten Block, der alle kanonischen globalen Variablen listet und
7868 erklärt. Bitte keine anderen einführen ohne das sauber zu
7869 dokumentieren.</para>
7871 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
7872 man sicher geht, dass man die richtige erwischt.</para>
7875 <sect2 id="devel.fcgi.performance">
7876 <title>Performance und Statistiken</title>
7878 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
7879 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
7880 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
7881 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
7882 sind es je nach Menge der definierten Variablen 1-2s. Ab der
7883 Moose/Rose::DB Version sind es 5-6s.</para>
7885 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
7886 den kritischen Pfaden, unter 0,15 sonst.</para>
7890 <sect1 id="dev-programmatic-api-calls" xreflabel="Programmatische API-Aufrufe">
7891 <title>Programmatische API-Aufrufe</title>
7893 <sect2 id="dev-programmatic-api-calls.introduction" xreflabel="Einführung in programmatische API-Aufrufe">
7894 <title>Einführung</title>
7897 Es ist möglich, Funktionen in kivitendo programmatisch aus anderen Programmen aufzurufen. Dazu ist nötig, dass
7898 Authentifizierungsinformationen in jedem Aufruf mitgegeben werden. Dafür gibt es zwei Methoden: die HTTP-»Basic«-Authentifizierung
7899 oder die Übergabe als spziell benannte GET-Parameter. Neben den Authentifizierungsinformationen muss auch der zu verwendende Mandant
7904 <sect2 id="dev-programmatic-api-calls.client_selection" xreflabel="Mandantenauswahl bei programmatischen API-Aufrufen">
7905 <title>Wahl des Mandanten</title>
7908 Der zu verwendende Mandant kann als Parameter <varname>{AUTH}client_id</varname> mit jedem Request mitgeschickt werden. Der Wert
7909 muss dabei die Datenbank-ID des Mandanten sein. kivitendo prüft, ob der Account, der über die Authentifizierungsinformationen
7910 übergeben wurde, Zugriff auf den angegebenen Mandanten hat.
7914 Wird in einem Request kein Mandant mitgegeben, so wird derjenige Mandant genommen, wer als Standardmandant markiert wurde. Gibt es
7915 keinen solchen, kommt es zu einer Fehlermeldung.
7919 <sect2 id="dev-programmatic-api-calls.http_basic_authentication" xreflabel="Programmatische API-Aufrufe mit HTTP-»Basic« authentifizieren">
7920 <title>HTTP-»Basic«-Authentifizierung</title>
7923 Für diese Methode muss jedem Request der bekannte HTTP-Header <constant>Authorization</constant> mitgeschickt werden (siehe <ulink
7924 url="https://tools.ietf.org/html/rfc7617">RFC 7617</ulink>). Unterstützt wird ausschließlich die »Basic«-Methode. Loginname und
7925 Passwort werden bei dieser Methode durch einen Doppelpunkt getrennt und Base64-encodiert im genannten HTTP-Header übertragen.
7929 Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei Benutzung über den Webbrowser, ob
7930 dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
7934 Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
7939 <sect2 id="dev-programmatic-api-calls.authentication_via_parameters" xreflabel="Programmatische API-Aufrufe mit Parametern authentifizieren">
7940 <title>Authentifizierung mit Parametern</title>
7943 Für diese Methode müssen jedem Request zwei Parameter mitgegeben werden: <varname>{AUTH}login</varname> und
7944 <varname>{AUTH}password</varname>. Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei
7945 Benutzung über den Webbrowser, ob dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
7949 Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
7955 Die Verwendung dieser Methode ist veraltet. Statt dessen sollte die oben erwähnte HTTP-»Basic«-Authentifizierung verwendet werden.
7960 <sect2 id="dev-programmatic-api-calls.examples">
7961 <title>Beispiele</title>
7964 Das folgende Beispiel nutzt das Kommandozeilenprogramm »curl« und ruft die Funktion auf, die eine vorhandene Telefonnummer in den
7965 Ansprechpersonen sucht und dazu Informationen zurückliefert. Dabei wird die HTTP-»Basic«-Authentifizierung genutzt.
7968 <programlisting>$ curl --silent --user 'jdoe:SecretPassword!' \
7969 'https://…/controller.pl?action=PhoneNumber/look_up&number=053147110815'</programlisting>
7973 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
7974 <title>SQL-Upgradedateien</title>
7976 <sect2 id="db-upgrade-files.introduction"
7977 xreflabel="Einführung in die Datenbank-Upgradedateien">
7978 <title>Einführung</title>
7980 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
7981 gesteuert, die sich im Verzeichnis
7982 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
7983 muss pro Datenbankupgrade eine Datei existieren, die neben den
7984 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
7985 Kontrollinformationen enthält.</para>
7987 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
7988 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
7989 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
7990 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
7991 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
7992 Versionsnummern braucht.</para>
7994 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
7995 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
7996 führt diese nicht erneut aus. Dazu dient die Tabelle
7997 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
7998 angelegt wird.</para>
8001 <sect2 id="db-upgrade-files.format"
8002 xreflabel="Format der Upgradedateien">
8003 <title>Format der Kontrollinformationen</title>
8005 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
8006 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
8007 hat dabei das folgende Format:</para>
8009 <para>Für SQL-Upgradedateien:</para>
8011 <programlisting>-- @key: value</programlisting>
8013 <para>Für Perl-Upgradedateien:</para>
8015 <programlisting># @key: value</programlisting>
8017 <para>Leerzeichen vor "<varname>value</varname>" werden
8020 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
8024 <term><varname>tag</varname></term>
8027 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
8028 Dieser "tag" kann von anderen Kontrolldateien in ihren
8029 Abhängigkeiten verwendet werden (Schlüsselwort
8030 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
8031 in der Datenbank eingetragen wird.</para>
8033 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
8034 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
8036 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
8037 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
8038 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
8044 <term><varname>charset</varname></term>
8047 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
8048 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
8049 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
8050 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
8051 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
8052 hingegen müssen immer in UTF-8 encodiert sein und sollten
8053 demnach auch ein "<literal>use utf8;</literal>"
8059 <term><varname>description</varname></term>
8062 <para>Benötigt. Eine Beschreibung, was in diesem Update
8063 passiert. Diese wird dem Benutzer beim eigentlichen
8064 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
8065 sein sollte, sollte die Beschreibung auf Deutsch
8071 <term><varname>depends</varname></term>
8074 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
8075 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
8076 dass die in dieser Liste aufgeführten Scripte bereits
8077 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
8079 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
8080 Script "b" existiert, das von Änderungen in "a" abhängt, und
8081 eine neue Kontrolldatei für "c" erstellt wird, die von
8082 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
8083 Tag "b" als Abhängigkeit zu definieren.</para>
8085 <para>Es ist nicht erlaubt, sich selbst referenzierende
8086 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
8087 und "c" -> "a").</para>
8092 <term><varname>priority</varname></term>
8095 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
8096 der Scripte ausgeführt werden, die die gleichen
8097 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
8098 der Wert 1000 benutzt.</para>
8100 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
8101 "depends" benutzt werden. kivitendo sortiert die auszuführenden
8102 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
8103 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
8104 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
8105 dann "y", dann "z"), dann nach der Priorität und bei gleicher
8106 Priorität alphabetisch nach dem "tag".</para>
8111 <term><varname>ignore</varname></term>
8114 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
8115 Skript bei der Anmeldung ignoriert und entsprechend nicht
8122 <sect2 id="db-upgrade-files.format-perl-files"
8123 xreflabel="Format von Perl-Upgradedateien">
8124 <title>Format von in Perl geschriebenen
8125 Datenbankupgradescripten</title>
8127 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
8128 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
8129 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
8131 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
8132 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
8133 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
8134 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
8135 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
8136 aufgerufen wird.</para>
8138 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
8139 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
8140 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
8141 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
8142 "<literal>SL::DBUpgrade2::tag</literal>".</para>
8144 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
8145 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
8146 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
8148 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
8151 <programlisting># @tag: beispiel-upgrade-file42
8152 # @description: Ein schönes Beispielscript
8153 # @depends: release_3_1_0
8154 package SL::DBUpgrade2::beispiel_upgrade_file42;
8159 use parent qw(SL::DBUpgrade2::Base);
8164 # hier Aktionen ausführen
8173 <sect2 id="db-upgrade-files.dbupgrade-tool"
8174 xreflabel="Hilfsscript dbupgrade2_tool.pl">
8175 <title>Hilfsscript dbupgrade2_tool.pl</title>
8177 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
8178 existiert ein Hilfsscript namens
8179 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
8180 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
8181 liest alle Datenbankupgradescripte aus dem Verzeichnis
8182 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
8183 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
8184 von der Kommandozeile überprüft werden können.</para>
8186 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
8187 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
8188 sich aber auch Informationen auf verschiedene Art ausgeben
8193 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
8194 --list</command>"</para>
8196 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
8197 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
8198 würde. Es werden neben der Listenposition der Tag, die
8199 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
8203 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
8204 --tree</command>"</para>
8206 <para>Listet alle Tags in Baumform basierend auf den
8207 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
8208 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
8209 beim übergeordneten Script als Abhängigkeit eingetragen
8213 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
8214 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
8215 --rtree</command>"</para>
8217 <para>Listet alle Tags in Baumform basierend auf den
8218 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
8219 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
8220 die das übergeordnete Script als Abhängigkeit eingetragen
8225 <para>Baumform mit Postscriptausgabe:
8226 "<command>./scripts/dbupgrade2_tool.pl
8227 --graphviz</command>"</para>
8229 <para>Benötigt das Tool "<command>graphviz</command>", um mit
8230 seiner Hilfe die <link
8231 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
8232 Baumform</link> in eine Postscriptdatei namens
8233 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
8234 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
8235 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
8236 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
8241 <para>Scripte, von denen kein anderes Script abhängt:
8242 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
8244 <para>Listet die Tags aller Scripte auf, von denen keine anderen
8245 Scripte abhängen.</para>
8251 <sect1 id="translations-languages" xreflabel="Translations and languages">
8252 <title>Translations and languages</title>
8254 <sect2 id="translations-languages.introduction"
8255 xreflabel="Introduction to translations and languages">
8256 <title>Introduction</title>
8259 <para>Dieser Abschnitt ist in Englisch geschrieben, um
8260 internationalen Übersetzern die Arbeit zu erleichtern.</para>
8263 <para>This section describes how localization packages in kivitendo
8264 are built. Currently the only language fully supported is German, and
8265 since most of the internal messages are held in English the English
8266 version is usable too.</para>
8269 <sect2 id="translations-languages.character-set"
8270 xreflabel="Character set">
8271 <title>Character set</title>
8273 <para>All files included in a language pack must use UTF-8 as their
8277 <sect2 id="translations-languages.file-structure"
8278 xreflabel="File structure">
8279 <title>File structure</title>
8281 <para>The structure of locales in kivitendo is:</para>
8283 <programlisting>kivitendo/locale/<langcode>/</programlisting>
8285 <para>where <langcode> stands for an abbreviation of the
8286 language package. The builtin packages use two letter <ulink
8287 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
8288 but the actual name is not relevant for the program and can easily be
8290 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
8291 tags</ulink> (i.e. "en_GB"). In fact the original language packages
8292 from SQL Ledger are named in this way.</para>
8294 <para>In such a language directory the following files are
8299 <term>LANGUAGE</term>
8302 <para>This file is mandatory.</para>
8304 <para>The <filename>LANGUAGE</filename> file contains the self
8305 descripted name of the language. It should contain a native
8306 representation first, and in parenthesis an english translation
8307 after that. Example:</para>
8309 <programlisting>Deutsch (German)</programlisting>
8317 <para>This file is mandatory.</para>
8319 <para>The central translation file. It is essentially an inline
8320 Perl script autogenerated by <command>locales.pl</command>. To
8321 generate it, generate the directory and the two files mentioned
8322 above, and execute the following command:</para>
8324 <programlisting>scripts/locales.pl <langcode></programlisting>
8326 <para>Otherwise you can simply copy one of the other languages.
8327 You will be told how many are missing like this:</para>
8329 <programlisting>$ scripts/locales.pl en
8330 English - 0.6% - 2015/2028 missing</programlisting>
8332 <para>A file named "<filename>missing</filename>" will be
8333 generated and can be edited. You can also edit the
8334 "<filename>all</filename>" file directly. Edit everything you
8335 like to fit the target language and execute
8336 <command>locales.pl</command> again. See how the missing words
8342 <term>Num2text</term>
8345 <para>Legacy code from SQL Ledger. It provides a means for
8346 numbers to be converted into natural language, like
8347 <literal>1523 => one thousand five hundred twenty
8348 three</literal>. If you want to provide it, it must be inlinable
8349 Perl code which provides a <function>num2text</function> sub. If
8350 an <function>init</function> sub exists it will be executed
8353 <para>Only used in the check and receipt printing module.</para>
8358 <term>special_chars</term>
8361 <para>kivitendo comes with a lot of interfaces to different
8362 formats, some of which are rather picky with their accepted
8363 charset. The <filename>special_chars</filename> file contains a
8364 listing of chars not suited for different file format and
8365 provides substitutions. It is written in "Simple Ini" style,
8366 containing a block for every file format.</para>
8368 <para>First entry should be the order of substitution for
8369 entries as a whitespace separated list. All entries are
8370 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
8371 and <literal>\\</literal> all work.</para>
8373 <para>After that every entry is a special char that should be
8374 translated when writing text into such a file.</para>
8376 <para>Example:</para>
8378 <programlisting>[Template/XML]
8379 order=& < > \n
8383 \n=<br></programlisting>
8385 <para>Note the importance of the order in this example.
8386 Substituting < and > befor & would lead to $gt; become
8389 <para>For a list of valid formats, see the German
8390 <filename>special_chars</filename> entry. As of this writing the
8391 following are recognized:</para>
8393 <programlisting>HTML
8398 Template/OpenDocument
8399 filenames</programlisting>
8401 <para>The last of which is very machine dependant. Remember that
8402 a lot of characters are forbidden by some filesystems, for
8403 example MS Windows doesn't like ':' in its files where Linux
8404 doesn't mind that. If you want the files created with your
8405 language pack to be portable, find all chars that could cause
8411 <term>missing</term>
8414 <para>This file is not a part of the language package
8417 <para>This is a file generated by
8418 <command>scripts/locales.pl</command> while processing your
8419 locales. It's only to have the missing entries singled out and
8420 does not belong to a language package.</para>
8428 <para>This file is not a part of the language package
8431 <para>Another file generated by
8432 <command>scripts/locales.pl</command>. If for any reason a
8433 translation does not appear anymore and can be deleted, it gets
8434 moved here. The last 50 or so entries deleted are saved here in
8435 case you made a typo, so that you don't have to translate
8436 everything again. If a tranlsation is missing, the lost file is
8437 checked first. If you maintain a language package, you might
8438 want to keep this safe somewhere.</para>
8443 <term>more/all</term>
8446 <para>This subdir and file is not a part of the language package
8449 <para>If the directory more exists and contains a file called
8450 all it will be parsed in addition to the mandatory all (see
8451 above). The file is useful if you want to change some
8452 translations for the current installation without conflicting
8453 further upgrades. The file is not autogenerated and has the same
8454 format as the all, but needs another key (more_texts). See the
8455 german translation for an example or copy the following code:
8458 # -*- coding: utf-8; -*-
8463 # These are additional texts for custom translations.
8464 # The format is the same as for the normal file all, only
8465 # with another key (more_texts instead of texts).
8466 # The file has the form of 'english text' => 'foreign text',
8468 $self->{more_texts} = {
8470 'Ship via' => 'Terms of delivery',
8471 'Shipping Point' => 'Delivery time',
8473 </programlisting></para>
8480 <sect1 id="devel.testsuite">
8481 <title>Die kivitendo-Test-Suite</title>
8483 <sect2 id="devel.testsuite.intro">
8484 <title>Einführung</title>
8486 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
8487 basiert auf dem Standard-Perl-Modul
8488 <literal>Test::More</literal>.</para>
8490 <para>Die grundlegenden Fakten sind:</para>
8494 <para>Alle Tests liegen im Unterverzeichnis
8495 <filename>t/</filename>.</para>
8499 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
8500 enthält einen oder mehrere Testfälle.</para>
8504 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
8505 Es sind selbstständig ausführbare Perl-Scripte.</para>
8509 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
8510 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
8511 auf <literal>.t</literal> endet.</para>
8516 <sect2 id="devel.testsuite.prerequisites">
8517 <title>Voraussetzungen</title>
8519 <para>Für die Ausführung werden neben den für kivitendo eh schon
8520 benötigten Module noch weitere Perl-Module benötigt. Diese
8525 <para><literal>Test::Deep</literal> (Debian-Paketname:
8526 <literal>libtest-deep-perl</literal>; Fedora:
8527 <literal>perl-Test-Deep</literal>; openSUSE:
8528 <literal>perl-Test-Deep</literal>)</para>
8532 <para><literal>Test::Exception</literal> (Debian-Paketname:
8533 <literal>libtest-exception-perl</literal>; Fedora:
8534 <literal>perl-Test-Exception</literal>; openSUSE:
8535 <literal>perl-Test-Exception</literal>)</para>
8539 <para><literal>Test::Output</literal> (Debian-Paketname:
8540 <literal>libtest-output-perl</literal>; Fedora:
8541 <literal>perl-Test-Output</literal>; openSUSE:
8542 <literal>perl-Test-Output</literal>)</para>
8546 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
8547 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
8548 kann für frühere Versionen aus dem <ulink
8549 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
8553 <para><literal>LWP::Simple</literal> aus dem Paket
8554 <literal>libwww-perl</literal> (Debian-Panetname:
8555 <literal>libwww-perl</literal>; Fedora:
8556 <literal>perl-libwww-perl</literal>; openSUSE:
8557 <literal>perl-libwww-perl</literal>)</para>
8561 <para><literal>URI::Find</literal> (Debian-Panetname:
8562 <literal>liburi-find-perl</literal>; Fedora:
8563 <literal>perl-URI-Find</literal>; openSUSE:
8564 <literal>perl-URI-Find</literal>)</para>
8568 <para><literal>Sys::CPU</literal> (Debian-Panetname:
8569 <literal>libsys-cpu-perl</literal>; Fedora und openSUSE: nicht
8574 <para><literal>Thread::Pool::Simple</literal> (Debian-Panetname:
8575 <literal>libthread-pool-simple-perl</literal>; Fedora und
8576 openSUSE: nicht vorhanden)</para>
8580 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
8581 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
8582 müssen in der Konfigurationsdatei im Abschnit
8583 <literal>testing/database</literal> Datenbankverbindungsparameter
8584 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
8585 Recht haben, Datenbanken anzulegen und zu löschen.</para>
8587 <para>Der so angegebene Benutzer muss nicht zwingend über
8588 Super-User-Rechte verfügen. Allerdings gibt es einige
8589 Datenbank-Upgrades, die genau diese Rechte benötigen. Für den Fall
8590 kann man in diesem Konfigurationsabschnitt einen weiteren
8591 Benutzeraccount angeben, der dann über Super-User-Rechte verfügt, und
8592 mit dem die betroffenen Upgrades durchgeführt werden. In der
8593 Beispiel-Konfigurationsdatei finden Sie die benötigten
8597 <sect2 id="devel.testsuite.execution">
8598 <title>Existierende Tests ausführen</title>
8600 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
8601 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
8602 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
8603 <filename>t/test.pl</filename>.</para>
8605 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
8606 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
8607 kivitendo-Basisverzeichnis heraus ausführen.</para>
8609 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
8610 an <filename>t/test.pl</filename>. Beispielsweise:</para>
8612 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
8615 <sect2 id="devel.testsuite.meaning_of_scripts">
8616 <title>Bedeutung der verschiedenen Test-Scripte</title>
8618 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
8619 Programmierstil. Einige besonders zu erwähnende, weil auch während der
8620 Entwicklung nützliche Tests sind:</para>
8624 <para><filename>t/001compile.t</filename> -- compiliert alle
8625 Quelldateien und bricht bei Fehlern sofort ab</para>
8629 <para><filename>t/002goodperl.t</filename> -- überprüft alle
8630 Perl-Dateien auf Anwesenheit von '<literal>use
8631 strict</literal>'-Anweisungen</para>
8635 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
8636 <function>system()</function> und <function>exec()</function> auf
8641 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
8642 Tab-Zeichen enthalten</para>
8646 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
8647 Rechtschreibfehlern</para>
8651 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
8652 Dokumentation im POD-Format auf Gültigkeit</para>
8656 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
8657 einzelner Funktionen und Module.</para>
8660 <sect2 id="devel.testsuite.create_new">
8661 <title>Neue Test-Scripte erstellen</title>
8663 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
8664 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
8665 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
8668 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
8669 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
8672 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
8677 <para>Überprüfung auf fehlende symbolische Links</para>
8681 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
8682 gewissen Einschränkungen wie das Erlauben von deutschen
8687 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
8691 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
8695 <para>Test, ob alle zu übersetzenden Strings in
8696 <filename>locale/de/all</filename> vorhanden sind</para>
8700 <para>Test, ob alle Webseiten-Templates in
8701 <filename>templates/webpages</filename> mit vom Perl-Modul
8702 <literal>Template</literal> compiliert werden können</para>
8707 <sect3 id="devel.testsuite.directory_and_test_names">
8708 <title>Konvention für Verzeichnis- und Dateinamen</title>
8710 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
8711 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
8712 und ihnen soweit es geht folgen:</para>
8716 <para>Die Dateiendung muss <filename>.t</filename>
8721 <para>Namen sind englisch, komplett klein geschrieben und
8722 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
8723 <filename>bad_function_params.t</filename>).</para>
8727 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
8728 benannt sein, mit dem sich die Scripte darin befassen
8729 (beispielsweise <filename>background_jobs</filename> für Tests
8730 rund um Hintergrund-Jobs).</para>
8734 <para>Test-Scripte sollten einen überschaubaren Bereich von
8735 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
8736 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
8737 Test-Scripte schreiben.</para>
8742 <sect3 id="devel.testsuite.minimal_example">
8743 <title>Minimales Skelett für eigene Scripte</title>
8745 <para>Der folgenden Programmcode enthält das kleinstmögliche
8746 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
8749 <programlisting>use Test::More tests => 0;
8753 use Support::TestSetup;
8755 Support::TestSetup::login();</programlisting>
8757 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
8758 benötigt (Stichwort: alle globalen Variablen wie
8759 <varname>$::auth</varname>, <varname>$::form</varname> oder
8760 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
8761 <filename>config/kivitendo.conf</filename> im Abschnitt
8762 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
8763 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
8765 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
8766 kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
8767 weggelassen werden, was die Ausführungszeit des Scripts leicht
8773 <sect1 id="devel.style-guide">
8774 <title>Stil-Richtlinien</title>
8776 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
8777 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
8778 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
8779 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
8781 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
8784 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
8785 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
8790 <para>Es werden keine echten Tabs sondern Leerzeichen
8795 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
8797 <programlisting>foreach my $row (@data) {
8799 # do something with $row
8803 $row->{modules} = MODULE->retrieve(
8804 id => $row->{id},
8805 date => $use_now ? localtime() : $row->{time},
8809 $report->add($row);
8814 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
8815 Zeile wie der letzte Befehl. Beispiele:</para>
8817 <programlisting>sub debug {
8823 <programlisting>if ($form->{item_rows} > 0) {
8829 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
8830 der Befehl / die öffnende schließende Klammer, die den Block
8831 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
8832 Beispiele wie bei 3. gelten.</para>
8836 <para>Die Wörter "<function>else</function>",
8837 "<function>elsif</function>", "<function>while</function>" befinden
8838 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
8841 <programlisting>if ($form->{sum} > 1000) {
8843 } elsif ($form->{sum} > 0) {
8851 } until ($a > 0);</programlisting>
8855 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
8856 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
8857 und grep-ähnliche Operatoren. Beispiel:</para>
8859 <programlisting>$main::lxdebug->message("Could not find file.");
8860 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
8864 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
8866 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
8867 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
8868 Blöcke schon. Beispiel:</para>
8870 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
8875 $form->{sum} += $form->{"row_$i"};
8876 $form->{ $form->{index} } += 1;
8878 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
8882 <para>Mehrzeilige Befehle</para>
8886 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
8887 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
8888 werden, in der die ersten Funktionsparameter in der ersten Zeile
8889 stehen. Beispiel:</para>
8891 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
8892 $form->{some_col_value});</programlisting>
8896 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
8897 besten in einer übersichtlichen Tabellenstruktur organisiert
8898 wird. Beispiel:</para>
8900 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
8901 : $form->{oldcount} ? $form->{oldcount} + 1
8902 : $form->{rowcount} - $form->{rowbase};</programlisting>
8908 <para>Kommentare</para>
8912 <para>Kommentare, die alleine in einer Zeile stehen, sollten
8913 soweit wie der Code eingerückt sein.</para>
8917 <para>Seitliche hängende Kommentare sollten einheitlich
8918 formatiert werden.</para>
8922 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
8923 auf Englisch zu verfassen. So wie ich keine Lust habe,
8924 französischen Quelltext zu lesen, sollte auch der kivitendo
8925 Quelltext für nicht-Deutschsprachige lesbar sein.
8928 <programlisting>my $found = 0;
8936 $i = 0 # initialize $i
8938 $i *= $const; # do something crazy
8939 $i = $n; # recover $i</programlisting>
8945 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
8946 Interpolation gewünscht ist. Beispiel:</para>
8948 <programlisting>$form->{sum} = 0;
8949 $form->{"row_$i"} = $form->{"row_$i"} - 5;
8950 $some_hash{42} = 54;</programlisting>
8954 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
8955 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
8956 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
8957 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
8959 <para>Als Beispiel sei die Funktion
8960 <function>print_options</function> aus
8961 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
8965 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
8966 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
8969 <para>Emacs und vim haben beide recht einfache Methoden zur
8970 Entfernung von trailing whitespace. Emacs kennt das Kommande
8971 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
8972 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
8973 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
8978 <para>Es wird kein <command>perltidy</command> verwendet.</para>
8980 <para>In der Vergangenheit wurde versucht,
8981 <command>perltidy</command> zu verwenden, um einen einheitlichen
8982 Stil zu erlangen. Es hat sich aber gezeigt, dass
8983 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
8984 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
8985 den Interessierten sind hier die
8986 <command>perltidy</command>-Optionen, die grob den beschriebenen
8987 Richtlinien entsprechen:</para>
8989 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
8990 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
8991 -lp -vt=1 -vtc=1</programlisting>
8995 <para><varname>STDERR</varname> ist tabu. Unkonditionale
8996 Debugmeldungen auch.</para>
8998 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
8999 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
9000 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
9002 <para>Die <classname>LXDebug</classname>-Methode
9003 "<function>message</function>" nimmt als ersten Paramter außerdem
9004 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
9005 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
9006 und werden in den meisten Fällen auch vom Repository
9007 zurückgewiesen.</para>
9011 <para>Alle neuen Module müssen use strict verwenden.</para>
9013 <para><varname>$form</varname>, <varname>$auth</varname>,
9014 <varname>$locale</varname>, <varname>$lxdebug</varname> und
9015 <varname>%myconfig</varname> werden derzeit aus dem main package
9016 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
9017 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
9022 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
9023 <title>Dokumentation erstellen</title>
9025 <sect2 id="devel.build-doc.introduction">
9026 <title>Einführung</title>
9028 <para>Diese Dokumentation ist in <productname>DocBook</productname>
9029 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
9030 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
9031 Editor nutzt, der spezielle Unterstützung für
9032 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
9033 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
9034 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
9038 <sect2 id="devel.build-doc.required-software">
9039 <title>Benötigte Software</title>
9041 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
9042 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
9043 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
9044 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
9045 <command>scripts/build_doc.sh</command>.</para>
9047 <para>Das Script benötigt zur Konvertierung verschiedene
9048 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
9054 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
9055 in einer halbwegs aktuellen Version</para>
9059 <para>Das Java-Build-System <ulink
9060 url="http://ant.apache.org/">Apache Ant</ulink></para>
9064 <para>Das Dokumentations-System Dobudish für
9065 <productname>DocBook</productname> 4.5, eine Zusammenstellung
9066 diverser Stylesheets und Grafiken zur Konvertierung von
9067 <productname>DocBook</productname> XML in andere Formate. Das
9068 Paket, das benötigt wird, ist zum Zeitpunkt der
9069 Dokumentationserstellung
9070 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
9071 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
9076 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
9077 sind auf allen gängigen Plattformen verfügbar. Beispiel für
9078 Debian/Ubuntu:</para>
9080 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
9082 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
9083 <filename>doc/build</filename> entpackt werden. Beispiel unter der
9084 Annahme, das <productname>Dobudish</productname> in
9085 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
9087 <programlisting>cd doc/build
9088 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
9091 <sect2 id="devel.build-doc.build">
9092 <title>PDFs und HTML-Seiten erstellen</title>
9094 <para>Die eigentliche Konvertierung erfolgt nach Installation der
9095 benötigten Software mit einem einfachen Aufruf direkt aus dem
9096 kivitendo-Installationsverzeichnis heraus:</para>
9098 <programlisting>./scripts/build_doc.sh</programlisting>
9101 <sect2 id="devel.build-doc.repository">
9102 <title>Einchecken in das Git-Repository</title>
9104 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
9105 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
9106 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
9107 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
9109 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
9110 symbolischen Links gehören hingegen nicht in das Repository.</para>