<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<book id="kivitendo-documentation" lang="de">
- <title>kivitendo: Installation, Konfiguration, Entwicklung</title>
+ <title>kivitendo 3.5.0: Installation, Konfiguration, Entwicklung</title>
<chapter id="Aktuelle-Hinweise">
<title>Aktuelle Hinweise</title>
<itemizedlist>
<listitem>
- <para>im
kivitendo-Forum: <ulink
- url="https://forum.kivitendo.org/">https://forum.kivitendo.org/</ulink></para>
+ <para>im
Community-Forum: <ulink
+ url="https://forum.kivitendo.de:32443">https://forum.kivitendo.de:32443</ulink></para>
</listitem>
<listitem>
- <para>im alten Lx-Office-Wiki unter Dokumentation (<ulink
- url="http://wiki.lx-office.org/index.php?title=Installation_Lx-Office_ERP">http://wiki.lx-office.org/index.php?title=Installation_Lx-Office_ERP</ulink>)</para>
+ <para>im Kunden-Forum: <ulink
+ url="http://redmine.kivitendo-premium.de/projects/forum/boards/">http://redmine.kivitendo-premium.de/projects/forum/boards/</ulink></para>
+ </listitem>
+
+ <listitem>
+ <para>in der doc/UPGRADE Datei im doc-Verzeichnis der
+ Installation</para>
+ </listitem>
+
+ <listitem>
+ <para>Im Schulungs- und Dienstleistungsangebot der entsprechenden
+ kivitendo-Partner: <ulink
+ url="http://www.kivitendo.de/partner.html">http://www.kivitendo.de/partner.html</ulink></para>
</listitem>
</itemizedlist>
</chapter>
<chapter id="config">
<title>Installation und Grundkonfiguration</title>
+ <sect1 id="Installation-Übersicht">
+ <title>Übersicht</title>
+
+ <para>Die Installation von kivitendo umfasst mehrere Schritte. Die
+ folgende Liste kann sowohl für Neulinge als auch für alte Hasen als
+ Übersicht und Stichpunktliste zum Abhaken dienen, um eine Version mit
+ minimalen Features möglichst schnell zum Laufen zu kriegen.</para>
+
+ <orderedlist>
+ <listitem>
+ <para><emphasis>Voraussetzungen überprüfen</emphasis>: kivitendo
+ benötigt gewisse Ressourcen und benutzt weitere Programme. Das
+ Kapitel "<xref linkend="Benötigte-Software-und-Pakete"/>" erläutert
+ diese. Auch die Liste der benötigten Perl-Module befindet sich
+ hier.</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis>Installation von kivitendo</emphasis>: Diese umfasst
+ die "<xref linkend="Manuelle-Installation-des-Programmpaketes"/>"
+ sowie grundlegende Einstellungen, die der "<xref
+ linkend="config.config-file"/>" erläutert.</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis>Konfiguration externer Programme</emphasis>: hierzu
+ gehören die Datenbank ("<xref
+ linkend="Anpassung-der-PostgreSQL-Konfiguration"/>") und der
+ Webserver ("<xref linkend="Apache-Konfiguration"/>").</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis>Benutzerinformationen speichern können</emphasis>:
+ man benötigt mindestens eine Datenbank, in der Informationen zur
+ Authentifizierung sowie die Nutzdaten gespeichert werden. Wie man
+ das als Administrator macht, verrät "<xref
+ linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>".</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis>Benutzer, Gruppen und Datenbanken
+ anlegen</emphasis>: wie dies alles zusammenspielt erläutert "<xref
+ linkend="Benutzer--und-Gruppenverwaltung"/>".</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis>Los geht's</emphasis>: alles soweit erledigt? Dann
+ kann es losgehen: "<xref linkend="kivitendo-ERP-verwenden"/>"</para>
+ </listitem>
+ </orderedlist>
+
+ <para>Alle weiteren Unterkapitel in diesem Kapitel sind ebenfalls
+ wichtig und sollten vor einer ernsthaften Inbetriebnahme gelesen
+ werden.</para>
+ </sect1>
+
<sect1 id="Benötigte-Software-und-Pakete">
<title>Benötigte Software und Pakete</title>
ohne große Probleme auf den derzeit aktuellen verbreiteten
Distributionen läuft.</para>
- <para>Mitte 2012 sind das folgende Systeme, von denen bekannt ist,
+ <para>Anfang 2016 sind das folgende Systeme, von denen bekannt ist,
dass kivitendo auf ihnen läuft:</para>
<itemizedlist>
<listitem>
- <para>Ubuntu 10.04 LTS Lucid Lynx bis 12.04 Precise Pangolin</para>
- </listitem>
+ <para>Debian</para>
- <listitem>
- <para>Debian 5.0 Lenny und 6.0 Squeeze</para>
+ <itemizedlist>
+ <listitem>
+ <para>7.0 "Wheezy"</para>
+ </listitem>
+
+ <listitem>
+ <para>8.0 "Jessie"</para>
+ </listitem>
+ </itemizedlist>
</listitem>
<listitem>
- <para>openSUSE 11.2 und 11.3</para>
+ <para>Ubuntu 12.04 LTS "Precise Pangolin", 14.04 "Trusty Tahr"
+ LTS, 15.10 "Wily Werewolf" und 16.04 "Xenial Xerus" LTS
+ Alpha</para>
</listitem>
<listitem>
- <para>SuSE Linux Enterprice Server 11</para>
+ <para>openSUSE LEAP 42.1</para>
</listitem>
<listitem>
- <para>Fedora 13 bis 16</para>
+ <para>Fedora 22</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="Pakete" xreflabel="Pakete">
- <title>Pakete</title>
+ <title>Benötigte Perl-Pakete installieren</title>
<para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
- Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2)
- benötigt.</para>
+ Apache) und ein Datenbankserver (PostgreSQL) in einer aktuellen Version
+ (s.a. Liste der unterstützten Betriebssysteme) benötigt.</para>
+
+ <para>Zusätzlich benötigt kivitendo einige Perl-Pakete, die nicht
+ Bestandteil einer Standard-Perl-Installation sind. Um zu überprüfen,
+ ob die erforderlichen Pakete installiert und aktuell genug sind, wird
+ ein Script mitgeliefert, das wie folgt aufgerufen wird:</para>
+
+ <programlisting>./scripts/installation_check.pl</programlisting>
- <para>Zusätzlich benötigt kivitendo die folgenden Perl-Pakete, die
- nicht Bestandteil einer Standard-Perl-Installation sind:</para>
+ <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
<itemizedlist>
<listitem>
- <para>parent</para>
+ <para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Archive::Zip</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Algorithm::CheckDigits</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>CGI</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Clone</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Config::Std</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>DateTime</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>DateTime::Format::Strptime</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>DBI</literal></para>
</listitem>
<listitem>
- <para>Archive::Zip</para>
+ <para><literal>DBD::Pg</literal></para>
</listitem>
<listitem>
- <para>Config::Std</para>
+ <para><literal>Email::Address</literal></para>
</listitem>
<listitem>
- <para>DateTime</para>
+ <para><literal>Email::MIME</literal></para>
</listitem>
<listitem>
- <para>DBI</para>
+ <para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71
+ inklusive; siehe <xref
+ linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para>
</listitem>
<listitem>
- <para>DBD::Pg</para>
+ <para><literal>File::Copy::Recursive</literal></para>
</listitem>
<listitem>
- <para>Email::Address</para>
+ <para><literal>File::MimeInfo</literal></para>
</listitem>
<listitem>
- <para>JSON</para>
+ <para><literal>GD</literal></para>
</listitem>
<listitem>
- <para>List::MoreUtils</para>
+ <para><literal>HTML::Parser</literal></para>
</listitem>
<listitem>
- <para>Params::Validate</para>
+ <para><literal>HTML::Restrict</literal></para>
</listitem>
<listitem>
- <para>PDF::API2</para>
+ <para><literal>Image::Info</literal></para>
</listitem>
<listitem>
- <para>Rose::Object</para>
+ <para><literal>JSON</literal></para>
</listitem>
<listitem>
- <para>Rose::DB</para>
+ <para><literal>List::MoreUtils</literal></para>
</listitem>
<listitem>
- <para>Rose::DB::Object</para>
+ <para><literal>List::UtilsBy</literal></para>
</listitem>
<listitem>
- <para>Template</para>
+ <para><literal>Net::SMTP::SSL</literal> (optional, bei
+ E-Mail-Versand über SSL; siehe Abschnitt "<xref
+ linkend="config.sending-email.smtp"/>")</para>
</listitem>
<listitem>
- <para>Text::CSV_XS</para>
+ <para><literal>Net::SSLGlue</literal> (optional, bei
+ E-Mail-Versand über TLS; siehe Abschnitt "<xref
+ linkend="config.sending-email.smtp"/>")</para>
</listitem>
<listitem>
- <para>Text::Iconv</para>
+ <para><literal>Params::Validate</literal></para>
</listitem>
<listitem>
- <para>URI</para>
+ <para><literal>PBKDF2::Tiny</literal></para>
</listitem>
<listitem>
- <para>XML::Writer</para>
+ <para><literal>PDF::API2</literal></para>
</listitem>
<listitem>
- <para>YAML</para>
+ <para><literal>Rose::Object</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Rose::DB</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Rose::DB::Object</literal> Version 0.788 oder
+ neuer</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>String::ShellQuote</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Sort::Naturally</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Template</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Text::CSV_XS</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Text::Iconv</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Text::Unidecode</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>URI</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>XML::Writer</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>YAML</literal></para>
</listitem>
</itemizedlist>
+ <para>Seit Version größer v3.5.0 sind die folgenden Pakete hinzugekommen:
+ <literal>Text::Unidecode</literal></para>
+
+ <para>Seit Version v3.4.0 sind die folgenden Pakete hinzugekommen:
+ <literal>Algorithm::CheckDigits</literal><literal>PBKDF2::Tiny</literal></para>
+
+ <para>Seit Version v3.2.0 sind die folgenden Pakete hinzugekommen:
+ <literal>GD</literal>, <literal>HTML::Restrict</literal>,
+ <literal>Image::Info</literal></para>
+
+ <para>Seit v3.0.0 sind die folgenden Pakete hinzugekommen:
+ <literal>File::Copy::Recursive</literal>.</para>
+
+ <para>Seit v2.7.0 sind die folgenden Pakete hinzugekommen:
+ <literal>Email::MIME</literal>, <literal>Net::SMTP::SSL</literal>,
+ <literal>Net::SSLGlue</literal>.</para>
<para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
hinzugekommen, <literal>URI</literal> und
empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
installieren.</para>
- <para>Die zu installierenden Pakete können in den verschiedenen
- Distributionen unterschiedlich heißen.</para>
-
- <para>Für Debian oder Ubuntu benötigen Sie diese Pakete:</para>
+ <sect3>
+ <title>Debian und Ubuntu</title>
+
+ <para>Für Debian und Ubuntu stehen die meisten der benötigten
+ Perl-Pakete als Debian-Pakete zur Verfügung. Sie können mit
+ folgendem Befehl installiert werden:</para>
+
+ <programlisting>apt install apache2 libarchive-zip-perl libclone-perl \
+ libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
+ libemail-address-perl libemail-mime-perl libfcgi-perl libjson-perl \
+ liblist-moreutils-perl libnet-smtp-ssl-perl libnet-sslglue-perl \
+ libparams-validate-perl libpdf-api2-perl librose-db-object-perl \
+ librose-db-perl librose-object-perl libsort-naturally-perl \
+ libstring-shellquote-perl libtemplate-perl libtext-csv-xs-perl \
+ libtext-iconv-perl liburi-perl libxml-writer-perl libyaml-perl \
+ libimage-info-perl libgd-gd2-perl libapache2-mod-fcgid \
+ libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \
+ libcrypt-pbkdf2-perl git libcgi-pm-perl libtext-unidecode-perl
+</programlisting>
+
+ <para>Für das Paket HTML::Restrict gibt es kein Debian-Paket, dies
+ muß per CPAN installiert werden. Unter Ubuntu funktioniert das
+ mit:</para>
+
+ <programlisting>apt-get install build-essential
+cpan HTML::Restrict</programlisting>
+ </sect3>
- <programlisting>apt-get install apache2 postgresql libparent-perl libarchive-zip-perl \
- libdatetime-perl libdbi-perl libdbd-pg-perl libpg-perl \
- libemail-address-perl liblist-moreutils-perl libpdf-api2-perl \
- librose-object-perl librose-db-perl librose-db-object-perl \
- libtemplate-perl libtext-csv-xs-perl libtext-iconv-perl liburi-perl \
- libxml-writer-perl libyaml-perl libconfig-std-perl \
- libparams-validate-perl libjson-perl libclass-accessor-perl</programlisting>
+ <sect3>
+ <title>Fedora</title>
- <para>Für Fedora Core benötigen Sie diese Pakete:</para>
+ <para>Für Fedora stehen die meisten der benötigten Perl-Pakete als
+ RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
+ installiert werden:</para>
- <programlisting>yum install httpd postgresql-server perl-parent perl-DateTime \
- perl-DBI perl-DBD-Pg perl-Email-Address perl-List-MoreUtils \
- perl-PDF-API2 perl-Rose-Object perl-Rose-DB perl-Rose-DB-Object \
+ <programlisting>dnf install httpd mod_fcgid perl-Archive-Zip perl-Clone perl-DBD-Pg \
+ perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
+ perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils perl-Net-SMTP-SSL perl-Net-SSLGlue \
+ perl-PDF-API2 perl-Params-Validate perl-Rose-DB perl-Rose-DB-Object \
+ perl-Rose-Object perl-Sort-Naturally perl-String-ShellQuote \
perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
- perl-XML-Writer perl-YAML</programlisting>
+ perl-XML-Writer perl-YAML perl-parent postgresql-server perl-CPAN \
+ perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor perl-Text-Balanced</programlisting>
- <para>Für OpenSuSE benötigen Sie diese Pakete:</para>
+ <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
+ werden. Dazu können Sie die folgenden Befehle nutzen:</para>
- <programlisting>zypper install apache2 postgresql-server perl-Archive-Zip \
- perl-DateTime perl-DBI perl-DBD-Pg perl-MailTools perl-List-MoreUtils \
- perl-PDF-API2 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
- perl-URI perl-XML-Writer perl-YAML</programlisting>
+ <programlisting>cpan Config::Std HTML::Restrict</programlisting>
+ </sect3>
+
+ <sect3>
+ <title>openSUSE</title>
- <para>Bei openSuSE 11 ist <literal>parent</literal> bereits enthalten,
- und braucht nicht nachinstalliert werden. Die
- <literal>Rose::*</literal> Pakete sind derzeit nicht für SuSE gepackt,
- und müssen anderweitig nachinstalliert werden.</para>
+ <para>Für openSUSE stehen die meisten der benötigten Perl-Pakete als
+ RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl
+ installiert werden:</para>
- <para>kivitendo enthält ein Script, mit dem überprüft werden kann, ob
- alle benötigten Perl-Module installiert sind. Der Aufruf lautet wie
- folgt:</para>
+ <programlisting>zypper install apache2 apache2-mod_fcgid perl-Archive-Zip perl-Clone \
+ perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
+ perl-Email-MIME perl-FastCGI perl-File-Copy-Recursive perl-JSON perl-List-MoreUtils \
+ perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PDF-API2 perl-Params-Validate \
+ perl-Sort-Naturally perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
+ perl-URI perl-XML-Writer perl-YAML perl-CPAN \
+ perl-Algorithm-CheckDigits perl-GD perl-Class-XSAccessor postgresql-server</programlisting>
- <programlisting>./scripts/installation_check.pl</programlisting>
+ <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
+ werden. Dazu können Sie die folgenden Befehle nutzen:</para>
+
+ <programlisting>cpan Rose::Db::Object</programlisting>
+ </sect3>
+ </sect2>
+ <sect2>
+ <title>Andere Pakete installieren</title>
+
+ <para>Seit Version v3.4.0 wird für den Bankimport optional das Paket
+ 'aqbanking-tools' benötigt.</para>
+
+ <para>Debian und Ubuntu: <programlisting>apt install aqbanking-tools
+ </programlisting></para>
+
+ <para>OpenSuSE: <programlisting>zypper install aqbanking-tools</programlisting></para>
+
+ <para>Seit Version v3.4.1 wird generell zum Feststellen der
+ Seitenanzahl von PDF_Dokumenten 'pdfinfo' benötigt was im Paket
+ 'poppler-utils' enthalten ist.</para>
+
+ <para>Debian und Ubuntu: <programlisting>apt install poppler-utils
+ </programlisting></para>
+
+ <para>OpenSuSE: <programlisting>zypper install poppler-tools</programlisting></para>
</sect2>
+
</sect1>
<sect1 id="Manuelle-Installation-des-Programmpaketes"
xreflabel="Manuelle Installation des Programmpaketes">
<title>Manuelle Installation des Programmpaketes</title>
- <para>Die kivitendo ERP Installationsdatei (kivitendo-erp-2.6.3.tgz) wird
- im Dokumentenverzeichnis des Webservers (z.B.
+ <para>Der aktuelle Stable-Release, bzw. beta Release wird bei github
+ gehostet und kann <ulink
+ url="https://github.com/kivitendo/kivitendo-erp/releases">hier</ulink>
+ heruntergeladen werden.</para>
+
+ <para>Die kivitendo ERP Installationsdatei
+ (<filename>kivitendo-erp-3.4.1.tgz</filename>) wird im
+ Dokumentenverzeichnis des Webservers (z.B.
<filename>/var/www/html/</filename>,
<filename>/srv/www/htdocs</filename> oder
<filename>/var/www/</filename>) entpackt:</para>
<programlisting>cd /var/www
-tar xvzf kivitendo-erp-2.6.3.tgz</programlisting>
+tar xvzf kivitendo-erp-3.4.1.tgz</programlisting>
<para>Wechseln Sie in das entpackte Verzeichnis:</para>
Webserverkonfiguration benutzen, um auf das tatsächliche
Installationsverzeichnis zu verweisen.</para>
- <para>Die Verzeichnisse <filename>users</filename>, <filename>spool</filename> und <filename>webdav</filename> müssen für den Benutzer
- beschreibbar sein, unter dem der Webserver läuft. Die restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer- und
- Gruppennamen sind bei verschiedenen Distributionen unterschiedlich (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
- core <constant>apache</constant> oder bei OpenSuSE <constant>wwwrun</constant>).</para>
+ <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das
+ WebDAV Verzeichnis derzeit manuell angelegt werden:</para>
+
+ <programlisting>mkdir webdav</programlisting>
+
+ <para>Die Verzeichnisse <filename>users</filename>,
+ <filename>spool</filename> und <filename>webdav</filename> müssen für
+ den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
+ restlichen Dateien müssen für diesen Benutzer lesbar sein. Die Benutzer-
+ und Gruppennamen sind bei verschiedenen Distributionen unterschiedlich
+ (z.B. bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora
+ <constant>apache</constant> oder bei OpenSUSE
+ <constant>wwwrun</constant>).</para>
<para>Der folgende Befehl ändert den Besitzer für die oben genannten
Verzeichnisse auf einem Debian/Ubuntu-System:</para>
<programlisting>chown -R www-data users spool webdav</programlisting>
- <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen <filename>templates</filename> und <filename>users</filename>
- Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in kivitendo angelegt wird:</para>
+ <para>Weiterhin muss der Webserver-Benutzer in den Verzeichnissen
+ <filename>templates</filename> und <filename>users</filename>
+ Unterverzeichnisse für jeden neuen Benutzer anlegen dürfen, der in
+ kivitendo angelegt wird:</para>
<programlisting>chown www-data templates users</programlisting>
+
+ <note>
+ <para>Wir empfehlen eine Installation mittels des Versionsmanagager
+ git. Hierfür muss ein git-Client installiert sein. Damit ist man sehr
+ viel flexibler für zukünftige Upgrades. Installations-Anleitung (bitte
+ die Pfade anpassen) bspw. wie folgt: <programlisting>cd /var/www/
+git clone https://github.com/kivitendo/kivitendo-erp.git
+cd kivitendo-erp/
+git checkout `git tag -l | egrep -ve "(beta|rc)" | tail -1`</programlisting>
+ Erläuterung: Der Befehl wechselt zur letzten Stable-Version (git tag -l listet
+ alle Tags auf, das egrep schmeisst alle Einträge mit beta oder rc raus und
+ das tail gibt davon den obersten Treffer zurück).
+
+ Sehr sinnvoll ist es, direkt im Anschluss einen eigenen Branch zu
+ erzeugen, um bspw. seine eigenen Druckvorlagen-Anpassungen damit zu
+ verwalten. Hierfür reicht ein simples <programlisting> git checkout -b meine_eigenen_änderungen</programlisting>
+ nach dem letzten Kommando (weiterführende Informationen <ulink
+ url="http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html">
+ Git Magic</ulink>).</para>
+
+<para>
+ Ein beispielhafter Workflow für Druckvorlagen-Anpassungen von 3.4.1 nach 3.5:
+ <programlisting>
+$ git clone https://github.com/kivitendo/kivitendo-erp.git
+$ cd kivitendo-erp/
+$ git checkout release-3.4.1 # das ist der aktuelle release, den wir wollen
+$ git add templates/fullhouse # das sind unsere druckvorlagen inkl. produktbilder
+$ git commit -m "juhu tolle ändernungen"
+[meine_aenderungen 1d89e41] juhu tolle ändernungen
+ 4 files changed, 380 insertions(+)
+ create mode 100644 templates/fullhouse/img/webdav/tesla.png
+ create mode 100644 templates/fullhouse/mahnung.tex
+ create mode 100644 templates/fullhouse/zahlungserinnerung_zwei.tex
+ create mode 100644 templates/fullhouse/zahlungserinnerung_zwei_invoice.tex
+
+# 5 Jahre später ...
+
+$ git fetch
+$ git rebase --onto release-3.5.0 release-3.4.1 meine_aenderungen
+Zunächst wird der Branch zurückgespult, um Ihre Änderungen
+darauf neu anzuwenden ...
+Wende an: juhu tolle ändernungen
+$ service apache2 restart
+</programlisting></para>
+ </note>
</sect1>
<sect1 id="config.config-file">
xreflabel="Einführung in die Konfigurationsdatei">
<title>Einführung</title>
- <para>In kivitendo gibt es nur noch eine Konfigurationsdatei,
- die benötigt wird: <filename>config/kivitendo.conf</filename> (kurz:
- "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation
- von kivitendo bzw. der Migration von älteren Versionen angelegt
+ <para>In kivitendo gibt es nur noch eine Konfigurationsdatei, die
+ benötigt wird: <filename>config/kivitendo.conf</filename> (kurz: "die
+ Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von
+ kivitendo bzw. der Migration von älteren Versionen angelegt
werden.</para>
<para>Als Vorlage dient die Datei
abweichen.</para>
<note>
- <para>
- Vor der Umbenennung in kivitendo hieß diese Datei noch <filename>config/lx_office.conf</filename>. Aus Gründen der Kompatibilität
- wird diese Datei eingelesen, sofern die Datei <filename>config/kivitendo.conf</filename> nicht existiert.
- </para>
+ <para>Vor der Umbenennung in kivitendo hieß diese Datei noch
+ <filename>config/lx_office.conf</filename>. Aus Gründen der
+ Kompatibilität wird diese Datei eingelesen, sofern die Datei
+ <filename>config/kivitendo.conf</filename> nicht existiert.</para>
</note>
<para>Diese Hauptkonfigurationsdatei ist dann eine
<itemizedlist>
<listitem>
- <para><literal>authentication</literal></para>
+ <para><literal>authentication</literal> (siehe Abschnitt "<xref
+ linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
+ in diesem Kapitel)</para>
</listitem>
<listitem>
</listitem>
<listitem>
- <para><literal>features</literal></para>
+ <para><literal>paths</literal></para>
</listitem>
<listitem>
- <para><literal>paths</literal></para>
+ <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
+ linkend="config.sending-email.smtp"/>)</para>
</listitem>
<listitem>
<para><literal>periodic_invoices</literal></para>
</listitem>
+ <listitem>
+ <para><literal>self_tests</literal></para>
+ </listitem>
+
<listitem>
<para><literal>console</literal></para>
</listitem>
+ <listitem>
+ <para><literal>testing</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>testing/database</literal></para>
+ </listitem>
+
<listitem>
<para><literal>debug</literal></para>
</listitem>
password =
[system]
-dbcharset = UTF-8</programlisting>
+default_manager = german</programlisting>
+
+ <para>Für kivitendo Installationen in der Schweiz sollte hier <varname>german</varname>
+ durch <varname>swiss</varname> ersetzt werden.</para>
+ <para>Die Einstellung <varname>default_manager = swiss</varname> bewirkt:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Beim Erstellen einer neuen Datenbank in der kivitendo Administration
+ werden automatisch die Standard-Werte für die Schweiz voreingestellt:
+ Währung CHF, 5er-Rundung, Schweizer KMU-Kontenplan, Sollversteuerung,
+ Aufwandsmethode, Bilanzierung (die Werte können aber manuell angepasst werden).</para>
+ </listitem>
+ <listitem>
+ <para>Einstellen der Standardkonten für Rundungserträge und -aufwendungen
+ (unter Mandantenkonfiguration → Standardkonten veränderbar)</para>
+ </listitem>
+ <listitem>
+ <para>das verwendete Zahlenformat wird auf <varname>1'000.00</varname> eingestellt
+ (unter Programm → Benutzereinstellungen veränderbar)</para>
+ </listitem>
+ <listitem>
+ <para>DATEV-Automatik und UStVA werden nicht angezeigt, Erfolgsrechnung
+ ersetzt GUV ( unter Mandantenkonfiguration → Features veränderbar)</para>
+ </listitem>
+ </itemizedlist>
<para>Nutzt man wiederkehrende Rechnungen, kann man unter
<varname>[periodic_invoices]</varname> den Login eines Benutzers
angeben, der nach Erstellung der Rechnungen eine entsprechende E-Mail
mit Informationen über die erstellten Rechnungen bekommt.</para>
- <para>Nutzt man den <link
- linkend="config.task-server">Taskserver</link> für <link
- linkend="features.periodic-invoices">wiederkehrende Rechnungen</link>,
- muss unter <varname>[task_server]</varname> ein Login eines Benutzers
- angegeben werden, mit dem sich der Taskserver an kivitendo bei der
- Datenbank anmeldet, die dem Benutzer zugewiesen ist.</para>
+ <para>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
+ Ausführung bestimmter Aufgaben mit, den <link
+ linkend="config.task-server">Taskserver</link>. Er wird u.a. für
+ Features wie die <link
+ linkend="features.periodic-invoices">wiederkehrenden Rechnungen</link>
+ benötigt, erledigt aber auch andere erforderliche Aufgaben und muss
+ daher in Betrieb genommen werden. Seine Einrichtung wird im Abschnitt
+ <link linkend="config.task-server">Task-Server</link> genauer
+ beschrieben.</para>
<para>Für Entwickler finden sich unter <varname>[debug]</varname>
wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
<para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
<sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
- <title>Zeichensätze/die Verwendung von UTF-8</title>
-
- <para>kivitendo kann komplett mit UTF-8 als Zeichensatz verwendet
- werden. Dabei gibt es zwei Punkte zu beachten: PostgreSQL muss in
- Version 8.2 oder neuer benutzt werden, und der
- PostgreSQL-Datenbankcluster muss ebenfalls mit UTF-8 als Locale
- angelegt worden sein.</para>
-
- <para>Dieses ist kann überprüft werden: ist das Encoding der Datenbank
- “template1” “UTF8”, so kann auch kivitendo mit UTF-8 betrieben werden.
- Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
- UTF-8-Encoding anzulegen und diesen zu verwenden. Unter Debian und
- Ubuntu kann dies z.B. für PostgreSQL 8.2 mit dem folgenden Befehl
+ <title>Zeichensätze/die Verwendung von Unicode/UTF-8</title>
+
+ <para>kivitendo setzt zwingend voraus, dass die Datenbank
+ Unicode/UTF-8 als Encoding einsetzt. Bei aktuellen
+ Serverinstallationen braucht man hier meist nicht einzugreifen.</para>
+
+ <para>Das Encoding des Datenbankservers kann überprüft werden. Ist das
+ Encoding der Datenbank "template1" "Unicode" bzw. "UTF-8", so braucht
+ man nichts weiteres diesbezüglich unternehmen. Zum Testen:</para>
+
+ <programlisting>su postgres
+echo '\l' | psql
+exit </programlisting>
+
+ <para>Andernfalls ist es notwendig, einen neuen Datenbankcluster mit
+ Unicode-Encoding anzulegen und diesen zu verwenden. Unter Debian und
+ Ubuntu kann dies z.B. für PostgreSQL 9.3 mit dem folgenden Befehl
getan werden:</para>
- <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2 clustername</programlisting>
+ <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 9.3 clustername</programlisting>
<para>Die Datenbankversionsnummer muss an die tatsächlich verwendete
Versionsnummer angepasst werden.</para>
<para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
- <para>Wurde PostgreSQL nicht mit UTF-8 als Encoding initialisiert und
- ist ein Neuanlegen eines weiteren Clusters nicht möglich, so kann
- kivitendo mit ISO-8859-15 als Encoding betrieben werden.</para>
-
<para>Das Encoding einer Datenbank kann in <command>psql</command> mit
<literal>\l</literal> geprüft werden.</para>
</sect2>
<para>In der Datei <filename>postgresql.conf</filename>, die je nach
Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
<filename>/var/lib/pgsql/data/</filename> oder
- <filename>/etc/postgresql/</filename>, muss sichergestellt werden,
+ <filename>/etc/postgresql/</filename>), muss sichergestellt werden,
dass TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
Parameter <varname>listen_address</varname> gesteuert. Laufen
PostgreSQL und kivitendo auf demselben Rechner, so kann dort der Wert
<para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
Verzeichnis wie die <filename>postgresql.conf</filename> zu finden
- sein sollte, müssen die Berichtigungen für den Zugriff geändert
- werden. Hier gibt es mehrere Möglichkeiten. Eine besteht darin, lokale
- Verbindungen immer zuzulassen:</para>
-
- <programlisting>local all all trust
-host all all 127.0.0.1 255.0.0.0 trust</programlisting>
-
- <para>Besser ist es, für eine bestimmte Datenbank Zugriff nur per
- Passwort zuzulassen. Beispielsweise:</para>
+ sein sollte, müssen die Berechtigungen für den Zugriff geändert
+ werden. Hier gibt es mehrere Möglichkeiten. Sinnvoll ist es nur die
+ nötigen Verbindungen immer zuzulassen, für eine lokal laufende
+ Datenbank zum Beispiel:</para>
<programlisting>local all kivitendo password
host all kivitendo 127.0.0.1 255.255.255.255 password</programlisting>
<para>In der Datenbank <literal>template1</literal> muss die
Unterstützung für servergespeicherte Prozeduren eingerichet werden.
- Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an, und
- führen Sie die folgenden Kommandos aus:</para>
+ Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an:
+ <programlisting>su - postgres
+psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
+
+ <programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
+\q</programlisting>
- <programlisting>create language 'plpgsql';</programlisting>
+ <note>
+ <para><literal>CREATE EXTENSION</literal> ist seit Version 9.1 die
+ bevorzugte Syntax um die Sprache <literal>plpgsql</literal>
+ anzulegen. In diesen Versionen ist die Extension meist auch schon
+ vorhanden. Sollten Sie eine ältere Version von Postgres haben,
+ benutzen Sie stattdessen den folgenden Befehl.</para>
+
+ <programlisting>CREATE LANGUAGE 'plpgsql';
+\q</programlisting>
+ </note>
</sect2>
<sect2 id="Datenbankbenutzer-anlegen">
anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
können:</para>
- <programlisting>su - postgres createuser -d -P kivitendo</programlisting>
+ <para>Die Frage, ob der neue User Superuser sein soll, können Sie mit
+ nein beantworten, genauso ist die Berechtigung neue User (Roles) zu
+ generieren nicht nötig.</para>
+
+ <programlisting>su - postgres
+createuser -d -P kivitendo
+exit</programlisting>
<para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
- Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo” bzw.
- den hier gewählten Benutzernamen.</para>
+ Sie den evtl. voreingestellten Benutzer “postgres” auf “kivitendo”
+ bzw. den hier gewählten Benutzernamen.</para>
</sect2>
</sect1>
<note>
<para>Für einen deutlichen Performanceschub sorgt die Ausführung
mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
- <xref linkend="Apache-Konfiguration.FCGI" /> beschrieben.</para>
+ <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
</note>
<para>Der Zugriff auf das Programmverzeichnis muss in der Apache
anderen Datei hinzu, die beim Starten des Webservers eingelesen
wird:</para>
- <programlisting>AddHandler cgi-script .pl
-Alias /kivitendo-erp/ /var/www/kiviteno-erp/
+ <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
+Alias /kivitendo-erp/ /var/www/kivitendo-erp/
<Directory /var/www/kivitendo-erp>
+ AddHandler cgi-script .pl
Options ExecCGI Includes FollowSymlinks
</Directory>
<Directory /var/www/kivitendo-erp/users>
- Order Deny,Allow
- Deny from All
+ Require all granted
</Directory></programlisting>
<para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
<note>
<para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
Plus ‘<literal>+</literal>’ gesetzt werden.</para>
+
+ <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss
+ noch explizit das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting>
+ aktiviert werden.</para>
</note>
<para>Auf einigen Webservern werden manchmal die Grafiken und
</listitem>
<listitem>
- <para>Apache 2.2.11 (Ubuntu) und mod_fastcgi.</para>
+ <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
+ </listitem>
+
+ <listitem>
+ <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
</listitem>
</itemizedlist>
verwendet.</para>
<warning>
- <para>FCGI 0.69 und höher ist extrem strict in der Behandlung von
- Unicode, und verweigert bestimmte Eingaben von kivitendo. Falls es
- Probleme mit Umlauten in Ihrere Installation gibt, muss auf die
- Vorgängerversion FCGI 0.68 ausgewichen werden.</para>
+ <para>FCGI-Versionen ab 0.69 und bis zu 0.71 inklusive sind extrem
+ strict in der Behandlung von Unicode, und verweigern bestimmte
+ Eingaben von kivitendo. Falls es Probleme mit Umlauten in Ihrer
+ Installation gibt, muss zwingend Version 0.68 oder aber Version
+ 0.72 und neuer eingesetzt werden.</para>
- <para>Mit CPAN lässt sie sich die Vorgängerversion wie folgt
- installieren:</para>
+ <para>Mit <ulink url="http://www.cpan.org">CPAN</ulink> lässt sie
+ sich die Vorgängerversion wie folgt installieren:</para>
<programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
</warning>
<title>Konfiguration des Webservers</title>
<para>Bevor Sie versuchen, eine kivitendo Installation unter FCGI
- laufen zu lassen, empfliehlt es sich die Installation ersteinmal
+ laufen zu lassen, empfiehlt es sich die Installation ersteinmal
unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
debuggen die beim ersten aufsetzen auftreten können. Sollte die
Installation schon funktionieren, lesen Sie weiter.</para>
<Directory /path/to/kivitendo-erp>
AllowOverride All
Options ExecCGI Includes FollowSymlinks
- Order Allow,Deny
- Allow from All
+ Require all granted
</Directory>
<DirectoryMatch /path/to/kivitendo-erp/users>
- Order Deny,Allow
- Deny from All
+Require all denied
</DirectoryMatch></programlisting>
- <para>Seit mod_fcgid-Version 2.6.3 gelten sehr kleine Grenzen für
+ <warning>
+ <para>Wer einen älteren Apache als Version 2.4 im Einsatz hat,
+ muss entsprechend die Syntax der Directorydirektiven verändert.
+ Statt</para>
+
+ <programlisting>Require all granted</programlisting>
+
+ <para>muß man Folgendes einstellen:</para>
+
+ <programlisting>
+ Order Allow,Deny
+ Allow from All </programlisting>
+
+ <para>und statt</para>
+
+ <programlisting>Require all denied</programlisting>
+
+ <para>muss stehen:</para>
+
+ <programlisting>
+ Order Deny,Allow
+ Deny from All </programlisting>
+
+ </warning>
+
+ <para>Seit mod_fcgid-Version 2.3.6 gelten sehr kleine Grenzen für
die maximale Größe eines Requests. Diese sollte wie folgt
hochgesetzt werden:</para>
<programlisting>FcgidMaxRequestLen 10485760</programlisting>
- <para>Das ganze sollte dann so aussehen:</para>
+ <para>Das Ganze sollte dann so aussehen:</para>
<programlisting>AddHandler fcgid-script .fpl
AliasMatch ^/url/for/kivitendo-erp/[^/]+\.pl /path/to/kivitendo-erp/dispatcher.fpl
FastCGI-Version.</para>
</sect3>
</sect2>
+
+ <sect2>
+ <title>Weitergehende Konfiguration</title>
+
+ <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung
+ von kivitendo nur über https-verschlüsselten Verbindungen, sowie
+ weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die
+ Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser
+ Anleitung, hier ein Hinweis auf einen entsprechenden <ulink
+ url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag
+ (Stand Sept. 2015)</ulink> und einen aktuellen (Stand Mai 2017)
+ <ulink url="https://mozilla.github.io/server-side-tls/ssl-config-generator/">
+ SSL-Konfigurations-Generator</ulink>.</para>
+ </sect2>
</sect1>
<sect1 id="config.task-server">
<para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
- wird bisher nur für die Erzeugung der wiederkehrenden Rechnungen
- benutzt, wird aber in Zukunft deutlich mehr Aufgaben übertragen
- bekommen.</para>
+ wird u.a. für die Erzeugung der wiederkehrenden Rechnungen und weitere
+ essenzielle Aufgaben benutzt.</para>
+
+ <para>Der Task-Server muss einmalig global in der Konfigurationsdatei
+ konfiguriert werden. Danach wird er für jeden Mandanten, für den er
+ laufen soll, in der Adminsitrationsmaske eingeschaltet.</para>
+
+ <para>Beachten Sie, dass der Task-Server in den Boot-Vorgang Ihres
+ Servers integriert werden muss, damit er automatisch gestartet wird.
+ Dies kann kivitendo nicht für Sie erledigen.</para>
+
+ <para>Da der Taskserver als Perlscript läuft, wird Arbeitsspeicher,
+ der einmal benötigt wurde, nicht mehr an das Betriebssystem zurückgegeben,
+ solange der Taskserver läuft. Dies kann dazu führen, dass ein länger
+ laufender Taskserver mit der Zeit immer mehr Arbeitsspeicher für sich
+ beansprucht. Es ist deshalb sinnvoll, dass der Taskserver in regelmässigen
+ Abständen neu gestartet wird.</para>
<sect2 id="Konfiguration-des-Task-Servers">
<title>Verfügbare und notwendige Konfigurationsoptionen</title>
Optionen sind:</para>
<variablelist>
- <varlistentry>
- <term><varname>login</varname></term>
-
- <listitem>
- <para>gültiger kivitendo-Benutzername, der benutzt wird, um die
- zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss
- in der Administration angelegt werden. Diese Option muss
- angegeben werden.</para>
- </listitem>
- </varlistentry>
-
<varlistentry>
<term><varname>run_as</varname></term>
angegebenen Systembenutzer. Der Systembenutzer muss dieselben
Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
(siehe see <xref
- linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
- ist es sinnvoll, hier denselben Systembenutzer einzutragen,
+ linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher
+ ist es erforderlich, hier denselben Systembenutzer einzutragen,
unter dem auch der Webserver läuft.</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
+ <sect2 id="Konfiguration-der-Mandanten-fuer-den-Task-Servers">
+ <title>Konfiguration der Mandanten für den Task-Server</title>
+
+ <para>Ist der Task-Server grundlegend konfiguriert, so muss
+ anschließend jeder Mandant, für den der Task-Server laufen soll,
+ einmalig konfiguriert werden. Dazu kann in der Maske zum Bearbeiten
+ von Mandanten im Administrationsbereich eine kivitendo-Benutzerkennung
+ ausgewählt werden, unter der der Task-Server seine Arbeit
+ verrichtet.</para>
+
+ <para>Ist in dieser Einstellung keine Benutzerkennung ausgewählt, so
+ wird der Task-Server für diesen Mandanten keine Aufgaben
+ ausführen.</para>
+ </sect2>
+
<sect2 id="Einbinden-in-den-Boot-Prozess">
<title>Automatisches Starten des Task-Servers beim Booten</title>
anstelle eines symbolischen Links verwendet werden können.</para>
<sect3>
- <title>SystemV-basierende Systeme (z.B. Debian, OpenSuSE, Fedora
- Core)</title>
+ <title>SystemV-basierende Systeme (z.B. ältere Debian, ältere OpenSUSE,
+ ältere Fedora)</title>
<para>Kopieren Sie die Datei
- <filename>scripts/boot/system-v/kivitendo-server</filename>
- nach <filename>/etc/init.d/kivitendo-server</filename>. Passen
+ <filename>scripts/boot/system-v/kivitendo-task-server</filename>
+ nach <filename>/etc/init.d/kivitendo-task-server</filename>. Passen
Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
<literal>DAEMON=....</literal>). Binden Sie das Script in den
Boot-Prozess ein. Dies ist distributionsabhängig:</para>
<para>Debian-basierende Systeme:</para>
<programlisting>update-rc.d kivitendo-task-server defaults
-# Nur bei Debian Squeeze und neuer:
insserv kivitendo-task-server</programlisting>
</listitem>
<listitem>
- <para>OpenSuSE und Fedora Core:</para>
+ <para>Ältere OpenSUSE und ältere Fedora:</para>
<programlisting>chkconfig --add kivitendo-task-server</programlisting>
</listitem>
</itemizedlist>
<para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
- werden: <command>/etc/init.d/kivitendo-task-server
- start</command></para>
+ werden:</para>
+
+ <programlisting>/etc/init.d/kivitendo-task-server start</programlisting>
</sect3>
<sect3>
- <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
+ <title>Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)</title>
<para>Kopieren Sie die Datei
<filename>scripts/boot/upstart/kivitendo-task-server.conf</filename>
<literal>exec ....</literal>).</para>
<para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
- werden: <command>service kivitendo-task-server
- start</command></para>
+ werden:</para>
+
+ <programlisting>service kivitendo-task-server start</programlisting>
+ </sect3>
+
+ <sect3>
+ <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
+ Fedora, neuere Ubuntu und neuere Debians)</title>
+
+ <para>Kopieren Sie die Datei <filename>scripts/boot/systemd/kivitendo-task-server.service</filename> nach
+ <filename>/etc/systemd/system/</filename>. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeilen
+ <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>).</para>
+
+ <para>Machen Sie anschließend das Script systemd bekannt, und binden Sie es in den Boot-Prozess ein. Dazu führen Sie die folgenden
+ Befehl aus:</para>
+
+ <programlisting>systemctl daemon-reload
+systemctl enable kivitendo-task-server.service</programlisting>
+
+ <para>Wenn Sie den Task-Server jetzt sofort starten möchten, anstatt den Server neu zu starten, so können Sie das mit dem
+ folgenden Befehl tun:</para>
+
+ <programlisting>systemctl start kivitendo-task-server.service</programlisting>
</sect3>
</sect2>
<sect2 id="Administratorpasswort">
<title>Administratorpasswort</title>
- <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
- benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es kann auch
- nur dort und nicht mehr im Administrationsinterface selber geändert
- werden. Der Parameter dazu heißt <varname>admin_password</varname> im
- Abschnitt <varname>[authentication]</varname>.</para>
+ <para>Das Passwort, das zum Zugriff auf das Administrationsinterface
+ von kivitendo benutzt wird, wird ebenfalls in dieser Datei
+ gespeichert. Es kann auch nur dort und nicht mehr im
+ Administrationsinterface selber geändert werden. Der Parameter dazu
+ heißt <varname>admin_password</varname> im Abschnitt
+ <varname>[authentication]</varname>.</para>
</sect2>
<sect2 id="Authentifizierungsdatenbank">
<para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
gespeichert werden, so muss der Parameter <varname>module</varname>
den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
- der Administrator als auch die Benutzer selber ihre Psaswörter in
+ der Administrator als auch die Benutzer selber ihre Passwörter in
kivitendo ändern.</para>
<para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
der folgenden URL erreichbar sein sollte:</para>
<para><ulink
- url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
+ url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
</sect2>
</sect1>
<sect1 id="Benutzer--und-Gruppenverwaltung">
- <title>Benutzer- und Gruppenverwaltung</title>
+ <title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
- <para>Nach der Installation müssen Benutzer, Gruppen und Datenbanken
- angelegt werden. Dieses geschieht im Administrationsmenü, das Sie unter
- folgender URL finden:</para>
+ <para>Nach der Installation müssen Mandanten, Benutzer, Gruppen und
+ Datenbanken angelegt werden. Dieses geschieht im Administrationsmenü,
+ das Sie unter folgender URL finden:</para>
<para><ulink
- url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
+ url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
- <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
+ <para>Verwenden Sie zur Anmeldung das Passwort, das Sie in der Datei
<filename>config/kivitendo.conf</filename> eingetragen haben.</para>
<sect2 id="Zusammenhänge">
<title>Zusammenhänge</title>
- <para>kivitendo verwendet eine Datenbank zum Speichern all seiner
- Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um
- mit kivitendo arbeiten zu können, muss eine Person einen
- Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine
- Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist
- möglich und normal, dass mehreren Benutzern die selbe Datenbank
- zugewiesen wird, sodass sie alle mit den selben Daten arbeiten
- können.</para>
-
- <para>Die Basisdaten der Benutzer, die in der Administration
- eingegeben werden können, werden in einer zweiten Datenbank
- gespeichert, der bereits erwähnten Authentifizierungsdatenbank. Diese
- ist also den Produktivdaten enthaltenden Datenbanken vorgeschaltet.
- Pro kivitendo-Installation gibt es nur eine
- Authentifizierungsdatenbank, aber beliebig viele Datenbanken mit
- Firmendaten.</para>
-
- <para>kivitendo kann seinen Benutzern Zugriff auf bestimmte
- Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht
- gestattet, so werden der entsprechenden Menüpunkte auch nicht
- angezeigt. Diese Rechte werden ebenfalls in der
- Authentifizierungsdatenbank gespeichert.</para>
-
- <para>Um Rechte verteilen zu können, verwendet kivitendo ein
- Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche
- erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder
- mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen
- Funktionen, die mindestens einer Gruppe erlaubt sind, in der der
- Benutzer Mitglied ist.</para>
-
- <para>Die allgemeine Reihenfolge, in der Datenbanken, Gruppen und
- Benutzer angelegt werden sollten, lautet:</para>
+ <para>kivitendo verwaltet zwei Sets von Daten, die je nach Einrichtung
+ in einer oder zwei Datenbanken gespeichert werden.</para>
+
+ <para>Das erste Set besteht aus Anmeldeinformationen: welche Benutzer
+ und Mandanten gibt es, welche Gruppen, welche BenutzerIn hat Zugriff
+ auf welche Mandanten, und welche Gruppe verfügt über welche Rechte.
+ Diese Informationen werden in der Authentifizierungsdatenbank
+ gespeichert. Dies ist diejenige Datenbank, deren Verbindungsparameter
+ in der Konfigurationsdatei <filename>config/kivitendo.conf</filename>
+ gespeichert werden.</para>
+
+ <para>Das zweite Set besteht aus den eigentlichen Verkehrsdaten eines
+ Mandanten, wie beispielsweise die Stammdaten (Kunden, Lieferanten,
+ Waren) und Belege (Angebote, Lieferscheine, Rechnungen). Diese werden
+ in einer Mandantendatenbank gespeichert. Die Verbindungsinformationen
+ einer solchen Mandantendatenbank werden im Administrationsbereich
+ konfiguriert, indem man einen Mandanten anlegt und dort die Parameter
+ einträgt. Dabei hat jeder Mandant eine eigene Datenbank.</para>
+
+ <para>Aufgrund des Datenbankdesigns ist es für einfache Fälle möglich,
+ die Authentifizierungsdatenbank und eine der Mandantendatenbanken in
+ ein und derselben Datenbank zu speichern. Arbeitet man hingegen mit
+ mehr als einem Mandanten, wird empfohlen, für die
+ Authentifizierungsdatenbank eine eigene Datenbank zu verwenden, die
+ nicht gleichzeitig für einen Mandanten verwendet wird.</para>
+ </sect2>
+
+ <sect2 id="Mandanten-Benutzer-Gruppen">
+ <title>Mandanten, Benutzer und Gruppen</title>
+
+ <para>kivitendos Administration kennt Mandanten, Benutzer und Gruppen,
+ die sich frei zueinander zuordnen lassen.</para>
+
+ <para>kivitendo kann mehrere Mandaten aus einer Installation heraus
+ verwalten. Welcher Mandant benutzt wird, kann direkt beim Login
+ ausgewählt werden. Für jeden Mandanten wird ein eindeutiger Name
+ vergeben, der beim Login angezeigt wird. Weiterhin benötigt der
+ Mandant Datenbankverbindungsparameter für seine Mandantendatenbank.
+ Diese sollte über die <link
+ linkend="Datenbanken-anlegen">Datenbankverwaltung</link>
+ geschehen.</para>
+
+ <para>Ein Benutzer ist eine Person, die Zugriff auf kivitendo erhalten
+ soll. Sie erhält einen Loginnamen sowie ein Passwort. Weiterhin legt
+ der Administrator fest, an welchen Mandanten sich ein Benutzer
+ anmelden kann, was beim Login verifiziert wird.</para>
+
+ <para>Gruppen dienen dazu, Benutzern innerhalb eines Mandanten Zugriff
+ auf bestimmte Funktionen zu geben. Einer Gruppe werden dafür vom
+ Administrator gewisse Rechte zugeordnet. Weiterhin legt der
+ Administrator fest, für welche Mandanten eine Gruppe gilt, und welche
+ Benutzer Mitglieder in dieser Gruppe sind. Meldet sich ein Benutzer
+ dann an einem Mandanten an, so erhält er alle Rechte von allen
+ denjenigen Gruppen, die zum Einen dem Mandanten zugeordnet sind und in
+ denen der Benutzer zum Anderen Mitglied ist,</para>
+
+ <para>Die Reihenfolge, in der Datenbanken, Mandanten, Gruppen und
+ Benutzer angelegt werden, kann im Prinzip beliebig gewählt werden. Die
+ folgende Reihenfolge beinhaltet die wenigsten Arbeitsschritte:</para>
<orderedlist numeration="arabic">
<listitem>
</listitem>
<listitem>
- <para>Benutzer anlegen</para>
+ <para>Benutzer anlegen und Gruppen als Mitglied zuordnen</para>
</listitem>
<listitem>
- <para>Benutzer den Gruppen zuordnen</para>
+ <para>Mandanten anlegen und Gruppen sowie Benutzer zuweisen</para>
</listitem>
</orderedlist>
</sect2>
<para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
Beispielen ist dies ‘<literal>kivitendo</literal>’).</para>
-
- <para>Wenn Sie für die kivitendo-Installation nicht Unicode (UTF-8) sondern den europäischen Schriftsatz ISO-8859-15 benutzen
- wollen, so müssen Sie vor dem Anlegen der Datenbank in der Datei <filename>config/kivitendo.conf</filename> die Variable
- <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf den Wert ‘<literal>ISO-8859-15</literal>’ setzen.</para>
-
- <para>Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz
- verwenden müssen, da diese Einstellungen momentan global in kivitendo
- vorgenommen wird und nicht nach Datenbank unterschieden werden kann.
- Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz
- angelegt worden sein.</para>
</sect2>
<sect2 id="Gruppen-anlegen">
Anlegen können Sie die verschiedenen Bereiche wählen, auf die
Mitglieder dieser Gruppe Zugriff haben sollen.</para>
- <para>Benutzergruppen sind unabhängig von Datenbanken, da sie in der
- Authentifizierungsdatenbank gespeichert werden. Sie gelten für alle
- Datenbanken, die in dieser Installation verwaltet werden.</para>
+ <para>Benutzergruppen werden zwar in der Authentifizierungsdatenbank
+ gespeichert, gelten aber nicht automatisch für alle Mandanten. Der
+ Administrator legt vielmehr fest, für welche Mandanten eine Gruppe
+ gültig ist. Dies kann entweder beim Bearbeiten der Gruppe geschehen
+ ("diese Gruppe ist gültig für Mandanten X, Y und Z"), oder aber wenn
+ man einen Mandanten bearbeitet ("für diesen Mandanten sind die Gruppen
+ A, B und C gültig").</para>
+
+ <para>Wurden bereits Benutzer angelegt, so können hier die Mitglieder
+ dieser Gruppe festgelegt werden ("in dieser Gruppe sind die Benutzer
+ X, Y und Z Mitglieder"). Dies kann auch nachträglich beim Bearbeiten
+ eines Benutzers geschehen ("dieser Benutzer ist Mitglied in den
+ Gruppen A, B und C").</para>
</sect2>
<sect2 id="Benutzer-anlegen">
Standardeinstellungen vorgenommen, die den Gepflogenheiten des
deutschen Raumes entsprechen.</para>
- <para>Zwingend anzugeben sind der Loginname sowie die komplette
- Datenbankkonfiguration. Wenn die Passwortauthentifizierung über die
- Datenbank eingestellt ist, so kann hier auch das Benutzerpasswort
- gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung
- aktiv, so ist das Passwort-Feld deaktiviert.</para>
+ <para>Zwingend anzugeben ist der Loginname. Wenn die
+ Passwortauthentifizierung über die Datenbank eingestellt ist, so kann
+ hier auch das Benutzerpasswort gesetzt bzw. geändert werden. Ist
+ hingegen die LDAP-Authentifizierung aktiv, so ist das Passwort-Feld
+ deaktiviert.</para>
+
+ <para>Hat man bereits Mandanten und Gruppen angelegt, so kann hier
+ auch konfiguriert werden, auf welche Mandanten der Benutzer Zugriff
+ hat bzw. in welchen Gruppen er Mitglied ist. Beide Zuweisungen können
+ sowohl beim Benutzer vorgenommen werden ("dieser Benutzer hat Zugriff
+ auf Mandanten X, Y, Z" bzw. "dieser Benutzer ist Mitglied in Gruppen
+ X, Y und Z") als auch beim Mandanten ("auf diesen Mandanten haben
+ Benutzer A, B und C Zugriff") bzw. bei der Gruppe ("in dieser Gruppe
+ sind Benutzer A, B und C Mitglieder").</para>
+ </sect2>
- <para>In der Datenbankkonfiguration müssen die Zugriffsdaten einer der
- eben angelegten Datenbanken eingetragen werden.</para>
+ <sect2 id="Mandanten-anlegen">
+ <title>Mandanten anlegen</title>
+
+ <para>Ein Mandant besteht aus Administrationssicht primär aus einem
+ eindeutigen Namen. Weiterhin wird hier hinterlegt, welche Datenbank
+ als Mandantendatenbank benutzt wird. Hier müssen die Zugriffsdaten
+ einer der eben angelegten Datenbanken eingetragen werden.</para>
+
+ <para>Hat man bereits Benutzer und Gruppen angelegt, so kann hier auch
+ konfiguriert werden, welche Benutzer Zugriff auf den Mandanten haben
+ bzw. welche Gruppen für den Mandanten gültig sind. Beide Zuweisungen
+ können sowohl beim Mandanten vorgenommen werden ("auf diesen Mandanten
+ haben Benutzer X, Y und Z Zugriff" bzw. "für diesen Mandanten sind die
+ Gruppen X, Y und Z gültig") als auch beim Benutzer ("dieser Benutzer
+ hat Zugriff auf Mandanten A, B und C") bzw. bei der Gruppe ("diese
+ Gruppe ist für Mandanten A, B und C gültig").</para>
</sect2>
+ </sect1>
- <sect2 id="Gruppenmitgliedschaften-verwalten">
- <title>Gruppenmitgliedschaften verwalten</title>
+ <sect1 id="Drucker--Systemverwaltung">
+ <title>Drucker- und Systemverwaltung</title>
+
+ <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte
+ Druckeradministration und System.</para>
+
+ <sect2 id="Druckeradministration">
+ <title>Druckeradministration</title>
+
+ <para>Unter dem Menüpunkt Druckeradministration lassen sich beliebig
+ viele "Druckbefehle" im System verwalten. Diese Befehle werden
+ mandantenweise zugeordnet. Unter Druckerbeschreibung wird der Namen
+ des Druckbefehls festgelegt, der dann in der Druckerauswahl des Belegs
+ angezeigt wird.</para>
+
+ <para>Unter Druckbefehl definiert man den eigentlichen Druckbefehl,
+ der direkt auf dem Webserver ausgeführt wird, bspw. 'lpr -P
+ meinDrucker' oder ein kompletter Pfad zu einem Skript
+ (/usr/local/src/kivitendo/scripts/pdf_druck_in_verzeichnis.sh). Wird
+ ferner noch ein optionales Vorlagenkürzel verwendet, wird dieses
+ Kürzel bei der Auswahl der Druckvorlagendatei mit einem Unterstrich
+ ergänzt, ist bspw. das Kürzel 'epson_drucker' definiert, so wird beim
+ Ausdruck eines Angebots folgende Vorlage geparst:
+ sales_quotation_epson_drucker.tex.</para>
+ </sect2>
- <para>Nach dem Anlegen von Benutzern und Gruppen müssen Benutzer den
- Gruppen zugewiesen werden. Dazu gibt es zwei Möglichkeiten:</para>
+ <sect2 id="System">
+ <title>System sperren / entsperren</title>
- <orderedlist numeration="arabic">
- <listitem>
- <para>In der Gruppenverwaltung wählt man eine Gruppe aus. Im
- folgenden Dialog kann man dann einzeln die Benutzer der Gruppe
- hinzufügen.</para>
- </listitem>
+ <para>Unter dem Menüpunkt System gibt es den Eintrag 'Installation
+ sperren/entsperren'. Setzt man diese Sperre so ist der Zugang zu der
+ gesamten kivitendo Installation gesperrt.</para>
- <listitem>
- <para>In der Gruppenverwaltung wählt man das Tool zur Verwaltung
- der Gruppenmitgliedschaft. Hier wird eine Matrix angezeigt, die
- alle im System angelegten Gruppen und Benutzer enthält. Durch
- Setzen der Häkchen wird der Benutzer in der ausgewählten Zeile der
- Gruppe in der ausgewählten Spalte hinzugefügt.</para>
- </listitem>
- </orderedlist>
+ <para>Falls die Sperre gesetzt ist, erscheint anstelle der
+ Anmeldemaske die Information: 'kivitendo ist momentan zwecks
+ Wartungsarbeiten nicht zugänglich.'.</para>
+
+ <para>Wichtig zu erwähnen ist hierbei noch, dass sich kivitendo
+ automatisch 'sperrt', falls es bei einem Versionsupdate zu einem
+ Datenbankfehler kam. Somit kann hier nicht aus Versehen mit einem
+ inkonsistenten Datenbestand weitergearbeitet werden.</para>
+ </sect2>
+ </sect1>
+
+ <sect1 id="config.sending-email"
+ xreflabel="E-Mail-Versand aus kivitendo heraus">
+ <title>E-Mail-Versand aus kivitendo heraus</title>
+
+ <para>kivitendo kann direkt aus dem Programm heraus E-Mails versenden,
+ z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit dies
+ funktioniert, muss eingestellt werden, über welchen Server die E-Mails
+ verschickt werden sollen. kivitendo unterstützt dabei zwei Mechanismen:
+ Versand über einen lokalen E-Mail-Server (z.B. mit
+ <productname>Postfix</productname> oder <productname>Exim</productname>,
+ was auch die standardmäßig aktive Methode ist) sowie Versand über einen
+ SMTP-Server (z.B. der des eigenen Internet-Providers).</para>
+
+ <para>Welche Methode und welcher Server verwendet werden, wird über die
+ Konfigurationsdatei <filename>config/kivitendo.conf</filename>
+ festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
+ Abschnitt '<literal>[mail_delivery]</literal>'.</para>
+
+ <sect2 id="config.sending-email.sendmail"
+ xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
+ <title>Versand über lokalen E-Mail-Server</title>
+
+ <para>Diese Methode bietet sich an, wenn auf dem Server, auf dem
+ kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
+ <productname>Postfix</productname>, <productname>Exim</productname>
+ oder <productname>Sendmail</productname> läuft.</para>
+
+ <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
+ '<literal>method = sendmail</literal>' gesetzt sein. Dies ist
+ gleichzeitig der Standardwert, falls er nicht verändert wird.</para>
+
+ <para>Um zu kontrollieren, wie das Programm zum Einliefern gestartet
+ wird, dient der Parameter '<literal>sendmail = ...</literal>'. Der
+ Standardwert verweist auf das Programm
+ <filename>/usr/bin/sendmail</filename>, das bei allen oben genannten
+ E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.</para>
+
+ <para>Die Konfiguration des E-Mail-Servers selber würde den Rahmen
+ dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
+ verwiesen.</para>
</sect2>
- <sect2 id="Migration-alter-Installationen">
- <title>Migration alter Installationen</title>
-
- <para>Wenn kivitendo 2.6.3 über eine ältere Version installiert wird,
- in der die Benutzerdaten noch im Dateisystem im Verzeichnis
- <literal>users</literal> verwaltet wurden, so bietet kivitendo die
- Möglichkeit, diese Benutzerdaten automatisch in die
- Authentifizierungsdatenbank zu übernehmen. Dies geschieht, wenn man
- sich nach dem Update der Installation das erste Mal im
- Administrationsbereich anmeldet. Findet kivitendo die Datei
- <literal>users/members</literal>, so wird der Migrationsprozess
- gestartet.</para>
-
- <para>Der Migrationsprozess ist nahezu vollautomatisch. Alle
- Benutzerdaten können übernommen werden. Nach den Benutzerdaten bietet
- kivitendo noch die Möglichkeit an, dass automatisch eine
- Benutzergruppe angelegt wird. Dieser Gruppe wird Zugriff auf alle
- Funktionen von kivitendo gewährt. Alle migrierten Benutzern werden
- Mitglied in dieser Gruppe. Damit wird das Verhalten von kivitendo bis
- Version 2.4.3 inklusive wiederhergestellt, und die Benutzer können
- sich sofort wieder anmelden und mit dem System arbeiten.</para>
+ <sect2 id="config.sending-email.smtp"
+ xreflabel="E-Mail-Versand über einen SMTP-Server">
+ <title>Versand über einen SMTP-Server</title>
+
+ <para>Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
+ vorhanden oder zwar einer vorhanden, dieser aber nicht konfiguriert
+ ist.</para>
+
+ <para>Um diese Methode auszuwählen, muss der Konfigurationsparameter
+ '<literal>method = smtp</literal>' gesetzt sein. Die folgenden
+ Parameter dienen dabei der weiteren Konfiguration:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><varname>hostname</varname></term>
+
+ <listitem>
+ <para>Name oder IP-Adresse des SMTP-Servers. Standardwert:
+ '<literal>localhost</literal>'</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>port</varname></term>
+
+ <listitem>
+ <para>Portnummer. Der Standardwert hängt von der verwendeten
+ Verschlüsselungsmethode ab. Gilt '<literal>security =
+ none</literal>' oder '<literal>security = tls</literal>', so ist
+ 25 die Standardportnummer. Für '<literal>security =
+ ssl</literal>' ist 465 die Portnummer. Muss normalerweise nicht
+ geändert werden.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>security</varname></term>
+
+ <listitem>
+ <para>Wahl der zu verwendenden Verschlüsselung der Verbindung
+ mit dem Server. Standardwert ist '<literal>none</literal>',
+ wodurch keine Verschlüsselung verwendet wird. Mit
+ '<literal>tls</literal>' wird TLS-Verschlüsselung eingeschaltet,
+ und mit '<literal>ssl</literal>' wird Verschlüsselung via SSL
+ eingeschaltet. Achtung: Für '<literal>tls</literal>' und
+ '<literal>ssl</literal>' werden zusätzliche Perl-Module benötigt
+ (siehe unten).</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>login</varname> und
+ <varname>password</varname></term>
+
+ <listitem>
+ <para>Falls der E-Mail-Server eine Authentifizierung verlangt,
+ so können mit diesen zwei Parametern der Benutzername und das
+ Passwort angegeben werden. Wird Authentifizierung verwendet, so
+ sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
+ aktiviert werden.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</sect2>
</sect1>
<sect1 id="Drucken-mit-kivitendo">
<title>Drucken mit kivitendo</title>
- <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX Vorlagen.
+ <para>Das Drucksystem von kivitendo benutzt von Haus aus LaTeX-Vorlagen.
Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
- Debianoiden Betriebssystemen sind das die Pakete:</para>
+ debianoiden Betriebssystemen installiert man die Pakete mit:</para>
+
+ <para><programlisting>apt-get install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
+ texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
- <para><literal>texlive-latex-base texlive-latex-extra
- texlive-fonts-recommended</literal></para>
+ <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
- <para>Diese hinteren beiden enthalten Bibliotheken und Schriftarten die
- von den Standardvorlagen verwendet werden.</para>
+ <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
+ texlive-collection-latexrecommended texlive-collection-langgerman \
+ texlive-collection-langenglish</programlisting></para>
- <para>TODO: rpm Pakete.</para>
+ <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
- <para>In den allermeisten Installationen sollte drucken jetzt schon
- funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
- Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
- die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
- Beispiel:</para>
+ <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
+ texlive-collection-latexrecommended texlive-collection-langgerman \
+ texlive-collection-langenglish</programlisting></para>
+
+ <para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
<itemizedlist>
<listitem>
- <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
- LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
- Vorlagen aus der Community auf. Installieren Sie die entsprechenden
- Pakete.</para>
+ <para>RB</para>
+ </listitem>
+
+ <listitem>
+ <para>f-tex</para>
</listitem>
<listitem>
- <para>! Package inputenc Error: Unicode char \u8:æ¡\9c not set up for
- use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
- einer Standardinstallation exotische utf8 Zeichen zu drucken.
- TeXLive unterstützt von Haus nur romanische Schriften und muss mit
- diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
- Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
+ <para>rev-odt</para>
</listitem>
</itemizedlist>
- <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
- heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
- Prüfen Sie den Namen in der Konfiguration (Standard:
- <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
- (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
- darf.</para>
- </sect1>
+ <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version
+ 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
- <sect1 id="OpenDocument-Vorlagen">
- <title>OpenDocument-Vorlagen</title>
+ <sect2 id="Vorlagenverzeichnis-anlegen"
+ xreflabel="Vorlagenverzeichnis anlegen">
+ <title>Vorlagenverzeichnis anlegen</title>
- <para>kivitendo unterstützt die Verwendung von Vorlagen im
- OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
- kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
- diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
- OpenDocument-Vorlagen zu aktivieren muss in der Datei
- <filename>config/kivitendo.conf</filename> die Variable
- <literal>opendocument</literal> im Abschnitt
- <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
+ <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die
+ LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
+
+ <programlisting>./scripts/installation_check.pl -lv</programlisting>
+
+ <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
+ Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
+ <xref linkend="Gruppen-anlegen"/>.</para>
+
+ <para>Im Userbereich lässt sich unter: "<guimenu>System</guimenu>
+ -> <guisubmenu>Mandantenverwaltung</guisubmenu> ->
+ <guimenuitem>Verschiedenes</guimenuitem>" die Option "Neue
+ Druckvorlagen aus Vorlagensatz erstellen" auswählen.</para>
+
+ <orderedlist>
+ <listitem>
+ <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
+ Vorlagensatz aus, der kopiert werden soll
+ (<filename>RB</filename>, <filename>f-tex</filename> oder
+ <filename>odt-rev</filename>.)</para>
+ </listitem>
+
+ <listitem>
+ <para><option>Neuer Name</option>: Der Verzeichnisname für den
+ neuen Vorlagensatz. Dieser kann im Rahmen der üblichen Bedingungen
+ für Verzeichnisnamen frei gewählt werden.</para>
+ </listitem>
+ </orderedlist>
+
+ <para>Nach dem Speichern wird das Vorlagenverzeichnis angelegt und ist
+ für den aktuellen Mandanten ausgewählt. Der gleiche Vorlagensatz kann,
+ wenn er mal angelegt ist, bei mehreren Mandanten verwendet werden.
+ Eventuell müssen Anpassungen (Logo, Erscheinungsbild, etc) noch
+ vorgenommen werden. Den Ordner findet man im Dateisystem unter
+ <filename>./templates/[Neuer Name]</filename></para>
+ </sect2>
+
+ <sect2 id="Vorlagen-RB">
+ <title>Der Druckvorlagensatz RB</title>
+
+ <para>Hierbei handelt es sich um einen vollständigen LaTeX
+ Dokumentensatz mit alternativem Design. Die odt oder html-Varianten
+ sind nicht gepflegt.</para>
+
+ <para>Die konzeptionelle Idee der Vorlagen wird <ulink
+ url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
+ auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die
+ eigenen Firmendaten finden sich in der Datei Readme.tex im
+ Vorlagenverzeichnis.</para>
+
+ <para>Eine kurze Übersicht der Features:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Mehrsprachenfähig, mit Deutscher und Englischer
+ Übersetzung</para>
+ </listitem>
+
+ <listitem>
+ <para>Zentrale Konfigurationsdateien, die für alle Belege benutzt
+ werden, z.B. für Kopf- und Fußzeilen, und Infos wie
+ Bankdaten</para>
+ </listitem>
+
+ <listitem>
+ <para>mehrere vordefinierte Varianten für
+ Logos/Hintergrundbilder</para>
+ </listitem>
+
+ <listitem>
+ <para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
+ "Außerhalb EU"</para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
+
+ <sect2 id="f-tex">
+ <title>f-tex</title>
+
+ <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur
+ Verfügung stellt.</para>
+
+ <sect3 id="f-tex-Feature-Übersicht">
+ <title>Feature-Übersicht</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>Keine Redundanz. Es wird ein- und dieselbe LaTeX-Vorlage
+ für alle briefartigen Dokumente verwendet. Also Angebot,
+ Rechnung, Proformarechnung, Lieferschein, aber eben nicht für
+ Paketaufkleber etc.</para>
+ </listitem>
+
+ <listitem>
+ <para>Leichte Anpassung an das Firmen-Layout durch Verwendung
+ eines Hintergrund-PDFs. Dieses kann leicht mit dem eigenen
+ Lieblingsprogramm erstellt werden (Openoffice, Inkscape, Gimp,
+ Adobe*)</para>
+ </listitem>
+
+ <listitem>
+ <para>Hintergrund-PDF umschaltbar auf "nur erste Seite"
+ (Standard) oder "alle Seiten" (Option
+ "<option>bgPdfFirstPageOnly</option>" in Datei
+ <filename>letter.lco</filename>)</para>
+ </listitem>
+
+ <listitem>
+ <para>Hintergrund-PDF für Ausdruck auf bereits bedrucktem
+ Briefpapier abschaltbar. Es wird dann nur bei per E-Mail
+ versendeten Dokumenten eingebunden (Option
+ "<option>bgPdfEmailOnly</option>" in Datei
+ <filename>letter.lco</filename>).</para>
+ </listitem>
+
+ <listitem>
+ <para>Nutzung der Layout-Funktionen von LaTeX für Seitenumbruch,
+ Wiederholung von Kopfzeilen, Zwischensummen etc. (danke an
+ Kai-Martin Knaak für die Vorarbeit)</para>
+ </listitem>
+
+ <listitem>
+ <para>Anzeige des Empfängerlandes im Adressfeld nur, wenn es vom
+ Land des eigenen Unternehmens abweicht (also die Rechnung das
+ Land verlässt).</para>
+ </listitem>
+
+ <listitem>
+ <para>Multisprachfähig leicht um weitere Sprachen zu erweitern,
+ alle Übersetzungen in der Datei
+ <filename>translatinos.tex</filename>.</para>
+ </listitem>
+
+ <listitem>
+ <para>Auflistung von Bruttopreisen für Endverbraucher.</para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="f-tex-Installation">
+ <title>Die Installation</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>Vorlagenverzeichnis mit Option f-tex anlegen, siehe: <xref
+ linkend="Vorlagenverzeichnis-anlegen"/>. Das Vorlagensystem
+ funktioniert jetzt schon, hat allerdings noch einen
+ Beispiel-Briefkopf.</para>
+ </listitem>
+
+ <listitem>
+ <para>Erstelle eine pdf-Hintergrund Datei und verlinke sie nach
+ <filename>./letter_head.pdf</filename>.</para>
+ </listitem>
+
+ <listitem>
+ <para>Editiere den Bereich "<option>settings</option>" in der
+ datei <filename>letter.lco</filename>.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>oder etwas detaillierter:</para>
+
+ <para>Es wird eine Datei <filename>sample.lco</filename> erstellt
+ und diese nach <filename>letter.lco</filename> verlinkt. Eigentlich
+ ist dies die Datei die für die firmenspezifischen Anpassungen
+ gedacht ist. Da die Einstiegshürde in LaTeX nicht ganz niedrig ist,
+ wird in dieser Datei auf ein Hintergrund-PDF verwiesen. Ich empfehle
+ über dieses PDF die persönlichen Layoutanpassungen vorzunehmen und
+ <filename>sample.lco</filename> unverändert zu lassen. Die Anpassung
+ über eine <filename>*.lco</filename>-Datei, die letztlich auf
+ <filename>letter.lco</filename> verlinkt ist ist aber auch
+ möglich.</para>
+
+ <para>Es wird eine Datei <filename>sample_head.pdf</filename> mit
+ ausgeliefert, diese wird nach <filename>letter_head.pdf</filename>
+ verlinkt. Damit gibt es schon mal eine funktionsfähige Vorlage.
+ Schau Dir nach Abschluss der Installation die Datei
+ <filename>sample_head.pdf</filename> an und erstelle ein
+ entsprechendes PDF passend zum Briefkopf Deiner Firma, diese dann im
+ Template Verzeichniss ablegen und statt
+ <filename>sample_head.pdf</filename> nach
+ <filename>letter_head.pdf</filename> verlinken.</para>
+
+ <para>Letzlich muss <filename>letter_head.pdf</filename> auf das
+ passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
+ enthält.</para>
+
+ <para>Es wird eine Datei <filename>mydata.tex.example</filename>
+ ausgeliefert, die nach <filename>mytdata.tex</filename> verlinkt
+ ist. Bei verwendetem Hintergrund-PDF wird nur der Eintrag für das
+ Land verwendet. Die Datei muss also nicht angefasst werden. Die
+ anderen Werte sind für das Modul 'lp' (Label Print in erp - zur Zeit
+ nicht im öffentlichen Zweig).</para>
+
+ <para>Alle Anpassungen zum Briefkopf, Fusszeilen, Firmenlogos, etc.
+ sollten über die Hintergrund-PDF-Datei oder die
+ <filename>*.lco</filename>-Datei erfolgen.</para>
+ </sect3>
+
+ <sect3 id="f-tex-Funktionsübersicht">
+ <title>f-tex Funktionsübersicht</title>
+
+ <para>Das Konzept von kivitendo sieht vor, für jedes Dokument
+ (Auftragsbestätigung, Lieferschein, Rechnung, etc.) eine
+ LaTeX-Vorlage vorzuhalten, dies ist sehr wartungsunfreundlich. Auch
+ das Einlesen einer einheitlichen Quelle für den Briefkopf bringt nur
+ bedingte Vorteile, da hier leicht die Pflege der Artikel-Tabellen
+ aus dem Ruder läuft. Bei dem vorliegenden Ansatz wird für alle
+ briefartigen Dokumente mit Artikel-Tabellen eine einheitliche
+ LaTeX-Vorlage verwendet, welche über Codeweichen die Besonderheiten
+ der jeweiligen Dokumente berücksichtigt:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Tabellen mit oder ohne Preis</para>
+ </listitem>
+
+ <listitem>
+ <para>Sprache der Tabellenüberschriften etc.</para>
+ </listitem>
+
+ <listitem>
+ <para>Anpassung der Bezugs-Zeile (z.B. Rechnungsnummer versus
+ Angebotsnummer)</para>
+ </listitem>
+
+ <listitem>
+ <para>Darstellung von Brutto oder Netto-Preisen in der
+ Auflistung (Endverbraucher versus gewerblicher Kunde)</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Nachteil:</para>
+
+ <para>LaTeX hat ohnehin eine sehr steile Lehrnkurve. Die Datei
+ <filename>letter.tex</filename> ist sehr komplex und verstärkt damit
+ diesen Effekt noch einmal erheblich. Wer LaTeX-Erfahrung hat, oder
+ geübt ist Scriptsparachen nachzuvollziehen kann natürlich auch
+ innerhalb der Tabellendarstellung gut persönliche Anpassungen
+ vornehmen. Aber man kann sich hier bei Veränderungen sehr schnell
+ heftig in den Fuss schiessen.</para>
+
+ <para>Wer nicht so tief in die Materie einsteigen will oder leicht
+ zu frustrieren ist, sollte sein Hintergrund-PDF auf Basis der
+ mitglieferten Datei <filename>sample_head.pdf</filename> erstellen,
+ und sich an der Form der dargestellten Tabellen, wie sie
+ ausgeliefert werden, erfreuen.</para>
+
+ <para>Kleiner Tipp: Nicht zu viel auf einmal wollen, lieber kleine,
+ kontinuierliche Schritte gehen.</para>
+ </sect3>
+
+ <sect3 id="f-tex-Bruttopreise">
+ <title>Bruttopreise für Endverbraucher</title>
+
+ <para>Der auszuweisende Bruttopreis wird innerhalb der
+ LaTeX-Umgebung berechnet. Es gibt zwar ein Feld, um bei Aufträgen
+ "alle Preise Brutto" auszuwählen, aber:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>hierfür müssen die Preise auch in Brutto in der Datenbank
+ stehen (ja - das lässt sich über die Preisgruppen und die
+ Zuordung einer Default-Preisgruppe handhaben)</para>
+ </listitem>
+
+ <listitem>
+ <para>man darf beim Anlegen des Vorgangs nicht vergessen, dieses
+ Häkchen zu setzen. (Das ist in der Praxis, wenn man sowohl
+ Endverbraucher als auch Gewerbekunden beliefert, der eigentliche
+ Knackpunkt)</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Es gibt mit f-tex eine weitere Alternative. Die Information ob
+ Brutto oder Nettorechnung wird mit den Zahlarten verknüpft.
+ Zahlarten bei denen Rechnungen, Angebote, etc, in Brutto ausgegeben
+ werden sollen, enden mit "_E" (für Endverbraucher). Falls identische
+ Zahlarten für Gewerbekunden und Endverbraucher vorhanden sind, legt
+ man diese einfach doppelt an (einmal mit der Namensendung "_E").
+ Gewinn:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Die Entscheidung, ob Nettopreise ausgewiesen werden, ist
+ nicht mehr fix mit einer Preisliste verbunden.</para>
+ </listitem>
+
+ <listitem>
+ <para>Die Default-Zahlart kann im Kundendatensatz hinterlegt
+ werden, und man muss nicht mehr daran denken, "alle Preise
+ Netto" auszuwählen.</para>
+ </listitem>
+
+ <listitem>
+ <para>Die Entscheidung, ob Netto- oder Bruttopreise ausgewiesen
+ werden, kann direkt beim Drucken revidiert werden, ohne dass
+ sich der Auftragswert ändert.</para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="f-tex-lieferadressen">
+ <title>Lieferadressen</title>
+
+ <para>In Lieferscheinen kommen <varname>shipto*</varname>-Variablen
+ im Adressfeld zum Einsatz. Wenn die
+ <varname>shipto*</varname>-Variable leer ist, wird die entsprechende
+ Adressvariable eingesetzt. Wenn also die Lieferadresse in Straße,
+ Hausnummer und Ort abweicht, müssen auch nur diese Felder in der
+ Lieferadresse ausgefüllt werden. Für den Firmenname wird der Wert
+ der Hauptadresse angezeigt.</para>
+ </sect3>
+ </sect2>
+
+ <sect2 id="Vorlagen-rev-odt">
+ <title>Der Druckvorlagensatz rev-odt</title>
+
+ <para>Hierbei handelt es sich um einen Dokumentensatz der mit
+ odt-Vorlagen erstellt wurde. Es gibt in dem Verzeichnis eine
+ Readme-Datei, die eventuell aktueller als die Dokumentation hier ist.
+ Die odt-Vorlagen in diesem Verzeichnis "rev-odt" wurden von revamp-it,
+ Zürich erstellt und werden laufend aktualisiert. Ein paar der
+ Formulierungen in den Druckvorlagen entsprechen dem Schweizer
+ Sprachgebrauch, z.B. "Offerte" oder "allfällig".</para>
+
+ <para>Hinweis zum Einsatz des Feldes "Land" bei den Stammdaten für
+ KundInnen und LieferantInnen, sowie bei Lieferadressen: Die in diesem
+ Vorlagensatz vorhandenen Vorlagen erwarten für "Land" das
+ entsprechende Kürzel, das in Adressen vor die Postleitzahl gesetzt
+ wird. Das Feld kann auch komplett leer bleiben. Wer dies anders
+ handhaben möchte, muss die Vorlagen entsprechend anpassen.</para>
+
+ <para>odt-Vorlagen können mit LibreOffice oder OpenOffice editiert und
+ den eigenen Bedürfnissen angepasst werden. Wichtig beim Editieren von
+ if-Blöcken ist, dass immer der gesamte Block überschrieben werden muss
+ und nicht nur Teile davon, da dies sonst oft zu einer odt-Datei führt,
+ die vom Parser nicht korrekt gelesen werden kann.</para>
+
+ <para>Mahnungen können unter folgenden Einschränkungen mit den odt-Vorlagen
+ im Vorlagensatz rev-odt erzeugt werden:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>als Druckoption steht nur 'PDF(OpenDocument/OASIS)' zur
+ Verfügung, das heisst, die Mahnungen werden als PDF-Datei ausgegeben.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>für jede Rechnung muss eine eigene Mahnung erzeugt werden
+ (auch wenn bei einzelnen KundInnen mehrere überfällige Rechnungen
+ vorhanden sind).</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Mehrere Mahnungen für eine Kundin / einen Kunden werden zu einer
+ PDF-Datei zusammengefasst</para>
+
+ <para>Die Vorlagen zahlungserinnerung.odt sowie mahnung.odt sind für das
+ Erstellen einer Zahlungserinnerung bzw. Mahnung selbst vorgesehen, die
+ Vorlage mahnung_invoice.odt für das Erstellen einer Rechnung über die
+ verrechneten Mahngebühren und Verzugszinsen.</para>
+
+ <para>Zur Zeit gibt es in kivitendo noch keine Möglichkeit,
+ odt-Vorlagen bei Briefen und Pflichtenheften einzusetzen.
+ Entsprechende Vorlagen sind deshalb nicht vorhanden.</para>
+
+ <para>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
+ empfang@revamp-it.ch</para>
+ </sect2>
+
+ <sect2 id="allgemeine-hinweise-zu-latex">
+ <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
+
+ <para>In den allermeisten Installationen sollte das Drucken jetzt
+ schon funktionieren. Sollte ein Fehler auftreten, wirft TeX sehr lange
+ Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste
+ Zeile, die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler
+ sind zum Beispiel:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>! LaTeX Error: File `eurosym.sty' not found. Die
+ entsprechende LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor
+ allem bei Vorlagen aus der Community auf. Installieren Sie die
+ entsprechenden Pakete.</para>
+ </listitem>
+
+ <listitem>
+ <para>! Package inputenc Error: Unicode char \u8:... set up for
+ use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
+ einer Standardinstallation exotische utf8 Zeichen zu drucken.
+ TeXLive unterstützt von Haus nur romanische Schriften und muss mit
+ diversen Tricks dazu gebracht werden andere Zeichen zu
+ akzeptieren. Adere TeX Systeme wie XeTeX schaffen hier
+ Abhilfe.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Wird gar kein Fehler angezeigt, sondern nur der Name des
+ Templates, heißt das normalerweise, dass das LaTeX Binary nicht
+ gefunden wurde. Prüfen Sie den Namen in der Konfiguration (Standard:
+ <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
+ (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
+ darf.</para>
+
+ <para>Wenn sich das Problem nicht auf Grund der Ausgabe im Webbrowser
+ verifizieren lässt:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>editiere [kivitendo-home]/config/kivitendo.conf und ändere
+ "keep_temp_files" auf 1</para>
+
+ <para><programlisting>keep_temp_files = 1;</programlisting></para>
+ </listitem>
+
+ <listitem>
+ <para>bei fastcgi oder mod_perl den Webserver neu Starten</para>
+ </listitem>
+
+ <listitem>
+ <para>Nochmal einen Druckversuch im Webfrontend auslösen</para>
+ </listitem>
+
+ <listitem>
+ <para>wechsel in das users Verzeichnis von kivitendo</para>
+
+ <para><programlisting>cd [kivitendo-home]/users</programlisting></para>
+ </listitem>
+
+ <listitem>
+ <para>LaTeX Suchpfad anpassen:</para>
+
+ <para><programlisting>export TEXINPUTS=".:[kivitendo-home]/templates/[aktuelles_template_verzeichniss]:"</programlisting></para>
+ </listitem>
+
+ <listitem>
+ <para>Finde heraus, welche Datei kivitendo beim letzten Durchlauf
+ erstellt hat</para>
+
+ <para><programlisting>ls -lahtr ./1*.tex</programlisting></para>
+
+ <para>Es sollte die letzte Datei ganz unten sein</para>
+ </listitem>
+
+ <listitem>
+ <para>für besseren Hinweis auf Fehler texdatei nochmals
+ übersetzen</para>
+
+ <para><programlisting>pdflatex ./1*.tex</programlisting></para>
+
+ <para>in der *.tex datei nach dem Fehler suchen.</para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
+ </sect1>
+
+ <sect1 id="OpenDocument-Vorlagen">
+ <title>OpenDocument-Vorlagen</title>
+
+ <para>kivitendo unterstützt die Verwendung von Vorlagen im
+ OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2) erzeugen.
+ kivitendo kann dabei sowohl neue OpenDocument-Dokumente als auch aus
+ diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
+ OpenDocument-Vorlagen zu aktivieren muss in der Datei
+ <filename>config/kivitendo.conf</filename> die Variable
+ <literal>opendocument</literal> im Abschnitt
+ <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
Dieses ist die Standardeinstellung.</para>
- <para>Weiterhin muss in der Datei
- <filename>config/kivitendo.conf</filename> die Variable
- <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf
- die Zeichenkodierung gesetzt werden, die auch bei der Speicherung der
- Daten in der Datenbank verwendet wird. Diese ist in den meisten Fällen
- "UTF-8".</para>
+ <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
+ weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
+ LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt werden, so muss
+ neben LibreOffice oder OpenOffice auch der “X virtual frame buffer”
+ (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
+ Andere Distributionen enthalten ihn in anderen Paketen.</para>
+
+ <para>Nach der Installation müssen in der Datei
+ <filename>config/kivitendo.conf</filename> im Abschnitt
+ <literal>applications</literal> zwei weitere Variablen
+ angepasst werden:</para>
+ <para><literal>openofficeorg_writer</literal> muss den
+ vollständigen Pfad zu LibreOffice oder OpenOffice enthalten.
+ Dabei dürfen keine Anführungszeichen eingesetzt werden.</para>
+ <para>Beispiel für Debian oder Ubuntu:</para>
+ <programlisting>openofficeorg_writer = /usr/bin/libreoffice</programlisting>
+ <para><literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
+ enthalten.</para>
+
+ <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
+ LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die benutzt
+ wird, wenn die Variable <literal>$openofficeorg_daemon</literal> gesetzt
+ ist, startet ein LibreOffice oder OpenOffice, das auch nach der Umwandlung
+ des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen wird dann diese
+ laufende Instanz benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung
+ deutlich reduziert wird, weil nicht für jedes Dokument ein LibreOffice bzw.
+ OpenOffice gestartet werden muss. Der Nachteil ist, dass diese Methode
+ Python und die Python-UNO-Bindings benötigt, die Bestandteil von LibreOffice
+ bzw. OpenOffice sind.</para>
+
+ <note>
+ <para>Für die Verbindung zu LibreOffice bzw. OpenOffice wird
+ normalerweise der Python-Interpreter
+ <filename>/usr/bin/python</filename> benutzt.
+ Sollte dies nicht der richtige sein, so kann man mit zwei
+ Konfigurationsvariablen entscheiden, welcher Python-Interpreter
+ genutzt wird. Mit der Option <literal>python_uno</literal> aus dem
+ Abschnitt <literal>applications</literal> wird der Interpreter selber
+ festgelegt; sie steht standardmäßig auf dem eben erwähnten Wert
+ <literal>/usr/bin/python</literal>.</para>
+
+ <para>Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
+ neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
+ z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
+ OpenOffice-Verzeichnis befinden. Diese zweite Variable heißt
+ <literal>python_uno_path</literal> und befindet sich im Abschnitt
+ <literal>environment</literal>. Sie ist standardmäßig leer. Werden
+ hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
+ voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
+ über die Umgebungsvariable <literal>PYTHONPATH</literal>
+ übergeben.</para>
+ </note>
+
+ <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
+ wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet
+ und die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses
+ Makro muss in der Dokumentenvorlage enthalten sein und
+ “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
+ ‘<literal>templates/print/rev-odt/invoice.odt</literal>’
+ enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
+ ebenfalls enthalten sein muss.</para>
+
+ <para>Als letztes muss herausgefunden werden, welchen Namen
+ OpenOffice bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen
+ gibt. Unter Debian ist dies momentan
+ <literal>~/.config/libreoffice</literal>. kivitendo verwendet das
+ Verzeichnis <literal>users/.openoffice.org2</literal>.
+ Eventuell muss dieses Verzeichnis umbenannt werden.</para>
+
+ <para>Dieses Verzeichnis, wie auch das komplette
+ <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
+ sein. Dieses wurde bereits erledigt (siehe <xref
+ linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber
+ erneut überprüft werden, wenn die Konvertierung nach PDF
+ fehlschlägt.</para>
+
+ <sect2>
+ <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
+
+ <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
+ Aufgaben erfüllen.</para>
+
+ <para>Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit <emphasis
+ role="bold">Schweizer Bank-Einzahlungsscheinen (BESR)</emphasis>.
+ Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
+ benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
+ Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
+ zu beachten ist (<emphasis role="bold">in fett sind nötige einmalige
+ Anpassungen aufgeführt</emphasis>):</para>
+
+ <sect3>
+ <title>Bezeichnung der Vorlagen</title>
+
+ <para>Rechnung: invoice_besr.odt, Auftrag:
+ sales_order_besr.odt</para>
+ </sect3>
+
+ <sect3>
+ <title>Vorbereitungen im Adminbereich</title>
+
+ <para>Damit beim Erstellen von Rechnungen und Aufträgen neben der
+ Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
+ Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
+ ein Drucker eingerichtet werden:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Druckeradministration → Drucker hinzufügen</para>
+ </listitem>
+
+ <listitem>
+ <para>Mandant wählen</para>
+ </listitem>
+
+ <listitem>
+ <para>Druckerbeschreibung → aussagekräftiger Text: wird in
+ der Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B.
+ mit Einzahlungsschein Bank xy)</para>
+ </listitem>
+
+ <listitem>
+ <para>Druckbefehl → beliebiger Text (hat für das Erzeugen
+ von Aufträgen oder Rechnungen als odt-Datei keine Bedeutung,
+ darf aber nicht leer sein)</para>
+ </listitem>
+
+ <listitem>
+ <para>Vorlagenkürzel → besr bzw. selbst gewähltes
+ Vorlagensuffix (muss genau der Zeichenfolge entsprechen, die
+ zwischen "invoice_" bzw. "sales_order_" und ".odt"
+ steht.)</para>
+ </listitem>
+
+ <listitem>
+ <para>speichern</para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3>
+ <title>Benutzereinstellungen</title>
+
+ <para>Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
+ im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
+ dies persönlich für sich bei den Benutzereinstellungen
+ konfigurieren:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Programm → Benutzereinstellungen →
+ Druckoptionen</para>
+ </listitem>
+
+ <listitem>
+ <para>Standardvorlagenformat → OpenDocument/OASIS</para>
+ </listitem>
+
+ <listitem>
+ <para>Standardausgabekanal → Bildschirm</para>
+ </listitem>
+
+ <listitem>
+ <para>Standarddrucker → gewünschte Druckerbeschreibung
+ auswählen (z.B. mit Einzahlungsschein Bank xy)</para>
+ </listitem>
+
+ <listitem>
+ <para>Anzahl Kopien → leer</para>
+ </listitem>
+
+ <listitem>
+ <para>speichern</para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3>
+ <title>Aufbau und nötige Anpassungen der Vorlagen</title>
+
+ <para>In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
+ aus dem von kivitendo erzeugten odt-Dokument die korrekte
+ Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
+ OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
+ schreiben.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Für den Einzahlungsschein ist die letzte Seite des
+ Dokuments reserviert</para>
+ </listitem>
+
+ <listitem>
+ <para>Direkt über dem Einzahlungsschein enthält die Vorlage eine
+ Zeile mit folgenden Angaben (<emphasis
+ role="bold">Bank-Konto-Identifikationsnummer und
+ Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
+ Bank angepasst werden</emphasis>):<itemizedlist>
+ <listitem>
+ <para>DDDREF: 4 Werte zum Bilden der Referenznummer
+ (jeweils durch einen Leerschlag getrennt): <itemizedlist>
+ <listitem>
+ <para>erster Wert: <emphasis
+ role="bold">Bank-Konto-Identifikation</emphasis>
+ (nur Ziffern, maximal 6), <emphasis role="bold">muss
+ angepasst werden</emphasis>.</para>
+ </listitem>
+
+ <listitem>
+ <para>zweiter Wert: <%customernumber%>
+ (Kundennummer: nur Ziffern, maximal 6)</para>
+ </listitem>
+
+ <listitem>
+ <para>dritter Wert: <%ordnumber%>
+ (Auftragsnummer bei Auftragsvorlage
+ sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
+ führende Buchstaben werden vom Makro entfernt</para>
+ </listitem>
+
+ <listitem>
+ <para>vierter Wert: <%invnumber%>
+ (Rechnungsnummer bei Rechnungsvorlage
+ invoice_besr.odt, sonst 0) maximal 7 Ziffern,
+ führende Buchstaben werden vom Makro entfernt</para>
+ </listitem>
+ </itemizedlist></para>
+ </listitem>
+
+ <listitem>
+ <para>DDDKONTO: <emphasis role="bold">Postkonto-Nummer der
+ Bank, muss angepasst werden</emphasis>.</para>
+ </listitem>
+
+ <listitem>
+ <para>DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
+ falls Einzahlungsschein ohne Betrag</para>
+ </listitem>
+
+ <listitem>
+ <para>DDDEND: muss am Ende der Zeile vorhanden sein</para>
+ </listitem>
+ </itemizedlist></para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Im Einzahlungsschein selbst müssen
+ der Name und die Adresse der Bank, die Postkonto-Nummer der
+ Bank, sowie der eigene Firmenname und die Firmenadresse
+ angepasst werden.</emphasis> Dabei ist darauf zu achten, dass
+ sich die Positionen der Postkonto-Nummern der Bank, sowie der
+ Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
+ verschieben.</para>
+ </listitem>
+ </itemizedlist>
+
+ <screenshot>
+ <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
+ ändernde Einträge in rot</screeninfo>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </sect3>
+
+ <sect3>
+ <title>Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
+ odt-Rechnung (analog bei Auftrag)</title>
+
+ <para>Im Fussbereich der Rechnungsmaske muss neben Rechnung,
+ OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
+ Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
+ den Benutzereinstellungen als persönlicher Standard gewählt
+ wurde.</para>
+ </sect3>
+
+ <sect3>
+ <title>Makroeinstellungen in LibreOffice anpassen</title>
+
+ <para>Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung
+ die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
+ ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
+ angepasst werden:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Extras → Optionen → Sicherheit →
+ Makrosicherheit</para>
+ </listitem>
+
+ <listitem>
+ <para>Sicherheitslevel auf "Mittel" einstellen (Diese
+ Einstellung muss auf jedem Computer durchgeführt werden, mit dem
+ von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
+ werden.)</para>
+ </listitem>
+
+ <listitem>
+ <para>Beim Öffnen einer odt-Rechnung oder eines odt-Auftrags bei
+ der entsprechenden Nachfrage "Makros ausführen" auswählen.
+ </para>
+
+ <para><emphasis role="bold">Wichtig</emphasis>: die Makros sind
+ so eingestellt, dass sie beim Öffnen der Vorlagen selbst nicht
+ ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
+ Vorlagen sind keine speziellen Einstellungen in LibreOffice
+ nötig.</para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+ </sect2>
+ </sect1>
+
+ <sect1 id="nomenclature">
+ <title>Nomenklatur</title>
- <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
- weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
- OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
- neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
- (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
- Andere Distributionen enthalten ihn in anderen Paketen.</para>
+ <sect2 id="booking.dates">
+ <title>Datum bei Buchungen</title>
- <para>Nach der Installation müssen in der Datei
- <filename>config/kivitendo.conf</filename> zwei weitere Variablen
- angepasst werden: <literal>openofficeorg_writer</literal> muss den
- vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
- <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
- enthalten. Beide stehen im Abschnitt
- <literal>applications</literal>.</para>
+ <para>Seit der Version 3.5 werden für Buchungen in kivitendo einheitlich
+ folgende Bezeichnungen verwendet:</para>
- <para>Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
- OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
- Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
- ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
- bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
- benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
- reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
- werden muss. Der Nachteil ist, dass diese Methode Python und die
- Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
- sind.</para>
+ <itemizedlist>
+ <listitem>
+ <para><option>Erfassungsdatum</option> (en: <option>Entry Date</option>,
+ code: <option>Gldate</option>)</para>
- <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
- wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
- mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
- Dokumentenvorlage enthalten sein und
- “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
- ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
- enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
- ebenfalls enthalten sein muss.</para>
+ <para>bezeichnet das Datum, an dem die Buchung in kivitendo erfasst wurde.
+ </para>
+ </listitem>
- <para>Als letztes muss herausgefunden werden, welchen Namen
- OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
- gibt. Unter Debian ist dies momentan
- <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
- OpenOffice.org-Installation anders sein, so muss das Verzeichnis
- <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
- Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
- folgender Befehl auszuführen:</para>
+ <listitem>
+ <para><option>Buchungsdatum</option> (en: <option>Booking Date</option>,
+ code: <option>Transdate</option>)</para>
- <para><literal>mv users/.openoffice.org2
- users/.openoffice</literal></para>
+ <para>bezeichnet das buchhaltungstechnisch für eine Buchung relevante
+ Datum</para>
- <para>Dieses Verzeichnis, wie auch das komplette
- <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
- sein. Dieses wurde bereits erledigt (siehe <xref
- linkend="Manuelle-Installation-des-Programmpaketes" />), kann aber
- erneut überprüft werden, wenn die Konvertierung nach PDF
- fehlschlägt.</para>
+ <para>Das <option>Rechnungsdatum</option> bei Verkaufs- und
+ Einkaufsrechnungen entspricht dem Buchungsdatum. Das heisst, in
+ Berichten wie dem Buchungsjournal, in denen eine Spalte
+ <option>Buchungsdatum</option> angezeigt werden kann, erscheint hier
+ im Fall von Rechnungen das Rechnungsdatum.</para>
+ </listitem>
+
+ <listitem>
+ <para>Bezieht sich ein verbuchter Beleg auf einen Zeitpunkt, der nicht mit
+ dem Buchungsdatum übereinstimmt, so kann dieses Datum momentan in kivitendo
+ nur unter Bemerkungen erfasst werden.</para>
+
+ <para>Möglicherweise wird für solche Fälle in einer späteren Version von
+ kivitendo ein dritter Datumswert für Buchungen erstellt. (Beispiel:
+ Einkaufsbeleg stammt aus einem früheren Jahr, das bereits
+ buchhaltungstechnisch abgeschlossen wurde, und muss deshalb später
+ verbucht werden.)</para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
</sect1>
<sect1 id="config.eur">
<para>kivitendo besaß bis inklusive Version 2.6.3 einen
Konfigurationsparameter namens <varname>eur</varname>, der sich in der
- Konfigurationsdatei <filename>config/lx_office.conf</filename>
- befand. Somit galt er für alle Mandanten, die in dieser Installation
- benutzt wurden.</para>
+ Konfigurationsdatei <filename>config/kivitendo.conf</filename> (damals
+ noch <filename>config/lx_office.conf</filename>) befand. Somit galt er
+ für alle Mandanten, die in dieser Installation benutzt wurden.</para>
<para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
die Mandantendatenbank verschoben und dabei auch gleich in drei
der Admininstration können diese Optionen nun unabhängig voneinander
eingestellt werden.</para>
+ <para>Für die Schweiz sind folgende Einstellungen üblich:
+ <itemizedlist>
+ <listitem>
+ <para>Sollversteuerung</para>
+ </listitem>
+ <listitem>
+ <para>Aufwandsmethode</para>
+ </listitem>
+ <listitem>
+ <para>Bilanzierung</para>
+ </listitem>
+ </itemizedlist>
+ Diese Einstellungen werden automatisch beim Erstellen einer neuen
+ Datenbank vorausgewählt, wenn in <filename>config/kivitendo.conf</filename> unter
+ <varname>[system]</varname> <literal>default_manager = swiss</literal> eingestellt ist.
+ </para>
+
<para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
Variablen werden so gesetzt, daß sich an der Funktionalität nichts
ändert.</para>
<para>Die aktuelle Konfiguration wird unter Nummernkreise und
- Standardkonten unter dem neuen Punkt "Einstellungen" angezeigt
- (read-only). Eine spätere Änderung ist für einen bestehenden Mandanten
- nicht mehr möglich. Dies war auch vorher nicht möglich, bzw.
- vorhandene Daten wurden so belassen und haben damit die Ergebnisse
- verfälscht.</para>
+ Standardkonten unter dem neuen Punkt "Einstellungen" (read-only)
+ angezeigt. Unter <guimenu>System</guimenu> →
+ <guisubmenu>Mandantenkonfiguration</guisubmenu> können die
+ Einstellungen auch geändert werden. Dabei ist zu beachten, dass eine
+ Änderung vorhandene Daten so belässt und damit evtl. die Ergebnisse
+ verfälscht. Dies gilt vor Allem für die Warenbuchungsmethode (siehe
+ auch <link linkend="config.eur.inventory-system-perpetual">
+ Bemerkungen zur Bestandsmethode</link>).</para>
</sect2>
<sect2 id="config.eur.inventory-system-perpetual">
- <title>Bemerkungen zu Bestandsmethode</title>
+ <title>Bemerkungen zur Bestandsmethode</title>
<para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
<para>Die folgenden Schritte sind notwendig, um das Konto manuell
anzulegen und zu konfigurieren. Zuerst wird in
- <guimenu>System</guimenu> ->
- <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konto
+ <guimenu>System</guimenu> →
+ <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konto
erfassen</guimenuitem> das Konto angelegt.</para>
<screenshot>
<mediaobject>
<imageobject>
- <imagedata fileref="images/skr04-update-3804/konto3804.png" />
+ <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
</imageobject>
</mediaobject>
</screenshot>
- <para>
- Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst werden. Dazu unter <guimenu>System</guimenu> ->
- <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel 13 auswählen und ihn
- wie im folgenden Screenshot angezeigt anpassen.
- </para>
+ <para>Als Zweites muss Steuergruppe 13 für Konto 3803 angepasst
+ werden. Dazu unter <guimenu>System</guimenu> →
+ <guisubmenu>Steuern</guisubmenu> →
+ <guimenuitem>Bearbeiten</guimenuitem> den Eintrag mit Steuerschlüssel
+ 13 auswählen und ihn wie im folgenden Screenshot angezeigt
+ anpassen.</para>
<screenshot>
<screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
<mediaobject>
<imageobject>
- <imagedata fileref="images/skr04-update-3804/steuer3803.png" />
+ <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
</imageobject>
</mediaobject>
</screenshot>
- <para>
- Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> ->
- <guisubmenu>Steuern</guisubmenu> -> <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem Screenshot übernehmen.
- </para>
+ <para>Als Drittes wird ein neuer Eintrag mit Steuerschlüssel 13 für
+ Konto 3804 (19%) angelegt. Dazu unter <guimenu>System</guimenu> →
+ <guisubmenu>Steuern</guisubmenu> →
+ <guimenuitem>Erfassen</guimenuitem> auswählen und die Werte aus dem
+ Screenshot übernehmen.</para>
<screenshot>
<screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
<mediaobject>
<imageobject>
- <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
+ <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
</imageobject>
</mediaobject>
</screenshot>
- <para>
- Als Nächstes sind alle Konten anzupassen, die als Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
- Steuerautomatik auf 3804 bekommen. Dies betrifft in der Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
- müssen Sie dazu unter <guimenu>System</guimenu> -> <guisubmenu>Kontenübersicht</guisubmenu> -> <guimenuitem>Konten
- anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen wie im Screenshot gezeigt vornehmen.
- </para>
+ <para>Als Nächstes sind alle Konten anzupassen, die als
+ Steuerautomatikkonto die 3803 haben, sodass sie ab dem 1.1.2007 auch
+ Steuerautomatik auf 3804 bekommen. Dies betrifft in der
+ Standardkonfiguration die Konten 4315 und 4726. Als Beispiel für 4315
+ müssen Sie dazu unter <guimenu>System</guimenu> →
+ <guisubmenu>Kontenübersicht</guisubmenu> → <guimenuitem>Konten
+ anzeigen</guimenuitem> das Konto 4315 anklicken und die Einstellungen
+ wie im Screenshot gezeigt vornehmen.</para>
<screenshot>
<screeninfo>Konto 4315 anpassen</screeninfo>
<mediaobject>
<imageobject>
- <imagedata fileref="images/skr04-update-3804/konto4315.png" />
+ <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
</imageobject>
</mediaobject>
</screenshot>
- <para>
- Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
- <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
- </para>
+ <para>Als Letztes sollte die Steuerliste unter
+ <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
+ <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
+ Vergleich der Screenshot.</para>
<screenshot>
<screeninfo>Steuerliste vergleichen</screeninfo>
<mediaobject>
<imageobject>
- <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
+ <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
</imageobject>
</mediaobject>
</screenshot>
</sect2>
</sect1>
+ <sect1 id="config.bilanz">
+ <title>Verhalten des Bilanzberichts</title>
+
+ <para>Bis Version 3.0 wurde "closedto" ("Bücher schließen zum") als
+ Grundlage für das Startdatum benutzt. Schließt man die Bücher allerdings
+ monatsweise führt dies zu falschen Werten.</para>
+
+ <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
+ einstellen indem man:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
+ vorher)</para>
+ </listitem>
+
+ <listitem>
+ <para>immer den Jahresanfang nimmt (1.1. relativ zum
+ Stichtag)</para>
+ </listitem>
+
+ <listitem>
+ <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
+
+ <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
+ gibt</para>
+
+ <para>- oder mit "alle Buchungen" als Alternative"</para>
+ </listitem>
+
+ <listitem>
+ <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
+ gibt</para>
+ </listitem>
+
+ <listitem>
+ <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Folgende Hinweise zu den Optionen: Das "Bücher schließen Datum"
+ ist sinnvoll, wenn man nur komplette Jahre schließt. Bei Wirtschaftsjahr
+ = Kalendarjahr entspricht dies aber auch dem Jahresanfang. "Alle
+ Buchungen" kann z.B. sinnvoll sein wenn man ohne Jahresabschluß
+ durchbucht. Eröffnungsbuchung mit "alle Buchungen" als Fallback ist z.B.
+ sinnvoll, wenn man am sich Anfang des zweiten Buchungsjahres befindet,
+ und noch keinen Jahreswechsel und auch noch keine EB-Buchungen hat. Bei
+ den Optionen mit EB-Buchungen wird vorausgesetzt, daß diese immer am 1.
+ Tag des Wirtschaftsjahres gebucht werden. Zur Sicherheit wird das
+ Startdatum im Bilanzbericht jetzt zusätzlich zum Stichtag mit angezeigt.
+ Das hilft auch bei der Kontrolle für den Abgleich mit der GuV bzw.
+ Erfolgsrechnung.</para>
+ </sect1>
+
+ <sect1 id="config.erfolgsrechnung">
+ <title>Erfolgsrechnung</title>
+
+ <para>Seit der Version 3.4.1 existiert in kivitendo der Bericht <emphasis role="bold">
+ Erfolgsrechnung</emphasis>.</para>
+
+ <para>Die Erfolgsrechnung kann in der Mandantenkonfiguration unter Features
+ an- oder abgeschaltet werden. Mit der Einstellung <varname>default_manager = swiss
+ </varname> in der <filename>config/kivitendo.conf</filename> wird beim neu Erstellen
+ einer Datenbank automatisch die Anzeige der Erfolgsrechnung im Menü <guimenu>Berichte
+ </guimenu> ausgewählt und ersetzt dort die GUV.</para>
+
+ <para>Im Gegensatz zur GUV werden bei der Erfolgsrechnung sämtliche Aufwands- und
+ Erlöskonten einzeln aufgelistet (analog zur Bilanz), sortiert nach ERTRAG und AUFWAND.</para>
+
+ <para>Bei den Konteneinstellungen muss bei jedem Konto, das in der Erfolgsrechnung
+ erscheinen soll, unter <varname>Sonstige Einstellungen/Erfolgsrechnung</varname>
+ entweder <literal>01.Ertrag</literal> oder <literal>06.Aufwand</literal> ausgewählt
+ werden.</para>
+
+ <para>Wird bei einem Erlöskonto <literal>06.Aufwand</literal> ausgewählt,
+ so wird dieses Konto als Aufwandsminderung unter AUFWAND aufgelistet.</para>
+
+ <para>Wird bei einem Aufwandskonto <literal>01.Ertrag</literal> ausgewählt,
+ so wird dieses Konto als Ertragsminderung unter ERTRAG aufgelistet.</para>
+
+ <para>Soll bei einer bereits bestehenden Buchhaltung in Zukunft zusätzlich
+ die Erfolgsrechnung als Bericht verwendet werden, so müssen die Einstellungen
+ zu allen Erlös- und Aufwandskonten unter <varname>Sonstige
+ Einstellungen/Erfolgsrechnung</varname> überprüft und allenfalls neu gesetzt werden.</para>
+ </sect1>
+
+ <sect1 id="config.rounding">
+ <title>Rundung in Verkaufsbelegen</title>
+
+ <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert von 5 Rappen (0.05 CHF).</para>
+
+ <para>Auch wenn im elektronischen Zahlungsverkehr Beträge mit einer Genauigkeit
+ von 0.01 CHF verwendet werden können, ist es trotzdem nach wie vor üblich,
+ Rechnungen mit auf 0.05 CHF gerundeten Beträgen auszustellen.</para>
+
+ <para>In kivitendo kann seit der Version 3.4.1 die Einstellung für eine solche
+ Rundung pro Mandant / Datenbank festgelegt werden.</para>
+
+ <para>Die Einstellung wird beim Erstellen der Datenbank bei <literal>Genauigkeit</literal>
+ festgelegt. Sie kann anschliessend über das Webinterface von kivitendo nicht mehr
+ verändert werden.</para>
+
+ <para>Abhängig vom Wert für <varname>default_manager</varname> in
+ <filename>config/kivitendo.conf</filename> werden dabei folgende
+ Werte voreingestellt:</para>
+ <itemizedlist>
+ <listitem>
+ <para>0.05 (default_manager = swiss)</para>
+ </listitem>
+ <listitem>
+ <para>0.01 (default_manager = german)</para>
+ </listitem>
+ </itemizedlist>
+ <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
+ </varname>in der Spalte <varname>precision</varname> gespeichert.</para>
+
+ <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
+ und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet,
+ wenn dieser nicht der eingestellten Genauigkeit entspricht.</para>
+
+ <para>Beim Buchen einer Verkaufsrechnung wird der Rundungsbetrag
+ automatisch auf die in der Mandantenkonfiguration festgelegten
+ Standardkonten für Rundungserträge bzw. Rundungsaufwendungen gebucht.</para>
+
+ <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr verändert.)</para>
+
+ <para>Die in den Druckvorlagen zur Verfügung stehenden Variablen
+ <varname>quototal</varname>, <varname>ordtotal</varname> bzw.
+ <varname>invtotal</varname> enthalten den gerundeten Betrag.</para>
+
+ <para><emphasis role="bold">Achtung:</emphasis> Werden Verkaufsbelege
+ in anderen Währungen als der Standardwährung erstellt, so muss in
+ kivitendo ab Version 3.4.1 die Genauigkeit 0.01 verwendet werden.</para>
+ <para>Das heisst, Firmen in der Schweiz, die teilweise Verkaufsrechnungen
+ in Euro oder anderen Währungen erstellen wollen, müssen beim Erstellen
+ der Datenbank als Genauigkeit 0.01 wählen und können zur Zeit die
+ 5er Rundung noch nicht nutzen.</para>
+ </sect1>
+
+ <sect1 id="config.client">
+ <title>Einstellungen pro Mandant</title>
+
+ <para>Einige Einstellungen können von einem Benutzer mit dem <link
+ linkend="Zusammenhänge">Recht</link> "Administration (Für die Verwaltung
+ der aktuellen Instanz aus einem Userlogin heraus)" gemacht werden. Diese
+ Einstellungen sind dann für die aktuellen Mandanten-Datenbank gültig.
+ Die Einstellungen sind unter <guimenu>System</guimenu> →
+ <guisubmenu>Mandantenkonfiguration</guisubmenu> erreichbar.</para>
+
+ <para>Bitte beachten Sie die Hinweise zu den einzelnen Einstellungen.
+ Einige Einstellungen sollten nicht ohne Weiteres im laufenden Betrieb
+ geändert werden (siehe auch <link
+ linkend="config.eur.inventory-system-perpetual">Bemerkungen zu
+ Bestandsmethode</link>).</para>
+
+ <para>Die Einstellungen <literal>show_bestbefore</literal> und
+ <literal>payments_changeable</literal> aus dem Abschnitt
+ <literal>features</literal> und die Einstellungen im Abschnitt
+ <literal>datev_check</literal> (sofern schon vorhanden) der <link
+ linkend="config.config-file">kivitendo-Konfigurationsdatei</link> werden
+ bei einem Datenbankupdate einer älteren Version automatisch übernommen.
+ Diese Einträge können danach aus der Konfigurationsdatei entfernt
+ werden.</para>
+ </sect1>
+
<sect1 id="kivitendo-ERP-verwenden">
<title>kivitendo ERP verwenden</title>
<para>Die Administrationsseite erreichen Sie unter:</para>
<para><ulink
- url="http://localhost/kivitendo-erp/admin.pl">http://localhost/kivitendo-erp/admin.pl</ulink></para>
+ url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
</sect1>
</chapter>
<title>Features und Funktionen</title>
<sect1 id="features.periodic-invoices"
- xreflabel="Wiedekehrende Rechnungen">
+ xreflabel="Wiederkehrende Rechnungen">
<title>Wiederkehrende Rechnungen</title>
<sect2 id="features.periodic-invoices.introduction"
<listitem>
<para>Bei aktiven Rechnungen wird automatisch eine Rechnung
- erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines
- neuen Monats).</para>
+ erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
+ eines neuen Monats).</para>
<para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
<varname>[periodic_invoices]</varname>.</para>
</sect2>
+ <sect2 id="features.periodic-invoices.variables">
+ <title>Spezielle Variablen</title>
+
+ <para>Um die erzeugten Rechnungen individualisieren zu können, werden
+ beim Umwandeln des Auftrags in eine Rechnung einige speziell
+ formatierte Variablen durch für die jeweils aktuelle
+ Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B.
+ den Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei
+ die Syntax <literal><%variablenname%></literal>.</para>
+
+ <para>Sofern es sich um eine Datumsvariable handelt, kann das
+ Ausgabeformat weiter bestimmt werden, indem an den Variablennamen
+ Formatoptionen angehängt werden. Die Syntax sieht dabei wie folgt aus:
+ <literal><%variablenname FORMAT=Formatinformation%></literal>.
+ Die zur verfügung stehenden Formatinformationen werden unten genauer
+ beschrieben.</para>
+
+ <para>Diese Variablen können auch beim automatischen Versand der
+ erzeugten Rechnungen per E-Mail genutzt werden, indem sie in den
+ Feldern für den Betreff oder die Nachricht verwendet werden.</para>
+
+ <para>Diese Variablen werden in den folgenden Elementen des Auftrags
+ ersetzt:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Bemerkungen</para>
+ </listitem>
+
+ <listitem>
+ <para>Interne Bemerkungen</para>
+ </listitem>
+
+ <listitem>
+ <para>Vorgangsbezeichnung</para>
+ </listitem>
+
+ <listitem>
+ <para>In den Beschreibungs- und Langtextfeldern aller
+ Positionen</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><varname><%current_quarter%></varname>,
+ <varname><%previous_quarter%></varname>,
+ <varname><%next_quarter%></varname></term>
+
+ <listitem>
+ <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
+ zwischen <literal>1</literal> und <literal>4</literal>.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname><%current_month%></varname>,
+ <varname><%previous_month%></varname>,
+ <varname><%next_month%></varname></term>
+
+ <listitem>
+ <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
+ <literal>1</literal> und <literal>12</literal>.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname><%current_month_long%></varname>,
+ <varname><%previous_month_long%></varname>,
+ <varname><%next_month_long%></varname></term>
+
+ <listitem>
+ <para>Aktueller, vorheriger und nächster Monat als Name
+ (<literal>Januar</literal>, <literal>Februar</literal>
+ etc.).</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname><%current_year%></varname>,
+ <varname><%previous_year%></varname>,
+ <varname><%next_year%></varname></term>
+
+ <listitem>
+ <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
+ Jahreszahl (<literal>2013</literal> etc.).</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname><%period_start_date%></varname>,
+ <varname><%period_end_date%></varname></term>
+
+ <listitem>
+ <para>Formatiertes Datum des ersten und letzten Tages im
+ Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im
+ ersten Quartal von 2013 wären dies der
+ <literal>01.01.2013</literal> und
+ <literal>31.03.2013</literal>).</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>Die invidiuellen Formatinformationen bestehen aus Paaren von
+ Prozentzeichen und einem Buchstaben, welche beide zusammen durch den
+ dazugehörigen Wert ersetzt werden. So wird z.B. <literal>%Y</literal>
+ durch das viertstellige Jahr ersetzt. Alle möglichen Platzhalter
+ sind:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><varname>%a</varname></term>
+
+ <listitem>
+ <para>Der abgekürzte Wochentagsname.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>%A</varname></term>
+
+ <listitem>
+ <para>Der ausgeschriebene Wochentagsname.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>%b</varname></term>
+
+ <listitem>
+ <para>Der abgekürzte Monatsname.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>%B</varname></term>
+
+ <listitem>
+ <para>Der ausgeschriebene Monatsname.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>%C</varname></term>
+
+ <listitem>
+ <para>Das Jahrhundert (Jahr/100) als eine zweistellige
+ Zahl.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>%d</varname></term>
+
+ <listitem>
+ <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>%D</varname></term>
+
+ <listitem>
+ <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>%e</varname></term>
+
+ <listitem>
+ <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings
+ werden führende Nullen durch Leerzeichen ersetzt.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>%F</varname></term>
+
+ <listitem>
+ <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>%j</varname></term>
+
+ <listitem>
+ <para>Der Tag im Jahr als Zahl zwischen 001 und 366
+ inklusive.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>%m</varname></term>
+
+ <listitem>
+ <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>%u</varname></term>
+
+ <listitem>
+ <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei
+ die 1 dem Montag entspricht.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>%U</varname></term>
+
+ <listitem>
+ <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
+ wobei der erste Sonntag im Jahr das Startdatum von Woche 01
+ ist.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>%V</varname></term>
+
+ <listitem>
+ <para>Die ISO-8601:1988-Wochennummer als Zahl zwischen 01 und 53
+ inklusive, wobei Woche 01 die erste Woche, von der mindestens
+ vier Tage im Jahr liegen; Montag ist erster Tag der
+ Woche.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>%w</varname></term>
+
+ <listitem>
+ <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei
+ die 0 dem Sonntag entspricht.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>%W</varname></term>
+
+ <listitem>
+ <para>Die Wochennummer als Zahl zwischen 00 und 53 inklusive,
+ wobei der erste Montag im Jahr das Startdatum von Woche 01
+ ist.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>%y</varname></term>
+
+ <listitem>
+ <para>Das Jahr als zweistellige Zahl zwischen 00 und 99
+ inklusive.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>%Y</varname></term>
+
+ <listitem>
+ <para>Das Jahr als vierstellige Zahl.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>%%</varname></term>
+
+ <listitem>
+ <para>Das Prozentzeichen selber.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>Anwendungsbeispiel für die Ausgabe, von welchem Monat und Jahr
+ bis zu welchem Monat und Jahr die aktuelle Abrechnungsperiode dauert:
+ <literal>Abrechnungszeitrum: <%period_start_date FORMAT=%m/%Y%>
+ bis <%period_end_date FORMAT=%m/%Y%></literal></para>
+ </sect2>
+
<sect2 id="features.periodic-invoices.reports">
<title>Auflisten</title>
</sect2>
</sect1>
+ <sect1 id="features.bank" xreflabel="bankerweiterung">
+ <title>Bankerweiterung</title>
+
+ <sect2 id="features.bank.introduction"
+ xreflabel="Einführung in die Bankerweiterung">
+ <title>Einführung</title>
+
+ <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch
+ im Wiki und soll von dort später hierhin übernommen werden:</para>
+
+ <para><ulink
+ url="http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung">http://redmine.kivitendo-premium.de/projects/forum/wiki/Bankerweiterung</ulink></para>
+ </sect2>
+ </sect1>
+
<sect1 id="dokumentenvorlagen-und-variablen">
<title>Dokumentenvorlagen und verfügbare Variablen</title>
<function><%variablenname%></function> verwendet wird. Für
LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
(siehe <xref
- linkend="dokumentenvorlagen-und-variablen.tag-style" />).</para>
+ linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
- <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
- unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht
- ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
- alle Vorlagenarten.</para>
+ <para>kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen.
+ Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im
+ Folgenden gesagte für alle Vorlagenarten.</para>
<para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
verfügbar als hier aufgelistet werden. Die meisten davon können
<para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
siehe dazu <xref
- linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta" />.</para>
+ linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
</sect2>
<sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
<term><varname>template_meta.language.template_code</varname></term>
<listitem>
- <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
- Kürzel das im Dateinamen verwendetet wird.</para>
+ <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
+ dem Kürzel das im Dateinamen verwendetet wird.</para>
</listitem>
</varlistentry>
<listitem>
<para>Ausgabemedium. Kann zur Zeit die Werte
<constant>screen</constant> für Bildschirm,
- <constant>email</constant> für E-Mmail (triggert das
+ <constant>email</constant> für E-Mail (triggert das
<constant>_email</constant> Kürzel im Dateinamen),
<constant>printer</constant> für Drucker, und
<constant>queue</constant> für Warteschlange enthalten.</para>
dem Kürzel das im Dateinamen verwendetet wird.</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><varname>template_meta.tmpfile</varname></term>
+
+ <listitem>
+ <para>Datei-Prefix für temporäre Dateien.</para>
+ </listitem>
+ </varlistentry>
</variablelist>
</sect3>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><varname>c_vendor_id</varname></term>
+
+ <listitem>
+ <para>Lieferantennummer beim Kunden (nur Kunden)</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>v_customer_id</varname></term>
+
+ <listitem>
+ <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><varname>cp_email</varname></term>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><varname>gln</varname></term>
+
+ <listitem>
+ <para>GLN (Globale Lokationsnummer)</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>greeting</varname></term>
+
+ <listitem>
+ <para>Anrede</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><varname>homepage</varname></term>
</varlistentry>
<varlistentry>
- <term><varname>shiptodepartment1</varname></term>
+ <term><varname>shiptodepartment_1</varname></term>
<listitem>
<para>Abteilung 1 (Lieferadresse) <link
</varlistentry>
<varlistentry>
- <term><varname>shiptodepartment2</varname></term>
+ <term><varname>shiptodepartment_2</varname></term>
<listitem>
<para>Abteilung 2 (Lieferadresse) <link
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><varname>shiptogln</varname></term>
+
+ <listitem>
+ <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><varname>shiptoname</varname></term>
</sect3>
<sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
- <title>Informationen über den Bearbeiter</title>
+ <title>Informationen über den Verkäufer</title>
<variablelist>
<varlistentry>
</varlistentry>
</variablelist>
</sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
+ <title>Variablen für Lieferbedingungen</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><varname>delivery_term</varname></term>
+
+ <listitem>
+ <para>Datenbank-Objekt der Lieferbedingung</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>delivery_term.description</varname></term>
+
+ <listitem>
+ <para>Beschreibung der Lieferbedingung</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>delivery_term.description_long</varname></term>
+
+ <listitem>
+ <para>Langtext bzw. übersetzter Langtext der
+ Lieferbedingung</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
</sect2>
<sect2 id="dokumentenvorlagen-und-variablen.invoice">
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><varname>rounding</varname></term>
+
+ <listitem>
+ <para>Betrag, um den <varname>invtotal</varname> gerundet wurde
+ (kann positiv oder negativ sein)</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><varname>shippingpoint</varname></term>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><varname>cusordnumber_oe</varname></term>
+
+ <listitem>
+ <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
+ Posten ursprünglich stammt (nur Verkauf)</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><varname>discount</varname></term>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><varname>donumber_do</varname></term>
+
+ <listitem>
+ <para>Lieferscheinnummer des Lieferscheins, aus dem die
+ Position ursprünglich stammt, wenn die Rechnung im Rahmen des
+ Workflows aus einem Lieferschein erstellt wurde.</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><varname>drawing</varname></term>
<term><varname>netprice</varname></term>
<listitem>
- <para>Nettopreis</para>
+ <para>Alternative zu <varname>sellprice</varname>, aber
+ <varname>netprice</varname> entspricht dem effektiven
+ Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor.
+ <varname>netprice</varname> wird rückgerechnet aus Zeilensumme
+ / Menge. Diese Variable ist nützlich, wenn man den gewährten
+ Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge *
+ Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll.
+ <varname>netprice</varname> hat nichts mit Netto/Brutto im
+ Sinne von Steuern zu tun.</para>
</listitem>
</varlistentry>
<term><varname>ordnumber_oe</varname></term>
<listitem>
- <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
- aus einem Sammelauftrag erstellt wurde</para>
+ <para>Auftragsnummer des Originalauftrags, aus dem der Posten
+ ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren
+ Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch
+ eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In
+ letzterem Fall wird die unsprüngliche Auftragsnummer
+ angezeigt.</para>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><varname>transdate_do</varname></term>
+
+ <listitem>
+ <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
+ Workflows aus einem Lieferschein stammte.</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><varname>transdate_oe</varname></term>
<listitem>
- <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
- aus einem Sammelauftrag erstellt wurde</para>
+ <para>Datum des Auftrags, wenn die Rechnung im Rahmen des
+ Workflows aus einem Auftrag erstellt wurde. Wenn es
+ Sammelaufträge gab wird das Datum des ursprünglichen Auftrags
+ genommen.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>transdate_quo</varname></term>
+
+ <listitem>
+ <para>Datum des Angebots, wenn die Position im Rahmen des
+ Workflows aus einem Angebot stammte.</para>
</listitem>
</varlistentry>
Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
Verfügung.</para>
+
+ <para>Die benutzerdefinierten Variablen der Lieferadressen stehen
+ unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der
+ Präfix <varname>shiptocvar_</varname>.</para>
</sect3>
</sect2>
<sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
<title>Allgemeine Variablen in Mahnungen</title>
- <para>Die Variablen des Verkäufers stehen wie gewohnt als
- <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
- Kunden stehen als Variablen <varname>name</varname>,
+ <para>Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie gewohnt als
+ <varname>employee_...</varname> bzw. <varname>salesman_...</varname> zur Verfügung.
+ Werden mehrere Rechnungen in einer Mahnung zusammengefasst, so werden
+ die Metadaten (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung
+ im Ausdruck genommen.</para>
+ <para>Die Adressdaten des Kunden stehen als Variablen <varname>name</varname>,
<varname>street</varname>, <varname>zipcode</varname>,
<varname>city</varname>, <varname>country</varname>,
<varname>department_1</varname>, <varname>department_2</varname>,
- und <varname>email</varname> zur Verfügung.</para>
+ und <varname>email</varname> zur Verfügung. Der Ansprechpartner <varname>cp_...</varname>
+ steht auch zu Verfügung, wird allerdings auch nur von der ersten angemahnten Rechnung (s.o.)
+ genommen.</para>
<para>Weitere Variablen beinhalten:</para>
<term><varname>fee</varname></term>
<listitem>
- <para>Kummulative Mahngebühren</para>
+ <para>Kumulative Mahngebühren</para>
</listitem>
</varlistentry>
<title>Blöcke, bedingte Anweisungen und Schleifen</title>
<sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
- <title>Einfürhung</title>
+ <title>Einführung</title>
<para>Der Parser kennt neben den Variablen einige weitere
Konstrukte, die gesondert behandelt werden. Diese sind wie
und dem "end" werden nur ausgegeben, wenn die Variable
<varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
+ <para>Handelt es sich bei der benannten Variable um ein Array, also
+ um einen Variablennamen, über den man mit <command><%foreach
+ variablenname%></command> iteriert, so wird mit diesem Konstrukt
+ darauf getestet, ob das Array Elemente enthält. Somit würde im
+ folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt
+ ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich
+ welche getätigt wurden:</para>
+
+ <programlisting><%if payment%>
+Zahlungseingänge:
+ <%foreach payment%>
+ Am <%paymentdate%>: <%payment%> €
+ <%end foreach%>
+<%end if%></programlisting>
+
<para>Die Bedingung kann auch negiert werden, indem das Wort
<function>not</function> nach dem <filename>if</filename> verwendet
wird. Beispiel:</para>
Mittels <function>!=</function> anstelle von <function>==</function>
würde auf Ungleichheit getestet.</para>
- <programlisting>%if var1 == var2%></programlisting>
+ <programlisting><%if var1 == var2%></programlisting>
<para>Testet die Variable <varname>var1</varname> auf
übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
auf Ungleichheit getestet.</para>
<para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
- auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
+ auch Tests auf Ã\9cbereinstimmung mit regulären Ausdrücken ohne
Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
dieselbe Syntax wie oben nur mit <function>=~</function> und
<function>!~</function> als Vergleichsoperatoren.</para>
entfernt.</para>
</sect2>
- <sect2 id="excel-templates.limitations">
- <title>Einschränkungen</title>
-
- <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
- mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
- beschränkt sich daher darauf, Textstellen exakt durch einen anderen
- Text zu ersetzen.</para>
-
- <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
- <command><%if%></command> und
- <command><%foreach%></command> nicht vorhanden. Der Delimiter
- <constant><% %></constant> kommt in den Headerinformationen
- evtl. vor. Deshalb wurde auf den sichereren Delimiter
- <constant><<</constant> und <constant>>></constant>
- gewechselt.</para>
+ <sect2 id="excel-templates.limitations">
+ <title>Einschränkungen</title>
+
+ <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
+ mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
+ beschränkt sich daher darauf, Textstellen exakt durch einen anderen
+ Text zu ersetzen.</para>
+
+ <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
+ <command><%if%></command> und
+ <command><%foreach%></command> nicht vorhanden. Der Delimiter
+ <constant><% %></constant> kommt in den Headerinformationen
+ evtl. vor. Deshalb wurde auf den sichereren Delimiter
+ <constant><<</constant> und <constant>>></constant>
+ gewechselt.</para>
+ </sect2>
+ </sect1>
+
+ <sect1 id="features.warehouse">
+
+
+ <title>Mandantenkonfiguration Lager</title>
+
+ <para>
+ Die Lagerverwaltung in kivitendo funktioniert standardmässig wie folgt: Wird ein Lager mit einem Lagerplatz angelegt, so gibt es die
+ Möglichkeit hier über den Menüpunkt Lager entsprechende Warenbewegungen durchzuführen. Ferner kann jede Position eines Lieferscheins
+ ein-, bzw. ausgelagert werden (Einkauf-, bzw. Verkauf). Es können beliebig viele Lager mit beliebig vielen Lagerplätzen abgebildet
+ werden. Die Lagerbewegungen über einen Lieferschein erfolgt durch Anklicken jeder Einzelposition und das Auswählen dieser Position zu
+ einem Lager mit Lagerplatz. Dieses Verfahren lässt sich schrittweise vereinfachen, je nachdem wie die Einstellungen in der
+ Mandatenkonfiguration gesetzt werden.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para><option>Auslagern über Standardlagerplatz</option> Hier wird
+ ein zusätzlicher Knopf (Auslagern über Standard-Lagerplatz) in dem
+ Lieferschein-Beleg hinzugefügt, der dann alle Lagerbewegungen über
+ den Standardlagerplatz (konfigurierbar pro Ware) durchführt.</para>
+ </listitem>
+
+ <listitem>
+ <para><option>Auslagern ohne Bestandsprüfung</option> Das obige
+ Auslagern schlägt fehl, wenn die entsprechende Menge für die
+ Lagerbewegung nicht vorhanden ist, möchte man dies auch ignorieren
+ und ggf. dann nachpflegen, so kann man eine Negativ-Warenmenge mit
+ dieser Option erlauben. Hierfür muss ein entsprechender Lagerplatz
+ (Fehlbestand, o.ä.) konfiguriert sein.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ Zusätzliche Funktionshinweise:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para><option>Standard-Lagerplatz</option> Ist dieser konfiguriert,
+ wird dies auch als Standard-Voreinstellung bei der Neuerfassung von
+ Stammdaten → Waren / Dienstleistung / Erzeugnis verwendet.</para>
+ </listitem>
+
+ <listitem>
+ <para><option>Standard-Lagerplatz verwenden, falls keiner in
+ Stammdaten definiert</option> Wird beim 'Auslagern über
+ Standardlagerplatz' keine Standardlagerplatz zu der Ware gefunden,
+ so wird mit dieser Option einfach der Standardlagerplatz
+ verwendet.</para>
+ </listitem>
+ </itemizedlist>
+
+
+ </sect1>
+
+ <sect1 id="features.swiss-charts-of-accounts">
+ <title>Schweizer Kontenpläne</title>
+
+ <para>Seit der Version 3.5 stehen in kivitendo 3 Kontenpläne für
+ den Einsatz in der Schweiz zur Verfügung, einer für Firmen und
+ Organisationen, die nicht mehrwertsteuerpflichtig sind, einer
+ für Firmen, die mehrwertsteuerpflichtig sind und einer speziell
+ für Vereine.</para>
+
+ <para>Die Kontenpläne orientieren sich am in der Schweiz üblicherweise
+ verwendeten KMU-Kontenrahmen und sind mit der Revision des Schweizerischen
+ Obligationenrechts (OR) vom 1.1.2013 kompatibel, insbesondere
+ <literal>Art.957a Abs.2</literal>.</para>
+
+ <para>Beim Vereinskontenplan sind standardmässig nur die Konten 1100
+ (Debitoren CHF) und 1101 (Debitoren EUR) als Buchungskonten im Verkauf
+ sowie die Konten 2000 (Kreditoren CHF) und 2001 (Kreditoren EUR) als
+ Buchungskonten im Einkauf vorgesehen. Weitere Konten können bei Bedarf
+ in den Konto-Detaileinstellungen als Einkaufs- oder Verkaufskonten
+ konfiguriert werden.</para>
+
+ <para>Die Möglichkeit, Saldosteuersätze zu verwenden ist in der aktuellen
+ Version von kivitendo noch nicht integriert.</para>
+
+ <para>Trotzdem können auch Firmen, die per Saldosteuersatz mit der
+ Eidgenössischen Steuerverwaltung abrechnen, kivitendo bereits nutzen.
+ Dazu wird der Kontenplan mit MWST ausgewählt. Anschliessend müssen
+ alle Aufwandskonten editiert werden und dort der Steuersatz auf 0%
+ gesetzt werden.</para>
+
+ <para>So werden bei Kreditorenbuchungen keine Vorsteuern verbucht.</para>
+
+ <para>Bezugssteuern für aus dem Ausland bezogene Dienstleistungen müssen
+ manuell verbucht werden.</para>
+
+ <para>Wünsche für Anpassungen an den Schweizer Kontenplänen sowie
+ Vorschläge für weitere (z.B. branchenspezifische) Kontenpläne
+ bitte an <literal>empfang@revamp-it.ch</literal> senden.</para>
+ </sect1>
+
+ <sect1 id="features.part_classification">
+ <title>Artikelklassifizierung</title>
+
+ <sect2>
+ <title>Übersicht</title>
+
+ <para>Die Klassifizierung von Artikeln dient einer weiteren Gliederung,
+ um zum Beispiel den Einkauf vom Verkauf zu trennen, gekennzeichnet
+ durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel (z.B. "E").
+ Für jede Klassifizierung besteht eine Beschreibung und eine Abkürzung
+ die normalerweise aus einem Zeichen besteht, kann aber auf mehrere
+ Zeichen erweitert werden, falls zur Unterscheidung notwendig. Sinnvoll
+ sind jedoch nur maximal 2 Zeichen.</para>
+ </sect2>
+
+ <sect2>
+ <title>Basisklassifizierung</title>
+
+ <para>Als Basisklassifizierungen gibt es</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Einkauf</para>
+ </listitem>
+
+ <listitem>
+ <para>Verkauf</para>
+ </listitem>
+
+ <listitem>
+ <para>Handelsware</para>
+ </listitem>
+
+ <listitem>
+ <para>Produktion</para>
+ </listitem>
+
+ <listitem>
+ <para>- keine - (diese wird bei einer Aktualisierung für alle
+ existierenden Artikel verwendet und ist gültig für Verkauf und
+ Einkauf)</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Es können weitere Klassifizierungen angelegt werden. So kann es
+ z.B. für separat auszuweisende Artikel folgende Klassen geben:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
+ </listitem>
+
+ <listitem>
+ <para>Material (Verpackungsmaterial) mit Kürzel M</para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
+
+ <sect2>
+ <title>Attribute</title>
+
+ <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
+ alle gleichzeitg gültig sein können</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
+ werden</para>
+ </listitem>
+
+ <listitem>
+ <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
+ werden</para>
+ </listitem>
+
+ <listitem>
+ <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
+ (LaTeX) eine zusätzliche Variable</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Für das Attribut "separat ausweisen" stehen in den LaTeX-Vorlagen
+ die Variable <emphasis role="bold"><%non_separate_subtotal%>
+ </emphasis>zur Verfügung, die alle nicht separat auszuweisenden
+ Artikelkosten saldiert, sowie pro separat auszuweisenden
+ Klassifizierungen die Variable<emphasis role="bold"><
+ %separate_X_subtotal%></emphasis>, wobei X das Kürzel der
+ Klassifizierung ist.</para>
+
+ <para>Im obigen Beispiel wäre das für Lieferkosten <emphasis
+ role="bold"><%separate_L_subtotal%></emphasis> und für
+ Verpackungsmaterial <emphasis role="bold">
+ <%separate_M_subtotal%></emphasis>.</para>
+ </sect2>
+
+ <sect2>
+ <title>Zwei-Zeichen Abkürzung</title>
+
+ <para>Der Typ des Artikels und die Klassifizierung werden durch zwei
+ Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des
+ Artikel-Typs ('P','A','S'), deutsch 'W', 'E', und 'D' für Ware
+ Erzeugnis oder Dienstleistung und ggf. weiterer Typen.</para>
+
+ <para>Der zweite Buchstabe (und ggf. auch ein dritter, falls nötig)
+ entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
+
+ <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
+ Erleichterung mit dargestellt.</para>
+ </sect2>
+ </sect1>
+
+ <sect1 id="features.file_managment">
+ <title>Dateiverwaltung (Mini-DMS)</title>
+
+ <sect2>
+ <title>Übersicht</title>
+ <para>Parallel zum alten WebDAV gibt es ein Datei-Management-System, das Dateien
+ verschiedenen Typs verwaltet. Dies können</para>
+ <orderedlist>
+ <listitem>
+ <para>aus ERP-Daten per LaTeX Template erzeugte PDF-Dokumente,</para>
+ </listitem>
+ <listitem>
+ <para>zu bestimmten ERP-Daten gehörende Anhangdateien unterschiedlichen Formats,</para>
+ </listitem>
+ <listitem>
+ <para>per Scanner eingelesene PDF-Dateien,</para>
+ </listitem>
+ <listitem>
+ <para>per E-Mail empfangene Dateianhänge unterschiedlichen Formats,</para>
+ </listitem>
+ <listitem>
+ <para>sowie speziel für Artikel hochgeladene Bilder sein.</para>
+ </listitem>
+ </orderedlist>
+ <screenshot>
+ <screeninfo>Übersicht</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </sect2>
+
+ <sect2>
+ <title>Struktur</title>
+
+ <para>Über eine vom Speichermedium unabhängige Zwischenschicht werden die Dateien und ihre Versionen in der Datenbank verwaltet. Darunter können verschiedene Implementierungen (Backends) gleichzeitig existieren:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>Dateisystem</para>
+ </listitem>
+ <listitem>
+ <para>WebDAV</para>
+ </listitem>
+ <listitem>
+ <para>Schnittstelle zu externen Dokumenten-Management-Systemen</para>
+ </listitem>
+ <listitem>
+ <para>andere Datenbank</para>
+ </listitem>
+ <listitem>
+ <para>etc ...</para>
+ </listitem>
+ </itemizedlist>
+ <para>Es gibt unterschiedliche Typen von Dateien. Jedem Typ läßt sich in der
+ Mandantenkonfiguration ein bestimmtes Backend zuordnen.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>"document": Das sind entweder generierte, eingescannte oder hochgeladene PDF-Dateien,
+ die zu bestimmten ERP-Daten (ERP-Objekte, wie z.B. Rechnung, Lieferschein) gehören.</para>
+ </listitem>
+ <listitem>
+ <para>"attachment": zusätzlich hochgeladene Dokumente, die an bestimmte ERP-Objekte angehängt werden,
+ z.B. technische Zeichnungen, Aufmaße. Diese können auch für Artikel,
+ Lieferanten und Kunden hinterlegt sein.</para>
+ </listitem>
+ <listitem>
+ <para>"image": Bilder für Artikel. Diese können auch verkleinert in einer Vorschau (Thumbnail)
+ angezeigt werden.</para>
+ </listitem>
+ </itemizedlist>
+ <para>Zusätzlich werden in der Datenbank zu den Dateien neben der Zuordnung zu ERP-Objekten, Dateityp
+ Dateinamen und Backend, in dem die Datei gespeichert ist, auch die Quelle der Datei notiert:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para> "created": vom System erzeugte Dokumente"</para>
+ </listitem>
+ <listitem>
+ <para> "uploaded": hochgeladene Dokumente</para>
+ </listitem>
+ <listitem>
+ <para> "email": vom Mail-System empfangene Dateien</para>
+ </listitem>
+ <listitem>
+ <para> "scanner[1]": von einem oder mehreren Scannern erzeugte Dateien. Existieren mehrere Scanner,
+ so sind diese durch unterschiedliche Quellennamen zu definieren.</para>
+ </listitem>
+ </itemizedlist>
+ <para>Je nach Dateityp sind nur bestimmte Quellen zulässig. So gibt es für "attachment" und "image" nur
+ die Quelle "uploaded". Für "document" gibt es auf jeden Fall die Quelle "created".
+ Die Quellen "scanner" und "email" müssen derzeit in der Datenbank konfiguriert werden
+ (siehe <xref linkend="file_management.dbconfig"/>).</para>
+ </sect2>
+
+ <sect2>
+ <title>Anwendung</title>
+ <para>Die Daten werden bei den ERP-Objekten als extra Reiter dargestellt.
+ Eine Verkaufsrechnung z.B. hat die
+ Reiter "Dokumente" und "Dateianhänge".</para>
+ <screenshot>
+ <screeninfo>Reiter "Dateianhänge"</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata scale="50" fileref="images/DMS-Anhaenge.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Bei den Dateianhängen wird immer nur die aktuelle Version einer Datei angezeigt.
+ Wird eine Datei mit gleichem Namen hochgeladen, so wird eine neue Version der Datei erstellt.
+ Vorher wird der Anwender durch einen Dialog gefragt, ob er eine neue Version anlegen will oder
+ ob er die Datei umbenennen will, falls es eine neue Datei sein soll.</para>
+ <screenshot>
+ <screeninfo>Reiter "Dateianhänge"</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100" contentwidth="40" fileref="images/DMS-Anhaenge-hochladen.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Es können mehrere Dateien gleichzeitig hochgeladen werden,
+ solange in Summe die maximale Größe nicht überschritten wird
+ (siehe <xref linkend="file_management.clientconfig"/>).</para>
+ <screenshot>
+ <screeninfo>Reiter "Dokumente"</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="500" fileref="images/DMS-Dokumente.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Sind keine weiteren Quellen für Dokumente konfiguriert, so gibt es nur "erzeugte Dokumente".
+ Es werden alle Versionen der generierten Datei angezeigt. Für Verkaufsrechnungen kommen keine
+ anderen Quellen zur Geltung. Werden entsprechend der
+ <xref linkend="file_management.dbconfig"/> zusätzliche Quellen konfiguriert, so sind diese z.B. bei
+ Einkaufsrechnungen sichtbar:</para>
+ <screenshot>
+ <screeninfo>Reiter "Dokumente"</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="600" fileref="images/DMS-Dokumente-Scanner.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Statt des Löschens wird hier die Datei zurück zur Quelle verschoben. Somit kann die Datei anschließend
+ an ein anderes ERP-Objekt angehängt werden.</para>
+ <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie sind bisher nur bei Bildern relevant.</para>
</sect2>
+
+ <sect2>
+ <title>Konfigurierung</title>
+ <sect3 id="file_management.clientconfig" xreflabel="Mandantenkonfigurierung">
+ <title>Mandantenkonfiguration</title>
+ <sect4>
+ <title>Reiter "Features"</title>
+ <para>Unter dem Reiter <emphasis role="bold">Features</emphasis> im Abschnitt Dateimanagement ist
+ neben dem "alten" WebDAV das Dateimangement generell zu- und abschaltbar, sowie die Zuordnung der
+ Dateitypen zu Backends. Die Löschbarkeit von Dateien, sowie die maximale Uploadgröße sind Backend-unabhängig</para>
+ <screenshot>
+ <screeninfo>Mandantenkonfig Reiter "Features"</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="500" fileref="images/DMS-ClientConfig.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Die einzelnen Backends sind einzeln einschaltbar. Spezifische Backend-Konfigurierungen sind hier
+ noch ergänzbar.</para>
+ </sect4>
+ <sect4>
+ <title>Reiter "Allgemeine Dokumentenanhänge"</title>
+ <para>Unter dem Reiter <emphasis role="bold">Allgemeine Dokumentenanhänge</emphasis>
+ kann für alle ERP-Dokumente ( Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und Einkauf )
+ allgemeingültige Anhänge hochgeladen werden.</para>
+ <screenshot>
+ <screeninfo>Mandantenkonfig Reiter "Allgemeine Dokumentenanhänge"</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="500" fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Diese Anhänge werden beim Generieren von PDF-Dateien an die ERP-Dokumente angehängt,
+ z.B. AGBs oder aktuelle Angebote. Es werden in dem Fall die Daten kopiert, sodass an den ERP-Dokumenten immer
+ die Anhänge zum Generierungszeitpunkt eingebettet sind.
+ </para>
+ </sect4>
+ </sect3>
+ <sect3 id="file_management.dbconfig" xreflabel="Datenbank-Konfigurierung">
+ <title>Datenbank-Konfigurierung</title>
+ <para>Die zusätzlichen Quellen für "email" oder ein oder mehrere Scanner sind derzeit vom Administrator
+ direkt in der Datenbanktabelle "user_preferences" einzurichten. Die "value" ist im JSON-Format
+ mit den jeweiligen Werten des Verzeichnisses und der Beschreibung der Quelle.</para>
+ <programlisting>
+ id | login | namespace | version | key | value
+----+-----------+--------------+---------+----------+---------------------------
+ 1 | #default# | file_sources | 0.00000 | scanner1 |
+ {"dir":"/var/tmp/scanner1","desc":"Scanner Einkauf"}
+ 2 | #default# | file_sources | 0.00000 | scanner2 |
+ {"dir":"/var/tmp/scanner2","desc":"Scanner Verkauf"}
+ 3 | #default# | file_sources | 0.00000 | emails |
+ {"dir":"/var/tmp/emails","desc":"Empfangene Mails" }
+ </programlisting>
+ <para>Es ist daran gedacht, statt dem Default-Eintrag später für bestimmte Benutzer ('login') bestimmte Quellen zuzulassen.
+ Dies wird nach Bedarf implementiert.</para>
+ </sect3>
+ <sect3 id="file_management.kiviconfig" xreflabel="kivitendo-Konfigurationsdatei">
+ <title>kivitendo-Konfigurationsdatei</title>
+ <para>Dort ist im Abschnitt [paths] der relative oder absolute Pfad zum Dokumentenwurzelverzeichnis einzutragen.
+ Dieser muss für den Webserver schreib- und lesbar sein, jedoch nicht ausführbar.</para>
+ <programlisting>
+[paths]
+document_path = /var/local/kivi_documents
+ </programlisting>
+ <para>Unter diesem Wurzelverzeichnis wird pro Mandant automatisch ein Unterverzeichnis mit der ID des Mandanten angelegt.</para>
+ </sect3>
+ </sect2>
</sect1>
</chapter>
</itemizedlist>
<para><varname>$::form</varname> wurde unter <productname>SQL
- Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
+ Ledger</productname> als Gottobjekt für alles missbraucht. Sämtliche
alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel
</listitem>
<listitem>
- <para>Enthält unter anderem Listenbegrenzung vclimit,
- Datumsformat dateformat und Nummernformat numberformat</para>
+ <para>Enthält unter anderem Datumsformat dateformat und Nummernformat numberformat</para>
</listitem>
<listitem>
überwiegend die Daten, die sich unter <guimenu>Programm</guimenu>
-> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die
Informationen über den Benutzer die über die
- Administrator-Schnittstelle (admin.pl) eingegeben wurden.</para>
+ Administrator-Schnittstelle eingegeben wurden.</para>
</sect3>
<sect3>
vom aktuellen User abhängen wird das Objekt aus
Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
Request kurz resettet.</para>
+
+ <para>Dieses Objekt kapselt auch den gerade aktiven Mandanten.
+ Dessen Einstellungen können über
+ <literal>$::auth->client</literal> abgefragt werden; Rückgabewert
+ ist ein Hash mit den Werten aus der Tabelle
+ <literal>auth.clients</literal>.</para>
</sect3>
<sect3>
verfügbar:</para>
<programlisting>[debug]
-file = /tmp/kivitendo-debug.log</programlisting>
+file_name = /tmp/kivitendo-debug.log</programlisting>
<para>ist der Key <varname>file</varname> im Programm als
<varname>$::lx_office_conf->{debug}{file}</varname>
<para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
den kritischen Pfaden, unter 0,15 sonst.</para>
</sect2>
-
- <sect2 id="devel.fcgi.known-issues">
- <title>Bekannte Probleme</title>
-
- <sect3 id="devel.fcgi.known-issues.encoding">
- <title>Encoding Awareness</title>
-
- <para>UTF-8 kodierte Installationen sind sehr anfällig gegen
- fehlerhfate Encodings unter FCGI. latin9 Installationen behandeln
- falsch kodierte Zeichen eher unwissend, und geben sie einfach
- weiter. UTF-8 verweigert bei fehlerhaften Programmpfaden kurzerhand
- das Ausliefern. Es wird noch daran gearbeitet, alle Fehler da zu
- beseitigen.</para>
- </sect3>
- </sect2>
</sect1>
<sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
xreflabel="Einführung in die Datenbank-Upgradedateien">
<title>Einführung</title>
- <para>Der alte Mechanismus für SQL-Upgradescripte, der auf einer
- Versionsnummer beruht und dann in sql/Pg-upgrade nach einem Script für
- diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele
- Entwicklung im stable- und unstable-Baum betrifft.</para>
-
- <para>Dieser Mechanismus wurde für kivitendo 2.4.1 deutlich erweitert.
- Es werden weiterhin alle Scripte aus sql/Pg-upgrade ausgeführt.
- Zusätzlich gibt es aber ein zweites Verzeichnis, sql/Pg-upgrade2. In
- diesem Verzeichnis muss pro Datenbankupgrade eine Datei existieren,
- die neben den eigentlich auszuführenden SQL- oder Perl-Befehlen einige
+ <para>Datenbankupgrades werden über einzelne Upgrade-Scripte
+ gesteuert, die sich im Verzeichnis
+ <filename>sql/Pg-upgrade2</filename> befinden. In diesem Verzeichnis
+ muss pro Datenbankupgrade eine Datei existieren, die neben den
+ eigentlich auszuführenden SQL- oder Perl-Befehlen einige
Kontrollinformationen enthält.</para>
- <para>Neu sind die Kontrollinformationen, die Abhängigkeiten und
- Prioritäten definieren können werden, sodass Datenbankscripte zwar in
- einer sicheren Reihenfolge ausgeführt werden (z.B. darf ein "ALTER
- TABLE" erst ausgeführt werden, wenn die Tabelle mit "CREATE TABLE"
- angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man
- keine Versionsnummern mehr braucht.</para>
+ <para>Kontrollinformationen definieren Abhängigkeiten und Prioritäten,
+ sodass Datenbankscripte zwar in einer sicheren Reihenfolge ausgeführt
+ werden (z.B. darf ein <literal>ALTER TABLE</literal> erst ausgeführt
+ werden, wenn die Tabelle mit <literal>CREATE TABLE</literal> angelegt
+ wurde), diese Reihenfolge aber so flexibel ist, dass man keine
+ Versionsnummern braucht.</para>
<para>kivitendo merkt sich dabei, welches der Upgradescripte in
- sql/Pg-upgrade2 bereits durchgeführt wurde und führt diese nicht
- erneut aus. Dazu dient die Tabelle "schema_info", die bei der
- Anmeldung automatisch angelegt wird.</para>
+ <filename>sql/Pg-upgrade2</filename> bereits durchgeführt wurde und
+ führt diese nicht erneut aus. Dazu dient die Tabelle
+ "<literal>schema_info</literal>", die bei der Anmeldung automatisch
+ angelegt wird.</para>
</sect2>
<sect2 id="db-upgrade-files.format"
<para>Empfohlen. Gibt den Zeichensatz an, in dem das Script
geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei
- Abwesenheit des Tags der Zeichensatz
- "<literal>ISO-8859-15</literal>" angenommen.</para>
+ Abwesenheit des Tags für SQL-Upgradedateien der Zeichensatz
+ "<literal>ISO-8859-15</literal>" angenommen. Perl-Upgradescripte
+ hingegen müssen immer in UTF-8 encodiert sein und sollten
+ demnach auch ein "<literal>use utf8;</literal>"
+ enthalten.</para>
</listitem>
</varlistentry>
<listitem>
<para>Benötigt. Eine Beschreibung, was in diesem Update
passiert. Diese wird dem Benutzer beim eigentlichen
- Datenbankupdate angezeigt. Während der Tag in englisch gehalten
+ Datenbankupdate angezeigt. Während der Tag in Englisch gehalten
sein sollte, sollte die Beschreibung auf Deutsch
erfolgen.</para>
</listitem>
</variablelist>
</sect2>
+ <sect2 id="db-upgrade-files.format-perl-files"
+ xreflabel="Format von Perl-Upgradedateien">
+ <title>Format von in Perl geschriebenen
+ Datenbankupgradescripten</title>
+
+ <para>In Perl geschriebene Datenbankscripte werden nicht einfach so
+ ausgeführt sondern müssen sich an gewisse Konventionen halten. Dafür
+ bekommen sie aber auch einige Komfortfunktionen bereitgestellt.</para>
+
+ <para>Ein Upgradescript stellt dabei eine vollständige Objektklasse
+ dar, die vom Elternobjekt "<literal>SL::DBUpgrade2::Base</literal>"
+ erben und eine Funktion namens "<literal>run</literal>" zur Verfügung
+ stellen muss. Das Script wird ausgeführt, indem eine Instanz dieser
+ Klasse erzeugt und darauf die erwähnte "<literal>run</literal>"
+ aufgerufen wird.</para>
+
+ <para>Zu beachten ist, dass sich der Paketname der Datei aus dem Wert
+ für "<literal>@tag</literal>" ableitet. Dabei werden alle Zeichen, die
+ in Paketnamen ungültig wären (gerade Bindestriche), durch Unterstriche
+ ersetzt. Insgesamt sieht der Paketname wie folgt aus:
+ "<literal>SL::DBUpgrade2::tag</literal>".</para>
+
+ <para>Welche Komfortfunktionen zur Verfügung stehen, erfahren Sie in
+ der Perl-Dokumentation zum oben genannten Modul; aufzurufen mit
+ "<command>perldoc SL/DBUpgrade2/Base.pm</command>".</para>
+
+ <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
+ folgt aus:</para>
+
+ <programlisting># @tag: beispiel-upgrade-file42
+# @description: Ein schönes Beispielscript
+# @depends: release_3_1_0
+package SL::DBUpgrade2::beispiel_upgrade_file42;
+
+use strict;
+use utf8;
+
+use parent qw(SL::DBUpgrade2::Base);
+
+sub run {
+ my ($self) = @_;
+
+ # hier Aktionen ausführen
+
+ return 1;
+}
+
+1;
+</programlisting>
+ </sect2>
+
<sect2 id="db-upgrade-files.dbupgrade-tool"
xreflabel="Hilfsscript dbupgrade2_tool.pl">
<title>Hilfsscript dbupgrade2_tool.pl</title>
are built. Currently the only language fully supported is German, and
since most of the internal messages are held in English the English
version is usable too.</para>
+ </sect2>
+
+ <sect2 id="translations-languages.character-set"
+ xreflabel="Character set">
+ <title>Character set</title>
- <para>A stub version of French is included but not functunal at this
- point.</para>
+ <para>All files included in a language pack must use UTF-8 as their
+ encoding.</para>
</sect2>
<sect2 id="translations-languages.file-structure"
</listitem>
</varlistentry>
- <varlistentry>
- <term>charset</term>
-
- <listitem>
- <para>This file should be present.</para>
-
- <para>The <filename>charset</filename> file describes which
- charset a language package is written in and applies to all
- other language files in the package. It is possible to write
- some language packages without an explicit charset, but it is
- still strongly recommended. You'll never know in what
- environment your language package will be used, and neither
- UTF-8 nor Latin1 are guaranteed.</para>
-
- <para>The whole content of this file is a string that can be
- recognized as a valid charset encoding. Example:</para>
-
- <programlisting>UTF-8</programlisting>
- </listitem>
- </varlistentry>
-
<varlistentry>
<term>all</term>
<para>The last of which is very machine dependant. Remember that
a lot of characters are forbidden by some filesystems, for
- exmaple MS Windows doesn't like ':' in its files where Linux
+ example MS Windows doesn't like ':' in its files where Linux
doesn't mind that. If you want the files created with your
language pack to be portable, find all chars that could cause
trouble.</para>
want to keep this safe somewhere.</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term>more/all</term>
+
+ <listitem>
+ <para>This subdir and file is not a part of the language package
+ itself.</para>
+
+ <para>If the directory more exists and contains a file called
+ all it will be parsed in addition to the mandatory all (see
+ above). The file is useful if you want to change some
+ translations for the current installation without conflicting
+ further upgrades. The file is not autogenerated and has the same
+ format as the all, but needs another key (more_texts). See the
+ german translation for an example or copy the following code:
+ <programlisting>
+#!/usr/bin/perl
+# -*- coding: utf-8; -*-
+# vim: fenc=utf-8
+
+use utf8;
+
+# These are additional texts for custom translations.
+# The format is the same as for the normal file all, only
+# with another key (more_texts instead of texts).
+# The file has the form of 'english text' => 'foreign text',
+
+$self->{more_texts} = {
+
+ 'Ship via' => 'Terms of delivery',
+ 'Shipping Point' => 'Delivery time',
+}
+ </programlisting></para>
+ </listitem>
+ </varlistentry>
</variablelist>
</sect2>
</sect1>
+ <sect1 id="devel.testsuite">
+ <title>Die kivitendo-Test-Suite</title>
+
+ <sect2 id="devel.testsuite.intro">
+ <title>Einführung</title>
+
+ <para>kivitendo enthält eine Suite für automatisierte Tests. Sie
+ basiert auf dem Standard-Perl-Modul
+ <literal>Test::More</literal>.</para>
+
+ <para>Die grundlegenden Fakten sind:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Alle Tests liegen im Unterverzeichnis
+ <filename>t/</filename>.</para>
+ </listitem>
+
+ <listitem>
+ <para>Ein Script (bzw. ein Test) in <filename>t/</filename>
+ enthält einen oder mehrere Testfälle.</para>
+ </listitem>
+
+ <listitem>
+ <para>Alle Dateinamen von Tests enden auf <literal>.t</literal>.
+ Es sind selbstständig ausführbare Perl-Scripte.</para>
+ </listitem>
+
+ <listitem>
+ <para>Die Test-Suite besteht aus der Gesamtheit aller Tests,
+ sprich aller Scripte in <filename>t/</filename>, deren Dateiname
+ auf <literal>.t</literal> endet.</para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
+
+ <sect2 id="devel.testsuite.prerequisites">
+ <title>Voraussetzungen</title>
+
+ <para>Für die Ausführung werden neben den für kivitendo eh schon
+ benötigten Module noch weitere Perl-Module benötigt. Diese
+ sind:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><literal>Test::Deep</literal> (Debian-Paketname:
+ <literal>libtest-deep-perl</literal>; Fedora:
+ <literal>perl-Test-Deep</literal>; openSUSE:
+ <literal>perl-Test-Deep</literal>)</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Test::Exception</literal> (Debian-Paketname:
+ <literal>libtest-exception-perl</literal>; Fedora:
+ <literal>perl-Test-Exception</literal>; openSUSE:
+ <literal>perl-Test-Exception</literal>)</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Test::Output</literal> (Debian-Paketname:
+ <literal>libtest-output-perl</literal>; Fedora:
+ <literal>perl-Test-Output</literal>; openSUSE:
+ <literal>perl-Test-Output</literal>)</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Test::Harness</literal> 3.0.0 oder höher. Dieses
+ Modul ist ab Perl 5.10.1 Bestandteil der Perl-Distribution und
+ kann für frühere Versionen aus dem <ulink
+ url="http://www.cpan.org">CPAN</ulink> bezogen werden.</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>LWP::Simple</literal> aus dem Paket
+ <literal>libwww-perl</literal> (Debian-Panetname:
+ <literal>libwww-perl</literal>; Fedora:
+ <literal>perl-libwww-perl</literal>; openSUSE:
+ <literal>perl-libwww-perl</literal>)</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>URI::Find</literal> (Debian-Panetname:
+ <literal>liburi-find-perl</literal>; Fedora:
+ <literal>perl-URI-Find</literal>; openSUSE:
+ <literal>perl-URI-Find</literal>)</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Sys::CPU</literal> (Debian-Panetname: <literal>libsys-cpu-perl</literal>; Fedora und openSUSE: nicht
+ vorhanden)</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Thread::Pool::Simple</literal> (Debian-Panetname: <literal>libthread-pool-simple-perl</literal>; Fedora und
+ openSUSE: nicht vorhanden)</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Weitere Voraussetzung ist, dass die Testsuite ihre eigene
+ Datenbank anlegen kann, um Produktivdaten nicht zu gefährden. Dazu
+ müssen in der Konfigurationsdatei im Abschnit
+ <literal>testing/database</literal> Datenbankverbindungsparameter
+ angegeben werden. Der hier angegebene Benutzer muss weiterhin das
+ Recht haben, Datenbanken anzulegen und zu löschen.</para>
+ </sect2>
+
+ <sect2 id="devel.testsuite.execution">
+ <title>Existierende Tests ausführen</title>
+
+ <para>Es gibt mehrere Möglichkeiten zum Ausführen der Tests: entweder,
+ man lässt alle Tests auf einmal ausführen, oder man führt gezielt
+ einzelne Scripte aus. Für beide Fälle gibt es das Helferscript
+ <filename>t/test.pl</filename>.</para>
+
+ <para>Will man die komplette Test-Suite ausführen, so muss man einfach
+ nur <filename>t/test.pl</filename> ohne weitere Parameter aus dem
+ kivitendo-Basisverzeichnis heraus ausführen.</para>
+
+ <para>Um einzelne Test-Scripte auszuführen, übergibt man deren Namen
+ an <filename>t/test.pl</filename>. Beispielsweise:</para>
+
+ <programlisting>t/test.pl t/form/format_amount.t t/background_job/known_jobs.t</programlisting>
+ </sect2>
+
+ <sect2 id="devel.testsuite.meaning_of_scripts">
+ <title>Bedeutung der verschiedenen Test-Scripte</title>
+
+ <para>Die Test-Suite umfasst Tests sowohl für Funktionen als auch für
+ Programmierstil. Einige besonders zu erwähnende, weil auch während der
+ Entwicklung nützliche Tests sind:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><filename>t/001compile.t</filename> -- compiliert alle
+ Quelldateien und bricht bei Fehlern sofort ab</para>
+ </listitem>
+
+ <listitem>
+ <para><filename>t/002goodperl.t</filename> -- überprüft alle
+ Perl-Dateien auf Anwesenheit von '<literal>use
+ strict</literal>'-Anweisungen</para>
+ </listitem>
+
+ <listitem>
+ <para><filename>t/003safesys.t</filename> -- überprüft Aufrufe von
+ <function>system()</function> und <function>exec()</function> auf
+ Gültigkeit</para>
+ </listitem>
+
+ <listitem>
+ <para><filename>t/005no_tabs.t</filename> -- überprüft, ob Dateien
+ Tab-Zeichen enthalten</para>
+ </listitem>
+
+ <listitem>
+ <para><filename>t/006spelling.t</filename> -- sucht nach häufigen
+ Rechtschreibfehlern</para>
+ </listitem>
+
+ <listitem>
+ <para><filename>t/011pod.t</filename> -- überprüft die Syntax von
+ Dokumentation im POD-Format auf Gültigkeit</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Weitere Test-Scripte überprüfen primär die Funktionsweise
+ einzelner Funktionen und Module.</para>
+ </sect2>
+
+ <sect2 id="devel.testsuite.create_new">
+ <title>Neue Test-Scripte erstellen</title>
+
+ <para>Es wird sehr gern gesehen, wenn neue Funktionalität auch gleich
+ mit einem Test-Script abgesichert wird. Auch bestehende Funktion darf
+ und soll ausdrücklich nachträglich mit Test-Scripten abgesichert
+ werden.</para>
+
+ <sect3 id="devel.testsuite.ideas_for_non_function_tests">
+ <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
+ testen</title>
+
+ <para>Ideen, die abgesehen von Funktionen noch nicht umgesetzt
+ wurden:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Überprüfung auf fehlende symbolische Links</para>
+ </listitem>
+
+ <listitem>
+ <para>Suche nach Nicht-ASCII-Zeichen in Perl-Code-Dateien (mit
+ gewissen Einschränkungen wie das Erlauben von deutschen
+ Umlauten)</para>
+ </listitem>
+
+ <listitem>
+ <para>Test auf DOS-Zeilenenden (\r\n anstelle von nur \n)</para>
+ </listitem>
+
+ <listitem>
+ <para>Überprüfung auf Leerzeichen am Ende von Zeilen</para>
+ </listitem>
+
+ <listitem>
+ <para>Test, ob alle zu übersetzenden Strings in
+ <filename>locale/de/all</filename> vorhanden sind</para>
+ </listitem>
+
+ <listitem>
+ <para>Test, ob alle Webseiten-Templates in
+ <filename>templates/webpages</filename> mit vom Perl-Modul
+ <literal>Template</literal> compiliert werden können</para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="devel.testsuite.directory_and_test_names">
+ <title>Konvention für Verzeichnis- und Dateinamen</title>
+
+ <para>Es gibt momentan eine wenige Richtlinien, wie Test-Scripte zu
+ benennen sind. Bitte die folgenden Punkte als Richtlinie betrachten
+ und ihnen soweit es geht folgen:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Die Dateiendung muss <filename>.t</filename>
+ lauten.</para>
+ </listitem>
+
+ <listitem>
+ <para>Namen sind englisch, komplett klein geschrieben und
+ einzelne Wörter mit Unterstrichten getrennt (beispielsweise
+ <filename>bad_function_params.t</filename>).</para>
+ </listitem>
+
+ <listitem>
+ <para>Unterverzeichnisse sollten grob nach dem Themenbereich
+ benannt sein, mit dem sich die Scripte darin befassen
+ (beispielsweise <filename>background_jobs</filename> für Tests
+ rund um Hintergrund-Jobs).</para>
+ </listitem>
+
+ <listitem>
+ <para>Test-Scripte sollten einen überschaubaren Bereich von
+ Funktionalität testen, der logisch zusammenhängend ist (z.B. nur
+ Tests für eine einzelne Funktion in einem Modul). Lieber mehrere
+ Test-Scripte schreiben.</para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="devel.testsuite.minimal_example">
+ <title>Minimales Skelett für eigene Scripte</title>
+
+ <para>Der folgenden Programmcode enthält das kleinstmögliche
+ Testscript und kann als Ausgangspunkt für eigene Tests verwendet
+ werden:</para>
+
+ <programlisting>use Test::More tests => 0;
+
+use lib 't';
+
+use Support::TestSetup;
+
+Support::TestSetup::login();</programlisting>
+
+ <para>Wird eine vollständig initialisierte kivitendo-Umgebung
+ benötigt (Stichwort: alle globalen Variablen wie
+ <varname>$::auth</varname>, <varname>$::form</varname> oder
+ <varname>$::lxdebug</varname>), so muss in der Konfigurationsdatei
+ <filename>config/kivitendo.conf</filename> im Abschnitt
+ <literal>testing.login</literal> ein gültiger Login-Name eingetragen
+ sein. Dieser wird für die Datenbankverbindung benötigt.</para>
+
+ <para>Wir keine vollständig initialisierte Umgebung benötigt, so
+ kann die letzte Zeile <programlisting>Support::TestSetup::login();</programlisting>
+ weggelassen werden, was die Ausführungszeit des Scripts leicht
+ verringert.</para>
+ </sect3>
+ </sect2>
+ </sect1>
+
<sect1 id="devel.style-guide">
<title>Stil-Richtlinien</title>
</listitem>
<listitem>
- <para>Ein Spezialfall ist der ternäre Oprator "?:", der am
+ <para>Ein Spezialfall ist der ternäre Operator "?:", der am
besten in einer übersichtlichen Tabellenstruktur organisiert
wird. Beispiel:</para>
<para><varname>$form</varname>, <varname>$auth</varname>,
<varname>$locale</varname>, <varname>$lxdebug</varname> und
<varname>%myconfig</varname> werden derzeit aus dem main package
- importiert (siehe <xref linkend="devel.globals" />. Alle anderen
+ importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
Konstrukte sollten lexikalisch lokal gehalten werden.</para>
</listitem>
</orderedlist>
projects / kivitendo-erp.git / blobdiff