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>
557 <para><literal>aqbanking-tools</literal> Für das Parsen des MT940 Bankformats</para>
560 <para><literal>poppler-utils</literal> 'pdfinfo' zum Erkennen der Seitenanzahl bei der PDF-Generierung</para>
563 <para><literal>Postgres Trigram-Index</literal> Für datenbankoptimierte Suchanfragen. Bspw. im Paket <literal>postgresql-contrib</literal> enthalten</para>
566 <para>Debian und Ubuntu: <programlisting>apt install aqbanking-tools postgresql-contrib poppler-utils</programlisting></para>
567 <para>Fedora: <programlisting>dnf install aqbanking poppler-utils postgresql-contrib</programlisting></para>
568 <para>openSUSE: <programlisting>zypper install aqbanking-tools poppler-tools</programlisting></para>
572 <sect1 id="Manuelle-Installation-des-Programmpaketes"
573 xreflabel="Manuelle Installation des Programmpaketes">
574 <title>Manuelle Installation des Programmpaketes</title>
576 <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github
577 gehostet und kann <ulink
578 url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
579 heruntergeladen werden.</para>
581 <para>Das aktuelleste kivitendo ERP-Archiv
582 (<filename>kivitendo-erp-*.tgz</filename>) wird dann im
583 Dokumentenverzeichnis des Webservers (z.B.
584 <filename>/var/www/html/</filename>,
585 <filename>/srv/www/htdocs</filename> oder
586 <filename>/var/www/</filename>) entpackt:</para>
588 <programlisting>cd /var/www
589 tar xvzf kivitendo-erp-*.tgz</programlisting>
591 <para>Wechseln Sie in das entpackte Verzeichnis:</para>
593 <programlisting>cd kivitendo-erp</programlisting>
595 <para>Alternativ können Sie auch einen Alias in der
596 Webserverkonfiguration benutzen, um auf das tatsächliche
597 Installationsverzeichnis zu verweisen.</para>
599 <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
600 WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
602 <programlisting>mkdir webdav</programlisting>
604 <para>Die Verzeichnisse <filename>users</filename>,
605 <filename>spool</filename> und <filename>webdav</filename> müssen für
606 den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
607 restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer-
608 und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich
609 (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
610 <constant>apache</constant> oder bei openSUSE
611 <constant>wwwrun</constant>).</para>
613 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
614 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
616 <programlisting>chown -R www-data users spool webdav</programlisting>
618 <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen
619 <filename>templates</filename> und <filename>users</filename>
620 Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in
621 kivitendo angelegt wird:</para>
623 <programlisting>chown www-data templates users</programlisting>
626 <para>Wir empfehlen eine Installation mittels des Versionsmanagager
627 git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr
628 viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte
629 die Pfade anpassen) bspw. wie folgt: <programlisting>cd /var/www/
630 git clone https://github.com/kivitendo/kivitendo-erp.git
632 git checkout `git tag -l | egrep -ve "(alpha|beta|rc)" | tail -1`</programlisting>
633 Erläuterung: Der Befehl wechselt zur letzten Stable-Version (git tag
634 -l listet alle Tags auf, das egrep schmeisst alle Einträge mit alpha,
635 beta oder rc raus und das tail gibt davon den obersten Treffer
636 zurück). Sehr sinnvoll ist es, direkt im Anschluss einen eigenen
637 Branch zu erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen
638 damit zu verwalten. Hierfür reicht ein simples <programlisting> git checkout -b meine_eigenen_änderungen</programlisting>
639 nach dem letzten Kommando (weiterführende Informationen <ulink
640 url="http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html">
641 Git Magic</ulink>).</para>
643 <para>Ein beispielhafter Workflow für Druckvorlagen-Anpassungen von
644 3.4.1 nach 3.5: <programlisting>
645 $ git clone https://github.com/kivitendo/kivitendo-erp.git
647 $ git checkout release-3.4.1 # das ist der aktuelle release, den wir wollen
648 $ git add templates/fullhouse # das sind unsere druckvorlagen inkl. produktbilder
649 $ git commit -m "juhu tolle ändernungen"
650 [meine_aenderungen 1d89e41] juhu tolle ändernungen
651 4 files changed, 380 insertions(+)
652 create mode 100644 templates/fullhouse/img/webdav/tesla.png
653 create mode 100644 templates/fullhouse/mahnung.tex
654 create mode 100644 templates/fullhouse/zahlungserinnerung_zwei.tex
655 create mode 100644 templates/fullhouse/zahlungserinnerung_zwei_invoice.tex
660 $ git rebase --onto release-3.5.0 release-3.4.1 meine_aenderungen
661 Zunächst wird der Branch zurückgespult, um Ihre Änderungen
662 darauf neu anzuwenden ...
663 Wende an: juhu tolle ändernungen
664 $ service apache2 restart
665 </programlisting></para>
669 <sect1 id="config.config-file">
670 <title>kivitendo-Konfigurationsdatei</title>
672 <sect2 id="config.config-file.introduction"
673 xreflabel="Einführung in die Konfigurationsdatei">
674 <title>Einführung</title>
676 <para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
677 benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die
678 Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von
679 kivitendo bzw. der Migration von älteren Versionen angelegt
682 <para>Als Vorlage dient die Datei
683 <filename>config/kivitendo.conf.default</filename> (kurz: "die
684 Default-Datei"):</para>
686 <programlisting>$ cp config/kivitendo.conf.default config/kivitendo.conf</programlisting>
688 <para>Die Default-Datei wird immer zuerst eingelesen. Werte, die in
689 der Hauptkonfigurationsdatei stehen, überschreiben die Werte aus der
690 Default-Datei. Die Hauptkonfigurationsdatei muss also nur die
691 Abschnitte und Werte enthalten, die von denen der Default-Datei
695 <para>Vor der Umbenennung in kivitendo hieß diese Datei noch
696 <filename>config/lx_office.conf</filename>. Aus Gründen der
697 Kompatibilität wird diese Datei eingelesen, sofern die Datei
698 <filename>config/kivitendo.conf</filename> nicht existiert.</para>
701 <para>Diese Hauptkonfigurationsdatei ist dann eine
702 installationsspezifische Datei, d.h. sie enthält bspw. lokale
703 Passwörter und wird auch nicht im Versionsmanagement (git)
706 <para>Die Konfiguration ist ferner serverabhängig, d.h. für alle
707 Mandaten, bzw. Datenbanken gleich.</para>
710 <sect2 id="config.config-file.sections-parameters">
711 <title>Abschnitte und Parameter</title>
713 <para>Die Konfigurationsdatei besteht aus mehreren Teilen, die
714 entsprechend kommentiert sind:</para>
718 <para><literal>authentication</literal> (siehe Abschnitt "<xref
719 linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
720 in diesem Kapitel)</para>
724 <para><literal>authentication/database</literal></para>
728 <para><literal>authentication/ldap</literal></para>
732 <para><literal>system</literal></para>
736 <para><literal>paths</literal></para>
740 <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
741 linkend="config.sending-email.smtp"/>)</para>
745 <para><literal>applications</literal></para>
749 <para><literal>environment</literal></para>
753 <para><literal>print_templates</literal></para>
757 <para><literal>task_server</literal></para>
761 <para><literal>periodic_invoices</literal></para>
765 <para><literal>self_tests</literal></para>
769 <para><literal>console</literal></para>
773 <para><literal>testing</literal></para>
777 <para><literal>testing/database</literal></para>
781 <para><literal>debug</literal></para>
785 <para>Die üblicherweise wichtigsten Parameter, die am Anfang
786 einzustellen oder zu kontrollieren sind, sind:</para>
788 <programlisting>[authentication]
789 admin_password = geheim
791 [authentication/database]
799 default_manager = german</programlisting>
801 <para>Für kivitendo Installationen in der Schweiz sollte hier
802 <varname>german</varname> durch <varname>swiss</varname> ersetzt
805 <para>Die Einstellung <varname>default_manager = swiss</varname>
810 <para>Beim Erstellen einer neuen Datenbank in der kivitendo
811 Administration werden automatisch die Standard-Werte für die
812 Schweiz voreingestellt: Währung CHF, 5er-Rundung, Schweizer
813 KMU-Kontenplan, Sollversteuerung, Aufwandsmethode, Bilanzierung
814 (die Werte können aber manuell angepasst werden).</para>
818 <para>Einstellen der Standardkonten für Rundungserträge und
819 -aufwendungen (unter Mandantenkonfiguration → Standardkonten
824 <para>das verwendete Zahlenformat wird auf
825 <varname>1'000.00</varname> eingestellt (unter Programm →
826 Benutzereinstellungen veränderbar)</para>
830 <para>DATEV-Automatik und UStVA werden nicht angezeigt,
831 Erfolgsrechnung ersetzt GUV ( unter Mandantenkonfiguration →
832 Features veränderbar)</para>
836 <para>Nutzt man wiederkehrende Rechnungen, kann man unter
837 <varname>[periodic_invoices]</varname> den Login eines Benutzers
838 angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
839 mit Informationen über die erstellten Rechnungen bekommt.</para>
841 <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
842 Ausführung bestimmter Aufgaben mit, den <link
843 linkend="config.task-server">Taskserver</link>. Er wird u.a. für
844 Features wie die <link
845 linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
846 benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
847 daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
848 <link linkend="config.task-server">Task-Server</link> genauer
851 <para>Für Entwickler finden sich unter <varname>[debug]</varname>
852 wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
855 <sect2 id="config.config-file.prior-versions">
856 <title>Versionen vor 2.6.3</title>
858 <para>In älteren kivitendo Versionen gab es im Verzeichnis
859 <filename>config</filename> die Dateien
860 <filename>authentication.pl</filename> und
861 <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
862 gab auch die Möglichkeit, eine lokale Version der Konfigurationsdatei
863 zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab
864 2.6.3 nicht mehr möglich, aber auch nicht mehr nötig.</para>
866 <para>Beim Update von einer kivitendo-Version vor 2.6.3 auf 2.6.3 oder
867 jünger müssen die Einstellungen aus den alten Konfigurationsdateien
868 manuell übertragen und die alten Konfigurationsdateien anschließend
869 gelöscht oder verschoben werden. Ansonsten zeigt kivitendo eine
870 entsprechende Fehlermeldung an.</para>
874 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
875 <title>Anpassung der PostgreSQL-Konfiguration</title>
877 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
878 <para>Dies variert je nach eingesetzter Distribution, da distributionsabhängig unterschiedliche Strategien beim Upgrade der Postgres Version eingesetzt werden.
879 Als Hinweis einige Links zu den drei Distribution (Stand Dezember 2018):</para>
882 <para><ulink url="https://fedoraproject.org/wiki/PostgreSQL">Fedora (Postgres-Installation unter Fedora)</ulink></para>
885 <para><ulink url="https://help.ubuntu.com/lts/serverguide/postgresql.html">Ubuntu (Infos für Postgres für die aktuelle LTS Version)</ulink></para>
888 <para><ulink url="https://de.opensuse.org/PostgreSQL">OpenSuSE (aktuell nur bis Version OpenSuSE 13 verifiziert)</ulink></para>
891 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
892 <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
894 <para>kivitendo setzt zwingend voraus, dass die Datenbank
895 Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
896 Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
898 <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
899 Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
900 man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
902 <programlisting>su postgres
904 exit </programlisting>
906 <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
907 Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
908 Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
911 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
913 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
914 Versionsnummer angepasst werden.</para>
916 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
918 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit
919 <literal>\l</literal> geprüft werden.</para>
922 <sect2 id="Änderungen-an-Konfigurationsdateien">
923 <title>Änderungen an Konfigurationsdateien</title>
925 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
926 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
927 <filename>/var/lib/pgsql/data/</filename> oder
928 <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
929 dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
930 Parameter <varname>listen_address</varname> gesteuert. Laufen
931 PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
932 <literal>localhost</literal> verwendet werden. Andernfalls müssen
933 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
934 was mit dem Wert <literal>*</literal> geschieht.</para>
936 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
937 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
938 sein sollte, müssen die Berechtigungen für den Zugriff geändert
939 werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
940 nötigen Verbindungen immer zuzulassen, für eine lokal laufende
941 Datenbank zum Beispiel:</para>
943 <programlisting>local all kivitendo password
944 host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
947 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
948 <title>Erweiterung für servergespeicherte Prozeduren</title>
950 <para>In der Datenbank <literal>template1</literal> muss die
951 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
952 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
953 <programlisting>su - postgres
954 psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
956 <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
960 <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
961 bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
962 anzulegen. In diesen Versionen ist die Extension meist auch schon
963 vorhanden. Sollten Sie eine ältere Version von Postgres haben,
964 benutzen Sie stattdessen den folgenden Befehl.</para>
966 <programlisting>CREATE LANGUAGE 'plpgsql';
971 <sect2 id="Erweiterung-für-trigram">
972 <title>Erweiterung für Trigram Prozeduren</title>
974 <para>Ab Version 3.5.1 wird die Trigram-Index-Erweiterung benötigt.
975 Diese wird mit dem SQL-Updatescript
976 sql/Pg-upgrade2/trigram_extension.sql und Datenbank-Super-Benutzer
977 Rechten automatisch installiert. Dazu braucht der
978 DatenbankSuperbenutzer "postgres" ein Passwort.</para>
980 <programlisting>su - postgres
987 <para>Benutzername Postgres und Passwort können jetzt beim Anlegen
988 einer Datenbank bzw. bei Updatescripten, die SuperuserRechte
989 benötigen, eingegeben werden.</para>
992 <para><literal>pg_trgm</literal> ist je nach Distribution nicht im
993 Standard-Paket von Postgres enthalten. Ein <programlisting>select * from pg_available_extensions where name ='pg_trgm';</programlisting>
994 in template1 sollte entsprechend erfolgreich sein. Andernfalls muss
995 das Paket nachinstalliert werden, bspw. bei debian/ubuntu
996 <programlisting>apt install postgresql-contrib</programlisting></para>
1000 <sect2 id="Datenbankbenutzer-anlegen">
1001 <title>Datenbankbenutzer anlegen</title>
1003 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
1004 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
1005 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
1008 <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
1009 nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
1010 generieren nicht nötig.</para>
1012 <programlisting>su - postgres
1013 createuser -d -P kivitendo
1014 exit</programlisting>
1016 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
1017 Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
1018 bzw. den hier gewählten Benutzernamen.</para>
1022 <sect1 id="Apache-Konfiguration">
1023 <title>Webserver-Konfiguration</title>
1026 <title>Grundkonfiguration mittels CGI</title>
1029 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
1030 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
1031 <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
1034 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
1035 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
1036 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
1037 anderen Datei hinzu, die beim Starten des Webservers eingelesen
1040 <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
1041 Alias /kivitendo-erp/ /var/www/kivitendo-erp/
1043 <Directory /var/www/kivitendo-erp>
1044 AddHandler cgi-script .pl
1045 Options ExecCGI Includes FollowSymlinks
1048 <Directory /var/www/kivitendo-erp/users>
1050 </Directory></programlisting>
1052 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
1053 das kivitendo-Archiv entpacket haben.</para>
1056 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
1057 Plus ‘<literal>+</literal>’ gesetzt werden.</para>
1059 <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
1060 noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
1061 aktiviert werden.</para>
1064 <para>Auf einigen Webservern werden manchmal die Grafiken und
1065 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
1066 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
1068 <programlisting>EnableSendfile Off</programlisting>
1071 <sect2 id="Apache-Konfiguration.FCGI"
1072 xreflabel="Konfiguration für FastCGI/FCGI">
1073 <title>Konfiguration für FastCGI/FCGI</title>
1075 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
1076 <title>Was ist FastCGI?</title>
1078 <para>Direkt aus <ulink
1079 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
1082 <para><citation> FastCGI ist ein Standard für die Einbindung
1083 externer Software zur Generierung dynamischer Webseiten in einem
1084 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
1085 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
1086 umgehen. </citation></para>
1089 <sect3 id="Apache-Konfiguration.FCGI.Warum">
1090 <title>Warum FastCGI?</title>
1092 <para>Perl Programme (wie kivitendo eines ist) werden nicht statisch
1093 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
1094 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
1095 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
1096 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
1097 müssen, ist die Funktionalität von kivitendo soweit gewachsen, dass
1098 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
1099 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
1100 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
1101 führt dazu dass ein kivitendo Aufruf der Kernmasken mittlerweile
1102 deutlich länger dauert als früher, und dass davon 90% für das Laden
1103 der Module verwendet wird.</para>
1105 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
1106 wird nur die eigentliche Programmlogik ausgeführt.</para>
1109 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
1110 <title>Getestete Kombinationen aus Webservern und Plugin</title>
1112 <para>Folgende Kombinationen sind getestet:</para>
1116 <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
1119 <para>Apache 2.4.18 (Ubuntu 16.04 LTS) und mod_fcgid</para>
1122 <para>Apache 2.4.29 (Ubuntu 18.04 LTS) und mod_fcgid</para>
1126 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
1130 <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
1131 strict in der Behandlung von Unicode, und verweigern bestimmte
1132 Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
1133 Installation gibt, muss zwingend Version 0.68 oder aber Version
1134 0.72 und neuer eingesetzt werden.</para>
1136 <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
1137 sich die Vorgängerversion wie folgt installieren:</para>
1139 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
1143 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
1144 <title>Konfiguration des Webservers</title>
1146 <para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
1147 laufen zu lassen, empfiehlt es sich die Installation ersteinmal
1148 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
1149 debuggen die beim ersten aufsetzen auftreten können. Sollte die
1150 Installation schon funktionieren, lesen Sie weiter.</para>
1152 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
1153 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
1155 <programlisting>a2enmod fcgid</programlisting>
1157 <para>Die Konfiguration für die Verwendung von kivitendo mit FastCGI
1158 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
1159 und <function>Directory</function>-Direktiven. Dabei wird zwischen
1160 dem Installationspfad von kivitendo im Dateisystem
1161 ("<filename>/path/to/kivitendo-erp</filename>") und der URL
1162 unterschieden, unter der kivitendo im Webbrowser erreichbar ist
1163 ("<filename>/url/for/kivitendo-erp</filename>").</para>
1165 <para>Folgender Konfigurationsschnipsel funktioniert mit
1168 <programlisting>AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fcgi
1169 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1171 <Directory /path/to/kivitendo-erp>
1173 Options ExecCGI Includes FollowSymlinks
1177 <DirectoryMatch /path/to/kivitendo-erp/users>
1179 </DirectoryMatch></programlisting>
1182 <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
1183 muss entsprechend die Syntax der Directorydirektiven verändert.
1186 <programlisting>Require all granted</programlisting>
1188 <para>muß man Folgendes einstellen:</para>
1192 Allow from All </programlisting>
1194 <para>und statt</para>
1196 <programlisting>Require all denied</programlisting>
1198 <para>muss stehen:</para>
1202 Deny from All </programlisting>
1205 <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
1206 die maximale Größe eines Requests. Diese sollte wie folgt
1207 hochgesetzt werden:</para>
1209 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
1211 <para>Das Ganze sollte dann so aussehen:</para>
1213 <programlisting>AddHandler fcgid-script .fpl
1214 AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1215 Alias /url/for/kivitendo-erp/ /path/to/kivitendo-erp/
1216 FcgidMaxRequestLen 10485760
1218 <Directory /path/to/kivitendo-erp>
1220 Options ExecCGI Includes FollowSymlinks
1224 <DirectoryMatch /path/to/kivitendo-erp/users>
1226 </DirectoryMatch></programlisting>
1228 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
1229 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
1230 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
1231 gibt es hier kleine Performance-Einbußen.</para>
1233 <para>Es ist möglich, die gleiche kivitendo Version parallel unter
1234 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
1235 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
1237 <programlisting># Zugriff über CGI
1238 Alias /url/for/kivitendo-erp /path/to/kivitendo-erp
1240 # Zugriff mit mod_fcgid:
1241 AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
1242 Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/</programlisting>
1244 <para>Dann ist unter <filename>/url/for/kivitendo-erp/</filename>
1245 die normale Version erreichbar, und unter
1246 <constant>/url/for/kivitendo-erp-fcgid/</constant> die
1247 FastCGI-Version.</para>
1252 <title>Authentifizierung mittels HTTP Basic Authentication</title>
1255 Kivitendo unterstützt, dass Benutzerauthentifizierung über den Webserver mittels des »Basic«-HTTP-Authentifizierungs-Schema erfolgt
1256 (siehe <ulink url="https://tools.ietf.org/html/rfc7617">RFC 7617</ulink>). Dazu ist es aber nötig, dass der dabei vom Client
1257 mitgeschickte Header <constant>Authorization</constant> vom Webserver an Kivitendo über die Umgebungsvariable
1258 <constant>HTTP_AUTHORIZATION</constant> weitergegeben wird, was standardmäßig nicht der Fall ist. Für Apache kann dies über die
1259 folgende Konfigurationsoption aktiviert werden:
1262 <programlisting>SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1</programlisting>
1266 <title>Weitergehende Konfiguration</title>
1268 <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
1269 von kivitendo nur über https-verschlüsselten Verbindungen, sowie
1270 weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
1271 Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
1272 Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
1273 url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
1274 (Stand Sept. 2015)</ulink> und einen aktuellen (Stand Mai 2017) <ulink
1275 url="https://mozilla.github.io/server-side-tls/ssl-config-generator/">
1276 SSL-Konfigurations-Generator</ulink>.</para>
1280 <sect1 id="config.task-server">
1281 <title>Der Task-Server</title>
1283 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
1284 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
1285 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
1286 wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
1287 essenzielle Aufgaben benutzt.</para>
1289 <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
1290 konfiguriert werden. Danach wird er für jeden Mandanten, für den er
1291 laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
1293 <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
1294 Servers integriert werden muss, damit er automatisch gestartet wird.
1295 Dies kann kivitendo nicht für Sie erledigen.</para>
1297 <para>Da der Taskserver als Perlscript läuft, wird Arbeitsspeicher, der
1298 einmal benötigt wurde, nicht mehr an das Betriebssystem zurückgegeben,
1299 solange der Taskserver läuft. Dies kann dazu führen, dass ein länger
1300 laufender Taskserver mit der Zeit immer mehr Arbeitsspeicher für sich
1301 beansprucht. Es ist deshalb sinnvoll, dass der Taskserver in
1302 regelmässigen Abständen neu gestartet wird.</para>
1304 <sect2 id="Konfiguration-des-Task-Servers">
1305 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
1307 <para>Die Konfiguration erfolgt über den Abschnitt
1308 <literal>[task_server]</literal> in der Datei
1309 <filename>config/kivitendo.conf</filename>. Die dort verfügbaren
1310 Optionen sind:</para>
1314 <term><varname>run_as</varname></term>
1317 <para>Wird der Server vom Systembenutzer <literal>root</literal>
1318 gestartet, so wechselt er auf den mit <literal>run_as</literal>
1319 angegebenen Systembenutzer. Der Systembenutzer muss dieselben
1320 Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
1322 linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
1323 ist es erforderlich, hier denselben Systembenutzer einzutragen,
1324 unter dem auch der Webserver läuft.</para>
1329 <term><varname>debug</varname></term>
1332 <para>Schaltet Debug-Informationen an und aus.</para>
1338 <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
1339 <title>Konfiguration der Mandanten für den Task-Server</title>
1341 <para>Ist der Task-Server grundlegend konfiguriert, so muss
1342 anschließend jeder Mandant, für den der Task-Server laufen soll,
1343 einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
1344 von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
1345 ausgewählt werden, unter der der Task-Server seine Arbeit
1348 <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
1349 wird der Task-Server für diesen Mandanten keine Aufgaben
1353 <sect2 id="Einbinden-in-den-Boot-Prozess">
1354 <title>Automatisches Starten des Task-Servers beim Booten</title>
1356 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
1357 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
1358 Starten automatisch in das kivitendo-Installationsverzeichnis.</para>
1360 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
1361 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
1362 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
1363 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
1364 anstelle eines symbolischen Links verwendet werden können.</para>
1367 <title>SystemV-basierende Systeme (z.B. ältere Debian, ältere
1368 openSUSE, ältere Fedora)</title>
1370 <para>Kopieren Sie die Datei
1371 <filename>scripts/boot/system-v/kivitendo-task-server</filename>
1372 nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
1373 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1374 <literal>DAEMON=....</literal>). Binden Sie das Script in den
1375 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
1379 <para>Debian-basierende Systeme:</para>
1381 <programlisting>update-rc.d kivitendo-task-server defaults
1382 insserv kivitendo-task-server</programlisting>
1386 <para>Ältere openSUSE und ältere Fedora:</para>
1388 <programlisting>chkconfig --add kivitendo-task-server</programlisting>
1392 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1395 <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
1399 <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
1401 <para>Kopieren Sie die Datei
1402 <filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
1403 nach <filename>/etc/init/kivitendo-task-server.conf</filename>.
1404 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
1405 <literal>exec ....</literal>).</para>
1407 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
1410 <programlisting>service kivitendo-task-server start</programlisting>
1414 <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
1415 Fedora, neuere Ubuntu und neuere Debians)</title>
1417 <para>Kopieren Sie die Datei
1418 <filename>scripts/boot/systemd/kivitendo-task-server.service</filename>
1419 nach <filename>/etc/systemd/system/</filename>. Passen Sie in der
1420 kopierten Datei den Pfad zum Task-Server an (Zeilen
1421 <literal>ExecStart=....</literal> und
1422 <literal>ExecStop=...</literal>).</para>
1424 <para>Machen Sie anschließend das Script systemd bekannt, und binden
1425 Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden Befehl
1428 <programlisting>systemctl daemon-reload
1429 systemctl enable kivitendo-task-server.service</programlisting>
1431 <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt
1432 den Server neu zu starten, so können Sie das mit dem folgenden
1435 <programlisting>systemctl start kivitendo-task-server.service</programlisting>
1439 <sect2 id="Prozesskontrolle">
1440 <title>Wie der Task-Server gestartet und beendet wird</title>
1442 <para>Der Task-Server wird wie folgt kontrolliert:</para>
1444 <programlisting>./scripts/task_server.pl Befehl</programlisting>
1446 <para><literal>Befehl</literal> ist dabei eine der folgenden
1451 <para><literal>start</literal> startet eine neue Instanz des
1452 Task-Servers. Die Prozess-ID wird innerhalb des
1453 <filename>users</filename>-Verzeichnisses abgelegt.</para>
1457 <para><literal>stop</literal> beendet einen laufenden
1462 <para><literal>restart</literal> beendet und startet ihn
1467 <para><literal>status</literal> berichtet, ob der Task-Server
1472 <para>Der Task-Server wechselt beim Starten automatisch in das
1473 kivitendo-Installationsverzeichnis.</para>
1475 <para>Dieselben Optionen können auch für die SystemV-basierenden
1476 Runlevel-Scripte benutzt werden (siehe oben).</para>
1480 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
1481 <title>Benutzerauthentifizierung und Administratorpasswort</title>
1483 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
1484 über die Verwaltung von Gruppen und weitere Einstellungen</para>
1486 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
1487 <title>Grundlagen zur Benutzerauthentifizierung</title>
1489 <para>kivitendo verwaltet die Benutzerinformationen in einer
1490 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
1491 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
1492 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
1493 können, müssen aber nicht unterschiedlich sein.</para>
1495 <para>Im einfachsten Fall gibt es für kivitendo nur eine einzige
1496 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
1497 abgelegt werden.</para>
1499 <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
1500 entweder gegen die Authentifizierungsdatenbank oder gegen einen
1501 LDAP-Server überprüft werden.</para>
1503 <para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
1504 kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
1505 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1506 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
1507 einer Version vor v2.6.0 angelegt werden. Eine
1508 Beispielkonfigurationsdatei
1509 <filename>config/kivitendo.conf.default</filename> existiert, die als
1510 Vorlage benutzt werden kann.</para>
1513 <sect2 id="Administratorpasswort">
1514 <title>Administratorpasswort</title>
1516 <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
1517 von kivitendo benutzt wird, wird ebenfalls in dieser Datei
1518 gespeichert. Es kann auch nur dort und nicht mehr im
1519 Administrationsinterface selber geändert werden. Der Parameter dazu
1520 heißt <varname>admin_password</varname> im Abschnitt
1521 <varname>[authentication]</varname>.</para>
1524 <sect2 id="Authentifizierungsdatenbank">
1525 <title>Authentifizierungsdatenbank</title>
1527 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den
1528 Parametern in <varname>[authentication/database]</varname>
1529 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
1533 <term><literal>host</literal></term>
1536 <para>Der Rechnername oder die IP-Adresse des
1537 Datenbankservers</para>
1542 <term><literal>port</literal></term>
1545 <para>Die Portnummer des Datenbankservers, meist 5432</para>
1550 <term><literal>db</literal></term>
1553 <para>Der Name der Authentifizierungsdatenbank</para>
1558 <term><literal>user</literal></term>
1561 <para>Der Benutzername, mit dem sich kivitendo beim
1562 Datenbankserver anmeldet (z.B.
1563 "<literal>postgres</literal>")</para>
1568 <term><literal>password</literal></term>
1571 <para>Das Passwort für den Datenbankbenutzer</para>
1576 <para>Die Datenbank muss noch nicht existieren. kivitendo kann sie
1577 automatisch anlegen (mehr dazu siehe unten).</para>
1580 <sect2 id="Passwortüberprüfung">
1581 <title>Passwortüberprüfung</title>
1583 <para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
1584 die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
1585 Active-Directory-Server. Welche davon benutzt wird, regelt der
1586 Parameter <varname>module</varname> im Abschnitt
1587 <varname>[authentication]</varname>.</para>
1589 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
1590 gespeichert werden, so muss der Parameter <varname>module</varname>
1591 den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
1592 der Administrator als auch die Benutzer selber ihre Passwörter in
1593 kivitendo ändern.</para>
1595 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
1596 benutzt werden, so muss der Parameter <varname>module</varname> auf
1597 <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
1598 zusätzliche Informationen über den LDAP-Server im Abschnitt
1599 <literal>[authentication/ldap]</literal> angegeben werden:</para>
1603 <term><literal>host</literal></term>
1606 <para>Der Rechnername oder die IP-Adresse des LDAP- oder
1607 Active-Directory-Servers. Diese Angabe ist zwingend
1608 erforderlich.</para>
1613 <term><literal>port</literal></term>
1616 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
1621 <term><literal>tls</literal></term>
1624 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen
1625 Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
1626 ‘<literal>0</literal>’ belassen</para>
1631 <term><literal>attribute</literal></term>
1634 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der
1635 Benutzer eingegeben hat. Für Active-Directory-Server ist dies
1636 meist ‘<literal>sAMAccountName</literal>’, für andere
1637 LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist
1638 zwingend erforderlich.</para>
1643 <term><literal>base_dn</literal></term>
1646 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll.
1647 Diese Angabe ist zwingend erforderlich.</para>
1652 <term><literal>filter</literal></term>
1655 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort
1656 <literal><%login%></literal>, so wird dieses durch den vom
1657 Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird
1658 der LDAP-Baum nach einem Element durchsucht, bei dem das oben
1659 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1664 <term><literal>bind_dn</literal> und
1665 <literal>bind_password</literal></term>
1668 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er
1669 durchsucht werden kann (z.B. ist dies bei
1670 Active-Directory-Servern der Fall), so kann diese hier angegeben
1671 werden. Für Active-Directory-Server kann als
1672 ‘<literal>bind_dn</literal>’ entweder eine komplette LDAP-DN wie
1673 z.B. ‘<literal>cn=Martin
1674 Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der
1675 volle Name des Benutzers eingegeben werden; in diesem Beispiel
1676 also ‘<literal>Martin Mustermann</literal>’.</para>
1682 <sect2 id="Name-des-Session-Cookies">
1683 <title>Name des Session-Cookies</title>
1685 <para>Sollen auf einem Server mehrere kivitendo-Installationen
1686 aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1687 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem
1688 Parameter <varname>cookie_name</varname> im Abschnitt
1689 <varname>[authentication]</varname>gesetzt.</para>
1691 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1692 Server existiert.</para>
1695 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1696 <title>Anlegen der Authentifizierungsdatenbank</title>
1698 <para>Nachdem alle Einstellungen in
1699 <filename>config/kivitendo.conf</filename> vorgenommen wurden, muss
1700 kivitendo die Authentifizierungsdatenbank anlegen. Dieses geschieht
1701 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1702 der folgenden URL erreichbar sein sollte:</para>
1705 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1709 <sect1 id="Benutzer--und-Gruppenverwaltung">
1710 <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
1712 <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
1713 Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
1714 das Sie unter folgender URL finden:</para>
1717 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
1719 <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
1720 <filename>config/kivitendo.conf</filename> eingetragen haben.</para>
1722 <sect2 id="Zusammenhänge">
1723 <title>Zusammenhänge</title>
1725 <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
1726 in einer oder zwei Datenbanken gespeichert werden.</para>
1728 <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
1729 und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
1730 auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
1731 Diese Informationen werden in der Authentifizierungsdatenbank
1732 gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
1733 in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1734 gespeichert werden.</para>
1736 <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
1737 Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
1738 Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
1739 in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
1740 einer solchen Mandantendatenbank werden im Administrationsbereich
1741 konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
1742 einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
1744 <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
1745 die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
1746 ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
1747 mehr als einem Mandanten, wird empfohlen, für die
1748 Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
1749 nicht gleichzeitig für einen Mandanten verwendet wird.</para>
1752 <sect2 id="Mandanten-Benutzer-Gruppen">
1753 <title>Mandanten, Benutzer und Gruppen</title>
1755 <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
1756 die sich frei zueinander zuordnen lassen.</para>
1758 <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
1759 verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
1760 ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
1761 vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
1762 Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
1763 Diese sollte über die <link
1764 linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
1767 <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
1768 soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
1769 der Administrator fest, an welchen Mandanten sich ein Benutzer
1770 anmelden kann, was beim Login verifiziert wird.</para>
1772 <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
1773 auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
1774 Administrator gewisse Rechte zugeordnet. Weiterhin legt der
1775 Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
1776 Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
1777 dann an einem Mandanten an, so erhält er alle Rechte von allen
1778 denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
1779 denen der Benutzer zum Anderen Mitglied ist,</para>
1781 <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
1782 Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
1783 folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
1785 <orderedlist numeration="arabic">
1787 <para>Datenbank anlegen</para>
1791 <para>Gruppen anlegen</para>
1795 <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
1799 <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
1804 <sect2 id="Datenbanken-anlegen">
1805 <title>Datenbanken anlegen</title>
1807 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1808 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1809 Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
1812 <sect2 id="Gruppen-anlegen">
1813 <title>Gruppen anlegen</title>
1815 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1816 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1817 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1818 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1820 <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
1821 gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
1822 Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
1823 gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
1824 ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
1825 man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
1826 A, B und C gültig").</para>
1828 <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
1829 dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
1830 X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
1831 eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
1832 Gruppen A, B und C").</para>
1835 <sect2 id="Benutzer-anlegen">
1836 <title>Benutzer anlegen</title>
1838 <para>Beim Anlegen von Benutzern werden für viele Parameter
1839 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1840 deutschen Raumes entsprechen.</para>
1842 <para>Zwingend anzugeben ist der Loginname. Wenn die
1843 Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
1844 hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
1845 hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
1848 <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
1849 auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
1850 hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
1851 sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
1852 auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
1853 X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
1854 Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
1855 sind Benutzer A, B und C Mitglieder").</para>
1858 <sect2 id="Mandanten-anlegen">
1859 <title>Mandanten anlegen</title>
1861 <para>Ein Mandant besteht aus Administrationssicht primär aus einem
1862 eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
1863 als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
1864 einer der eben angelegten Datenbanken eingetragen werden.</para>
1866 <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
1867 konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
1868 bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
1869 können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
1870 haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
1871 Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
1872 hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
1873 Gruppe ist für Mandanten A, B und C gültig").</para>
1877 <sect1 id="Drucker--Systemverwaltung">
1878 <title>Drucker- und Systemverwaltung</title>
1880 <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
1881 Druckeradministration und System.</para>
1883 <sect2 id="Druckeradministration">
1884 <title>Druckeradministration</title>
1886 <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
1887 viele "Druckbefehle" im System verwalten. Diese Befehle werden
1888 mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
1889 des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
1890 angezeigt wird.</para>
1892 <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
1893 der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
1894 meinDrucker' oder ein kompletter Pfad zu einem Skript
1895 (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
1896 ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
1897 Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
1898 ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
1899 Ausdruck eines Angebots folgende Vorlage geparst:
1900 sales_quotation_epson_drucker.tex.</para>
1904 <title>System sperren / entsperren</title>
1906 <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
1907 sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
1908 gesamten kivitendo Installation gesperrt.</para>
1910 <para>Falls die Sperre gesetzt ist, erscheint anstelle der
1911 Anmeldemaske die Information: 'kivitendo ist momentan zwecks
1912 Wartungsarbeiten nicht zugänglich.'.</para>
1914 <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
1915 automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
1916 Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
1917 inkonsistenten Datenbestand weitergearbeitet werden.</para>
1921 <sect1 id="config.sending-email"
1922 xreflabel="E-Mail-Versand aus kivitendo heraus">
1923 <title>E-Mail-Versand aus kivitendo heraus</title>
1925 <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
1926 z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
1927 funktioniert, muss eingestellt werden, über welchen Server die E-Mails
1928 verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
1929 Versand über einen lokalen E-Mail-Server (z.B. mit
1930 <productname>Postfix</productname> oder <productname>Exim</productname>,
1931 was auch die standardmäßig aktive Methode ist) sowie Versand über einen
1932 SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
1934 <para>Welche Methode und welcher Server verwendet werden, wird über die
1935 Konfigurationsdatei <filename>config/kivitendo.conf</filename>
1936 festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
1937 Abschnitt '<literal>[mail_delivery]</literal>'.</para>
1939 <sect2 id="config.sending-email.sendmail"
1940 xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
1941 <title>Versand über lokalen E-Mail-Server</title>
1943 <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
1944 kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
1945 <productname>Postfix</productname>, <productname>Exim</productname>
1946 oder <productname>Sendmail</productname> läuft.</para>
1948 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1949 '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
1950 gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
1952 <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
1953 wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
1954 Standardwert verweist auf das Programm
1955 <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
1956 E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
1958 <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
1959 dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
1963 <sect2 id="config.sending-email.smtp"
1964 xreflabel="E-Mail-Versand über einen SMTP-Server">
1965 <title>Versand über einen SMTP-Server</title>
1967 <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
1968 vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
1971 <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
1972 '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
1973 Parameter dienen dabei der weiteren Konfiguration:</para>
1977 <term><varname>hostname</varname></term>
1980 <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
1981 '<literal>localhost</literal>'</para>
1986 <term><varname>port</varname></term>
1989 <para>Portnummer. Der Standardwert hängt von der verwendeten
1990 Verschlüsselungsmethode ab. Gilt '<literal>security =
1991 none</literal>' oder '<literal>security = tls</literal>', so ist
1992 25 die Standardportnummer. Für '<literal>security =
1993 ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
1994 geändert werden.</para>
1999 <term><varname>security</varname></term>
2002 <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
2003 mit dem Server. Standardwert ist '<literal>none</literal>',
2004 wodurch keine Verschlüsselung verwendet wird. Mit
2005 '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
2006 und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
2007 eingeschaltet. Achtung: Für '<literal>tls</literal>' und
2008 '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
2009 (siehe unten).</para>
2014 <term><varname>login</varname> und
2015 <varname>password</varname></term>
2018 <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
2019 so können mit diesen zwei Parametern der Benutzername und das
2020 Passwort angegeben werden. Wird Authentifizierung verwendet, so
2021 sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
2022 aktiviert werden.</para>
2029 <sect1 id="Drucken-mit-kivitendo">
2030 <title>Drucken mit kivitendo</title>
2032 <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
2033 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
2034 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
2035 debianoiden Betriebssystemen installiert man die Pakete mit:</para>
2037 <para><programlisting>apt install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
2038 texlive-latex-extra texlive-lang-german texlive-generic-extra texlive-xetex ghostscript</programlisting></para>
2040 <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
2042 <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
2043 texlive-collection-latexrecommended texlive-collection-langgerman \
2044 texlive-collection-langenglish</programlisting></para>
2046 <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
2048 <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
2049 texlive-collection-latexrecommended texlive-collection-langgerman \
2050 texlive-collection-langenglish</programlisting></para>
2052 <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
2064 <para>rev-odt</para>
2068 <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version
2069 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
2071 <sect2 id="Vorlagenverzeichnis-anlegen"
2072 xreflabel="Vorlagenverzeichnis anlegen">
2073 <title>Vorlagenverzeichnis anlegen</title>
2075 <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
2076 LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
2078 <programlisting>./scripts/installation_check.pl -lv</programlisting>
2080 <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
2081 Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
2082 <xref linkend="Gruppen-anlegen"/>.</para>
2084 <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
2085 -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
2086 <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
2087 Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
2091 <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
2092 Vorlagensatz aus, der kopiert werden soll
2093 (<filename>RB</filename>, <filename>f-tex</filename> oder
2094 <filename>odt-rev</filename>.)</para>
2098 <para><option>Neuer Name</option>: Der Verzeichnisname für den
2099 neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
2100 für Verzeichnisnamen frei gewählt werden.</para>
2104 <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
2105 für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
2106 wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
2107 Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
2108 vorgenommen werden. Den Ordner findet man im Dateisystem unter
2109 <filename>./templates/[Neuer Name]</filename></para>
2112 <sect2 id="Vorlagen-RB">
2113 <title>Der Druckvorlagensatz RB</title>
2115 <para>Hierbei handelt es sich um einen vollständigen LaTeX
2116 Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
2117 sind nicht gepflegt.</para>
2119 <para>Die konzeptionelle Idee der Vorlagen wird <ulink
2120 url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
2121 auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
2122 eigenen Firmendaten finden sich in der Datei Readme.tex im
2123 Vorlagenverzeichnis.</para>
2125 <para>Eine kurze Übersicht der Features:</para>
2129 <para>Mehrsprachenfähig, mit Deutscher und Englischer
2134 <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
2135 werden, z.B. für Kopf- und Fußzeilen, und Infos wie
2140 <para>mehrere vordefinierte Varianten für
2141 Logos/Hintergrundbilder</para>
2145 <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
2146 "Außerhalb EU"</para>
2152 <title>f-tex</title>
2154 <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur
2155 Verfügung stellt.</para>
2157 <sect3 id="f-tex-Feature-Übersicht">
2158 <title>Feature-Übersicht</title>
2162 <para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage
2163 für alle briefartigen Dokumente verwendet. Also Angebot,
2164 Rechnung, Proformarechnung, Lieferschein, aber eben nicht für
2165 Paketaufkleber etc.</para>
2169 <para>Leichte Anpassung an das Firmen-Layout durch Verwendung
2170 eines Hintergrund-PDFs. Dieses kann leicht mit dem eigenen
2171 Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp,
2176 <para>Hintergrund-PDF umschaltbar auf "nur erste Seite"
2177 (Standard) oder "alle Seiten" (Option
2178 "<option>bgPdfFirstPageOnly</option>" in Datei
2179 <filename>letter.lco</filename>)</para>
2183 <para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem
2184 Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
2185 versendeten Dokumenten eingebunden (Option
2186 "<option>bgPdfEmailOnly</option>" in Datei
2187 <filename>letter.lco</filename>).</para>
2191 <para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch,
2192 Wiederholung von Kopfzeilen, Zwischensummen etc. (danke an
2193 Kai-Martin Knaak für die Vorarbeit)</para>
2197 <para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom
2198 Land des eigenen Unternehmens abweicht (also die Rechnung das
2199 Land verlässt).</para>
2203 <para>Multisprachfähig leicht um weitere Sprachen zu erweitern,
2204 alle Übersetzungen in der Datei
2205 <filename>translatinos.tex</filename>.</para>
2209 <para>Auflistung von Bruttopreisen für Endverbraucher.</para>
2214 <sect3 id="f-tex-Installation">
2215 <title>Die Installation</title>
2219 <para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref
2220 linkend="Vorlagenverzeichnis-anlegen"/>. Das Vorlagensystem
2221 funktioniert jetzt schon, hat allerdings noch einen
2222 Beispiel-Briefkopf.</para>
2226 <para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
2227 <filename>./letter_head.pdf</filename>.</para>
2231 <para>Editiere den Bereich "<option>settings</option>" in der
2232 datei <filename>letter.lco</filename>.</para>
2236 <para>oder etwas detaillierter:</para>
2238 <para>Es wird eine Datei <filename>sample.lco</filename> erstellt
2239 und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
2240 ist dies die Datei die für die firmenspezifischen Anpassungen
2241 gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist,
2242 wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle
2243 über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und
2244 <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung
2245 über eine <filename>*.lco</filename>-Datei, die letztlich auf
2246 <filename>letter.lco</filename> verlinkt ist ist aber auch
2249 <para>Es wird eine Datei <filename>sample_head.pdf</filename> mit
2250 ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
2251 verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage.
2252 Schau Dir nach Abschluss der Installation die Datei
2253 <filename>sample_head.pdf</filename> an und erstelle ein
2254 entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
2255 Template Verzeichniss ablegen und statt
2256 <filename>sample_head.pdf</filename> nach
2257 <filename>letter_head.pdf</filename> verlinken.</para>
2259 <para>Letzlich muss <filename>letter_head.pdf</filename> auf das
2260 passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
2263 <para>Es wird eine Datei <filename>mydata.tex.example</filename>
2264 ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
2265 ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das
2266 Land verwendet. Die Datei muss also nicht angefasst werden. Die
2267 anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit
2268 nicht im öffentlichen Zweig).</para>
2270 <para>Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
2271 sollten über die Hintergrund-PDF-Datei oder die
2272 <filename>*.lco</filename>-Datei erfolgen.</para>
2275 <sect3 id="f-tex-Funktionsübersicht">
2276 <title>f-tex Funktionsübersicht</title>
2278 <para>Das Konzept von kivitendo sieht vor, für jedes Dokument
2279 (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
2280 LaTeX-Vorlage vorzuhalten, dies ist sehr wartungsunfreundlich. Auch
2281 das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
2282 bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen
2283 aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
2284 briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
2285 LaTeX-Vorlage verwendet, welche über Codeweichen die Besonderheiten
2286 der jeweiligen Dokumente berücksichtigt:</para>
2290 <para>Tabellen mit oder ohne Preis</para>
2294 <para>Sprache der Tabellenüberschriften etc.</para>
2298 <para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
2299 Angebotsnummer)</para>
2303 <para>Darstellung von Brutto oder Netto-Preisen in der
2304 Auflistung (Endverbraucher versus gewerblicher Kunde)</para>
2308 <para>Nachteil:</para>
2310 <para>LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei
2311 <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
2312 diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder
2313 geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch
2314 innerhalb der Tabellendarstellung gut persönliche Anpassungen
2315 vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell
2316 heftig in den Fuss schiessen.</para>
2318 <para>Wer nicht so tief in die Materie einsteigen will oder leicht
2319 zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
2320 mitglieferten Datei <filename>sample_head.pdf</filename> erstellen,
2321 und sich an der Form der dargestellten Tabellen, wie sie
2322 ausgeliefert werden, erfreuen.</para>
2324 <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine,
2325 kontinuierliche Schritte gehen.</para>
2328 <sect3 id="f-tex-Bruttopreise">
2329 <title>Bruttopreise für Endverbraucher</title>
2331 <para>Der auszuweisende Bruttopreis wird innerhalb der
2332 LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen
2333 "alle Preise Brutto" auszuwählen, aber:</para>
2337 <para>hierfür müssen die Preise auch in Brutto in der Datenbank
2338 stehen (ja - das lässt sich über die Preisgruppen und die
2339 Zuordung einer Default-Preisgruppe handhaben)</para>
2343 <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses
2344 Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
2345 Endverbraucher als auch Gewerbekunden beliefert, der eigentliche
2350 <para>Es gibt mit f-tex eine weitere Alternative. Die Information ob
2351 Brutto oder Nettorechnung wird mit den Zahlarten verknüpft.
2352 Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben
2353 werden sollen, enden mit "_E" (für Endverbraucher). Falls identische
2354 Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt
2355 man diese einfach doppelt an (einmal mit der Namensendung "_E").
2360 <para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist
2361 nicht mehr fix mit einer Preisliste verbunden.</para>
2365 <para>Die Default-Zahlart kann im Kundendatensatz hinterlegt
2366 werden, und man muss nicht mehr daran denken, "alle Preise
2367 Netto" auszuwählen.</para>
2371 <para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen
2372 werden, kann direkt beim Drucken revidiert werden, ohne dass
2373 sich der Auftragswert ändert.</para>
2378 <sect3 id="f-tex-lieferadressen">
2379 <title>Lieferadressen</title>
2381 <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen
2382 im Adressfeld zum Einsatz. Wenn die
2383 <varname>shipto*</varname>-Variable leer ist, wird die entsprechende
2384 Adressvariable eingesetzt. Wenn also die Lieferadresse in Straße,
2385 Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
2386 Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert
2387 der Hauptadresse angezeigt.</para>
2391 <sect2 id="Vorlagen-rev-odt">
2392 <title>Der Druckvorlagensatz rev-odt</title>
2394 <para>Hierbei handelt es sich um einen Dokumentensatz der mit
2395 odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
2396 Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
2397 Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
2398 Zürich erstellt und werden laufend aktualisiert. Ein paar der
2399 Formulierungen in den Druckvorlagen entsprechen dem Schweizer
2400 Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
2402 <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
2403 KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
2404 Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
2405 entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
2406 wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
2407 handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
2409 <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
2410 den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
2411 if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
2412 und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
2413 die vom Parser nicht korrekt gelesen werden kann.</para>
2415 <para>Mahnungen können unter folgenden Einschränkungen mit den
2416 odt-Vorlagen im Vorlagensatz rev-odt erzeugt werden:</para>
2420 <para>als Druckoption steht nur 'PDF(OpenDocument/OASIS)' zur
2421 Verfügung, das heisst, die Mahnungen werden als PDF-Datei
2426 <para>für jede Rechnung muss eine eigene Mahnung erzeugt werden
2427 (auch wenn bei einzelnen KundInnen mehrere überfällige Rechnungen
2428 vorhanden sind).</para>
2432 <para>Mehrere Mahnungen für eine Kundin / einen Kunden werden zu einer
2433 PDF-Datei zusammengefasst</para>
2435 <para>Die Vorlagen zahlungserinnerung.odt sowie mahnung.odt sind für
2436 das Erstellen einer Zahlungserinnerung bzw. Mahnung selbst vorgesehen,
2437 die Vorlage mahnung_invoice.odt für das Erstellen einer Rechnung über
2438 die verrechneten Mahngebühren und Verzugszinsen.</para>
2440 <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
2441 odt-Vorlagen bei Briefen und Pflichtenheften einzusetzen.
2442 Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
2444 <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
2445 empfang@revamp-it.ch</para>
2448 <sect2 id="allgemeine-hinweise-zu-latex">
2449 <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
2451 <para>In den allermeisten Installationen sollte das Drucken jetzt
2452 schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
2453 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
2454 Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
2455 sind zum Beispiel:</para>
2459 <para>! LaTeX Error: File `eurosym.sty' not found. Die
2460 entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
2461 allem bei Vorlagen aus der Community auf. Installieren Sie die
2462 entsprechenden Pakete.</para>
2466 <para>! Package inputenc Error: Unicode char \u8:... set up for
2467 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
2468 einer Standardinstallation exotische utf8 Zeichen zu drucken.
2469 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
2470 diversen Tricks dazu gebracht werden andere Zeichen zu
2471 akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
2476 <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
2477 Templates, heißt das normalerweise, dass das LaTeX Binary nicht
2478 gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
2479 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
2480 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
2483 <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
2484 verifizieren lässt:</para>
2488 <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
2489 "keep_temp_files" auf 1</para>
2491 <para><programlisting>keep_temp_files = 1;</programlisting></para>
2495 <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
2499 <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
2503 <para>wechsel in das users Verzeichnis von kivitendo</para>
2505 <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
2509 <para>LaTeX Suchpfad anpassen:</para>
2511 <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
2515 <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
2518 <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
2520 <para>Es sollte die letzte Datei ganz unten sein</para>
2524 <para>für besseren Hinweis auf Fehler texdatei nochmals
2527 <para><programlisting>pdflatex ./1*.tex</programlisting></para>
2529 <para>in der *.tex datei nach dem Fehler suchen.</para>
2535 <sect1 id="OpenDocument-Vorlagen">
2536 <title>OpenDocument-Vorlagen</title>
2538 <para>kivitendo unterstützt die Verwendung von Vorlagen im
2539 OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2)
2540 erzeugen. kivitendo kann dabei sowohl neue OpenDocument-Dokumente als
2541 auch aus diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
2542 OpenDocument-Vorlagen zu aktivieren muss in der Datei
2543 <filename>config/kivitendo.conf</filename> die Variable
2544 <literal>opendocument</literal> im Abschnitt
2545 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
2546 Dieses ist die Standardeinstellung.</para>
2548 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
2549 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
2550 LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt
2551 werden, so muss neben LibreOffice oder OpenOffice auch der “X virtual
2552 frame buffer” (xvfb) installiert werden. Bei Debian ist er im Paket
2553 “xvfb” enthalten. Andere Distributionen enthalten ihn in anderen
2556 <para>Nach der Installation müssen in der Datei
2557 <filename>config/kivitendo.conf</filename> im Abschnitt
2558 <literal>applications</literal> zwei weitere Variablen angepasst
2561 <para><literal>openofficeorg_writer</literal> muss den vollständigen
2562 Pfad zu LibreOffice oder OpenOffice enthalten. Dabei dürfen keine
2563 Anführungszeichen eingesetzt werden.</para>
2565 <para>Beispiel für Debian oder Ubuntu:</para>
2567 <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
2569 <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
2572 <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
2573 LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die
2574 benutzt wird, wenn die Variable <literal>$openofficeorg_daemon</literal>
2575 gesetzt ist, startet ein LibreOffice oder OpenOffice, das auch nach der
2576 Umwandlung des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen
2577 wird dann diese laufende Instanz benutzt. Der Vorteil ist, dass die Zeit
2578 zur Umwandlung deutlich reduziert wird, weil nicht für jedes Dokument
2579 ein LibreOffice bzw. OpenOffice gestartet werden muss. Der Nachteil ist,
2580 dass diese Methode Python und die Python-UNO-Bindings benötigt, die
2581 Bestandteil von LibreOffice bzw. OpenOffice sind.</para>
2584 <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
2585 normalerweise der Python-Interpreter
2586 <filename>/usr/bin/python</filename> benutzt. Sollte dies nicht der
2587 richtige sein, so kann man mit zwei Konfigurationsvariablen
2588 entscheiden, welcher Python-Interpreter genutzt wird. Mit der Option
2589 <literal>python_uno</literal> aus dem Abschnitt
2590 <literal>applications</literal> wird der Interpreter selber
2591 festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
2592 <literal>/usr/bin/python</literal>.</para>
2594 <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
2595 neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
2596 z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
2597 OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
2598 <literal>python_uno_path</literal> und befindet sich im Abschnitt
2599 <literal>environment</literal>. Sie ist standardmäßig leer. Werden
2600 hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
2601 voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
2602 über die Umgebungsvariable <literal>PYTHONPATH</literal>
2606 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
2607 wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet und
2608 die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses Makro muss
2609 in der Dokumentenvorlage enthalten sein und
2610 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
2611 ‘<literal>templates/print/rev-odt/invoice.odt</literal>’ enthält ein
2612 solches Makro, das in jeder anderen Dokumentenvorlage ebenfalls
2613 enthalten sein muss.</para>
2615 <para>Als letztes muss herausgefunden werden, welchen Namen OpenOffice
2616 bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen gibt.
2617 Unter Debian ist dies momentan <literal>~/.config/libreoffice</literal>.
2618 kivitendo verwendet das Verzeichnis
2619 <literal>users/.openoffice.org2</literal>. Eventuell muss dieses
2620 Verzeichnis umbenannt werden.</para>
2622 <para>Dieses Verzeichnis, wie auch das komplette
2623 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
2624 sein. Dieses wurde bereits erledigt (siehe <xref
2625 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber erneut
2626 überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.</para>
2629 <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
2631 <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
2632 Aufgaben erfüllen.</para>
2634 <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
2635 role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
2636 Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
2637 benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
2638 Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
2639 zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
2640 Anpassungen aufgeführt</emphasis>):</para>
2643 <title>Bezeichnung der Vorlagen</title>
2645 <para>Rechnung: invoice_besr.odt, Auftrag:
2646 sales_order_besr.odt</para>
2650 <title>Vorbereitungen im Adminbereich</title>
2652 <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
2653 Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
2654 Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
2655 ein Drucker eingerichtet werden:</para>
2659 <para>Druckeradministration → Drucker hinzufügen</para>
2663 <para>Mandant wählen</para>
2667 <para>Druckerbeschreibung → aussagekräftiger Text: wird in der
2668 Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B. mit
2669 Einzahlungsschein Bank xy)</para>
2673 <para>Druckbefehl → beliebiger Text (hat für das Erzeugen von
2674 Aufträgen oder Rechnungen als odt-Datei keine Bedeutung, darf
2675 aber nicht leer sein)</para>
2679 <para>Vorlagenkürzel → besr bzw. selbst gewähltes Vorlagensuffix
2680 (muss genau der Zeichenfolge entsprechen, die zwischen
2681 "invoice_" bzw. "sales_order_" und ".odt" steht.)</para>
2685 <para>speichern</para>
2691 <title>Benutzereinstellungen</title>
2693 <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
2694 im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
2695 dies persönlich für sich bei den Benutzereinstellungen
2696 konfigurieren:</para>
2700 <para>Programm → Benutzereinstellungen → Druckoptionen</para>
2704 <para>Standardvorlagenformat → OpenDocument/OASIS</para>
2708 <para>Standardausgabekanal → Bildschirm</para>
2712 <para>Standarddrucker → gewünschte Druckerbeschreibung auswählen
2713 (z.B. mit Einzahlungsschein Bank xy)</para>
2717 <para>Anzahl Kopien → leer</para>
2721 <para>speichern</para>
2727 <title>Aufbau und nötige Anpassungen der Vorlagen</title>
2729 <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
2730 aus dem von kivitendo erzeugten odt-Dokument die korrekte
2731 Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
2732 OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
2737 <para>Für den Einzahlungsschein ist die letzte Seite des
2738 Dokuments reserviert</para>
2742 <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
2743 Zeile mit folgenden Angaben (<emphasis
2744 role="bold">Bank-Konto-Identifikationsnummer und
2745 Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
2746 Bank angepasst werden</emphasis>):<itemizedlist>
2748 <para>DDDREF: 4 Werte zum Bilden der Referenznummer
2749 (jeweils durch einen Leerschlag getrennt): <itemizedlist>
2751 <para>erster Wert: <emphasis
2752 role="bold">Bank-Konto-Identifikation</emphasis>
2753 (nur Ziffern, maximal 6), <emphasis role="bold">muss
2754 angepasst werden</emphasis>.</para>
2758 <para>zweiter Wert: <%customernumber%>
2759 (Kundennummer: nur Ziffern, maximal 6)</para>
2763 <para>dritter Wert: <%ordnumber%>
2764 (Auftragsnummer bei Auftragsvorlage
2765 sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
2766 führende Buchstaben werden vom Makro entfernt</para>
2770 <para>vierter Wert: <%invnumber%>
2771 (Rechnungsnummer bei Rechnungsvorlage
2772 invoice_besr.odt, sonst 0) maximal 7 Ziffern,
2773 führende Buchstaben werden vom Makro entfernt</para>
2775 </itemizedlist></para>
2779 <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
2780 Bank, muss angepasst werden</emphasis>.</para>
2784 <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
2785 falls Einzahlungsschein ohne Betrag</para>
2789 <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
2791 </itemizedlist></para>
2795 <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
2796 der Name und die Adresse der Bank, die Postkonto-Nummer der
2797 Bank, sowie der eigene Firmenname und die Firmenadresse
2798 angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
2799 sich die Positionen der Postkonto-Nummern der Bank, sowie der
2800 Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
2806 <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
2807 ändernde Einträge in rot</screeninfo>
2811 <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
2818 <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
2819 odt-Rechnung (analog bei Auftrag)</title>
2821 <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
2822 OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
2823 Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
2824 den Benutzereinstellungen als persönlicher Standard gewählt
2829 <title>Makroeinstellungen in LibreOffice anpassen</title>
2831 <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
2832 die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
2833 ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
2834 angepasst werden:</para>
2838 <para>Extras → Optionen → Sicherheit → Makrosicherheit</para>
2842 <para>Sicherheitslevel auf "Mittel" einstellen (Diese
2843 Einstellung muss auf jedem Computer durchgeführt werden, mit dem
2844 von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
2849 <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
2850 der entsprechenden Nachfrage "Makros ausführen"
2853 <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
2854 so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
2855 ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
2856 Vorlagen sind keine speziellen Einstellungen in LibreOffice
2864 <sect1 id="nomenclature">
2865 <title>Nomenklatur</title>
2867 <sect2 id="booking.dates">
2868 <title>Datum bei Buchungen</title>
2870 <para>Seit der Version 3.5 werden für Buchungen in kivitendo
2871 einheitlich folgende Bezeichnungen verwendet:</para>
2875 <para><option>Erfassungsdatum</option> (en: <option>Entry
2876 Date</option>, code: <option>Gldate</option>)</para>
2878 <para>bezeichnet das Datum, an dem die Buchung in kivitendo
2879 erfasst wurde.</para>
2883 <para><option>Buchungsdatum</option> (en: <option>Booking
2884 Date</option>, code: <option>Transdate</option>)</para>
2886 <para>bezeichnet das buchhaltungstechnisch für eine Buchung
2887 relevante Datum</para>
2889 <para>Das <option>Rechnungsdatum</option> bei Verkaufs- und
2890 Einkaufsrechnungen entspricht dem Buchungsdatum. Das heisst, in
2891 Berichten wie dem Buchungsjournal, in denen eine Spalte
2892 <option>Buchungsdatum</option> angezeigt werden kann, erscheint
2893 hier im Fall von Rechnungen das Rechnungsdatum.</para>
2897 <para>Bezieht sich ein verbuchter Beleg auf einen Zeitpunkt, der
2898 nicht mit dem Buchungsdatum übereinstimmt, so kann dieses Datum
2899 momentan in kivitendo nur unter Bemerkungen erfasst werden.</para>
2901 <para>Möglicherweise wird für solche Fälle in einer späteren
2902 Version von kivitendo ein dritter Datumswert für Buchungen
2903 erstellt. (Beispiel: Einkaufsbeleg stammt aus einem früheren Jahr,
2904 das bereits buchhaltungstechnisch abgeschlossen wurde, und muss
2905 deshalb später verbucht werden.)</para>
2911 <sect1 id="config.eur">
2912 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
2915 <sect2 id="config.eur.introduction"
2916 xreflabel="Einführung in die Konfiguration zur EUR">
2917 <title>Einführung</title>
2919 <para>kivitendo besaß bis inklusive Version 2.6.3 einen
2920 Konfigurationsparameter namens <varname>eur</varname>, der sich in der
2921 Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
2922 noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
2923 für alle Mandanten, die in dieser Installation benutzt wurden.</para>
2925 <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
2926 die Mandantendatenbank verschoben und dabei auch gleich in drei
2927 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
2928 steuern lässt.</para>
2931 <sect2 id="config.eur.parameters"
2932 xreflabel="Konfigurationsparameter für EUR">
2933 <title>Konfigurationsparameter</title>
2935 <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
2936 Versteuerungsart und die Warenbuchungsmethode regeln:</para>
2940 <term><varname>profit_determination</varname></term>
2943 <para>Dieser Parameter legt die Berechnungsmethode für die
2944 Gewinnermittlung fest. Er enthält entweder
2945 <literal>balance</literal> für
2946 Betriebsvermögensvergleich/Bilanzierung oder
2947 <literal>income</literal> für die
2948 Einnahmen-Überschuss-Rechnung.</para>
2953 <term><varname>accounting_method</varname></term>
2956 <para>Dieser Parameter steuert die Buchungs- und
2957 Berechnungsmethoden für die Versteuerungsart. Er enthält
2958 entweder <literal>accrual</literal> für die Soll-Versteuerung
2959 oder <literal>cash</literal> für die Ist-Versteuerung.</para>
2964 <term><varname>inventory_system</varname></term>
2967 <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
2968 enthält entweder <literal>perpetual</literal> für die
2969 Bestandsmethode oder <literal>periodic</literal> für die
2970 Aufwandsmethode.</para>
2975 <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
2976 <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
2977 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
2978 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
2979 Bestandsmethode.</para>
2981 <para>Die Konfiguration "<varname>eur</varname>" unter
2982 <varname>[system]</varname> in der <link
2983 linkend="config.config-file">Konfigurationsdatei</link>
2984 <filename>config/kivitendo.conf</filename> wird nun nicht mehr
2985 benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
2988 <sect2 id="config.eur.setting-parameters">
2989 <title>Festlegen der Parameter</title>
2991 <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
2992 der Admininstration können diese Optionen nun unabhängig voneinander
2993 eingestellt werden.</para>
2995 <para>Für die Schweiz sind folgende Einstellungen üblich:
2998 <para>Sollversteuerung</para>
3002 <para>Aufwandsmethode</para>
3006 <para>Bilanzierung</para>
3008 </itemizedlist> Diese Einstellungen werden automatisch beim
3009 Erstellen einer neuen Datenbank vorausgewählt, wenn in
3010 <filename>config/kivitendo.conf</filename> unter
3011 <varname>[system]</varname> <literal>default_manager = swiss</literal>
3012 eingestellt ist.</para>
3014 <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
3015 Variablen werden so gesetzt, daß sich an der Funktionalität nichts
3018 <para>Die aktuelle Konfiguration wird unter Nummernkreise und
3019 Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
3020 angezeigt. Unter <guimenu>System</guimenu> →
3021 <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
3022 Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
3023 Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
3024 verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
3025 auch <link linkend="config.eur.inventory-system-perpetual">
3026 Bemerkungen zur Bestandsmethode</link>).</para>
3029 <sect2 id="config.eur.inventory-system-perpetual">
3030 <title>Bemerkungen zur Bestandsmethode</title>
3032 <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
3033 funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
3034 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
3035 werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
3036 anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
3037 der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
3038 Einkaufsrechnungen berechnet wird.</para>
3040 <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
3041 wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
3042 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
3046 <sect2 id="config.eur.knonw-issues">
3047 <title>Bekannte Probleme</title>
3049 <para>Bei bestimmten Berichten kann man derzeit noch inviduell
3050 einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
3051 werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
3052 Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
3053 die Konfigurationsvariable
3054 <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
3057 <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
3058 Optionen bewirken, z.B. mit zwei Standardfällen.</para>
3062 <sect1 id="config.skr04-update-3804">
3063 <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
3065 <sect2 id="config.skr04-update-3804.introduction">
3066 <title>Einführung</title>
3068 <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
3069 Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
3070 kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
3071 erstellt und die Steuereinstellungen korrekt einstellt. Hat der
3072 Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
3073 Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
3074 Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
3075 vielleicht schon selbst geholfen hat und mit seinen Änderungen
3076 zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
3077 ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
3078 Screenshots dargestellt.</para>
3080 <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
3081 USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
3082 dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
3083 und diese Buchungen sollten entsprechend kontrolliert werden.</para>
3086 <sect2 id="config.skr04-update-3804.create-chart">
3087 <title>Konto 3804 manuell anlegen</title>
3089 <para>Die folgenden Schritte sind notwendig, um das Konto manuell
3090 anzulegen und zu konfigurieren. Zuerst wird in
3091 <guimenu>System</guimenu> → <guisubmenu>Kontenübersicht</guisubmenu> →
3092 <guimenuitem>Konto erfassen</guimenuitem> das Konto angelegt.</para>
3095 <screeninfo>Konto 3804 erfassen</screeninfo>
3099 <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
3104 <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
3105 werden. Dazu unter <guimenu>System</guimenu> →
3106 <guisubmenu>Steuern</guisubmenu> →
3107 <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
3108 13 auswählen und ihn wie im folgenden Screenshot angezeigt
3112 <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
3116 <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
3121 <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
3122 Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
3123 <guisubmenu>Steuern</guisubmenu> → <guimenuitem>Erfassen</guimenuitem>
3124 auswählen und die Werte aus dem Screenshot übernehmen.</para>
3127 <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
3131 <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
3136 <para>Als Nächstes sind alle Konten anzupassen, die als
3137 Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
3138 Steuerautomatik auf 3804 bekommen. Dies betrifft in der
3139 Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
3140 müssen Sie dazu unter <guimenu>System</guimenu> →
3141 <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
3142 anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
3143 wie im Screenshot gezeigt vornehmen.</para>
3146 <screeninfo>Konto 4315 anpassen</screeninfo>
3150 <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
3155 <para>Als Letztes sollte die Steuerliste unter
3156 <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
3157 <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
3158 Vergleich der Screenshot.</para>
3161 <screeninfo>Steuerliste vergleichen</screeninfo>
3165 <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
3172 <sect1 id="config.bilanz">
3173 <title>Verhalten des Bilanzberichts</title>
3175 <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
3176 Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
3177 monatsweise führt dies zu falschen Werten.</para>
3179 <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
3180 einstellen indem man:</para>
3184 <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
3189 <para>immer den Jahresanfang nimmt (1.1. relativ zum
3194 <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
3196 <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3199 <para>- oder mit "alle Buchungen" als Alternative"</para>
3203 <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
3208 <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
3212 <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
3213 ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
3214 = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
3215 Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
3216 durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
3217 sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
3218 und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
3219 den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
3220 Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
3221 Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
3222 Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
3223 Erfolgsrechnung.</para>
3226 <sect1 id="config.erfolgsrechnung">
3227 <title>Erfolgsrechnung</title>
3229 <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht
3230 <emphasis role="bold"> Erfolgsrechnung</emphasis>.</para>
3232 <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter
3233 Features an- oder abgeschaltet werden. Mit der Einstellung
3234 <varname>default_manager = swiss </varname> in der
3235 <filename>config/kivitendo.conf</filename> wird beim neu Erstellen einer
3236 Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü
3237 <guimenu>Berichte </guimenu> ausgewählt und ersetzt dort die GUV.</para>
3239 <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche
3240 Aufwands- und Erlöskonten einzeln aufgelistet (analog zur Bilanz),
3241 sortiert nach ERTRAG und AUFWAND.</para>
3243 <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der
3244 Erfolgsrechnung erscheinen soll, unter <varname>Sonstige
3245 Einstellungen/Erfolgsrechnung</varname> entweder
3246 <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal>
3247 ausgewählt werden.</para>
3249 <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal>
3250 ausgewählt, so wird dieses Konto als Aufwandsminderung unter AUFWAND
3253 <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal>
3254 ausgewählt, so wird dieses Konto als Ertragsminderung unter ERTRAG
3257 <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft
3258 zusätzlich die Erfolgsrechnung als Bericht verwendet werden, so müssen
3259 die Einstellungen zu allen Erlös- und Aufwandskonten unter
3260 <varname>Sonstige Einstellungen/Erfolgsrechnung</varname> überprüft und
3261 allenfalls neu gesetzt werden.</para>
3264 <sect1 id="config.rounding">
3265 <title>Rundung in Verkaufsbelegen</title>
3267 <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert
3268 von 5 Rappen (0.05 CHF).</para>
3270 <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer
3271 Genauigkeit von 0.01 CHF verwendet werden können, ist es trotzdem nach
3272 wie vor üblich, Rechnungen mit auf 0.05 CHF gerundeten Beträgen
3273 auszustellen.</para>
3275 <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine
3276 solche Rundung pro Mandant / Datenbank festgelegt werden.</para>
3278 <para>Die Einstellung wird beim Erstellen der Datenbank bei
3279 <literal>Genauigkeit</literal> festgelegt. Sie kann anschliessend über
3280 das Webinterface von kivitendo nicht mehr verändert werden.</para>
3282 <para>Abhängig vom Wert für <varname>default_manager</varname> in
3283 <filename>config/kivitendo.conf</filename> werden dabei folgende Werte
3284 voreingestellt:</para>
3288 <para>0.05 (default_manager = swiss)</para>
3292 <para>0.01 (default_manager = german)</para>
3296 <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
3297 </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
3299 <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
3300 und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet, wenn
3301 dieser nicht der eingestellten Genauigkeit entspricht.</para>
3303 <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
3304 automatisch auf die in der Mandantenkonfiguration festgelegten
3305 Standardkonten für Rundungserträge bzw. Rundungsaufwendungen
3308 <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr
3311 <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
3312 <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
3313 <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
3315 <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege in
3316 anderen Währungen als der Standardwährung erstellt, so muss in kivitendo
3317 ab Version 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
3319 <para>Das heisst, Firmen in der Schweiz, die teilweise
3320 Verkaufsrechnungen in Euro oder anderen Währungen erstellen wollen,
3321 müssen beim Erstellen der Datenbank als Genauigkeit 0.01 wählen und
3322 können zur Zeit die 5er Rundung noch nicht nutzen.</para>
3325 <sect1 id="config.client">
3326 <title>Einstellungen pro Mandant</title>
3328 <para>Einige Einstellungen können von einem Benutzer mit dem <link
3329 linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
3330 der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
3331 Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
3332 Die Einstellungen sind unter <guimenu>System</guimenu> →
3333 <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
3335 <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
3336 Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
3337 geändert werden (siehe auch <link
3338 linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
3339 Bestandsmethode</link>).</para>
3341 <para>Die Einstellungen <literal>show_bestbefore</literal> und
3342 <literal>payments_changeable</literal> aus dem Abschnitt
3343 <literal>features</literal> und die Einstellungen im Abschnitt
3344 <literal>datev_check</literal> (sofern schon vorhanden) der <link
3345 linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
3346 bei einem Datenbankupdate einer älteren Version automatisch übernommen.
3347 Diese Einträge können danach aus der Konfigurationsdatei entfernt
3351 <sect1 id="kivitendo-ERP-verwenden">
3352 <title>kivitendo ERP verwenden</title>
3354 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
3355 folgender URL erreichbar:</para>
3358 url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
3360 <para>Die Administrationsseite erreichen Sie unter:</para>
3363 url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
3367 <chapter id="features" xreflabel="Features und Funktionen">
3368 <title>Features und Funktionen</title>
3370 <sect1 id="features.periodic-invoices"
3371 xreflabel="Wiederkehrende Rechnungen">
3372 <title>Wiederkehrende Rechnungen</title>
3374 <sect2 id="features.periodic-invoices.introduction"
3375 xreflabel="Einführung in wiederkehrende Rechnungen">
3376 <title>Einführung</title>
3378 <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
3379 und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
3380 Die konfigurierten Aufträge werden später automatisch in Rechnungen
3381 umgewandelt, so als ob man den Workflow benutzen würde, und auch die
3382 Auftragsnummer wird übernommen, sodass alle wiederkehrenden
3383 Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
3384 wiederzufinden sind.</para>
3387 <sect2 id="features.periodic-invoices.configuration"
3388 xreflabel="Konfiguration von wiederkehrenden Rechnungen">
3389 <title>Konfiguration</title>
3391 <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
3392 findet sich beim Bearbeiten des Auftrags ein neuer Knopf
3393 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
3394 Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
3395 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
3398 <para>Folgende Parameter kann man konfigurieren:</para>
3405 <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
3406 erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
3407 eines neuen Monats).</para>
3409 <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
3410 wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
3411 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
3412 nächsten Periodenwechsel für alle Perioden, seit der letzten
3413 aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
3414 verhindern, muss man vorher das Startdatum neu setzen.</para>
3416 <para>Für gekündigte Aufträge werden nie mehr Rechnungen
3417 erstellt. Man kann sich diese Aufträge aber gesondert in den
3418 Berichten anzeigen lassen.</para>
3423 <term>Periodizität</term>
3426 <para>Ob monatlich, quartalsweise oder jährlich auf neue
3427 Rechnungen überprüft werden soll. Für jede Periode seit dem
3428 Startdatum wird überprüft, ob für die Periode (beginnend immer
3429 mit dem ersten Tag der Periode) schon eine Rechnung erstellt
3430 wurde. Unter Umständen können bei einem Startdatum in der
3431 Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
3436 <term>Buchen auf</term>
3439 <para>Das Forderungskonto, in der Regel "Forderungen aus
3440 Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
3441 Buchungsgruppen der betreffenden Waren.</para>
3446 <term>Startdatum</term>
3449 <para>ab welchem Datum auf Rechnungserstellung geprüft werden
3455 <term>Enddatum</term>
3458 <para>ab wann keine Rechnungen mehr erstellt werden
3464 <term>Automatische Verlängerung um x Monate</term>
3467 <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
3468 eingetragenen Enddatums weiterhin erstellt werden, so kann man
3469 hier die Anzahl der Monate eingeben, um die das Enddatum
3470 automatisch nach hinten geschoben wird.</para>
3475 <term>Drucken</term>
3478 <para>Sind Drucker konfiguriert, so kann man sich die erstellten
3479 Rechnungen auch gleich ausdrucken lassen.</para>
3484 <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
3485 Informationen zu den erstellten Rechnungen verschickt werden.
3486 Konfiguriert wird dies in der <link
3487 linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
3488 <filename>config/kivitendo.conf</filename> im Abschnitt
3489 <varname>[periodic_invoices]</varname>.</para>
3492 <sect2 id="features.periodic-invoices.variables">
3493 <title>Spezielle Variablen</title>
3495 <para>Um die erzeugten Rechnungen individualisieren zu können, werden
3496 beim Umwandeln des Auftrags in eine Rechnung einige speziell
3497 formatierte Variablen durch für die jeweils aktuelle
3498 Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
3499 den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
3500 die Syntax <literal><%variablenname%></literal>.</para>
3502 <para>Sofern es sich um eine Datumsvariable handelt, kann das
3503 Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
3504 Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
3505 <literal><%variablenname FORMAT=Formatinformation%></literal>.
3506 Die zur verfügung stehenden Formatinformationen werden unten genauer
3509 <para>Diese Variablen können auch beim automatischen Versand der
3510 erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
3511 Feldern für den Betreff oder die Nachricht verwendet werden.</para>
3513 <para>Diese Variablen werden in den folgenden Elementen des Auftrags
3518 <para>Bemerkungen</para>
3522 <para>Interne Bemerkungen</para>
3526 <para>Vorgangsbezeichnung</para>
3530 <para>In den Beschreibungs- und Langtextfeldern aller
3535 <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
3539 <term><varname><%current_quarter%></varname>,
3540 <varname><%previous_quarter%></varname>,
3541 <varname><%next_quarter%></varname></term>
3544 <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
3545 zwischen <literal>1</literal> und <literal>4</literal>.</para>
3550 <term><varname><%current_month%></varname>,
3551 <varname><%previous_month%></varname>,
3552 <varname><%next_month%></varname></term>
3555 <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
3556 <literal>1</literal> und <literal>12</literal>.</para>
3561 <term><varname><%current_month_long%></varname>,
3562 <varname><%previous_month_long%></varname>,
3563 <varname><%next_month_long%></varname></term>
3566 <para>Aktueller, vorheriger und nächster Monat als Name
3567 (<literal>Januar</literal>, <literal>Februar</literal>
3573 <term><varname><%current_year%></varname>,
3574 <varname><%previous_year%></varname>,
3575 <varname><%next_year%></varname></term>
3578 <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
3579 Jahreszahl (<literal>2013</literal> etc.).</para>
3584 <term><varname><%period_start_date%></varname>,
3585 <varname><%period_end_date%></varname></term>
3588 <para>Formatiertes Datum des ersten und letzten Tages im
3589 Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
3590 ersten Quartal von 2013 wären dies der
3591 <literal>01.01.2013</literal> und
3592 <literal>31.03.2013</literal>).</para>
3597 <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
3598 Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
3599 dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
3600 durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
3605 <term><varname>%a</varname></term>
3608 <para>Der abgekürzte Wochentagsname.</para>
3613 <term><varname>%A</varname></term>
3616 <para>Der ausgeschriebene Wochentagsname.</para>
3621 <term><varname>%b</varname></term>
3624 <para>Der abgekürzte Monatsname.</para>
3629 <term><varname>%B</varname></term>
3632 <para>Der ausgeschriebene Monatsname.</para>
3637 <term><varname>%C</varname></term>
3640 <para>Das Jahrhundert (Jahr/100) als eine zweistellige
3646 <term><varname>%d</varname></term>
3649 <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
3654 <term><varname>%D</varname></term>
3657 <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
3662 <term><varname>%e</varname></term>
3665 <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
3666 werden führende Nullen durch Leerzeichen ersetzt.</para>
3671 <term><varname>%F</varname></term>
3674 <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
3679 <term><varname>%j</varname></term>
3682 <para>Der Tag im Jahr als Zahl zwischen 001 und 366
3688 <term><varname>%m</varname></term>
3691 <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
3696 <term><varname>%u</varname></term>
3699 <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
3700 die 1 dem Montag entspricht.</para>
3705 <term><varname>%U</varname></term>
3708 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3709 wobei der erste Sonntag im Jahr das Startdatum von Woche 01
3715 <term><varname>%V</varname></term>
3718 <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
3719 inklusive, wobei Woche 01 die erste Woche, von der mindestens
3720 vier Tage im Jahr liegen; Montag ist erster Tag der
3726 <term><varname>%w</varname></term>
3729 <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
3730 die 0 dem Sonntag entspricht.</para>
3735 <term><varname>%W</varname></term>
3738 <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
3739 wobei der erste Montag im Jahr das Startdatum von Woche 01
3745 <term><varname>%y</varname></term>
3748 <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
3754 <term><varname>%Y</varname></term>
3757 <para>Das Jahr als vierstellige Zahl.</para>
3762 <term><varname>%%</varname></term>
3765 <para>Das Prozentzeichen selber.</para>
3770 <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
3771 bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
3772 <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
3773 bis <%period_end_date FORMAT=%m/%Y%></literal></para>
3776 <sect2 id="features.periodic-invoices.reports">
3777 <title>Auflisten</title>
3779 <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
3780 Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
3781 Rechnungen inaktiv", mit denen man sich einen Überglick über die
3782 wiederkehrenden Rechnungen verschaffen kann.</para>
3785 <sect2 id="features.periodic-invoices.task-server">
3786 <title>Erzeugung der eigentlichen Rechnungen</title>
3788 <para>Die zeitliche und periodische Überprüfung, ob eine
3789 wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
3790 durch den <link linkend="config.task-server">Taskserver</link>, einen
3791 externen Dienst, der automatisch beim Start des Servers gestartet
3792 werden sollte.</para>
3795 <sect2 id="features.periodic-invoices.create-for-current-month">
3796 <title>Erste Rechnung für aktuellen Monat erstellen</title>
3798 <para>Will man im laufenden Monat eine monatlich wiederkehrende
3799 Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
3800 auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
3801 den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
3802 generiert hat. Alternativ setzt man das Startdatum auf den
3803 Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
3804 manuell über den Workflow.</para>
3808 <sect1 id="features.bank" xreflabel="bankerweiterung">
3809 <title>Bankerweiterung</title>
3811 <sect2 id="features.bank.introduction"
3812 xreflabel="Einführung in die Bankerweiterung">
3813 <title>Einführung</title>
3815 <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
3816 im Wiki und soll von dort später hierhin übernommen werden:</para>
3819 url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
3823 <sect1 id="dokumentenvorlagen-und-variablen">
3824 <title>Dokumentenvorlagen und verfügbare Variablen</title>
3826 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
3827 <title>Einführung</title>
3829 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
3830 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
3831 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
3832 <function><%variablenname%></function> verwendet wird. Für
3833 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
3835 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
3837 <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
3838 Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im Folgenden
3839 gesagte für alle Vorlagenarten.</para>
3841 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
3842 verfügbar als hier aufgelistet werden. Die meisten davon können
3843 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
3844 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
3845 diese wie folgt erhalten werden:</para>
3849 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
3850 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
3854 <para>In <filename>Form.pm</filename> die Funktion
3855 <function>parse_template</function> suchen und hier die Zeile
3856 <command>print(STDERR Dumper($self));</command> einfügen.</para>
3860 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
3861 ein PDF für eine Rechnung erzeugen.</para>
3865 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
3866 der Variablen <varname>$self</varname> in der Form <varname>'key'
3867 => 'value',</varname>. Alle <varname>key</varname>s sind
3873 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
3874 <title>Variablen ausgeben</title>
3876 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
3877 Tags geschrieben werden, also z.B.
3878 <varname><%variablenname%></varname>.</para>
3880 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
3881 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
3882 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
3883 werden die folgenden Flags unterstützt:</para>
3887 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
3888 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
3889 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
3890 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
3894 <para><option>NOESCAPE</option> unterdrückt das Escapen von
3895 Sonderzeichen für die Vorlagensprache. Wenn also in einer
3896 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
3897 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
3898 ist dieses Flag sinnvoll.</para>
3902 <para>Beispiel:</para>
3904 <programlisting><%quototal NOFORMAT%></programlisting>
3907 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
3908 <title>Verwendung in Druckbefehlen</title>
3910 <para>In der Admininstration können Drucker definiert werden. Auch im
3911 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
3912 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
3913 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
3914 <function>`...`</function> nicht zu unerwünschtem Verhalten
3917 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
3918 für das die Telefonnummer eines Ansprechpartners als Teil der
3919 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
3920 z.B. wie folgt aussehen:</para>
3922 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
3925 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
3926 xreflabel="Anfang und Ende der Tags verändern">
3927 <title>Anfang und Ende der Tags verändern</title>
3929 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
3930 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
3931 Prozentzeichen und dem Größerzeichen endet, beispielsweise
3932 <function><%customer%></function>. Da diese Form aber z.B. in
3933 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
3934 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
3935 Stil umgestellt werden.</para>
3937 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
3938 Format gültigen Kommentarzeichen anfangen, dann
3939 <function>config:</function> enthalten, die entsprechende Option
3940 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
3941 enden. Beispiel für LaTeX:</para>
3943 <programlisting>% config: tag-style=($ $)</programlisting>
3945 <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
3946 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
3947 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
3949 <programlisting><!-- config: tag-style=($ $) --></programlisting>
3952 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
3953 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
3955 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
3956 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
3957 "<filename>.ext</filename>" geeignet zu ersetzen:
3958 "<filename>.tex</filename>" für LaTeX-Vorlagen und
3959 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
3963 <term><filename>bin_list.ext</filename></term>
3966 <para>Lagerliste</para>
3971 <term><filename>check.ext</filename></term>
3979 <term><filename>invoice.ext</filename></term>
3982 <para>Rechnung</para>
3987 <term><filename>packing_list.ext</filename></term>
3990 <para>Packliste</para>
3995 <term><filename>pick_list.ext</filename></term>
3998 <para>Sammelliste</para>
4003 <term><filename>purchase_delivery_order.ext</filename></term>
4006 <para>Lieferschein (Einkauf)</para>
4011 <term><filename>purcharse_order.ext</filename></term>
4014 <para>Bestellung an Lieferanten</para>
4019 <term><filename>request_quotation.ext</filename></term>
4022 <para>Anfrage an Lieferanten</para>
4027 <term><filename>sales_delivery_order.ext</filename></term>
4030 <para>Lieferschein (Verkauf)</para>
4035 <term><filename>sales_order.ext</filename></term>
4038 <para>Bestellung</para>
4043 <term><filename>sales_quotation.ext</filename></term>
4046 <para>Angebot an Kunden</para>
4051 <term><filename>zahlungserinnerung.ext</filename></term>
4054 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
4059 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
4062 <para>Rechnung über Mahngebühren (Dateiname im Programm
4063 konfigurierbar)</para>
4069 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
4070 <title>Sprache, Drucker und E-Mail</title>
4072 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
4073 eingearbeitet. So wird aus der Vorlage
4074 <filename>sales_order.ext</filename> bei Sprache
4075 <function>de</function> und Druckerkürzel <function>lpr2</function>
4076 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
4077 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
4078 bekommen dann noch das Kürzel <filename>_email</filename>, der
4079 vollständige Vorlagenname wäre dann
4080 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
4081 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
4082 werden. Diese wird verwendet, wenn keine der anderen Varianten
4083 gefunden wird.</para>
4085 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
4086 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
4087 verschickt wird, ist:</para>
4091 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
4095 <para><filename>sales_order_de_lpr2.tex</filename></para>
4099 <para><filename>sales_order.tex</filename></para>
4103 <para><filename>default.tex</filename></para>
4107 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
4108 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
4110 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
4113 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
4114 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
4117 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
4118 xreflabel="Metainformationen zur angeforderten Vorlage">
4119 <title>Metainformationen zur angeforderten Vorlage</title>
4121 <para>Diese Variablen liefern Informationen darüber welche Variante
4122 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
4123 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
4124 Formulare einbinden möchten.</para>
4128 <term><varname>template_meta.formname</varname></term>
4131 <para>Basisname der Vorlage. Identisch mit der <link
4132 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
4133 zu den Dateinamen</link> ohne die Erweiterung. Ein
4134 Verkaufsauftrag enthält hier
4135 <constant>sales_order</constant>.</para>
4140 <term><varname>template_meta.language.description</varname></term>
4143 <para>Beschreibung der verwendeten Sprache</para>
4148 <term><varname>template_meta.language.template_code</varname></term>
4151 <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
4152 dem Kürzel das im Dateinamen verwendetet wird.</para>
4157 <term><varname>template_meta.language.output_numberformat</varname></term>
4160 <para>Zahlenformat der verwendeten Sprache in der Form
4161 "<constant>1.000,00</constant>". Experimentell! Nur
4162 interessant für Vorlagen die mit unformatierten Werten
4168 <term><varname>template_meta.language.output_dateformat</varname></term>
4171 <para>Datumsformat der verwendeten Sprache in der Form
4172 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
4173 interessant für Vorlagen die mit unformatierten Werten
4179 <term><varname>template_meta.format</varname></term>
4182 <para>Das angeforderte Format. Kann im Moment die Werte
4183 <constant>pdf</constant>, <constant>postscript</constant>,
4184 <constant>html</constant>, <constant>opendocument</constant>,
4185 <constant>opendocument_pdf</constant> und
4186 <constant>excel</constant> enthalten.</para>
4191 <term><varname>template_meta.extension</varname></term>
4194 <para>Dateierweiterung, wie im Dateinamen. Wird aus
4195 <constant>format</constant> entschieden.</para>
4200 <term><varname>template_meta.media</varname></term>
4203 <para>Ausgabemedium. Kann zur Zeit die Werte
4204 <constant>screen</constant> für Bildschirm,
4205 <constant>email</constant> für E-Mail (triggert das
4206 <constant>_email</constant> Kürzel im Dateinamen),
4207 <constant>printer</constant> für Drucker, und
4208 <constant>queue</constant> für Warteschlange enthalten.</para>
4213 <term><varname>template_meta.printer.description</varname></term>
4216 <para>Beschreibung des ausgewählten Druckers</para>
4221 <term><varname>template_meta.printer.template_code</varname></term>
4224 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
4225 dem Kürzel das im Dateinamen verwendetet wird.</para>
4230 <term><varname>template_meta.tmpfile</varname></term>
4233 <para>Datei-Prefix für temporäre Dateien.</para>
4239 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
4240 <title>Stammdaten von Kunden und Lieferanten</title>
4244 <term><varname>account_number</varname></term>
4247 <para>Kontonummer</para>
4252 <term><varname>bank</varname></term>
4255 <para>Name der Bank</para>
4260 <term><varname>bank_code</varname></term>
4263 <para>Bankleitzahl</para>
4268 <term><varname>bic</varname></term>
4271 <para>Bank-Identifikations-Code (Bank Identifier Code,
4277 <term><varname>business</varname></term>
4280 <para>Kunden-/Lieferantentyp</para>
4285 <term><varname>city</varname></term>
4293 <term><varname>contact</varname></term>
4296 <para>Kontakt</para>
4301 <term><varname>country</varname></term>
4309 <term><varname>c_vendor_id</varname></term>
4312 <para>Lieferantennummer beim Kunden (nur Kunden)</para>
4317 <term><varname>v_customer_id</varname></term>
4320 <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
4325 <term><varname>cp_email</varname></term>
4328 <para>Email des Ansprechpartners</para>
4333 <term><varname>cp_givenname</varname></term>
4336 <para>Vorname des Ansprechpartners</para>
4341 <term><varname>cp_greeting</varname></term>
4344 <para>Anrede des Ansprechpartners</para>
4349 <term><varname>cp_name</varname></term>
4352 <para>Name des Ansprechpartners</para>
4357 <term><varname>cp_phone1</varname></term>
4360 <para>Telefonnummer 1 des Ansprechpartners</para>
4365 <term><varname>cp_phone2</varname></term>
4368 <para>Telefonnummer 2 des Ansprechpartners</para>
4373 <term><varname>cp_title</varname></term>
4376 <para>Titel des Ansprechpartners</para>
4381 <term><varname>creditlimit</varname></term>
4384 <para>Kreditlimit</para>
4389 <term><varname>customeremail</varname></term>
4392 <para>Email des Kunden; nur für Kunden</para>
4397 <term><varname>customerfax</varname></term>
4400 <para>Faxnummer des Kunden; nur für Kunden</para>
4405 <term><varname>customernotes</varname></term>
4408 <para>Bemerkungen beim Kunden; nur für Kunden</para>
4413 <term><varname>customernumber</varname></term>
4416 <para>Kundennummer; nur für Kunden</para>
4421 <term><varname>customerphone</varname></term>
4424 <para>Telefonnummer des Kunden; nur für Kunden</para>
4429 <term><varname>discount</varname></term>
4437 <term><varname>email</varname></term>
4440 <para>Emailadresse</para>
4445 <term><varname>fax</varname></term>
4448 <para>Faxnummer</para>
4453 <term><varname>gln</varname></term>
4456 <para>GLN (Globale Lokationsnummer)</para>
4461 <term><varname>greeting</varname></term>
4469 <term><varname>homepage</varname></term>
4472 <para>Homepage</para>
4477 <term><varname>iban</varname></term>
4480 <para>Internationale Kontonummer (International Bank Account
4481 Number, IBAN)</para>
4486 <term><varname>language</varname></term>
4489 <para>Sprache</para>
4494 <term><varname>name</varname></term>
4497 <para>Firmenname</para>
4502 <term><varname>payment_description</varname></term>
4505 <para>Name der Zahlart</para>
4510 <term><varname>payment_terms</varname></term>
4513 <para>Zahlungskonditionen</para>
4518 <term><varname>phone</varname></term>
4521 <para>Telefonnummer</para>
4526 <term><varname>shiptocity</varname></term>
4529 <para>Stadt (Lieferadresse) <link
4530 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4535 <term><varname>shiptocontact</varname></term>
4538 <para>Kontakt (Lieferadresse) <link
4539 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4544 <term><varname>shiptocountry</varname></term>
4547 <para>Land (Lieferadresse) <link
4548 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4553 <term><varname>shiptodepartment_1</varname></term>
4556 <para>Abteilung 1 (Lieferadresse) <link
4557 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4562 <term><varname>shiptodepartment_2</varname></term>
4565 <para>Abteilung 2 (Lieferadresse) <link
4566 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4571 <term><varname>shiptoemail</varname></term>
4574 <para>Email (Lieferadresse) <link
4575 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4580 <term><varname>shiptofax</varname></term>
4583 <para>Fax (Lieferadresse) <link
4584 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4589 <term><varname>shiptogln</varname></term>
4592 <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
4593 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4598 <term><varname>shiptoname</varname></term>
4601 <para>Firmenname (Lieferadresse) <link
4602 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4607 <term><varname>shiptophone</varname></term>
4610 <para>Telefonnummer (Lieferadresse) <link
4611 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4616 <term><varname>shiptostreet</varname></term>
4619 <para>Straße und Hausnummer (Lieferadresse) <link
4620 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4625 <term><varname>shiptozipcode</varname></term>
4628 <para>Postleitzahl (Lieferadresse) <link
4629 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
4634 <term><varname>street</varname></term>
4637 <para>Straße und Hausnummer</para>
4642 <term><varname>taxnumber</varname></term>
4645 <para>Steuernummer</para>
4650 <term><varname>ustid</varname></term>
4653 <para>Umsatzsteuer-Identifikationsnummer</para>
4658 <term><varname>vendoremail</varname></term>
4661 <para>Email des Lieferanten; nur für Lieferanten</para>
4666 <term><varname>vendorfax</varname></term>
4669 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
4674 <term><varname>vendornotes</varname></term>
4677 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
4682 <term><varname>vendornumber</varname></term>
4685 <para>Lieferantennummer; nur für Lieferanten</para>
4690 <term><varname>vendorphone</varname></term>
4693 <para>Telefonnummer des Lieferanten; nur für
4699 <term><varname>zipcode</varname></term>
4702 <para>Postleitzahl</para>
4707 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
4708 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
4709 Stammdaten nicht eingetragen, so haben die Variablen
4710 <varname>shipto*</varname> den gleichen Wert wie die die
4711 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
4712 einige <varname>shipto*</varname>-Variablen so nicht in den
4713 Stammdaten wiederfinden sondern schlicht Kopien der
4714 Lieferdatenvariablen sind (z.B.
4715 <varname>shiptocontact</varname>).</para>
4719 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
4720 <title>Informationen über den Bearbeiter</title>
4724 <term><varname>employee_address</varname></term>
4727 <para>Adressfeld</para>
4732 <term><varname>employee_businessnumber</varname></term>
4735 <para>Firmennummer</para>
4740 <term><varname>employee_company</varname></term>
4743 <para>Firmenname</para>
4748 <term><varname>employee_co_ustid</varname></term>
4751 <para>Usatzsteuer-Identifikationsnummer</para>
4756 <term><varname>employee_duns</varname></term>
4759 <para>DUNS-Nummer</para>
4764 <term><varname>employee_email</varname></term>
4772 <term><varname>employee_fax</varname></term>
4780 <term><varname>employee_name</varname></term>
4783 <para>voller Name</para>
4788 <term><varname>employee_signature</varname></term>
4791 <para>Signatur</para>
4796 <term><varname>employee_taxnumber</varname></term>
4799 <para>Steuernummer</para>
4804 <term><varname>employee_tel</varname></term>
4807 <para>Telefonnummer</para>
4813 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
4814 <title>Informationen über den Verkäufer</title>
4818 <term><varname>salesman_address</varname></term>
4821 <para>Adressfeld</para>
4826 <term><varname>salesman_businessnumber</varname></term>
4829 <para>Firmennummer</para>
4834 <term><varname>salesman_company</varname></term>
4837 <para>Firmenname</para>
4842 <term><varname>salesman_co_ustid</varname></term>
4845 <para>Usatzsteuer-Identifikationsnummer</para>
4850 <term><varname>salesman_duns</varname></term>
4853 <para>DUNS-Nummer</para>
4858 <term><varname>salesman_email</varname></term>
4866 <term><varname>salesman_fax</varname></term>
4874 <term><varname>salesman_name</varname></term>
4877 <para>voller Name</para>
4882 <term><varname>salesman_signature</varname></term>
4885 <para>Signatur</para>
4890 <term><varname>salesman_taxnumber</varname></term>
4893 <para>Steuernummer</para>
4898 <term><varname>salesman_tel</varname></term>
4901 <para>Telefonnummer</para>
4907 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
4908 <title>Variablen für die einzelnen Steuern</title>
4912 <term><varname>tax</varname></term>
4920 <term><varname>taxbase</varname></term>
4923 <para>zu versteuernder Betrag</para>
4928 <term><varname>taxdescription</varname></term>
4931 <para>Name der Steuer</para>
4936 <term><varname>taxrate</varname></term>
4939 <para>Steuersatz</para>
4945 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
4946 <title>Variablen für Lieferbedingungen</title>
4950 <term><varname>delivery_term</varname></term>
4953 <para>Datenbank-Objekt der Lieferbedingung</para>
4958 <term><varname>delivery_term.description</varname></term>
4961 <para>Beschreibung der Lieferbedingung</para>
4966 <term><varname>delivery_term.description_long</varname></term>
4969 <para>Langtext bzw. übersetzter Langtext der
4970 Lieferbedingung</para>
4977 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
4978 <title>Variablen in Rechnungen</title>
4980 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
4981 <title>Allgemeine Variablen</title>
4985 <term><varname>creditremaining</varname></term>
4988 <para>Verbleibender Kredit</para>
4993 <term><varname>currency</varname></term>
4996 <para>Währung</para>
5001 <term><varname>cusordnumber</varname></term>
5004 <para>Bestellnummer beim Kunden</para>
5009 <term><varname>deliverydate</varname></term>
5012 <para>Lieferdatum</para>
5017 <term><varname>duedate</varname></term>
5020 <para>Fälligkeitsdatum</para>
5025 <term><varname>globalprojectnumber</varname></term>
5028 <para>Projektnummer des ganzen Beleges</para>
5033 <term><varname>globalprojectdescription</varname></term>
5036 <para>Projekbeschreibung des ganzen Beleges</para>
5041 <term><varname>intnotes</varname></term>
5044 <para>Interne Bemerkungen</para>
5049 <term><varname>invdate</varname></term>
5052 <para>Rechnungsdatum</para>
5057 <term><varname>invnumber</varname></term>
5060 <para>Rechnungsnummer</para>
5065 <term><varname>invtotal</varname></term>
5068 <para>gesamter Rechnungsbetrag</para>
5073 <term><varname>notes</varname></term>
5076 <para>Bemerkungen der Rechnung</para>
5081 <term><varname>orddate</varname></term>
5084 <para>Auftragsdatum</para>
5089 <term><varname>ordnumber</varname></term>
5092 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
5093 erstellt wurde</para>
5098 <term><varname>payment_description</varname></term>
5101 <para>Name der Zahlart</para>
5106 <term><varname>payment_terms</varname></term>
5109 <para>Zahlungskonditionen</para>
5114 <term><varname>quodate</varname></term>
5117 <para>Angebotsdatum</para>
5122 <term><varname>quonumber</varname></term>
5125 <para>Angebotsnummer</para>
5130 <term><varname>rounding</varname></term>
5133 <para>Betrag, um den <varname>invtotal</varname> gerundet
5134 wurde (kann positiv oder negativ sein)</para>
5139 <term><varname>shippingpoint</varname></term>
5142 <para>Versandort</para>
5147 <term><varname>shipvia</varname></term>
5150 <para>Transportmittel</para>
5155 <term><varname>subtotal</varname></term>
5158 <para>Zwischensumme aller Posten ohne Steuern</para>
5163 <term><varname>total</varname></term>
5166 <para>Restsumme der Rechnung (Summe abzüglich bereits
5167 bezahlter Posten)</para>
5172 <term><varname>transaction_description</varname></term>
5175 <para>Vorgangsbezeichnung</para>
5180 <term><varname>transdate</varname></term>
5183 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
5184 erstellt wurde</para>
5190 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
5191 <title>Variablen für jeden Posten auf der Rechnung</title>
5195 <term><varname>bin</varname></term>
5198 <para>Stellage</para>
5203 <term><varname>description</varname></term>
5206 <para>Artikelbeschreibung</para>
5211 <term><varname>cusordnumber_oe</varname></term>
5214 <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
5215 Posten ursprünglich stammt (nur Verkauf)</para>
5220 <term><varname>discount</varname></term>
5223 <para>Rabatt als Betrag</para>
5228 <term><varname>discount_sub</varname></term>
5231 <para>Zwischensumme mit Rabatt</para>
5236 <term><varname>donumber_do</varname></term>
5239 <para>Lieferscheinnummer des Lieferscheins, aus dem die
5240 Position ursprünglich stammt, wenn die Rechnung im Rahmen des
5241 Workflows aus einem Lieferschein erstellt wurde.</para>
5246 <term><varname>drawing</varname></term>
5249 <para>Zeichnung</para>
5254 <term><varname>ean</varname></term>
5257 <para>EAN-Code</para>
5262 <term><varname>image</varname></term>
5270 <term><varname>linetotal</varname></term>
5273 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
5278 <term><varname>longdescription</varname></term>
5281 <para>Langtext</para>
5286 <term><varname>microfiche</varname></term>
5289 <para>Mikrofilm</para>
5294 <term><varname>netprice</varname></term>
5297 <para>Alternative zu <varname>sellprice</varname>, aber
5298 <varname>netprice</varname> entspricht dem effektiven
5299 Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
5300 <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
5301 / Menge. Diese Variable ist nützlich, wenn man den gewährten
5302 Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
5303 Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
5304 <varname>netprice</varname> hat nichts mit Netto/Brutto im
5305 Sinne von Steuern zu tun.</para>
5310 <term><varname>nodiscount_linetotal</varname></term>
5313 <para>Zeilensumme ohne Rabatt</para>
5318 <term><varname>nodiscount_sub</varname></term>
5321 <para>Zwischensumme ohne Rabatt</para>
5326 <term><varname>number</varname></term>
5329 <para>Artikelnummer</para>
5334 <term><varname>ordnumber_oe</varname></term>
5337 <para>Auftragsnummer des Originalauftrags, aus dem der Posten
5338 ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
5339 Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
5340 eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
5341 letzterem Fall wird die unsprüngliche Auftragsnummer
5347 <term><varname>p_discount</varname></term>
5350 <para>Rabatt in Prozent</para>
5355 <term><varname>partnotes</varname></term>
5358 <para>Die beim Artikel gespeicherten Bemerkungen</para>
5363 <term><varname>partsgroup</varname></term>
5366 <para>Warengruppe</para>
5371 <term><varname>price_factor</varname></term>
5374 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
5380 <term><varname>price_factor_name</varname></term>
5383 <para>Der Name des Preisfaktors, sofern einer eingestellt
5389 <term><varname>projectnumber</varname></term>
5392 <para>Projektnummer</para>
5397 <term><varname>projectdescription</varname></term>
5400 <para>Projektbeschreibung</para>
5405 <term><varname>qty</varname></term>
5413 <term><varname>reqdate</varname></term>
5416 <para>Lieferdatum</para>
5421 <term><varname>runningnumber</varname></term>
5424 <para>Position auf der Rechnung (1, 2, 3...)</para>
5429 <term><varname>sellprice</varname></term>
5432 <para>Verkaufspreis</para>
5437 <term><varname>serialnumber</varname></term>
5440 <para>Seriennummer</para>
5445 <term><varname>tax_rate</varname></term>
5448 <para>Steuersatz</para>
5453 <term><varname>transdate_do</varname></term>
5456 <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
5457 Workflows aus einem Lieferschein stammte.</para>
5462 <term><varname>transdate_oe</varname></term>
5465 <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
5466 Workflows aus einem Auftrag erstellt wurde. Wenn es
5467 Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
5473 <term><varname>transdate_quo</varname></term>
5476 <para>Datum des Angebots, wenn die Position im Rahmen des
5477 Workflows aus einem Angebot stammte.</para>
5482 <term><varname>unit</varname></term>
5485 <para>Einheit</para>
5490 <term><varname>weight</varname></term>
5493 <para>Gewicht</para>
5498 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
5499 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
5500 einer <function>foreach</function>-Schleife ausgegeben werden, da
5501 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
5502 können. Die Variablen dafür lauten:</para>
5506 <term><varname>make</varname></term>
5509 <para>Lieferant</para>
5514 <term><varname>model</varname></term>
5517 <para>Lieferantenartikelnummer</para>
5523 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
5524 <title>Variablen für die einzelnen Zahlungseingänge</title>
5528 <term><varname>payment</varname></term>
5536 <term><varname>paymentaccount</varname></term>
5544 <term><varname>paymentdate</varname></term>
5552 <term><varname>paymentmemo</varname></term>
5560 <term><varname>paymentsource</varname></term>
5569 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
5570 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
5572 <para>Die vom Benutzer definierten Variablen für Kunden und
5573 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
5574 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
5575 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
5576 Variablennamen zusammen.</para>
5578 <para>Beispiel: Der Benutzer hat eine Variable namens
5579 <varname>number_of_employees</varname> definiert, die die Anzahl der
5580 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
5581 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
5584 <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
5585 unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
5586 Präfix <varname>shiptocvar_</varname>.</para>
5588 <para>Analog stehen die benutzerdefinierten Variablen für
5589 Ansprechpersonen mit dem Namenspräfix <varname>cp_cvar_</varname>
5590 zur Verfügung.</para>
5594 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
5595 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
5597 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
5598 <title>Namen der Vorlagen</title>
5600 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
5601 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
5602 Erstellung einer Rechnung über die Mahngebühren und Zinsen
5603 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
5604 Vorlagenname für diese Mahnstufe mit dem Zusatz
5605 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
5606 für die ausgewählte Sprache und den ausgewählten Drucker
5610 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
5611 <title>Allgemeine Variablen in Mahnungen</title>
5613 <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie
5614 gewohnt als <varname>employee_...</varname> bzw.
5615 <varname>salesman_...</varname> zur Verfügung. Werden mehrere
5616 Rechnungen in einer Mahnung zusammengefasst, so werden die Metadaten
5617 (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung im
5618 Ausdruck genommen.</para>
5620 <para>Die Adressdaten des Kunden stehen als Variablen
5621 <varname>name</varname>, <varname>street</varname>,
5622 <varname>zipcode</varname>, <varname>city</varname>,
5623 <varname>country</varname>, <varname>department_1</varname>,
5624 <varname>department_2</varname>, und <varname>email</varname> zur
5625 Verfügung. Der Ansprechpartner <varname>cp_...</varname> steht auch
5626 zu Verfügung, wird allerdings auch nur von der ersten angemahnten
5627 Rechnung (s.o.) genommen.</para>
5629 <para>Weitere Variablen beinhalten:</para>
5633 <term><varname>dunning_date</varname></term>
5636 <para>Datum der Mahnung</para>
5641 <term><varname>dunning_duedate</varname></term>
5644 <para>Fälligkeitsdatum für diese Mahhnung</para>
5649 <term><varname>dunning_id</varname></term>
5652 <para>Mahnungsnummer</para>
5657 <term><varname>fee</varname></term>
5660 <para>Kumulative Mahngebühren</para>
5665 <term><varname>interest_rate</varname></term>
5668 <para>Zinssatz per anno in Prozent</para>
5673 <term><varname>total_amount</varname></term>
5676 <para>Gesamter noch zu zahlender Betrag als
5677 <function>fee</function> + <function>total_interest</function>
5678 + <function>total_open_amount</function></para>
5683 <term><varname>total_interest</varname></term>
5686 <para>Zinsen per anno über alle Rechnungen</para>
5691 <term><varname>total_open_amount</varname></term>
5694 <para>Summe über alle offene Beträge der Rechnungen</para>
5700 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
5701 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
5705 <term><varname>dn_amount</varname></term>
5708 <para>Rechnungssumme (brutto)</para>
5713 <term><varname>dn_duedate</varname></term>
5716 <para>Originales Fälligkeitsdatum der Rechnung</para>
5721 <term><varname>dn_dunning_date</varname></term>
5724 <para>Datum der Mahnung</para>
5729 <term><varname>dn_dunning_duedate</varname></term>
5732 <para>Fälligkeitsdatum der Mahnung</para>
5737 <term><varname>dn_fee</varname></term>
5740 <para>Kummulative Mahngebühr</para>
5745 <term><varname>dn_interest</varname></term>
5748 <para>Zinsen per anno für diese Rechnung</para>
5753 <term><varname>dn_invnumber</varname></term>
5756 <para>Rechnungsnummer</para>
5761 <term><varname>dn_linetotal</varname></term>
5764 <para>Noch zu zahlender Betrag (ergibt sich aus
5765 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
5766 + <varname>dn_interest</varname>)</para>
5771 <term><varname>dn_netamount</varname></term>
5774 <para>Rechnungssumme (netto)</para>
5779 <term><varname>dn_open_amount</varname></term>
5782 <para>Offener Rechnungsbetrag</para>
5787 <term><varname>dn_ordnumber</varname></term>
5790 <para>Bestellnummer</para>
5795 <term><varname>dn_transdate</varname></term>
5798 <para>Rechnungsdatum</para>
5803 <term><varname>dn_curr</varname></term>
5806 <para>Währung, in der die Rechnung erstellt wurde. (Die
5807 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
5813 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
5814 <title>Variablen in automatisch erzeugten Rechnungen über
5815 Mahngebühren</title>
5817 <para>Die Variablen des Verkäufers stehen wie gewohnt als
5818 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
5819 Kunden stehen als Variablen <varname>name</varname>,
5820 <varname>street</varname>, <varname>zipcode</varname>,
5821 <varname>city</varname>, <varname>country</varname>,
5822 <varname>department_1</varname>, <varname>department_2</varname>,
5823 und <varname>email</varname> zur Verfügung.</para>
5825 <para>Weitere Variablen beinhalten:</para>
5829 <term><varname>duedate</varname></term>
5832 <para>Fälligkeitsdatum der Rechnung</para>
5837 <term><varname>dunning_id</varname></term>
5840 <para>Mahnungsnummer</para>
5845 <term><varname>fee</varname></term>
5848 <para>Mahngebühren</para>
5853 <term><varname>interest</varname></term>
5861 <term><varname>invamount</varname></term>
5864 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
5865 <varname>interest</varname>)</para>
5870 <term><varname>invdate</varname></term>
5873 <para>Rechnungsdatum</para>
5878 <term><varname>invnumber</varname></term>
5881 <para>Rechnungsnummer</para>
5888 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
5889 <title>Variablen in anderen Vorlagen</title>
5892 <title>Einführung</title>
5894 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
5895 Rechnung. Allerdings heißen die Variablen, die mit
5896 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
5897 fangen sie mit <varname>quo</varname> für "quotation" an:
5898 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
5899 wiederum fangen sie mit <varname>ord</varname> für "order" an:
5900 <varname>ordnumber</varname> für Bestellnummer etc.</para>
5902 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
5903 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
5904 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
5905 Vorlage keine Bedeutung haben oder noch nicht belegt sein
5908 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
5909 in Rechnungen aufgeführt.</para>
5912 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
5913 <title>Angebote und Preisanfragen</title>
5917 <term><varname>quonumber</varname></term>
5920 <para>Angebots- bzw. Anfragenummer</para>
5925 <term><varname>reqdate</varname></term>
5928 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
5929 Preisanfragen)</para>
5934 <term><varname>transdate</varname></term>
5937 <para>Angebots- bzw. Anfragedatum</para>
5943 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
5944 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
5948 <term><varname>ordnumber</varname></term>
5951 <para>Auftragsnummer</para>
5956 <term><varname>reqdate</varname></term>
5959 <para>Lieferdatum</para>
5964 <term><varname>transdate</varname></term>
5967 <para>Auftragsdatum</para>
5973 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
5974 <title>Lieferscheine (Verkauf und Einkauf)</title>
5978 <term><varname>cusordnumber</varname></term>
5981 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
5982 des Lieferanten (im Einkauf)</para>
5987 <term><varname>donumber</varname></term>
5990 <para>Lieferscheinnummer</para>
5995 <term><varname>transdate</varname></term>
5998 <para>Lieferscheindatum</para>
6003 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
6004 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
6005 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
6006 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
6007 <function>foreach</function>-Schleife ausgegeben werden. Diese
6008 Variablen sind:</para>
6012 <term><varname>si_bin</varname></term>
6015 <para>Lagerplatz</para>
6020 <term><varname>si_chargenumber</varname></term>
6023 <para>Chargennummer</para>
6028 <term><varname>si_bestbefore</varname></term>
6031 <para>Mindesthaltbarkeit</para>
6036 <term><varname>si_number</varname></term>
6039 <para>Artikelnummer</para>
6044 <term><varname>si_qty</varname></term>
6047 <para>Anzahl bzw. Menge</para>
6052 <term><varname>si_runningnumber</varname></term>
6055 <para>Positionsnummer (1, 2, 3 etc)</para>
6060 <term><varname>si_unit</varname></term>
6063 <para>Einheit</para>
6068 <term><varname>si_warehouse</varname></term>
6077 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
6078 <title>Variablen für Sammelrechnung</title>
6082 <term><varname>c0total</varname></term>
6085 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
6091 <term><varname>c30total</varname></term>
6094 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
6095 und < 60 Tage</para>
6100 <term><varname>c60total</varname></term>
6103 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
6104 und < 90 Tage</para>
6109 <term><varname>c90total</varname></term>
6112 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
6118 <term><varname>total</varname></term>
6121 <para>Gesamtbetrag aller Rechnungen</para>
6126 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
6130 <term><varname>invnumber</varname></term>
6133 <para>Rechnungsnummer</para>
6138 <term><varname>invdate</varname></term>
6141 <para>Rechnungsdatum</para>
6146 <term><varname>duedate</varname></term>
6149 <para>Fälligkeitsdatum</para>
6154 <term><varname>amount</varname></term>
6157 <para>Summe der Rechnung</para>
6162 <term><varname>open</varname></term>
6165 <para>Noch offener Betrag der Rechnung</para>
6170 <term><varname>c0</varname></term>
6173 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
6179 <term><varname>c30</varname></term>
6182 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
6188 <term><varname>c60</varname></term>
6191 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
6197 <term><varname>c90</varname></term>
6200 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
6208 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
6209 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
6211 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
6212 <title>Einführung</title>
6214 <para>Der Parser kennt neben den Variablen einige weitere
6215 Konstrukte, die gesondert behandelt werden. Diese sind wie
6216 Variablennamen in spezieller Weise markiert:
6217 <command><%anweisung%> ... <%end%></command></para>
6219 <para>Anmerkung zum <command><%end%></command>: Der besseren
6220 Verständlichkeit halber kann man nach dem <command>end</command>
6221 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
6222 Anweisung (z.B. <command>if</command> oder
6223 <command>foreach</command>) damit abgeschlossen wird.</para>
6225 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
6226 <command><%if type == "sales_quotation"%></command>, so könnte
6227 er mit <command><%end%></command> genauso abgeschlossen werden
6228 wie mit <command><%end if%></command> oder auch
6229 <command><%end type == "sales_quotation"%></command>.</para>
6232 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
6233 <title>Der if-Block</title>
6235 <programlisting><%if variablenname%>
6237 <%end%></programlisting>
6239 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
6240 und dem "end" werden nur ausgegeben, wenn die Variable
6241 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
6243 <para>Handelt es sich bei der benannten Variable um ein Array, also
6244 um einen Variablennamen, über den man mit <command><%foreach
6245 variablenname%></command> iteriert, so wird mit diesem Konstrukt
6246 darauf getestet, ob das Array Elemente enthält. Somit würde im
6247 folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
6248 ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
6249 welche getätigt wurden:</para>
6251 <programlisting><%if payment%>
6253 <%foreach payment%>
6254 Am <%paymentdate%>: <%payment%> €
6255 <%end foreach%>
6256 <%end if%></programlisting>
6258 <para>Die Bedingung kann auch negiert werden, indem das Wort
6259 <function>not</function> nach dem <filename>if</filename> verwendet
6260 wird. Beispiel:</para>
6262 <programlisting><%if not cp_greeting%>
6264 <%end%></programlisting>
6266 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
6267 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
6268 einer Variablen mit einer festen Zeichenkette oder einer anderen
6269 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
6270 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
6271 die rechte Seite des Vergleichsoperators in Anführungszeichen
6272 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
6273 anderer Variablen). Zwei Beispiele, die beide Vergleiche
6276 <programlisting><%if var1 == "Wert"%></programlisting>
6278 <para>Testet die Variable <varname>var1</varname> auf
6279 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
6280 Mittels <function>!=</function> anstelle von <function>==</function>
6281 würde auf Ungleichheit getestet.</para>
6283 <programlisting><%if var1 == var2%></programlisting>
6285 <para>Testet die Variable <varname>var1</varname> auf
6286 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
6287 <function>!=</function> anstelle von <function>==</function> würde
6288 auf Ungleichheit getestet.</para>
6290 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
6291 auch Tests auf Übereinstimmung mit regulären Ausdrücken ohne
6292 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
6293 dieselbe Syntax wie oben nur mit <function>=~</function> und
6294 <function>!~</function> als Vergleichsoperatoren.</para>
6296 <para>Beispiel für einen Test, ob die Variable
6297 <varname>intnotes</varname> (interne Bemerkungen) das Wort
6298 <constant>schwierig</constant> enthält:</para>
6300 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
6303 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
6304 <title>Der foreach-Block</title>
6306 <programlisting><%foreach variablenname%>
6308 <%end%></programlisting>
6310 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
6311 wie das Perl-Array der Variablen <varname>variablenname</varname>
6312 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
6313 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
6314 benutzt. In jedem Durchlauf werden die <link
6315 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
6316 Variablen</link> jeweils auf den Wert für die aktuelle Position
6319 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
6321 <programlisting><%foreach number%>
6322 Position: <%runningnumber%>
6323 Anzahl: <%qty%>
6324 Artikelnummer: <%number%>
6325 Beschreibung: <%description%>
6327 <%end%></programlisting>
6329 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
6330 <function><%foreach%></function>-Block innerhalb einer
6331 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
6332 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
6333 Inhalt zwischen <function><%foreach%></function> und
6334 <function><%end%></function> wiederholt, nicht aber die
6335 komplette Zeile, in der er steht.</para>
6339 <sect2 id="dokumentenvorlagen-und-variablen.markup">
6340 <title>Markup-Code zur Textformatierung innerhalb von
6343 <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
6344 anders formatiert haben möchte, so ist dies begrenzt möglich.
6345 kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
6346 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
6347 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
6348 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
6349 (HTML oder PDF über LaTeX) umgesetzt.</para>
6351 <para>Die unterstützen Formatierungen sind:</para>
6355 <term><b>Text</b></term>
6358 <para>Text wird in Fettdruck gesetzt.</para>
6363 <term><i>Text</i></term>
6366 <para>Text wird kursiv gesetzt.</para>
6371 <term><u>Text</u></term>
6374 <para>Text wird unterstrichen.</para>
6379 <term><s>Text</s></term>
6382 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
6383 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
6388 <term><bullet></term>
6391 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
6397 <para>Der Befehl <command><bullet></command> funktioniert
6398 momentan auch nur in Latex-Vorlagen.</para>
6402 <sect1 id="excel-templates">
6403 <title>Excel-Vorlagen</title>
6405 <sect2 id="excel-templates.summary">
6406 <title>Zusammenfassung</title>
6408 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
6409 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
6413 <sect2 id="excel-templates.usage">
6414 <title>Bedienung</title>
6416 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
6417 werden. Die Konfigurationsoption heißt <varname>excel_templates =
6418 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
6420 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
6421 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
6422 werden. In den normalen Verkaufsmasken taucht nun
6423 <constant>Excel</constant> als auswählbares Format auf und kann von da
6424 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
6426 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
6427 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
6428 <filename>sales_quotation.xls</filename> gespeichert.</para>
6431 <sect2 id="excel-templates.syntax">
6432 <title>Variablensyntax</title>
6434 <para>Einfache Syntax:
6435 <command><<varname>></command></para>
6437 <para>Dabei sind <constant><<</constant> und
6438 <constant>>></constant> die Delimiter. Da Excel auf festen
6439 Breiten besteht, kann der Tag künstlich verlängert werden, indem
6440 weitere <constant><</constant> oder <constant>></constant>
6441 eingefügt werden. Der Tag muss nicht symmetrisch sein.
6444 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6446 <para>Um die Limitierung der festen Breite zu reduzieren, können
6447 weitere Variablen in einem Block interpoliert werden. Whitespace wird
6448 dazwishen dann erhalten. Beispiel:</para>
6450 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6452 <para>Die Variablen werden interpoliert, und linksbündig mit
6453 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
6454 lang, werden überzählige Zeichen abgeschnitten.</para>
6456 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
6457 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
6459 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
6461 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
6462 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
6466 <sect2 id="excel-templates.limitations">
6467 <title>Einschränkungen</title>
6469 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
6470 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
6471 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
6472 Text zu ersetzen.</para>
6474 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
6475 <command><%if%></command> und
6476 <command><%foreach%></command> nicht vorhanden. Der Delimiter
6477 <constant><% %></constant> kommt in den Headerinformationen
6478 evtl. vor. Deshalb wurde auf den sichereren Delimiter
6479 <constant><<</constant> und <constant>>></constant>
6484 <sect1 id="features.warehouse">
6485 <title>Mandantenkonfiguration Lager</title>
6487 <para>Die Lagerverwaltung in kivitendo funktioniert standardmässig wie
6488 folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
6489 Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen
6490 durchzuführen. Ferner kann jede Position eines Lieferscheins ein-, bzw.
6491 ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele
6492 Lager mit beliebig vielen Lagerplätzen abgebildet werden. Die
6493 Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder
6494 Einzelposition und das Auswählen dieser Position zu einem Lager mit
6495 Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je
6496 nachdem wie die Einstellungen in der Mandatenkonfiguration gesetzt
6501 <para><option>Auslagern über Standardlagerplatz</option> Hier wird
6502 ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
6503 Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
6504 den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
6508 <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
6509 Auslagern schlägt fehl, wenn die entsprechende Menge für die
6510 Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
6511 und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
6512 dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
6513 (Fehlbestand, o.ä.) konfiguriert sein.</para>
6517 <para>Zusätzliche Funktionshinweise:</para>
6521 <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
6522 wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
6523 Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
6527 <para><option>Standard-Lagerplatz verwenden, falls keiner in
6528 Stammdaten definiert</option> Wird beim 'Auslagern über
6529 Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
6530 so wird mit dieser Option einfach der Standardlagerplatz
6536 <sect1 id="features.swiss-charts-of-accounts">
6537 <title>Schweizer Kontenpläne</title>
6539 <para>Seit der Version 3.5 stehen in kivitendo 3 Kontenpläne für den
6540 Einsatz in der Schweiz zur Verfügung, einer für Firmen und
6541 Organisationen, die nicht mehrwertsteuerpflichtig sind, einer für
6542 Firmen, die mehrwertsteuerpflichtig sind und einer speziell für
6545 <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
6546 verwendeten KMU-Kontenrahmen und sind mit der Revision des
6547 Schweizerischen Obligationenrechts (OR) vom 1.1.2013 kompatibel,
6548 insbesondere <literal>Art.957a Abs.2</literal>.</para>
6550 <para>Beim Vereinskontenplan sind standardmässig nur die Konten 1100
6551 (Debitoren CHF) und 1101 (Debitoren EUR) als Buchungskonten im Verkauf
6552 sowie die Konten 2000 (Kreditoren CHF) und 2001 (Kreditoren EUR) als
6553 Buchungskonten im Einkauf vorgesehen. Weitere Konten können bei Bedarf
6554 in den Konto-Detaileinstellungen als Einkaufs- oder Verkaufskonten
6555 konfiguriert werden.</para>
6557 <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der
6558 aktuellen Version von kivitendo noch nicht integriert.</para>
6560 <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
6561 Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
6562 Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen alle
6563 Aufwandskonten editiert werden und dort der Steuersatz auf 0% gesetzt
6566 <para>So werden bei Kreditorenbuchungen keine Vorsteuern
6569 <para>Bezugssteuern für aus dem Ausland bezogene Dienstleistungen müssen
6570 manuell verbucht werden.</para>
6572 <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
6573 Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne bitte an
6574 <literal>empfang@revamp-it.ch</literal> senden.</para>
6577 <sect1 id="features.part_classification">
6578 <title>Artikelklassifizierung</title>
6581 <title>Übersicht</title>
6583 <para>Die Klassifizierung von Artikeln dient einer weiteren
6584 Gliederung, um zum Beispiel den Einkauf vom Verkauf zu trennen,
6585 gekennzeichnet durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel
6586 (z.B. "E"). Für jede Klassifizierung besteht eine Beschreibung und
6587 eine Abkürzung die normalerweise aus einem Zeichen besteht, kann aber
6588 auf mehrere Zeichen erweitert werden, falls zur Unterscheidung
6589 notwendig. Sinnvoll sind jedoch nur maximal 2 Zeichen.</para>
6593 <title>Basisklassifizierung</title>
6595 <para>Als Basisklassifizierungen gibt es</para>
6599 <para>Einkauf</para>
6603 <para>Verkauf</para>
6607 <para>Handelsware</para>
6611 <para>Produktion</para>
6615 <para>- keine - (diese wird bei einer Aktualisierung für alle
6616 existierenden Artikel verwendet und ist gültig für Verkauf und
6621 <para>Es können weitere Klassifizierungen angelegt werden. So kann es
6622 z.B. für separat auszuweisende Artikel folgende Klassen geben:</para>
6626 <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
6630 <para>Material (Verpackungsmaterial) mit Kürzel M</para>
6636 <title>Attribute</title>
6638 <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
6639 alle gleichzeitg gültig sein können</para>
6643 <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
6648 <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
6653 <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
6654 (LaTeX) eine zusätzliche Variable</para>
6658 <para>Für das Attribut "separat ausweisen" stehen in den
6659 LaTeX-Vorlagen die Variable <emphasis
6660 role="bold"><%non_separate_subtotal%> </emphasis>zur Verfügung,
6661 die alle nicht separat auszuweisenden Artikelkosten saldiert, sowie
6662 pro separat auszuweisenden Klassifizierungen die Variable<emphasis
6663 role="bold">< %separate_X_subtotal%></emphasis>, wobei X das
6664 Kürzel der Klassifizierung ist.</para>
6666 <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
6667 role="bold"><%separate_L_subtotal%></emphasis> und für
6668 Verpackungsmaterial <emphasis role="bold">
6669 <%separate_M_subtotal%></emphasis>.</para>
6673 <title>Zwei-Zeichen Abkürzung</title>
6675 <para>Der Typ des Artikels und die Klassifizierung werden durch zwei
6676 Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
6677 Artikel-Typs ('P','A','S'), deutsch 'W', 'E', und 'D' für Ware
6678 Erzeugnis oder Dienstleistung und ggf. weiterer Typen.</para>
6680 <para>Der zweite Buchstabe (und ggf. auch ein dritter, falls nötig)
6681 entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
6683 <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
6684 Erleichterung mit dargestellt.</para>
6688 <sect1 id="features.file_managment">
6689 <title>Dateiverwaltung (Mini-DMS)</title>
6692 <title>Übersicht</title>
6694 <para>Parallel zum alten WebDAV gibt es ein Datei-Management-System,
6695 das Dateien verschiedenen Typs verwaltet. Dies können</para>
6699 <para>aus ERP-Daten per LaTeX Template erzeugte
6700 PDF-Dokumente,</para>
6704 <para>zu bestimmten ERP-Daten gehörende Anhangdateien
6705 unterschiedlichen Formats,</para>
6709 <para>per Scanner eingelesene PDF-Dateien,</para>
6713 <para>per E-Mail empfangene Dateianhänge unterschiedlichen
6718 <para>sowie speziel für Artikel hochgeladene Bilder sein.</para>
6723 <screeninfo>Übersicht</screeninfo>
6727 <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
6734 <title>Struktur</title>
6736 <para>Über eine vom Speichermedium unabhängige Zwischenschicht werden
6737 die Dateien und ihre Versionen in der Datenbank verwaltet. Darunter
6738 können verschiedene Implementierungen (Backends) gleichzeitig
6743 <para>Dateisystem</para>
6751 <para>Schnittstelle zu externen
6752 Dokumenten-Management-Systemen</para>
6756 <para>andere Datenbank</para>
6760 <para>etc ...</para>
6764 <para>Es gibt unterschiedliche Typen von Dateien. Jedem Typ läßt sich
6765 in der Mandantenkonfiguration ein bestimmtes Backend zuordnen.</para>
6769 <para>"document": Das sind entweder generierte, eingescannte oder
6770 hochgeladene PDF-Dateien, die zu bestimmten ERP-Daten
6771 (ERP-Objekte, wie z.B. Rechnung, Lieferschein) gehören.</para>
6775 <para>"attachment": zusätzlich hochgeladene Dokumente, die an
6776 bestimmte ERP-Objekte angehängt werden, z.B. technische
6777 Zeichnungen, Aufmaße. Diese können auch für Artikel, Lieferanten
6778 und Kunden hinterlegt sein.</para>
6782 <para>"image": Bilder für Artikel. Diese können auch verkleinert
6783 in einer Vorschau (Thumbnail) angezeigt werden.</para>
6787 <para>Zusätzlich werden in der Datenbank zu den Dateien neben der
6788 Zuordnung zu ERP-Objekten, Dateityp Dateinamen und Backend, in dem die
6789 Datei gespeichert ist, auch die Quelle der Datei notiert:</para>
6793 <para>"created": vom System erzeugte Dokumente"</para>
6797 <para>"uploaded": hochgeladene Dokumente</para>
6801 <para>"email": vom Mail-System empfangene Dateien</para>
6805 <para>"scanner[1]": von einem oder mehreren Scannern erzeugte
6806 Dateien. Existieren mehrere Scanner, so sind diese durch
6807 unterschiedliche Quellennamen zu definieren.</para>
6811 <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es
6812 für "attachment" und "image" nur die Quelle "uploaded". Für "document"
6813 gibt es auf jeden Fall die Quelle "created". Die Quellen "scanner" und
6814 "email" müssen derzeit in der Datenbank konfiguriert werden (siehe
6815 <xref linkend="file_management.dbconfig"/>).</para>
6819 <title>Anwendung</title>
6821 <para>Die Daten werden bei den ERP-Objekten als extra Reiter
6822 dargestellt. Eine Verkaufsrechnung z.B. hat die Reiter "Dokumente" und
6823 "Dateianhänge".</para>
6826 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6830 <imagedata fileref="images/DMS-Anhaenge.png" scale="50"/>
6835 <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer
6836 Datei angezeigt. Wird eine Datei mit gleichem Namen hochgeladen, so
6837 wird eine neue Version der Datei erstellt. Vorher wird der Anwender
6838 durch einen Dialog gefragt, ob er eine neue Version anlegen will oder
6839 ob er die Datei umbenennen will, falls es eine neue Datei sein
6843 <screeninfo>Reiter "Dateianhänge"</screeninfo>
6847 <imagedata contentwidth="40"
6848 fileref="images/DMS-Anhaenge-hochladen.png"
6854 <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
6855 solange in Summe die maximale Größe nicht überschritten wird (siehe
6856 <xref linkend="file_management.clientconfig"/>).</para>
6859 <screeninfo>Reiter "Dokumente"</screeninfo>
6863 <imagedata fileref="images/DMS-Dokumente.png" width="500"/>
6868 <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt
6869 es nur "erzeugte Dokumente". Es werden alle Versionen der generierten
6870 Datei angezeigt. Für Verkaufsrechnungen kommen keine anderen Quellen
6871 zur Geltung. Werden entsprechend der <xref
6872 linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert,
6873 so sind diese z.B. bei Einkaufsrechnungen sichtbar:</para>
6876 <screeninfo>Reiter "Dokumente"</screeninfo>
6880 <imagedata contentwidth="600"
6881 fileref="images/DMS-Dokumente-Scanner.png"/>
6886 <para>Statt des Löschens wird hier die Datei zurück zur Quelle
6887 verschoben. Somit kann die Datei anschließend an ein anderes
6888 ERP-Objekt angehängt werden.</para>
6890 <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie
6891 sind bisher nur bei Bildern relevant.</para>
6895 <title>Konfigurierung</title>
6897 <sect3 id="file_management.clientconfig"
6898 xreflabel="Mandantenkonfigurierung">
6899 <title>Mandantenkonfiguration</title>
6902 <title>Reiter "Features"</title>
6904 <para>Unter dem Reiter <emphasis role="bold">Features</emphasis>
6905 im Abschnitt Dateimanagement ist neben dem "alten" WebDAV das
6906 Dateimangement generell zu- und abschaltbar, sowie die Zuordnung
6907 der Dateitypen zu Backends. Die Löschbarkeit von Dateien, sowie
6908 die maximale Uploadgröße sind Backend-unabhängig</para>
6911 <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
6915 <imagedata fileref="images/DMS-ClientConfig.png" width="500"/>
6920 <para>Die einzelnen Backends sind einzeln einschaltbar.
6921 Spezifische Backend-Konfigurierungen sind hier noch
6926 <title>Reiter "Allgemeine Dokumentenanhänge"</title>
6928 <para>Unter dem Reiter <emphasis role="bold">Allgemeine
6929 Dokumentenanhänge</emphasis> kann für alle ERP-Dokumente (
6930 Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und
6931 Einkauf ) allgemeingültige Anhänge hochgeladen werden.</para>
6934 <screeninfo>Mandantenkonfig Reiter "Allgemeine
6935 Dokumentenanhänge"</screeninfo>
6939 <imagedata fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"
6945 <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die
6946 ERP-Dokumente angehängt, z.B. AGBs oder aktuelle Angebote. Es
6947 werden in dem Fall die Daten kopiert, sodass an den ERP-Dokumenten
6948 immer die Anhänge zum Generierungszeitpunkt eingebettet
6953 <sect3 id="file_management.dbconfig"
6954 xreflabel="Datenbank-Konfigurierung">
6955 <title>Datenbank-Konfigurierung</title>
6957 <para>Die zusätzlichen Quellen für "email" oder ein oder mehrere
6958 Scanner sind derzeit vom Administrator direkt in der
6959 Datenbanktabelle "user_preferences" einzurichten. Die "value" ist im
6960 JSON-Format mit den jeweiligen Werten des Verzeichnisses und der
6961 Beschreibung der Quelle.</para>
6964 id | login | namespace | version | key | value
6965 ----+-----------+--------------+---------+----------+---------------------------
6966 1 | #default# | file_sources | 0.00000 | scanner1 |
6967 {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
6968 2 | #default# | file_sources | 0.00000 | scanner2 |
6969 {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
6970 3 | #default# | file_sources | 0.00000 | emails |
6971 {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
6974 <para>Es ist daran gedacht, statt dem Default-Eintrag später für
6975 bestimmte Benutzer ('login') bestimmte Quellen zuzulassen. Dies wird
6976 nach Bedarf implementiert.</para>
6979 <sect3 id="file_management.kiviconfig"
6980 xreflabel="kivitendo-Konfigurationsdatei">
6981 <title>kivitendo-Konfigurationsdatei</title>
6983 <para>Dort ist im Abschnitt [paths] der relative oder absolute Pfad
6984 zum Dokumentenwurzelverzeichnis einzutragen. Dieser muss für den
6985 Webserver schreib- und lesbar sein, jedoch nicht ausführbar.</para>
6989 document_path = /var/local/kivi_documents
6992 <para>Unter diesem Wurzelverzeichnis wird pro Mandant automatisch
6993 ein Unterverzeichnis mit der ID des Mandanten angelegt.</para>
6999 <title>Webshop-Api</title>
7001 <para>Das Shopmodul bietet die Möglichkeit Onlineshopartikel und
7002 Onlineshopbestellungen zu verwalten und zu bearbeiten.</para>
7004 <para>Es ist Multishopfähig, d.h. Artikel können mehreren oder
7005 unterschiedlichen Shops zugeordnet werden. Bestellungen können aus
7006 mehreren Shops geholt werden.</para>
7008 <para>Zur Zeit bietet das Modul nur einen Connector zur REST-Api von
7009 Shopware. Weitere Connectoren können dazu programmiert und eingerichtet
7013 <title>Rechte für die Webshopapi</title>
7015 <para>In der Administration können folgende Rechte vergeben
7020 <para>Webshopartikel anlegen und bearbeiten</para>
7024 <para>Shopbestellungen holen und bearbeiten</para>
7028 <para>Shop anlegen und bearbeiten</para>
7034 <title>Konfiguration</title>
7036 <para>Unter System->Webshops können Shops angelegt und konfiguriert
7041 <imagedata contentdepth="500" contentwidth="700"
7042 fileref="images/Shop_Listing.png"/>
7048 <title>Webshopartikel</title>
7051 <title>Shopvariablenreiter in Artikelstammdaten</title>
7053 <para>Mit dem Recht "Shopartikel anlegen und bearbeiten" und des
7054 Markers <emphasis role="bold">"Shopartikel" in den Basisdaten
7055 </emphasis>zeigt sich der Reiter "Shopvariablen" in den
7056 Artikelstammdaten. Hier können jetzt die Artikel mit
7057 unterschiedlichen Beschreibung und/oder Preisen für die
7058 konfigutierten Shops angelegt und bearbeitet werden. An dieser
7059 Stelle können auch beliebig viele Bilder dem Shopartikel zugeordnet
7060 werden. Artikelbilder gelten für alle Shops.</para>
7064 <imagedata contentdepth="500" contentwidth="600"
7065 fileref="images/Shop_Artikel.png"/>
7069 <para>Die Artikelgruppen werden direkt vom Shopsystem geholt somit
7070 ist es möglich einen Artikel auch mehreren Gruppen
7075 <title>Shopartikelliste</title>
7077 <para>Unter dem Menu Webshop->Webshop Artikel hat man nochmal
7078 eine Gesamtübersicht. Von hier aus ist es möglich Artikel im Stapel
7079 unter verschiedenen Kriterien <alles><nur Preis><nur
7080 Bestand><Preis und Bestand> an die jeweiligen Shops
7085 <imagedata fileref="images/Shop_Artikel_Listing.png"/>
7092 <title>Bestellimport</title>
7094 <para>Unter dem Menupunkt Webshop->Webshop Import öffnet sich die
7095 Bestellimportsliste. Hier ist sind Möglichkeiten gegeben Neue
7096 Bestellungen vom Shop abzuholen, geholte Bestellungen im Stapel oder
7097 einzeln als Auftrag zu transferieren. Die Liste kann nach
7098 verschiedenen Kriterien gefiltert werden.</para>
7102 <imagedata fileref="images/Shop_Bestell.png"/>
7106 <para>Bei Einträgen in der Liste.</para>
7110 <para>keine Kundennummer: Es gibt ähnliche Kundendatensätze und
7111 der Datensatz konnte nicht eindeutig zugewiesen werden.</para>
7115 <para>Kundennummer und Rechnungen rot hinterlegt: Der Kunde hat
7116 offene Posten und kann deswegen nicht im Stapel übernommen
7121 <para>Rechnungsadresse grün hinterlegt: Der Kunde konnte eindeutig
7122 einem Datensatz zugeordnet werden. Die Shopbestellung kann im
7123 Stapel mit dem Button "Anwenden" und wenn markiert als Auftrag
7124 übernommen werden.</para>
7128 <para>Kundennummer vorhanden, aber die Checkbox "Auftrag
7129 erstellen" fehlt. Der Kunde hat vermutlich eine
7130 Shopauftragssperre.</para>
7134 <para>Lieferadresse grau hinterlegt: Optische Anzeige, dass es
7135 sich um eine unterschiedliche Lieferadresse handelt.
7136 Lieferadressen werden aber grundsätzlich beim Transferieren zu
7137 Aufträgen mit übernommen.</para>
7141 <para>In der Spalte Positionen/Betrag/Versandkosten zeigt sich ein
7142 tooltip zu den Positionen.</para>
7146 <para>Maske Auftrag erstellen</para>
7148 <para>Viele Shopsysteme haben drei verschieden Adresstypen Kunden-,
7149 Rechnungs-, und Lieferadresse, die sich auch alle unterscheiden
7150 können. Diese werden im oberen Bereich angezeigt. Es ist möglich jede
7151 dieser Adresse einzeln in kivitendo als Kunde zu übernehmen. Es werden
7152 die Werte Formulareingabe übernommen. Es wird bei einer Änderung
7153 allerdings nur diese in die kivitendo Kundenstammdaten übernommen, die
7154 Shopbestellung bleibt bestehen.</para>
7156 <para>Mit der mittleren Adresse(Rechnungsadresse) im oberen Bereich,
7157 kann ich den ausgewählten kivitendodatensatz des mittleren Bereich
7158 überschreiben. Das ist sinnvoll, wenn ich erkenne, das der Kunde z.B.
7159 umgezogen ist.</para>
7161 <para>Im mittleren Bereich das Adresslisting zeigt:</para>
7165 <para>Rot hinterlegt: Kunde hat eine Shopauftragssperre, diese
7166 muss zuerst deaktiviert werden bevor ich diesem Kunden eine
7167 Shopbestellung zuordnen kann.</para>
7171 <para>Kundenname fett und rot: Hier hat der Kunde eine Bemerkung
7172 in den Stammdaten. Ein Tooltip zeigt diese Bemerkung. Das kann dan
7173 auch der Grund für die Auftragssperre sein.</para>
7177 <para>Die Buttons "Auftrag erstellen" und "Kunde mit
7178 Rechnungsadresse überschreiben" zeigen sich erst, wenn ein Kunde
7179 aus dem Listing ausgewählt ist.</para>
7183 <para>Es ist aber möglich die Shopbestellung zu löschen.</para>
7187 <para>Ist eine Bestellung schon übernommen, zeigen sich an dieser
7188 Stelle, die dazugehörigen Belegverknüpfungen.</para>
7194 <title>Mapping der Daten</title>
7196 <para>Das Mapping der kivitendo Daten mit den Shopdaten geschieht in
7197 der Datei SL/ShopConnector/<SHOPCONNECTORNAME>.pm
7198 z.B.:SL/ShopConnector/Shopware.pm</para>
7200 <para>In dieser Datei gibt es einen Bereich wo die Bestellpostionen,
7201 die Bestellkopfdaten und die Artikeldaten gemapt werden. In dieser
7202 Datei kann ein individelles Mapping dann gemacht werden. Zu Shopware
7203 gibt es hier eine sehr gute Dokumentation: <ulink
7204 url="https://developers.shopware.com/developers-guide/rest-api/">https://developers.shopware.com/developers-guide/rest-api/</ulink></para>
7210 <title>Entwicklerdokumentation</title>
7212 <sect1 id="devel.globals" xreflabel="Globale Variablen">
7213 <title>Globale Variablen</title>
7216 <title>Wie sehen globale Variablen in Perl aus?</title>
7218 <para>Globale Variablen liegen in einem speziellen namespace namens
7219 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
7220 globs global und die meisten speziellen Variablen sind...
7223 <para>Daraus ergeben sich folgende Formen:</para>
7227 <term><literal>$main::form</literal></term>
7230 <para>expliziter Namespace "main"</para>
7235 <term><literal>$::form</literal></term>
7238 <para>impliziter Namespace "main"</para>
7243 <term><literal>open FILE, "file.txt"</literal></term>
7246 <para><varname>FILE</varname> ist global</para>
7251 <term><literal>$_</literal></term>
7254 <para>speziell</para>
7259 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
7260 Schlüsselwort wie "<function>global</function>", mit dem man
7261 importieren kann. <function>my</function>, <function>our</function>
7262 und <function>local</function> machen was anderes.</para>
7266 <term><literal>my $form</literal></term>
7269 <para>lexikalische Variable, gültig bis zum Ende des
7275 <term><literal>our $form</literal></term>
7278 <para><varname>$form</varname> referenziert ab hier
7279 <varname>$PACKAGE::form</varname>.</para>
7284 <term><literal>local $form</literal></term>
7287 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
7288 des scopes zurückgesetzt</para>
7295 <title>Warum sind globale Variablen ein Problem?</title>
7297 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
7299 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
7300 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
7301 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
7302 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
7303 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
7304 Datenbankverbindungen, weil die sehr lange zum Initialisieren
7307 <para>Das zweite Problem ist <function>strict</function>. Unter
7308 <function>strict</function> werden alle Variablen die nicht explizit
7309 mit <function>Package</function>, <function>my</function> oder
7310 <function>our</function> angegeben werden als Tippfehler angemarkert,
7311 dies hat, seit der Einführung, u.a. schon so manche langwierige
7312 Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package
7313 angegeben werden, werden die nicht geprüft, und somit kann sich
7314 schnell ein Tippfehler einschleichen.</para>
7318 <title>Kanonische globale Variablen</title>
7320 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
7321 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte
7322 vorgegebenen Eigenschaften, und alles andere sollte anderweitig
7323 umhergereicht werden.</para>
7325 <para>Diese Variablen sind im Moment die folgenden neun:</para>
7329 <para><varname>$::form</varname></para>
7333 <para><varname>%::myconfig</varname></para>
7337 <para><varname>$::locale</varname></para>
7341 <para><varname>$::lxdebug</varname></para>
7345 <para><varname>$::auth</varname></para>
7349 <para><varname>$::lx_office_conf</varname></para>
7353 <para><varname>$::instance_conf</varname></para>
7357 <para><varname>$::dispatcher</varname></para>
7361 <para><varname>$::request</varname></para>
7365 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im
7366 Folgenden eine kurze Erläuterung der bestimmten vorgegebenen
7367 Eigenschaften (Konventionen):</para>
7370 <title>$::form</title>
7374 <para>Ist ein Objekt der Klasse
7375 "<classname>Form</classname>"</para>
7379 <para>Wird nach jedem Request gelöscht</para>
7383 <para>Muss auch in Tests und Konsolenscripts vorhanden
7388 <para>Enthält am Anfang eines Requests die Requestparameter vom
7393 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
7394 cachen, das wird aber momentan absichtlich zerstört</para>
7398 <para><varname>$::form</varname> wurde unter <productname>SQL
7399 Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
7400 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
7401 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
7402 gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
7403 <function>IS->retrieve_customer()</function> in Sicherheit
7406 <para>Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man
7407 Berechnung in einem bestimmten Format durchführt (SL/Form.pm Zeile
7408 3552, Stand version 2.7beta), um dies hinterher wieder auf den
7409 richtigen Wert zu setzen:</para>
7411 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
7412 $::myconfig{numberformat} = $numberformat;
7413 # (...) div Berechnungen
7414 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
7416 <para>Das Objekt der Klasse Form hat leider im Moment noch viele
7417 zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
7418 nie einfach zerstören oder überschreiben (zumindestens nicht kurz
7419 vor einem Release oder in Absprache über bspw. die devel-Liste ;-).
7420 Es geht ziemlich sicher etwas kaputt.</para>
7422 <para><varname>$::form</varname> ist gleichzeitig der Standard Scope
7423 in den <productname>Template::Toolkit</productname> Templates
7424 außerhalb der Controller: der Ausdruck <function>[% var
7425 %]</function> greift auf <varname>$::form->{var}</varname> zu.
7426 Unter Controllern ist der Standard Scope anders, da lautet der
7427 Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
7428 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h.
7429 <function><%var%></function> zeigt auf
7430 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite
7431 erläutert, innerhalb von (Web-)Templates sieht man häufiger solche
7434 <programlisting>[%- IF business %]
7435 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
7436 [%- END %]</programlisting>
7438 <para>Entweder wird hier dann $::form->{business} ausgewertet
7439 oder aber der Funktion
7440 <function>$form->parse_html_template</function> wird explizit
7441 noch ein zusätzlicher Hash übergeben, der dann auch in den
7442 (Web-)Templates zu Verfügung steht, bspw. so:</para>
7444 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
7446 <para>Innerhalb von Schleifen wird
7447 <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname>
7448 bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm,
7449 welches über alle Positionen eines Lieferscheins in Schleife
7452 <programlisting>for $i (1 .. $form->{rowcount}) {
7454 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
7455 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
7456 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
7462 <title>%::myconfig</title>
7466 <para>Das einzige Hash unter den globalen Variablen</para>
7470 <para>Wird spätestens benötigt wenn auf die Datenbank
7471 zugegriffen wird</para>
7475 <para>Wird bei jedem Request neu erstellt.</para>
7479 <para>Enthält die Userdaten des aktuellen Logins</para>
7483 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
7484 extern serialisiert werden, weil da auch der Datenbankzugriff
7485 für diesen user drinsteht.</para>
7489 <para>Enthält unter anderem Datumsformat dateformat und
7490 Nummernformat numberformat</para>
7494 <para>Enthält Datenbankzugriffinformationen</para>
7498 <para><varname>%::myconfig</varname> ist im Moment der Ersatz für
7499 ein Userobjekt. Die meisten Funktionen, die etwas anhand des
7500 aktuellen Users entscheiden müssen, befragen
7501 <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies
7502 überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
7503 -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
7504 Informationen über den Benutzer die über die
7505 Administrator-Schnittstelle eingegeben wurden.</para>
7509 <title>$::locale</title>
7513 <para>Objekt der Klasse "Locale"</para>
7517 <para>Wird pro Request erstellt</para>
7521 <para>Muss auch für Tests und Scripte immer verfügbar
7526 <para>Cached intern über Requestgrenzen hinweg benutzte
7531 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
7532 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
7536 <title>$::lxdebug</title>
7540 <para>Objekt der Klasse "LXDebug"</para>
7544 <para>Wird global gecached</para>
7548 <para>Muss immer verfügbar sein, in nahezu allen
7553 <para><varname>$::lxdebug</varname> stellt Debuggingfunktionen
7554 bereit, wie "<function>enter_sub</function>" und
7555 "<function>leave_sub</function>", mit denen in den alten Modulen ein
7556 brauchbares Tracing gebaut ist, "<function>log_time</function>", mit
7557 der man die Wallclockzeit seit Requeststart loggen kann, sowie
7558 "<function>message</function>" und "<function>dump</function>" mit
7559 denen man flott Informationen ins Log (tmp/kivitendo-debug.log)
7562 <para>Beispielsweise so:</para>
7564 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
7565 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
7569 <title>$::auth</title>
7573 <para>Objekt der Klasse "SL::Auth"</para>
7577 <para>Wird global gecached</para>
7581 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
7585 <para>Wird nach jedem Request resettet.</para>
7589 <para><varname>$::auth</varname> stellt Funktionen bereit um die
7590 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
7591 vom aktuellen User abhängen wird das Objekt aus
7592 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
7593 Request kurz resettet.</para>
7595 <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
7596 Dessen Einstellungen können über
7597 <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
7598 ist ein Hash mit den Werten aus der Tabelle
7599 <literal>auth.clients</literal>.</para>
7603 <title>$::lx_office_conf</title>
7607 <para>Objekt der Klasse
7608 "<classname>SL::LxOfficeConf</classname>"</para>
7612 <para>Global gecached</para>
7616 <para>Repräsentation der
7617 <filename>config/kivitendo.conf[.default]</filename>-Dateien</para>
7621 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
7622 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass
7623 das Programm die Konfiguration ändern kann oder sollte.</para>
7625 <para>Beispielsweise ist über den Konfigurationseintrag [debug] die
7626 Debug- und Trace-Log-Datei wie folgt konfiguriert und
7629 <programlisting>[debug]
7630 file_name = /tmp/kivitendo-debug.log</programlisting>
7632 <para>ist der Key <varname>file</varname> im Programm als
7633 <varname>$::lx_office_conf->{debug}{file}</varname>
7637 <para>Zugriff auf die Konfiguration erfolgt im Moment über
7638 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
7643 <title>$::instance_conf</title>
7647 <para>Objekt der Klasse
7648 "<classname>SL::InstanceConfiguration</classname>"</para>
7652 <para>wird pro Request neu erstellt</para>
7656 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
7657 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
7658 ist hier eine Mandantendatenbank. Beispielsweise überprüft
7659 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
7660 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
7664 <title>$::dispatcher</title>
7668 <para>Objekt der Klasse
7669 "<varname>SL::Dispatcher</varname>"</para>
7673 <para>wird pro Serverprozess erstellt.</para>
7677 <para>enthält Informationen über die technische Verbindung zum
7682 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
7683 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
7684 Objekt untergebracht.</para>
7688 <title>$::request</title>
7692 <para>Hashref (evtl später Objekt)</para>
7696 <para>Wird pro Request neu initialisiert.</para>
7700 <para>Keine Unterstruktur garantiert.</para>
7704 <para><varname>$::request</varname> ist ein generischer Platz um
7705 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
7706 at a distance benutzt werden, sondern um lokales memoizing zu
7707 ermöglichen, das garantiert am Ende des Requests zerstört
7710 <para>Vieles von dem, was im moment in <varname>$::form</varname>
7711 liegt, sollte eigentlich hier liegen. Die groben
7712 Differentialkriterien sind:</para>
7716 <para>Kommt es vom User, und soll unverändert wieder an den
7717 User? Dann <varname>$::form</varname>, steht da eh schon</para>
7721 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des
7722 Requests gebraucht werden? Dann
7723 <varname>$::request</varname></para>
7727 <para>Muss ich von anderen Teilen des Programms lesend drauf
7728 zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
7729 Wrappermethode</para>
7736 <title>Ehemalige globale Variablen</title>
7738 <para>Die folgenden Variablen waren einmal im Programm, und wurden
7742 <title>$::cgi</title>
7746 <para>war nötig, weil cookie Methoden nicht als
7747 Klassenfunktionen funktionieren</para>
7751 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
7752 Klassennamespace gehalten wird und über Requestgrenzen
7757 <para>liegt jetzt unter
7758 <varname>$::request->{cgi}</varname></para>
7764 <title>$::all_units</title>
7768 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
7769 ein paar hundert mal pro Request eine Liste der Einheiten
7770 brauchen, und de als Parameter durch einen Riesenstack von
7771 Funktionen geschleift werden müssten.</para>
7775 <para>Liegt jetzt unter
7776 <varname>$::request->{cache}{all_units}</varname></para>
7781 <function>AM->retrieve_all_units()</function> gesetzt oder
7788 <title>%::called_subs</title>
7792 <para>wurde benutzt um callsub deep recursions
7797 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
7798 möglichen Rekursioenen darstellt, und da nie welche
7803 <para>komplette recursion protection wurde entfernt.</para>
7810 <sect1 id="devel.fcgi">
7811 <title>Entwicklung unter FastCGI</title>
7813 <sect2 id="devel.fcgi.general">
7814 <title>Allgemeines</title>
7816 <para>Wenn Änderungen in der Konfiguration von kivitendo gemacht
7817 werden, muss der Webserver neu gestartet werden.</para>
7819 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
7820 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
7821 müssen folgende Aspekte beachtet werden.</para>
7824 <sect2 id="devel.fcgi.exiting">
7825 <title>Programmende und Ausnahmen</title>
7827 <para>Betrifft die Funktionen <function>warn</function>,
7828 <function>die</function>, <function>exit</function>,
7829 <function>carp</function> und <function>confess</function>.</para>
7831 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
7832 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
7833 am Laufen zu halten. Man kann mit <function>die</function>,
7834 <function>confess</function> oder <function>carp</function> Fehler
7835 ausgeben, die dann vom Dispatcher angezeigt werden. Die kivitendo
7836 eigene <function>$::form-</function>error()> tut im Prinzip das
7837 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
7838 <function>exit</function> hingegen werden nicht abgefangen.
7839 <function>warn</function> wird direkt nach STDERR, also in Server Log
7840 eine Nachricht schreiben (sofern in der Konfiguration nicht die
7841 Warnungen in das kivitendo Log umgeleitet wurden), und
7842 <function>exit</function> wird die Ausführung beenden.</para>
7844 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
7845 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
7846 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
7847 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
7850 <sect2 id="devel.fcgi.globals">
7851 <title>Globale Variablen</title>
7853 <para>Um zu vermeiden, dass Informationen von einem Request in einen
7854 anderen gelangen, müssen alle globalen Variablen vor einem Request
7855 sauber initialisiert werden. Das ist besonders wichtig im
7856 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
7857 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
7860 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
7861 abgetrennten Block, der alle kanonischen globalen Variablen listet und
7862 erklärt. Bitte keine anderen einführen ohne das sauber zu
7863 dokumentieren.</para>
7865 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
7866 man sicher geht, dass man die richtige erwischt.</para>
7869 <sect2 id="devel.fcgi.performance">
7870 <title>Performance und Statistiken</title>
7872 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
7873 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
7874 Rechnungsmaske in kivitendo 2.4.3 stable dauert auf einem Core2duo mit
7875 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
7876 sind es je nach Menge der definierten Variablen 1-2s. Ab der
7877 Moose/Rose::DB Version sind es 5-6s.</para>
7879 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
7880 den kritischen Pfaden, unter 0,15 sonst.</para>
7884 <sect1 id="dev-programmatic-api-calls" xreflabel="Programmatische API-Aufrufe">
7885 <title>Programmatische API-Aufrufe</title>
7887 <sect2 id="dev-programmatic-api-calls.introduction" xreflabel="Einführung in programmatische API-Aufrufe">
7888 <title>Einführung</title>
7891 Es ist möglich, Funktionen in kivitendo programmatisch aus anderen Programmen aufzurufen. Dazu ist nötig, dass
7892 Authentifizierungsinformationen in jedem Aufruf mitgegeben werden. Dafür gibt es zwei Methoden: die HTTP-»Basic«-Authentifizierung
7893 oder die Übergabe als spziell benannte GET-Parameter. Neben den Authentifizierungsinformationen muss auch der zu verwendende Mandant
7898 <sect2 id="dev-programmatic-api-calls.client_selection" xreflabel="Mandantenauswahl bei programmatischen API-Aufrufen">
7899 <title>Wahl des Mandanten</title>
7902 Der zu verwendende Mandant kann als Parameter <varname>{AUTH}client_id</varname> mit jedem Request mitgeschickt werden. Der Wert
7903 muss dabei die Datenbank-ID des Mandanten sein. kivitendo prüft, ob der Account, der über die Authentifizierungsinformationen
7904 übergeben wurde, Zugriff auf den angegebenen Mandanten hat.
7908 Wird in einem Request kein Mandant mitgegeben, so wird derjenige Mandant genommen, wer als Standardmandant markiert wurde. Gibt es
7909 keinen solchen, kommt es zu einer Fehlermeldung.
7913 <sect2 id="dev-programmatic-api-calls.http_basic_authentication" xreflabel="Programmatische API-Aufrufe mit HTTP-»Basic« authentifizieren">
7914 <title>HTTP-»Basic«-Authentifizierung</title>
7917 Für diese Methode muss jedem Request der bekannte HTTP-Header <constant>Authorization</constant> mitgeschickt werden (siehe <ulink
7918 url="https://tools.ietf.org/html/rfc7617">RFC 7617</ulink>). Unterstützt wird ausschließlich die »Basic«-Methode. Loginname und
7919 Passwort werden bei dieser Methode durch einen Doppelpunkt getrennt und Base64-encodiert im genannten HTTP-Header übertragen.
7923 Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei Benutzung über den Webbrowser, ob
7924 dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
7928 Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
7933 <sect2 id="dev-programmatic-api-calls.authentication_via_parameters" xreflabel="Programmatische API-Aufrufe mit Parametern authentifizieren">
7934 <title>Authentifizierung mit Parametern</title>
7937 Für diese Methode müssen jedem Request zwei Parameter mitgegeben werden: <varname>{AUTH}login</varname> und
7938 <varname>{AUTH}password</varname>. Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei
7939 Benutzung über den Webbrowser, ob dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
7943 Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
7949 Die Verwendung dieser Methode ist veraltet. Statt dessen sollte die oben erwähnte HTTP-»Basic«-Authentifizierung verwendet werden.
7954 <sect2 id="dev-programmatic-api-calls.examples">
7955 <title>Beispiele</title>
7958 Das folgende Beispiel nutzt das Kommandozeilenprogramm »curl« und ruft die Funktion auf, die eine vorhandene Telefonnummer in den
7959 Ansprechpersonen sucht und dazu Informationen zurückliefert. Dabei wird die HTTP-»Basic«-Authentifizierung genutzt.
7962 <programlisting>$ curl --silent --user 'jdoe:SecretPassword!' \
7963 'https://…/controller.pl?action=PhoneNumber/look_up&number=053147110815'</programlisting>
7967 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
7968 <title>SQL-Upgradedateien</title>
7970 <sect2 id="db-upgrade-files.introduction"
7971 xreflabel="Einführung in die Datenbank-Upgradedateien">
7972 <title>Einführung</title>
7974 <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
7975 gesteuert, die sich im Verzeichnis
7976 <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
7977 muss pro Datenbankupgrade eine Datei existieren, die neben den
7978 eigentlich auszuführenden SQL- oder Perl-Befehlen einige
7979 Kontrollinformationen enthält.</para>
7981 <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
7982 sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
7983 werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
7984 werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
7985 wurde), diese Reihenfolge aber so flexibel ist, dass man keine
7986 Versionsnummern braucht.</para>
7988 <para>kivitendo merkt sich dabei, welches der Upgradescripte in
7989 <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
7990 führt diese nicht erneut aus. Dazu dient die Tabelle
7991 "<literal>schema_info</literal>", die bei der Anmeldung automatisch
7992 angelegt wird.</para>
7995 <sect2 id="db-upgrade-files.format"
7996 xreflabel="Format der Upgradedateien">
7997 <title>Format der Kontrollinformationen</title>
7999 <para>Die Kontrollinformationen sollten sich am Anfang der jeweiligen
8000 Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
8001 hat dabei das folgende Format:</para>
8003 <para>Für SQL-Upgradedateien:</para>
8005 <programlisting>-- @key: value</programlisting>
8007 <para>Für Perl-Upgradedateien:</para>
8009 <programlisting># @key: value</programlisting>
8011 <para>Leerzeichen vor "<varname>value</varname>" werden
8014 <para>Die folgenden Schlüsselworte werden verarbeitet:</para>
8018 <term><varname>tag</varname></term>
8021 <para>Wird zwingend benötigt. Dies ist der "Name" des Upgrades.
8022 Dieser "tag" kann von anderen Kontrolldateien in ihren
8023 Abhängigkeiten verwendet werden (Schlüsselwort
8024 "<varname>depends</varname>"). Der "tag" ist auch der Name, der
8025 in der Datenbank eingetragen wird.</para>
8027 <para>Normalerweise sollte die Kontrolldatei genau so heißen wie
8028 der "tag", nur mit der Endung ".sql" bzw. "pl".</para>
8030 <para>Ein Tag darf nur aus alphanumerischen Zeichen sowie den
8031 Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht
8032 erlaubt und sollten stattdessen mit Unterstrichen ersetzt
8038 <term><varname>charset</varname></term>
8041 <para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
8042 geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
8043 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
8044 Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
8045 "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
8046 hingegen müssen immer in UTF-8 encodiert sein und sollten
8047 demnach auch ein "<literal>use utf8;</literal>"
8053 <term><varname>description</varname></term>
8056 <para>Benötigt. Eine Beschreibung, was in diesem Update
8057 passiert. Diese wird dem Benutzer beim eigentlichen
8058 Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
8059 sein sollte, sollte die Beschreibung auf Deutsch
8065 <term><varname>depends</varname></term>
8068 <para>Optional. Eine mit Leerzeichen getrennte Liste von "tags",
8069 von denen dieses Upgradescript abhängt. kivitendo stellt sicher,
8070 dass die in dieser Liste aufgeführten Scripte bereits
8071 durchgeführt wurden, bevor dieses Script ausgeführt wird.</para>
8073 <para>Abhängigkeiten werden rekursiv betrachtet. Wenn also ein
8074 Script "b" existiert, das von Änderungen in "a" abhängt, und
8075 eine neue Kontrolldatei für "c" erstellt wird, die von
8076 Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den
8077 Tag "b" als Abhängigkeit zu definieren.</para>
8079 <para>Es ist nicht erlaubt, sich selbst referenzierende
8080 Abhängigkeiten zu definieren (z.B. "a" -> "b", "b" -> "c"
8081 und "c" -> "a").</para>
8086 <term><varname>priority</varname></term>
8089 <para>Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in
8090 der Scripte ausgeführt werden, die die gleichen
8091 Abhängigkeitstiefen besitzen. Fehlt dieser Parameter, so wird
8092 der Wert 1000 benutzt.</para>
8094 <para>Dies ist reine Kosmetik. Für echte Reihenfolgen muss
8095 "depends" benutzt werden. kivitendo sortiert die auszuführenden
8096 Scripte zuerst nach der Abhängigkeitstiefe (wenn "z" von "y"
8097 abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von
8098 2, "y" von 1 und "x" von 0. "x" würde hier zuerst ausgeführt,
8099 dann "y", dann "z"), dann nach der Priorität und bei gleicher
8100 Priorität alphabetisch nach dem "tag".</para>
8105 <term><varname>ignore</varname></term>
8108 <para>Optional. Falls der Wert auf 1 (true) steht, wird das
8109 Skript bei der Anmeldung ignoriert und entsprechend nicht
8116 <sect2 id="db-upgrade-files.format-perl-files"
8117 xreflabel="Format von Perl-Upgradedateien">
8118 <title>Format von in Perl geschriebenen
8119 Datenbankupgradescripten</title>
8121 <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
8122 ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
8123 bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
8125 <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
8126 dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
8127 erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
8128 stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
8129 Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
8130 aufgerufen wird.</para>
8132 <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
8133 für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
8134 in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
8135 ersetzt. Insgesamt sieht der Paketname wie folgt aus:
8136 "<literal>SL::DBUpgrade2::tag</literal>".</para>
8138 <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
8139 der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
8140 "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
8142 <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
8145 <programlisting># @tag: beispiel-upgrade-file42
8146 # @description: Ein schönes Beispielscript
8147 # @depends: release_3_1_0
8148 package SL::DBUpgrade2::beispiel_upgrade_file42;
8153 use parent qw(SL::DBUpgrade2::Base);
8158 # hier Aktionen ausführen
8167 <sect2 id="db-upgrade-files.dbupgrade-tool"
8168 xreflabel="Hilfsscript dbupgrade2_tool.pl">
8169 <title>Hilfsscript dbupgrade2_tool.pl</title>
8171 <para>Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern,
8172 existiert ein Hilfsscript namens
8173 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem
8174 kivitendo-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses Tool
8175 liest alle Datenbankupgradescripte aus dem Verzeichnis
8176 <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die
8177 gleichen Methoden wie kivitendo selber, sodass alle Fehlersituationen
8178 von der Kommandozeile überprüft werden können.</para>
8180 <para>Wird dem Script kein weiterer Parameter übergeben, so wird nur
8181 eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
8182 sich aber auch Informationen auf verschiedene Art ausgeben
8187 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl
8188 --list</command>"</para>
8190 <para>Gibt eine Liste aller Scripte aus. Die Liste ist in der
8191 Reihenfolge sortiert, in der kivitendo die Scripte ausführen
8192 würde. Es werden neben der Listenposition der Tag, die
8193 Abhängigkeitstiefe und die Priorität ausgegeben.</para>
8197 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl
8198 --tree</command>"</para>
8200 <para>Listet alle Tags in Baumform basierend auf den
8201 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von
8202 denen keine anderen abhängen. Die Unterknoten sind Scripte, die
8203 beim übergeordneten Script als Abhängigkeit eingetragen
8207 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
8208 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl
8209 --rtree</command>"</para>
8211 <para>Listet alle Tags in Baumform basierend auf den
8212 Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit
8213 der geringsten Abhängigkeitstiefe. Die Unterknoten sind Scripte,
8214 die das übergeordnete Script als Abhängigkeit eingetragen
8219 <para>Baumform mit Postscriptausgabe:
8220 "<command>./scripts/dbupgrade2_tool.pl
8221 --graphviz</command>"</para>
8223 <para>Benötigt das Tool "<command>graphviz</command>", um mit
8224 seiner Hilfe die <link
8225 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte
8226 Baumform</link> in eine Postscriptdatei namens
8227 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist
8228 vermutlich die übersichtlichste Form, weil hierbei jeder Knoten
8229 nur einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen
8230 können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben
8235 <para>Scripte, von denen kein anderes Script abhängt:
8236 "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"</para>
8238 <para>Listet die Tags aller Scripte auf, von denen keine anderen
8239 Scripte abhängen.</para>
8245 <sect1 id="translations-languages" xreflabel="Translations and languages">
8246 <title>Translations and languages</title>
8248 <sect2 id="translations-languages.introduction"
8249 xreflabel="Introduction to translations and languages">
8250 <title>Introduction</title>
8253 <para>Dieser Abschnitt ist in Englisch geschrieben, um
8254 internationalen Übersetzern die Arbeit zu erleichtern.</para>
8257 <para>This section describes how localization packages in kivitendo
8258 are built. Currently the only language fully supported is German, and
8259 since most of the internal messages are held in English the English
8260 version is usable too.</para>
8263 <sect2 id="translations-languages.character-set"
8264 xreflabel="Character set">
8265 <title>Character set</title>
8267 <para>All files included in a language pack must use UTF-8 as their
8271 <sect2 id="translations-languages.file-structure"
8272 xreflabel="File structure">
8273 <title>File structure</title>
8275 <para>The structure of locales in kivitendo is:</para>
8277 <programlisting>kivitendo/locale/<langcode>/</programlisting>
8279 <para>where <langcode> stands for an abbreviation of the
8280 language package. The builtin packages use two letter <ulink
8281 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
8282 but the actual name is not relevant for the program and can easily be
8284 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
8285 tags</ulink> (i.e. "en_GB"). In fact the original language packages
8286 from SQL Ledger are named in this way.</para>
8288 <para>In such a language directory the following files are
8293 <term>LANGUAGE</term>
8296 <para>This file is mandatory.</para>
8298 <para>The <filename>LANGUAGE</filename> file contains the self
8299 descripted name of the language. It should contain a native
8300 representation first, and in parenthesis an english translation
8301 after that. Example:</para>
8303 <programlisting>Deutsch (German)</programlisting>
8311 <para>This file is mandatory.</para>
8313 <para>The central translation file. It is essentially an inline
8314 Perl script autogenerated by <command>locales.pl</command>. To
8315 generate it, generate the directory and the two files mentioned
8316 above, and execute the following command:</para>
8318 <programlisting>scripts/locales.pl <langcode></programlisting>
8320 <para>Otherwise you can simply copy one of the other languages.
8321 You will be told how many are missing like this:</para>
8323 <programlisting>$ scripts/locales.pl en
8324 English - 0.6% - 2015/2028 missing</programlisting>
8326 <para>A file named "<filename>missing</filename>" will be
8327 generated and can be edited. You can also edit the
8328 "<filename>all</filename>" file directly. Edit everything you
8329 like to fit the target language and execute
8330 <command>locales.pl</command> again. See how the missing words
8336 <term>Num2text</term>
8339 <para>Legacy code from SQL Ledger. It provides a means for
8340 numbers to be converted into natural language, like
8341 <literal>1523 => one thousand five hundred twenty
8342 three</literal>. If you want to provide it, it must be inlinable
8343 Perl code which provides a <function>num2text</function> sub. If
8344 an <function>init</function> sub exists it will be executed
8347 <para>Only used in the check and receipt printing module.</para>
8352 <term>special_chars</term>
8355 <para>kivitendo comes with a lot of interfaces to different
8356 formats, some of which are rather picky with their accepted
8357 charset. The <filename>special_chars</filename> file contains a
8358 listing of chars not suited for different file format and
8359 provides substitutions. It is written in "Simple Ini" style,
8360 containing a block for every file format.</para>
8362 <para>First entry should be the order of substitution for
8363 entries as a whitespace separated list. All entries are
8364 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
8365 and <literal>\\</literal> all work.</para>
8367 <para>After that every entry is a special char that should be
8368 translated when writing text into such a file.</para>
8370 <para>Example:</para>
8372 <programlisting>[Template/XML]
8373 order=& < > \n
8377 \n=<br></programlisting>
8379 <para>Note the importance of the order in this example.
8380 Substituting < and > befor & would lead to $gt; become
8383 <para>For a list of valid formats, see the German
8384 <filename>special_chars</filename> entry. As of this writing the
8385 following are recognized:</para>
8387 <programlisting>HTML
8392 Template/OpenDocument
8393 filenames</programlisting>
8395 <para>The last of which is very machine dependant. Remember that
8396 a lot of characters are forbidden by some filesystems, for
8397 example MS Windows doesn't like ':' in its files where Linux
8398 doesn't mind that. If you want the files created with your
8399 language pack to be portable, find all chars that could cause
8405 <term>missing</term>
8408 <para>This file is not a part of the language package
8411 <para>This is a file generated by
8412 <command>scripts/locales.pl</command> while processing your
8413 locales. It's only to have the missing entries singled out and
8414 does not belong to a language package.</para>
8422 <para>This file is not a part of the language package
8425 <para>Another file generated by
8426 <command>scripts/locales.pl</command>. If for any reason a
8427 translation does not appear anymore and can be deleted, it gets
8428 moved here. The last 50 or so entries deleted are saved here in
8429 case you made a typo, so that you don't have to translate
8430 everything again. If a tranlsation is missing, the lost file is
8431 checked first. If you maintain a language package, you might
8432 want to keep this safe somewhere.</para>
8437 <term>more/all</term>
8440 <para>This subdir and file is not a part of the language package
8443 <para>If the directory more exists and contains a file called
8444 all it will be parsed in addition to the mandatory all (see
8445 above). The file is useful if you want to change some
8446 translations for the current installation without conflicting
8447 further upgrades. The file is not autogenerated and has the same
8448 format as the all, but needs another key (more_texts). See the
8449 german translation for an example or copy the following code:
8452 # -*- coding: utf-8; -*-
8457 # These are additional texts for custom translations.
8458 # The format is the same as for the normal file all, only
8459 # with another key (more_texts instead of texts).
8460 # The file has the form of 'english text' => 'foreign text',
8462 $self->{more_texts} = {
8464 'Ship via' => 'Terms of delivery',
8465 'Shipping Point' => 'Delivery time',
8467 </programlisting></para>
8474 <sect1 id="devel.testsuite">
8475 <title>Die kivitendo-Test-Suite</title>
8477 <sect2 id="devel.testsuite.intro">
8478 <title>Einführung</title>
8480 <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
8481 basiert auf dem Standard-Perl-Modul
8482 <literal>Test::More</literal>.</para>
8484 <para>Die grundlegenden Fakten sind:</para>
8488 <para>Alle Tests liegen im Unterverzeichnis
8489 <filename>t/</filename>.</para>
8493 <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
8494 enthält einen oder mehrere Testfälle.</para>
8498 <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
8499 Es sind selbstständig ausführbare Perl-Scripte.</para>
8503 <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
8504 sprich aller Scripte in <filename>t/</filename>, deren Dateiname
8505 auf <literal>.t</literal> endet.</para>
8510 <sect2 id="devel.testsuite.prerequisites">
8511 <title>Voraussetzungen</title>
8513 <para>Für die Ausführung werden neben den für kivitendo eh schon
8514 benötigten Module noch weitere Perl-Module benötigt. Diese
8519 <para><literal>Test::Deep</literal> (Debian-Paketname:
8520 <literal>libtest-deep-perl</literal>; Fedora:
8521 <literal>perl-Test-Deep</literal>; openSUSE:
8522 <literal>perl-Test-Deep</literal>)</para>
8526 <para><literal>Test::Exception</literal> (Debian-Paketname:
8527 <literal>libtest-exception-perl</literal>; Fedora:
8528 <literal>perl-Test-Exception</literal>; openSUSE:
8529 <literal>perl-Test-Exception</literal>)</para>
8533 <para><literal>Test::Output</literal> (Debian-Paketname:
8534 <literal>libtest-output-perl</literal>; Fedora:
8535 <literal>perl-Test-Output</literal>; openSUSE:
8536 <literal>perl-Test-Output</literal>)</para>
8540 <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
8541 Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
8542 kann für frühere Versionen aus dem <ulink
8543 url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
8547 <para><literal>LWP::Simple</literal> aus dem Paket
8548 <literal>libwww-perl</literal> (Debian-Panetname:
8549 <literal>libwww-perl</literal>; Fedora:
8550 <literal>perl-libwww-perl</literal>; openSUSE:
8551 <literal>perl-libwww-perl</literal>)</para>
8555 <para><literal>URI::Find</literal> (Debian-Panetname:
8556 <literal>liburi-find-perl</literal>; Fedora:
8557 <literal>perl-URI-Find</literal>; openSUSE:
8558 <literal>perl-URI-Find</literal>)</para>
8562 <para><literal>Sys::CPU</literal> (Debian-Panetname:
8563 <literal>libsys-cpu-perl</literal>; Fedora und openSUSE: nicht
8568 <para><literal>Thread::Pool::Simple</literal> (Debian-Panetname:
8569 <literal>libthread-pool-simple-perl</literal>; Fedora und
8570 openSUSE: nicht vorhanden)</para>
8574 <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
8575 Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
8576 müssen in der Konfigurationsdatei im Abschnit
8577 <literal>testing/database</literal> Datenbankverbindungsparameter
8578 angegeben werden. Der hier angegebene Benutzer muss weiterhin das
8579 Recht haben, Datenbanken anzulegen und zu löschen.</para>
8581 <para>Der so angegebene Benutzer muss nicht zwingend über
8582 Super-User-Rechte verfügen. Allerdings gibt es einige
8583 Datenbank-Upgrades, die genau diese Rechte benötigen. Für den Fall
8584 kann man in diesem Konfigurationsabschnitt einen weiteren
8585 Benutzeraccount angeben, der dann über Super-User-Rechte verfügt, und
8586 mit dem die betroffenen Upgrades durchgeführt werden. In der
8587 Beispiel-Konfigurationsdatei finden Sie die benötigten
8591 <sect2 id="devel.testsuite.execution">
8592 <title>Existierende Tests ausführen</title>
8594 <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
8595 man lässt alle Tests auf einmal ausführen, oder man führt gezielt
8596 einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
8597 <filename>t/test.pl</filename>.</para>
8599 <para>Will man die komplette Test-Suite ausführen, so muss man einfach
8600 nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
8601 kivitendo-Basisverzeichnis heraus ausführen.</para>
8603 <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
8604 an <filename>t/test.pl</filename>. Beispielsweise:</para>
8606 <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
8609 <sect2 id="devel.testsuite.meaning_of_scripts">
8610 <title>Bedeutung der verschiedenen Test-Scripte</title>
8612 <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
8613 Programmierstil. Einige besonders zu erwähnende, weil auch während der
8614 Entwicklung nützliche Tests sind:</para>
8618 <para><filename>t/001compile.t</filename> -- compiliert alle
8619 Quelldateien und bricht bei Fehlern sofort ab</para>
8623 <para><filename>t/002goodperl.t</filename> -- überprüft alle
8624 Perl-Dateien auf Anwesenheit von '<literal>use
8625 strict</literal>'-Anweisungen</para>
8629 <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
8630 <function>system()</function> und <function>exec()</function> auf
8635 <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
8636 Tab-Zeichen enthalten</para>
8640 <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
8641 Rechtschreibfehlern</para>
8645 <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
8646 Dokumentation im POD-Format auf Gültigkeit</para>
8650 <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
8651 einzelner Funktionen und Module.</para>
8654 <sect2 id="devel.testsuite.create_new">
8655 <title>Neue Test-Scripte erstellen</title>
8657 <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
8658 mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
8659 und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
8662 <sect3 id="devel.testsuite.ideas_for_non_function_tests">
8663 <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
8666 <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
8671 <para>Überprüfung auf fehlende symbolische Links</para>
8675 <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
8676 gewissen Einschränkungen wie das Erlauben von deutschen
8681 <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
8685 <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
8689 <para>Test, ob alle zu übersetzenden Strings in
8690 <filename>locale/de/all</filename> vorhanden sind</para>
8694 <para>Test, ob alle Webseiten-Templates in
8695 <filename>templates/webpages</filename> mit vom Perl-Modul
8696 <literal>Template</literal> compiliert werden können</para>
8701 <sect3 id="devel.testsuite.directory_and_test_names">
8702 <title>Konvention für Verzeichnis- und Dateinamen</title>
8704 <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
8705 benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
8706 und ihnen soweit es geht folgen:</para>
8710 <para>Die Dateiendung muss <filename>.t</filename>
8715 <para>Namen sind englisch, komplett klein geschrieben und
8716 einzelne Wörter mit Unterstrichten getrennt (beispielsweise
8717 <filename>bad_function_params.t</filename>).</para>
8721 <para>Unterverzeichnisse sollten grob nach dem Themenbereich
8722 benannt sein, mit dem sich die Scripte darin befassen
8723 (beispielsweise <filename>background_jobs</filename> für Tests
8724 rund um Hintergrund-Jobs).</para>
8728 <para>Test-Scripte sollten einen überschaubaren Bereich von
8729 Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
8730 Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
8731 Test-Scripte schreiben.</para>
8736 <sect3 id="devel.testsuite.minimal_example">
8737 <title>Minimales Skelett für eigene Scripte</title>
8739 <para>Der folgenden Programmcode enthält das kleinstmögliche
8740 Testscript und kann als Ausgangspunkt für eigene Tests verwendet
8743 <programlisting>use Test::More tests => 0;
8747 use Support::TestSetup;
8749 Support::TestSetup::login();</programlisting>
8751 <para>Wird eine vollständig initialisierte kivitendo-Umgebung
8752 benötigt (Stichwort: alle globalen Variablen wie
8753 <varname>$::auth</varname>, <varname>$::form</varname> oder
8754 <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
8755 <filename>config/kivitendo.conf</filename> im Abschnitt
8756 <literal>testing.login</literal> ein gültiger Login-Name eingetragen
8757 sein. Dieser wird für die Datenbankverbindung benötigt.</para>
8759 <para>Wir keine vollständig initialisierte Umgebung benötigt, so
8760 kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
8761 weggelassen werden, was die Ausführungszeit des Scripts leicht
8767 <sect1 id="devel.style-guide">
8768 <title>Stil-Richtlinien</title>
8770 <para>Die folgenden Regeln haben das Ziel, den Code möglichst gut les-
8771 und wartbar zu machen. Dazu gehört zum Einen, dass der Code einheitlich
8772 eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden
8773 wird (Stichworte "Klammern" oder "Hash-Keys").</para>
8775 <para>Diese Regeln sind keine Schikane sondern erleichtern allen das
8778 <para>Jeder, der einen Patch schickt, sollte seinen Code vorher
8779 überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
8784 <para>Es werden keine echten Tabs sondern Leerzeichen
8789 <para>Die Einrückung beträgt zwei Leerzeichen. Beispiel:</para>
8791 <programlisting>foreach my $row (@data) {
8793 # do something with $row
8797 $row->{modules} = MODULE->retrieve(
8798 id => $row->{id},
8799 date => $use_now ? localtime() : $row->{time},
8803 $report->add($row);
8808 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen
8809 Zeile wie der letzte Befehl. Beispiele:</para>
8811 <programlisting>sub debug {
8817 <programlisting>if ($form->{item_rows} > 0) {
8823 <para>Schließende geschweifte Klammern sind so weit eingerückt wie
8824 der Befehl / die öffnende schließende Klammer, die den Block
8825 gestartet hat, und nicht auf der Ebene des Inhalts. Die gleichen
8826 Beispiele wie bei 3. gelten.</para>
8830 <para>Die Wörter "<function>else</function>",
8831 "<function>elsif</function>", "<function>while</function>" befinden
8832 sich auf der gleichen Zeile wie schließende geschweifte Klammern.
8835 <programlisting>if ($form->{sum} > 1000) {
8837 } elsif ($form->{sum} > 0) {
8845 } until ($a > 0);</programlisting>
8849 <para>Parameter von Funktionsaufrufen müssen mit runden Klammern
8850 versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
8851 und grep-ähnliche Operatoren. Beispiel:</para>
8853 <programlisting>$main::lxdebug->message("Could not find file.");
8854 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
8858 <para>Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:</para>
8860 <para>Generell gilt: Hashkeys und Arrayindices sollten nicht durch
8861 Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
8862 Blöcke schon. Beispiel:</para>
8864 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
8869 $form->{sum} += $form->{"row_$i"};
8870 $form->{ $form->{index} } += 1;
8872 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
8876 <para>Mehrzeilige Befehle</para>
8880 <para>Werden die Parameter eines Funktionsaufrufes auf mehrere
8881 Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
8882 werden, in der die ersten Funktionsparameter in der ersten Zeile
8883 stehen. Beispiel:</para>
8885 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
8886 $form->{some_col_value});</programlisting>
8890 <para>Ein Spezialfall ist der ternäre Operator "?:", der am
8891 besten in einer übersichtlichen Tabellenstruktur organisiert
8892 wird. Beispiel:</para>
8894 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
8895 : $form->{oldcount} ? $form->{oldcount} + 1
8896 : $form->{rowcount} - $form->{rowbase};</programlisting>
8902 <para>Kommentare</para>
8906 <para>Kommentare, die alleine in einer Zeile stehen, sollten
8907 soweit wie der Code eingerückt sein.</para>
8911 <para>Seitliche hängende Kommentare sollten einheitlich
8912 formatiert werden.</para>
8916 <para>Sämtliche Kommentare und Sonstiges im Quellcode ist bitte
8917 auf Englisch zu verfassen. So wie ich keine Lust habe,
8918 französischen Quelltext zu lesen, sollte auch der kivitendo
8919 Quelltext für nicht-Deutschsprachige lesbar sein.
8922 <programlisting>my $found = 0;
8930 $i = 0 # initialize $i
8932 $i *= $const; # do something crazy
8933 $i = $n; # recover $i</programlisting>
8939 <para>Hashkeys sollten nur in Anführungszeichen stehen, wenn die
8940 Interpolation gewünscht ist. Beispiel:</para>
8942 <programlisting>$form->{sum} = 0;
8943 $form->{"row_$i"} = $form->{"row_$i"} - 5;
8944 $some_hash{42} = 54;</programlisting>
8948 <para>Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen
8949 unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
8950 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in
8951 grossen Tabellen), dann ist Lesbarkeit vorzuziehen.</para>
8953 <para>Als Beispiel sei die Funktion
8954 <function>print_options</function> aus
8955 <filename>bin/mozilla/io.pl</filename> angeführt.</para>
8959 <para>Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind
8960 unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die diffs
8963 <para>Emacs und vim haben beide recht einfache Methoden zur
8964 Entfernung von trailing whitespace. Emacs kennt das Kommande
8965 <command>nuke-trailing-whitespace</command>, vim macht das gleiche
8966 manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
8967 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern
8972 <para>Es wird kein <command>perltidy</command> verwendet.</para>
8974 <para>In der Vergangenheit wurde versucht,
8975 <command>perltidy</command> zu verwenden, um einen einheitlichen
8976 Stil zu erlangen. Es hat sich aber gezeigt, dass
8977 <command>perltidy</command>s sehr eigenwilliges Verhalten, was
8978 Zeilenumbrüche angeht, oftmals gut formatierten Code zerstört. Für
8979 den Interessierten sind hier die
8980 <command>perltidy</command>-Optionen, die grob den beschriebenen
8981 Richtlinien entsprechen:</para>
8983 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
8984 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
8985 -lp -vt=1 -vtc=1</programlisting>
8989 <para><varname>STDERR</varname> ist tabu. Unkonditionale
8990 Debugmeldungen auch.</para>
8992 <para>kivitendo bietet mit dem Modul <classname>LXDebug</classname>
8993 einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
8994 Grund, nach <varname>STDERR</varname> zu schreiben.</para>
8996 <para>Die <classname>LXDebug</classname>-Methode
8997 "<function>message</function>" nimmt als ersten Paramter außerdem
8998 eine Flagmaske, für die die Meldung angezeigt wird, wobei "0" immer
8999 angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden
9000 und werden in den meisten Fällen auch vom Repository
9001 zurückgewiesen.</para>
9005 <para>Alle neuen Module müssen use strict verwenden.</para>
9007 <para><varname>$form</varname>, <varname>$auth</varname>,
9008 <varname>$locale</varname>, <varname>$lxdebug</varname> und
9009 <varname>%myconfig</varname> werden derzeit aus dem main package
9010 importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
9011 Konstrukte sollten lexikalisch lokal gehalten werden.</para>
9016 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
9017 <title>Dokumentation erstellen</title>
9019 <sect2 id="devel.build-doc.introduction">
9020 <title>Einführung</title>
9022 <para>Diese Dokumentation ist in <productname>DocBook</productname>
9023 XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein Text-Editor.
9024 Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen
9025 Editor nutzt, der spezielle Unterstützung für
9026 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den
9027 <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
9028 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos
9032 <sect2 id="devel.build-doc.required-software">
9033 <title>Benötigte Software</title>
9035 <para>Bei <productname>DocBook</productname> ist Prinzip, dass
9036 ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden
9037 dann mit entsprechenden Stylesheets andere Formate wie PDF oder HTML
9038 erzeugt. Bei kivitendo übernimmt diese Aufgabe das Shell-Script
9039 <command>scripts/build_doc.sh</command>.</para>
9041 <para>Das Script benötigt zur Konvertierung verschiedene
9042 Softwarekomponenten, die im normalen kivitendo-Betrieb nicht benötigt
9048 url="http://www.oracle.com/technetwork/java/index.html">Java</ulink>
9049 in einer halbwegs aktuellen Version</para>
9053 <para>Das Java-Build-System <ulink
9054 url="http://ant.apache.org/">Apache Ant</ulink></para>
9058 <para>Das Dokumentations-System Dobudish für
9059 <productname>DocBook</productname> 4.5, eine Zusammenstellung
9060 diverser Stylesheets und Grafiken zur Konvertierung von
9061 <productname>DocBook</productname> XML in andere Formate. Das
9062 Paket, das benötigt wird, ist zum Zeitpunkt der
9063 Dokumentationserstellung
9064 <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
9065 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink>
9070 <para>Apache Ant sowie ein dazu passendes Java Runtime Environment
9071 sind auf allen gängigen Plattformen verfügbar. Beispiel für
9072 Debian/Ubuntu:</para>
9074 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
9076 <para>Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis
9077 <filename>doc/build</filename> entpackt werden. Beispiel unter der
9078 Annahme, das <productname>Dobudish</productname> in
9079 <filename>$HOME/Downloads</filename> heruntergeladen wurde:</para>
9081 <programlisting>cd doc/build
9082 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
9085 <sect2 id="devel.build-doc.build">
9086 <title>PDFs und HTML-Seiten erstellen</title>
9088 <para>Die eigentliche Konvertierung erfolgt nach Installation der
9089 benötigten Software mit einem einfachen Aufruf direkt aus dem
9090 kivitendo-Installationsverzeichnis heraus:</para>
9092 <programlisting>./scripts/build_doc.sh</programlisting>
9095 <sect2 id="devel.build-doc.repository">
9096 <title>Einchecken in das Git-Repository</title>
9098 <para>Sowohl die XML-Datei als auch die erzeugten PDF- und
9099 HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass
9100 nach Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut
9101 und alles zusammen in einem Commit eingecheckt werden sollten.</para>
9103 <para>Die "<filename>dobudish</filename>"-Verzeichnisse bzw.
9104 symbolischen Links gehören hingegen nicht in das Repository.</para>