<!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 3.3.0: Installation, Konfiguration, Entwicklung</title>
+ <title>kivitendo 3.6.1: Installation, Konfiguration,
+ Entwicklung</title>
<chapter id="Aktuelle-Hinweise">
<title>Aktuelle Hinweise</title>
<itemizedlist>
<listitem>
<para>im Community-Forum: <ulink
- url="https://forum.kivitendo.org:32443">https://forum.kivitendo.org:32443</ulink></para>
+ url="https://forum.kivitendo.de">https://forum.kivitendo.de</ulink></para>
</listitem>
+
<listitem>
<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>
+ <para>in der doc/UPGRADE Datei im doc-Verzeichnis der
+ Installation</para>
</listitem>
+
<listitem>
- <para>Im Schulungs- und Dienstleistungsangebot der entsprechenden kivitendo-Partner: <ulink
+ <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>
<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>
+ <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>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>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>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>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>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>
+ <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>
+ <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">
ohne große Probleme auf den derzeit aktuellen verbreiteten
Distributionen läuft.</para>
- <para>Anfang 2014 sind das folgende Systeme, von denen bekannt ist,
- dass kivitendo auf ihnen läuft:</para>
+ <para>Mitte 2020 (ab Version 3.5.6) empfehlen wir:</para>
<itemizedlist>
-
<listitem>
<para>Debian</para>
+
<itemizedlist>
- <listitem>
- <para>6.0 "Squeeze" (hier muss allerdings das Modul FCGI in der Version >= 0.72 compiled werden, und <literal>Rose::DB::Object</literal> ist zu alt)</para>
- </listitem>
- <listitem>
- <para>7.0 "Wheezy"</para>
- </listitem>
+ <listitem>
+ <para>10.0 "Buster"</para>
+ </listitem>
+ <listitem>
+ <para>11.0 "Bullseye"</para>
+ </listitem>
</itemizedlist>
</listitem>
<listitem>
- <para>Ubuntu 12.04 LTS "Precise Pangolin", 12.10 "Quantal Quetzal", 13.04 "Precise Pangolin" und 14.04 "Trusty Tahr" LTS Alpha</para>
- </listitem>
-
- <listitem>
- <para>openSUSE 12.2, 12.3 und 13.1</para>
+ <para>20.04 "Focal Fossa" LTS
+ </para>
</listitem>
<listitem>
- <para>SuSE Linux Enterprice Server 11</para>
+ <para>openSUSE Leap 15.x und SUSE Linux Enterprise Server 15 GA</para>
</listitem>
<listitem>
- <para>Fedora 16 bis 19</para>
+ <para>Fedora 29</para>
</listitem>
</itemizedlist>
</sect2>
<title>Benötigte Perl-Pakete installieren</title>
<para>Zum Betrieb von kivitendo werden zwingend ein Webserver (meist
- Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.4)
+ 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>
+ <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>Die vollständige Liste der benötigten Perl-Module lautet:</para>
<itemizedlist>
- <listitem><para><literal>parent</literal> (nur bei Perl vor 5.10.1)</para></listitem>
+ <listitem>
+ <para><literal>Algorithm::CheckDigits</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Archive::Zip</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>CAM::PDF</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>Daemon::Generic</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>DateTime</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>DateTime::Event::Cron</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>DateTime::Format::Strptime</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>DateTime::Set</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>DBI</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>DBD::Pg</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Digest::SHA</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Email::Address</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Email::MIME</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Exception::Class</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71
+ inklusive; siehe <xref
+ linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>File::Copy::Recursive</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>File::Flock</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>File::MimeInfo</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>File::Slurp</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>GD</literal></para>
+ </listitem>
- <listitem><para><literal>Archive::Zip</literal></para></listitem>
+ <listitem>
+ <para><literal>HTML::Parser</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>HTML::Restrict</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Image::Info</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Imager</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Imager::QRCode</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>IPC::Run</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>JSON</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>List::MoreUtils</literal></para>
+ </listitem>
+
+ <listitem>
+ <para><literal>List::UtilsBy</literal></para>
+ </listitem>
+
+ <listitem>
+ <para>LWP::Authen::Digest</para>
+ </listitem>
+
+ <listitem>
+ <para>LWP::UserAgent</para>
+ </listitem>
- <listitem><para><literal>Config::Std</literal></para></listitem>
+ <listitem>
+ <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><literal>DateTime</literal></para></listitem>
+ <listitem>
+ <para><literal>Net::SSLGlue</literal> (optional, bei
+ E-Mail-Versand über TLS; siehe Abschnitt "<xref
+ linkend="config.sending-email.smtp"/>")</para>
+ </listitem>
- <listitem><para><literal>DBI</literal></para></listitem>
+ <listitem>
+ <para><literal>Math::Round</literal></para>
+ </listitem>
- <listitem><para><literal>DBD::Pg</literal></para></listitem>
+ <listitem>
+ <para><literal>Params::Validate</literal></para>
+ </listitem>
- <listitem><para><literal>Email::Address</literal></para></listitem>
+ <listitem>
+ <para><literal>PBKDF2::Tiny</literal></para>
+ </listitem>
- <listitem><para><literal>Email::MIME</literal></para></listitem>
+ <listitem>
+ <para><literal>PDF::API2</literal></para>
+ </listitem>
- <listitem><para><literal>FCGI</literal> (nicht Versionen 0.68 bis 0.71 inklusive; siehe <xref linkend="Apache-Konfiguration.FCGI.WebserverUndPlugin"/>)</para></listitem>
+ <listitem>
+ <para><literal>Regexp::IPv6</literal></para>
+ </listitem>
- <listitem><para><literal>File::Copy::Recursive</literal></para></listitem>
+ <listitem>
+ <para><literal>Rest::Client</literal></para>
+ </listitem>
- <listitem><para><literal>JSON</literal></para></listitem>
+ <listitem>
+ <para><literal>Rose::Object</literal></para>
+ </listitem>
- <listitem><para><literal>List::MoreUtils</literal></para></listitem>
+ <listitem>
+ <para><literal>Rose::DB</literal></para>
+ </listitem>
- <listitem><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><literal>Rose::DB::Object</literal> Version 0.788 oder
+ neuer</para>
+ </listitem>
- <listitem><para><literal>Net::SSLGlue</literal> (optional, bei E-Mail-Versand über TLS; siehe Abschnitt "<xref
- linkend="config.sending-email.smtp"/>")</para></listitem>
+ <listitem>
+ <para><literal>Set::Infinite</literal></para>
+ </listitem>
- <listitem><para><literal>Params::Validate</literal></para></listitem>
+ <listitem>
+ <para><literal>String::ShellQuote</literal></para>
+ </listitem>
- <listitem><para><literal>PDF::API2</literal></para></listitem>
+ <listitem>
+ <para><literal>Sort::Naturally</literal></para>
+ </listitem>
- <listitem><para><literal>Rose::Object</literal></para></listitem>
+ <listitem>
+ <para><literal>Template</literal></para>
+ </listitem>
- <listitem><para><literal>Rose::DB</literal></para></listitem>
+ <listitem>
+ <para><literal>Text::CSV_XS</literal></para>
+ </listitem>
- <listitem><para><literal>Rose::DB::Object</literal> Version 0.788 oder neuer</para></listitem>
+ <listitem>
+ <para><literal>Text::Iconv</literal></para>
+ </listitem>
- <listitem><para><literal>Template</literal></para></listitem>
+ <listitem>
+ <para><literal>Text::Unidecode</literal></para>
+ </listitem>
- <listitem><para><literal>Text::CSV_XS</literal></para></listitem>
+ <listitem>
+ <para><literal>Try::Tiny</literal></para>
+ </listitem>
- <listitem><para><literal>Text::Iconv</literal></para></listitem>
+ <listitem>
+ <para><literal>URI</literal></para>
+ </listitem>
- <listitem><para><literal>URI</literal></para></listitem>
+ <listitem>
+ <para><literal>XML::Writer</literal></para>
+ </listitem>
- <listitem><para><literal>XML::Writer</literal></para></listitem>
+ <listitem>
+ <para><literal>XML::LibXML</literal></para>
+ </listitem>
- <listitem><para><literal>YAML</literal></para></listitem>
+ <listitem>
+ <para><literal>YAML::XS</literal> oder <literal>YAML</literal></para>
+ </listitem>
</itemizedlist>
- <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>,
+ <para>Seit Version größer v3.6.0 sind die folgenden Pakete hinzugekommen: <literal>IPC::Run</literal></para>
+
+ <para>Seit Version größer v3.5.8 sind die folgenden Pakete hinzugekommen: <literal>Imager</literal>, <literal>Imager::QRCode</literal>
+<literal>Rest::Client</literal><literal>Term::ReadLine::Gnu</literal></para>
+
+ <para>Seit Version größer v3.5.6 sind die folgenden Pakete hinzugekommen: <literal>Try::Tiny</literal>, <literal>Math::Round</literal></para>
+ <para>Seit Version größer v3.5.6 sind die folgenden Pakete hinzugekommen: <literal>XML::LibXML</literal>, <literal>CAM::PDF</literal></para>
+ <para>Seit Version größer v3.5.3 sind die folgenden Pakete hinzugekommen: <literal>Exception::Class</literal></para>
+
+ <para>Seit Version größer v3.5.1 sind die folgenden Pakete hinzugekommen: <literal>Set::Infinite</literal>,
+ <literal>List::UtilsBy</literal>, <literal>DateTime::Set</literal>, <literal>DateTime::Event::Cron</literal>
+ <literal>Daemon::Generic</literal>, <literal>DateTime::Event::Cron</literal>, <literal>File::Flock</literal>,
+ <literal>File::Slurp</literal></para>
+
+ <para>Seit Version größer v3.5.0 sind die folgenden Pakete
+ hinzugekommen: <literal>Text::Unidecode</literal>,
+ <literal>LWP::Authen::Digest</literal>,
+ <literal>LWP::UserAgent</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
<sect3>
<title>Debian und Ubuntu</title>
+ <para>Für Debian und Ubuntu stehen die meisten der benötigten
+ Pakete als Debian-Pakete zur Verfügung. Sie können mit
+ folgendem Befehl installiert werden:</para>
- <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-get install apache2 libarchive-zip-perl libclone-perl \
+ <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 \
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 \
- libfile-copy-recursive-perl postgresql</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>
+ 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 libwww-perl \
+ postgresql-contrib poppler-utils libhtml-restrict-perl \
+ libdatetime-set-perl libset-infinite-perl liblist-utilsby-perl \
+ libdaemon-generic-perl libfile-flock-perl libfile-slurp-perl \
+ libfile-mimeinfo-perl libpbkdf2-tiny-perl libregexp-ipv6-perl \
+ libdatetime-event-cron-perl libexception-class-perl libcam-pdf-perl \
+ libxml-libxml-perl libtry-tiny-perl libmath-round-perl \
+ libimager-perl libimager-qrcode-perl librest-client-perl libipc-run-perl
+ </programlisting>
+
+ <para>Sollten Pakete nicht zu Verfügung stehen, so können diese auch mittels CPAN installiert werden. Ferner muss für Ubuntu das Repository "Universe" aktiv sein (s.a. Anmerkungen).</para>
+ <note id="ubuntu-universe">
+ <para>Die Perl Pakete für Ubuntu befinden sich im "Universe" Repository. Falls dies nicht aktiv ist, kann dies mit folgendem Aufruf aktiviert werden:
+<programlisting>add-apt-repository universe</programlisting></para>
+ </note>
</sect3>
<sect3>
- <title>Fedora Core</title>
+ <title>Fedora</title>
- <para>Für Fedora Core stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl installiert werden:</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 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 \
+ <programlisting>dnf install httpd mod_fcgid postgresql-server postgresql-contrib\
+ perl-Algorithm-CheckDigits perl-Archive-Zip perl-CPAN perl-Class-XSAccessor \
+ perl-Clone perl-Config-Std perl-DBD-Pg perl-DBI perl-Daemon-Generic \
+ perl-DateTime perl-DateTime-Set perl-Email-Address perl-Email-MIME perl-FCGI \
+ perl-File-Copy-Recursive perl-File-Flock perl-File-MimeInfo perl-File-Slurp \
+ perl-GD perl-HTML-Restrict perl-JSON perl-List-MoreUtils perl-List-UtilsBy \
+ perl-Net-SMTP-SSL perl-Net-SSLGlue perl-PBKDF2-Tiny perl-PDF-API2 \
+ perl-Params-Validate perl-Regexp-IPv6 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 perl-parent postgresql-server</programlisting>
-
- <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
-
- <programlisting>yum install perl-CPAN
-cpan Config::Std</programlisting>
-
+ perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI perl-XML-Writer \
+ perl-YAML perl-libwww-perl</programlisting>
</sect3>
<sect3>
- <title>openSUSE</title>
-
- <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>
-
- <programlisting>zypper install apache2 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 postgresql-server</programlisting>
-
- <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert werden. Dazu können Sie die folgenden Befehle nutzen:</para>
+ <title>openSUSE Leap 15.x und SUSE Linux Enterprise Server 15 GA</title>
+
+ <para>Für openSUSE Leap 15.x stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung.</para>
+ <para>Damit diese installiert werden können, muß das System die erforderlichen Repositories kennen und Zugriff über das Internet darauf haben.</para>
+ <para>Daher machen wir die Repositories dem System bekannt.</para>
+ <para>Um die zusätzlichen Repositories für die Installation zur Verfügung zu stellen, kann man diese mit YaST oder auch in einem Terminal auf der Konsole bekannt geben. Wir beschränken uns hier mit der Eingabe auf der Konsole. In den allermeisten Fällen verwenden die Administratoren eine sichere SSH-Verbindung zum zu administrierenden Server.</para>
+ <para>Dazu geben wir folgenden Befehl ein:</para>
+ <programlisting>zypper addrepo -f \
+ http://download.opensuse.org/repositories/devel:languages:perl/openSUSE_Leap_15.2/ \
+ "devel:languages:perl"
+ </programlisting>
+ <programlisting>zypper addrepo -f \
+ https://download.opensuse.org/repositories/devel:languages:haskell:lts:13/\
+ openSUSE_Leap_15.0/ "devel:languages:haskell:lts:13"
+ </programlisting>
+ <programlisting>zypper addrepo -f \
+ https://download.opensuse.org/repositories/devel:languages:haskell:lts:13/\
+ openSUSE_Leap_15.0/ "devel:languages:haskell:lts:13"
+ </programlisting>
+ <para>Danach geben wir noch die beiden folgenden Befehle ein:</para>
+ <programlisting>zypper clean</programlisting>
+ <programlisting>zypper refresh</programlisting>
+ <para>Sollte zypper eine Meldung ausgeben, ob der Repositorie Key abgelehnt, nicht vertraut oder für immer akzeptiert werden soll, ist die Beantwortung durch drücken der "i" Taste am besten geeignet. Wer noch mehr über zypper erfahren möchte, kann sich einmal die zypper Hilfe anschauen.</para>
+ <programlisting>zypper --help</programlisting>
+ <note>
+ <para>Offiziell wird von openSUSE nur noch Versionen ab 15.2 unterstützt. Die SuSE Macher haben ab Version 15.x einen großen Umbau in der Verwaltung der Pakete vorgenommen, das heißt, der Paketumfang ist der SLES 15 als Programmunterbau angepasst. Dies gilt besonders der openSUSE Distribution. Es gibt ja einmal die openSUSE Distri und die Professionelle SLES Version. Dadurch sind viele Pakete aus dem ursprünglich nur für die openSUSE geltenen Repositorie enfernt worden, aber auch viele auf aktuellem Stand gehalten.</para>
+ </note>
+ <para>Ab openSUSE Leap 15.x kann man die Distribution auch als reine Text Version, also ohne KDE Oberfläche aufsetzen. Vorteil hierbei ist, dass weniger Balast und unnötige Pakte installiert werden.</para>
+ <para>Bei openSUSE Versionen bis 15.x, also 10.x, 11.x, 12.x, 13.x hatte der Administrator die Möglichkeit, bei der Installation der Distribution die KDE Oberfläche zu aktivieren. In dieser Konstellation hat man die Möglichkeit, eine VNC Verbindung vom administrativen Client zu verwenden. Ist das nicht eingerichtet, arbeitet der Admin dann direkt am Bildschirm des Servers. Nun loggen wir uns am Server direkt ein, starten Yast2 in einer Konsole wie folgt:</para>
+ <para>yast2 return.</para>
+ <para>Oder über die Menüführung wie folgt: Ein Klick auf das runde Icon, ganz links unten in der Menüleiste, dann die Maus verfahren auf System und YaST.</para>
+ <para>Im weiteren Verlauf der Installation, beschränken wir uns mit dem Installations Werkzeug zypper. Zypper ist ein Komandozeilen basiertes Installations Tool, welches bei openSUSE Standard ist. Zypper weist ein etwas eigenartiges Verhalten auf, dass sich in etwa wie folgt darstellt. Hat man die Repositories eingerichtet, kann man diese mit Yast als auch mit Zypper benutzen, setzt man einen Befehl wie etwa: zypper up ab, so findet zypper mehr neuere Programmversionen als Yast. Ich habe im allgemeinen noch keine Nachteile damit erlebt.</para>
+ <para>Programmpakete können mit folgendem Befehl installiert werden:</para>
+ <para>zypper install Paketname</para>
+ <para>Es wird empfohlen zusätzliche Pakete nicht direkt mit CPAN zu installieren, da man diese auch über andere Repositories beziehen kann, die bei openSUSE zur Verfügung stehen. Dadurch hat man den Vorteil, dass die Pakete mit YaST verwaltet werden, also wieder deinstalliert oder durch neuere ersetzt werden können. Zudem kann man auch noch eventuelle Bugs an openSUSE senden und diese dem Maintainer melden.</para>
+
+ <programlisting>zypper install perl-threads-shared ghc-pdfinfo apache2-mod_fcgid \
+ yast2-http-server postgresql-server postgresql-contrib perl-Algorithm-CheckDigits \
+ perl-Archive-Zip perl-CGI perl-CGI-Ajax perl-Clone \
+ perl-Config-Std perl-Class-XSAccessor perl-Daemon-Generic perl-DateTime \
+ perl-DateTime-Event-Cron perl-DateTime-Format-Strptime perl-DateTime-Set \
+ perl-DBI perl-DBD-Pg perl-Devel-REPL perl-FastCGI perl-Email-Address \
+ perl-Email-MIME perl-Email-MIME-ContentType perl-Email-MIME-Encodings \
+ perl-FCGI perl-File-Copy-Recursive perl-File-Flock perl-File-MimeInfo \
+ perl-File-Slurp perl-GD perl-HTML-Restrict perl-Image-Info \
+ perl-JSON perl-List-MoreUtils perl-List-UtilsBy perl-Log-Log4perl perl-Net-LDAP-Server \
+ perl-Net-SSLGlue perl-Net-SMTP-SSL perl-PBKDF2-Tiny perl-PDF-API2 \
+ perl-Params-Validate perl-Regexp-IPv6 perl-Rose-DB perl-Rose-Object \
+ perl-Rose-DB-Object perl-MooseX-Role-Cmd perl-Set-Crontab perl-Set-Infinite \
+ perl-Sort-Naturally perl-String-ShellQuote perl-Sys-CPU perl-Template-Toolkit \
+ perl-Text-CSV_XS perl-Test-Deep perl-Test-Output perl-Text-Iconv \
+ perl-Text-Unidecode perl-URI perl-URI-Find perl-XML-Writer \
+ perl-YAML perl-libwww-perl
+ </programlisting>
+
+ <para>Für die Entwickler installiert man noch die folgenden Pakete:</para>
+
+ <programlisting>zypper install ghc-mtl-devel ghc-old-locale-devel \
+ ghc-process-extras-devel ghc-rpm-macros ghc-text-devel ghc-time-devel \
+ ghc-Cabal-devel ghc-time-locale-compat-devel perl-Log-Log4perl ghc-pdfinfo \
+ ghc-pdfinfo-devel perl-Devel-REPL perl-URI-Find perl-Class-Utils \
+ perl-Error-Pure perl-File-Object perl-Readonly perl-Test-Warnings \
+ perl-Test-NoWarnings perl-Test-Deep perl-Test-Output perl-Test-Strict \
+ perl-Test-LongString perl-File-Find-Rule
+ </programlisting>
+
+ <para>Zusätzlich müssen einige Pakete für den Umgang mit Latex installiert werden. Die Latex Module barcodes sind nützliche Helfer um auch Barcodes im Dokument zu platzieren, der Vollständigkeit halber hier für die Installation mit angegeben.
+ Dazu können Sie die folgenden Befehle nutzen:</para>
+
+ <programlisting>zypper install texlive-wallpaper texlive-colortbl \
+ texlive-scrlttr2copy texlive-eurosym \
+ texlive-geometry texlive-german texlive-graphbox texlive-hyperref \
+ texlive-xifthen texlive-luainputenc texlive-lastpage texlive-ltabptch \
+ texlive-nomentbl texlive-threeparttablex texlive-substr texlive-tabulary \
+ texlive-ulem texlive-wallpaper texlive-xcolor texlive-xstring \
+ texlive-xypic texlive-mwe texlive-mweights texlive-barcodes \
+ texlive-GS1 texlive-ean texlive-makebarcode texlive-pst-barcode \
+ texlive-upca
+ </programlisting>
+
+ <para>Zusätzlich müssen einige Pakete aus dem CPAN installiert
+ werden. Dazu können Sie die folgenden Befehle anwenden:</para>
+
+ <programlisting>cpan DateTime::event::Cron DateTime::Set FCGI \
+ HTML::Restrict PBKDF2::Tiny Rose::Db::Object Set::Infinite</programlisting>
+ </sect3>
+ </sect2>
- <programlisting>yum install perl-CPAN
-cpan Rose::Db::Object</programlisting>
+ <sect2>
+ <title>Andere Pakete installieren</title>
- </sect3>
+ <itemizedlist>
+ <listitem>
+ <para><literal>poppler-utils</literal> 'pdfinfo' zum Erkennen der Seitenanzahl bei der PDF-Generierung</para>
+ </listitem>
+ <listitem>
+ <para><literal>Postgres Trigram-Index</literal> Für datenbankoptimierte Suchanfragen. Bspw. im Paket <literal>postgresql-contrib</literal> enthalten</para>
+ </listitem>
+ </itemizedlist>
+ <para>Debian und Ubuntu: <programlisting>apt install postgresql-contrib poppler-utils</programlisting></para>
+ <para>Fedora: <programlisting>dnf install poppler-utils postgresql-contrib</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>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.3.0.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>
+
+ <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>Das aktuelleste kivitendo ERP-Archiv
+ (<filename>kivitendo-erp-*.tgz</filename>) wird dann 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-3.3.0.tgz</programlisting>
+tar xvzf kivitendo-erp-*.tgz</programlisting>
<para>Wechseln Sie in das entpackte Verzeichnis:</para>
Webserverkonfiguration benutzen, um auf das tatsächliche
Installationsverzeichnis zu verweisen.</para>
- <para>Bei einer Neuinstallation von Version 3.1.0 oder später muß das WebDAV Verzeichnis derzeit manuell angelegt werden:</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
- core <constant>apache</constant> oder bei OpenSUSE <constant>wwwrun</constant>).</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
+ <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 "(alpha|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 alpha,
+ 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 ein alter release aus dem wir starten ...
+$ git checkout -b meine_eigene_änderungen # unser lokaler branch - unabhängig von allen anderen
+$ git add templates/mein_druck # das sind unsere druckvorlagen inkl. produktbilder
+$ git commit -m "juhu tolle änderungen"
+
+[meine_aenderungen 1d89e41] juhu tolle ändernungen
+ 4 files changed, 380 insertions(+)
+ create mode 100644 templates/mein_druck/img/webdav/tesla.png
+ create mode 100644 templates/mein_druck/mahnung.tex
+ create mode 100644 templates/mein_druck/zahlungserinnerung_zwei.tex
+ create mode 100644 templates/mein_druck/zahlungserinnerung_zwei_invoice.tex
+
+# 5 Jahre später ...
+# webserver abschalten!
+
+$ git checkout master
+$ git pull # oder git fetch und danach ein stable release tag auswählen (s.o.)
+$ git checkout meine_eigenen_änderungen
+$ git rebase master
+
+Zunächst wird der Branch zurückgespult, um Ihre Änderungen
+darauf neu anzuwenden ...
+Wende an: juhu tolle änderungen
+$ service apache2 restart # webserver starten!
+</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
entsprechend kommentiert sind:</para>
<itemizedlist>
- <listitem><para><literal>authentication</literal> (siehe Abschnitt "<xref
- linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>" in diesem Kapitel)</para></listitem>
-
- <listitem><para><literal>authentication/database</literal></para></listitem>
+ <listitem>
+ <para><literal>authentication</literal> (siehe Abschnitt "<xref
+ linkend="Benutzerauthentifizierung-und-Administratorpasswort"/>"
+ in diesem Kapitel)</para>
+ </listitem>
- <listitem><para><literal>authentication/ldap</literal></para></listitem>
+ <listitem>
+ <para><literal>authentication/database</literal></para>
+ </listitem>
- <listitem><para><literal>system</literal></para></listitem>
+ <listitem>
+ <para><literal>authentication/ldap</literal></para>
+ </listitem>
- <listitem><para><literal>paths</literal></para></listitem>
+ <listitem>
+ <para><literal>system</literal></para>
+ </listitem>
- <listitem><para><literal>mail_delivery</literal> (siehe Abschnitt "<xref linkend="config.sending-email.smtp"/>)</para></listitem>
+ <listitem>
+ <para><literal>paths</literal></para>
+ </listitem>
- <listitem><para><literal>applications</literal></para></listitem>
+ <listitem>
+ <para><literal>mail_delivery</literal> (siehe Abschnitt "<xref
+ linkend="config.sending-email.smtp"/>)</para>
+ </listitem>
- <listitem><para><literal>environment</literal></para></listitem>
+ <listitem>
+ <para><literal>applications</literal></para>
+ </listitem>
+ <listitem>
+ <para><literal>environment</literal></para>
+ </listitem>
- <listitem><para><literal>print_templates</literal></para></listitem>
+ <listitem>
+ <para><literal>print_templates</literal></para>
+ </listitem>
- <listitem><para><literal>task_server</literal></para></listitem>
+ <listitem>
+ <para><literal>task_server</literal></para>
+ </listitem>
- <listitem><para><literal>periodic_invoices</literal></para></listitem>
+ <listitem>
+ <para><literal>periodic_invoices</literal></para>
+ </listitem>
- <listitem><para><literal>self_tests</literal></para></listitem>
+ <listitem>
+ <para><literal>self_tests</literal></para>
+ </listitem>
- <listitem><para><literal>console</literal></para></listitem>
+ <listitem>
+ <para><literal>console</literal></para>
+ </listitem>
- <listitem><para><literal>testing</literal></para></listitem>
+ <listitem>
+ <para><literal>testing</literal></para>
+ </listitem>
- <listitem><para><literal>testing/database</literal></para></listitem>
+ <listitem>
+ <para><literal>testing/database</literal></para>
+ </listitem>
- <listitem><para><literal>debug</literal></para></listitem>
+ <listitem>
+ <para><literal>debug</literal></para>
+ </listitem>
</itemizedlist>
<para>Die üblicherweise wichtigsten Parameter, die am Anfang
port = 5432
db = kivitendo_auth
user = postgres
-password =</programlisting>
-
- <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>
+password =
- <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. Der Taskserver benötigt zwei Konfigurationseinstellungen, die unter
- <varname>[task_server]</varname> anzugeben sind: ein Mandant (entweder der Mandantenname oder eine Datenbank-ID, Variable
- <varname>client</varname>), aus dem die Datenbankkonfiguration entnommen wird, sowie ein Login (Variable <varname>login</varname>)
- eines Benutzers, der für gewisse Dinge wie die Rechnungserstellung als Verkäufer eingetragen wird.</para>
+[system]
+default_manager = german</programlisting>
- <para>Für Entwickler finden sich unter <varname>[debug]</varname>
- wichtige Funktionen, um die Fehlersuche zu erleichtern.</para>
- </sect2>
+ <para>Für kivitendo Installationen in der Schweiz sollte hier
+ <varname>german</varname> durch <varname>swiss</varname> ersetzt
+ werden.</para>
- <sect2 id="config.config-file.prior-versions">
- <title>Versionen vor 2.6.3</title>
+ <para>Die Einstellung <varname>default_manager = swiss</varname>
+ bewirkt:</para>
- <para>In älteren kivitendo Versionen gab es im Verzeichnis
+ <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>kivitendo bringt eine eigene Komponente zur zeitgesteuerten
+ Ausführung bestimmter Aufgaben mit, den <link
+ linkend="config.task-server">Task-Server</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>
+ </sect2>
+
+ <sect2 id="config.config-file.prior-versions">
+ <title>Versionen vor 2.6.3</title>
+
+ <para>In älteren kivitendo Versionen gab es im Verzeichnis
<filename>config</filename> die Dateien
<filename>authentication.pl</filename> und
<filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es
<title>Anpassung der PostgreSQL-Konfiguration</title>
<para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
-
+ <para>Dies variert je nach eingesetzter Distribution, da distributionsabhängig unterschiedliche Strategien beim Upgrade der Postgres Version eingesetzt werden.
+ Als Hinweis einige Links zu den drei Distribution (Stand Dezember 2018):</para>
+ <itemizedlist>
+ <listitem>
+ <para><ulink url="https://fedoraproject.org/wiki/PostgreSQL">Fedora (Postgres-Installation unter Fedora)</ulink></para>
+ </listitem>
+ <listitem>
+ <para><ulink url="https://help.ubuntu.com/lts/serverguide/postgresql.html">Ubuntu (Infos für Postgres für die aktuelle LTS Version)</ulink></para>
+ </listitem>
+ <listitem>
+ <para><ulink url="https://de.opensuse.org/PostgreSQL">OpenSuSE (aktuell nur bis Version OpenSuSE 13 verifiziert)</ulink></para>
+ </listitem>
+ </itemizedlist>
<sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
<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>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>
+ <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
<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 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>
+ 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>
Unterstützung für servergespeicherte Prozeduren eingerichet werden.
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>
+psql template1</programlisting> führen Sie die folgenden Kommandos aus:</para>
<programlisting>CREATE EXTENSION IF NOT EXISTS plpgsql;
\q</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';
+ <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="Erweiterung-für-trigram">
+ <title>Erweiterung für Trigram Prozeduren</title>
+
+ <para>Ab Version 3.5.1 wird die Trigram-Index-Erweiterung benötigt.
+ Diese wird mit dem SQL-Updatescript
+ sql/Pg-upgrade2/trigram_extension.sql und Datenbank-Super-Benutzer
+ Rechten automatisch installiert. Dazu braucht der
+ DatenbankSuperbenutzer "postgres" ein Passwort.</para>
+
+ <programlisting>su - postgres
+psql
+\password postgres
+
+Eingabe Passwort
\q</programlisting>
- </note>
+ <para>Benutzername Postgres und Passwort können jetzt beim Anlegen
+ einer Datenbank bzw. bei Updatescripten, die SuperuserRechte
+ benötigen, eingegeben werden.</para>
+
+ <note>
+ <para><literal>pg_trgm</literal> ist je nach Distribution nicht im
+ Standard-Paket von Postgres enthalten. Ein <programlisting>select * from pg_available_extensions where name ='pg_trgm';</programlisting>
+ in template1 sollte entsprechend erfolgreich sein. Andernfalls muss
+ das Paket nachinstalliert werden, bspw. bei debian/ubuntu
+ <programlisting>apt install postgresql-contrib</programlisting></para>
+ </note>
</sect2>
<sect2 id="Datenbankbenutzer-anlegen">
anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
können:</para>
- <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
+ <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
</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>
+
+ <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
<itemizedlist>
<listitem>
- <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
+ <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
</listitem>
-
<listitem>
- <para>Apache 2.2.11 / 2.2.22 (Ubuntu) und mod_fastcgi.</para>
+ <para>Apache 2.4.18 (Ubuntu 16.04 LTS) und mod_fcgid</para>
</listitem>
-
<listitem>
- <para>Apache 2.4.7 (Ubuntu 14.04.2 LTS) und mod_fcgid.</para>
+ <para>Apache 2.4.29 (Ubuntu 18.04 LTS) und mod_fcgid</para>
+ </listitem>
+ <listitem>
+ <para>Apache 2.4.41 (Ubuntu 20.04 LTS) und mod_fcgid</para>
</listitem>
- </itemizedlist>
- <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
- Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
- mod_fastcgi nicht mehr explizit eingegangen.</para>
+ </itemizedlist>
<para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
verwendet.</para>
<warning>
- <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>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 <ulink url="http://www.cpan.org">CPAN</ulink> 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>
<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>
<warning>
- <para>Im Vergleich zu Apache 2.2 hat sich in Apache 2.4 die Syntax der Directorydirektiven verändert. Statt</para>
- <programlisting>
+ <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> muß man jetzt Folgendes einstellen:</para>
- <programlisting>Require all granted</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
<programlisting>FcgidMaxRequestLen 10485760</programlisting>
-
<para>Das Ganze sollte dann so aussehen:</para>
<programlisting>AddHandler fcgid-script .fpl
<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>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
FastCGI-Version.</para>
</sect3>
</sect2>
+
+ <sect2>
+ <title>Authentifizierung mittels HTTP Basic Authentication</title>
+
+ <para>
+ Kivitendo unterstützt, dass Benutzerauthentifizierung über den Webserver mittels des »Basic«-HTTP-Authentifizierungs-Schema erfolgt
+ (siehe <ulink url="https://tools.ietf.org/html/rfc7617">RFC 7617</ulink>). Dazu ist es aber nötig, dass der dabei vom Client
+ mitgeschickte Header <constant>Authorization</constant> vom Webserver an Kivitendo über die Umgebungsvariable
+ <constant>HTTP_AUTHORIZATION</constant> weitergegeben wird, was standardmäßig nicht der Fall ist. Für Apache kann dies über die
+ folgende Konfigurationsoption aktiviert werden:
+ </para>
+
+ <programlisting>SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1</programlisting>
+ </sect2>
+ <sect2>
+ <title>Aktivierung von mod_rewrite/directory_match für git basierte Installationen</title>
+
+ <para>
+ Aufgrund von aktuellen (Mitte 2020) Sicherheitswarnungen für git basierte Webanwendungen ist die mitausgelieferte .htaccess
+ restriktiver geworden und verhindert somit das Auslesen von git basierten Daten.
+ Für debian/ubuntu muss das Modul mod_rewrite einmalig so aktiviert werden:
+ <programlisting>a2enmod rewrite</programlisting>
+ Alternativ und für Installationen ohne Apache ist folgender Artikel interessant:
+ <ulink url="https://www.cyberscan.io/blog/git-luecke">git-lücke</ulink>.
+ Anstelle des dort beschriebenen DirectoryMatch für Apache2 würden wir etwas weitergehend auch noch das Verzeichnis config miteinbeziehen
+ sowie ferner auch die Möglichkeit nicht ausschließen, dass es in Unterverzeichnissen auch noch .git Repositories geben kann.
+ Die Empfehlung für Apache 2.4 wäre damit:
+ <programlisting>
+ <DirectoryMatch "/(\.git|config)/">
+ Require all denied
+ </DirectoryMatch></programlisting>
+ </para>
+ </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></para>
+
+ <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>
+ <sect2>
+ <title>Aktivierung von Apache2 modsecurity</title>
+
+ <para>Aufgrund des OpenSource Charakters ist kivitendo nicht "out of the box" sicher.
+ Organisatorisch empfehlen wir hier die enge Zusammenarbeit mit einem kivitendo Partner der auch in der
+Lage ist weiterführende Fragen in Bezug auf Datenschutz und Datensicherheit zu beantworten.
+Unabhängig davon empfehlen wir im Webserver Bereich die Aktivierung und Konfiguration des Moduls modsecurity für den Apache2, damit
+XSS und SQL-Injections verhindert werden.</para>
+<para> Als Idee hierfür sei dieser Blog-Eintrag genannt:
+<ulink url="https://doxsec.wordpress.com/2017/06/11/using-modsecurity-web-application-firewall-to-prevent-sql-injection-and-xss-using-blocking-rules/">
+ Test Apache2 modsecurity for SQL Injection</ulink>.</para>
</sect2>
+
</sect1>
<sect1 id="config.task-server">
<title>Der Task-Server</title>
- <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 u.a. für die Erzeugung der wiederkehrenden
- Rechnungen und weitere essenzielle Aufgaben benutzt.</para>
+ <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 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 Task-Server als Perlscript läuft, wird Arbeitsspeicher, der
+ einmal benötigt wurde, nicht mehr an das Betriebssystem zurückgegeben,
+ solange der Task-Server läuft. Dies kann dazu führen, dass ein länger
+ laufender Task-Server mit der Zeit immer mehr Arbeitsspeicher für sich
+ beansprucht. Es ist deshalb sinnvoll, dass der Task-Server in
+ regelmässigen Abständen neu gestartet wird. Allerdings berücksichtigt der
+ Task-Server ein Memory-Limit, wenn dieses in der Konfigurationsdatei
+ angegeben ist. Bei Überschreiten dieses Limits beendet sich der
+ Task-Server. Sofern der Task-Server als systemd-Service mit dem
+ mitgelieferten Skript eingerichtet wurde, startet dieser danach
+ automatisch erneut.</para>
<sect2 id="Konfiguration-des-Task-Servers">
<title>Verfügbare und notwendige Konfigurationsoptionen</title>
Optionen sind:</para>
<variablelist>
- <varlistentry>
- <term><varname>client</varname></term>
-
- <listitem>
- <para>Name oder Datenbank-ID eines vorhandenen kivitendo-Mandanten, der benutzt wird, um die zu verwendende
- Datenbankverbindung auszulesen. Der Mandant muss in der Administration angelegt werden. Diese Option muss angegeben
- werden.</para>
-
- <para>Diese Option kam mit Release v3.x.0 hinzu und muss daher in Konfigurationen, die von älteren Versionen aktualisiert
- wurden, ergänzt werden.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><varname>login</varname></term>
-
- <listitem>
- <para>gültiger kivitendo-Benutzername, der z.B. als Verkäufer beim Erzeugen wiederkehrender Rechnungen benötigt wird. 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, ältere OpenSUSE, ältere 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-task-server</filename>
<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>Ältere OpenSUSE und ältere Fedora Core:</para>
+ <para>Ältere openSUSE und ältere Fedora:</para>
<programlisting>chkconfig --add kivitendo-task-server</programlisting>
</listitem>
</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>
</sect3>
<sect3>
- <title>systemd-basierende Systeme (z.B. neure OpenSUSE, neuere Fedora Core)</title>
+ <title>systemd-basierende Systeme (z.B. neure openSUSE, neuere
+ Fedora, neuere Ubuntu und neuere Debians)</title>
- <para>Verlinken 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 (Zeile
- <literal>ExecStart=....</literal> und <literal>ExecStop=...</literal>). Binden Sie das Script in den Boot-Prozess ein.
- </para>
+ <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>Alle hierzu benötigten Befehle sehen so aus:</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>cd /var/www/kivitendo-erp/scripts/boot/systemd
-ln -s $(pwd)/kivitendo-task-server.service /etc/systemd/system/</programlisting>
+ <programlisting>systemctl daemon-reload
+systemctl enable kivitendo-task-server.service</programlisting>
- <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet
- werden:</para>
+ <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>
+
+ <para>Ein so eingerichteter Task-Server startet nach Beendigung
+ automatisch erneut. Das betrifft eine Beendigung über die Oberfläche,
+ eine Beendingung über die Prozesskontrolle und eine Beendigung bei
+ Überschreiten des Memory-Limits. Soll der Task-Server nicht erneut
+ starten, so können Sie ihn mit folgendem Befehl stoppen:</para>
+
+ <programlisting>systemctl stop kivitendo-task-server.service</programlisting>
+
</sect3>
</sect2>
<para>Dieselben Optionen können auch für die SystemV-basierenden
Runlevel-Scripte benutzt werden (siehe oben).</para>
- </sect2>
- <sect2 id="Prozesskontrolle2">
- <title>Task-Server mit mehreren Mandanten</title>
-
- <para>Beim Task-Server werden der zu verwendende Mandant und Login-Name des Benutzers, unter dem der Task-Server laufen soll, in die
- Konfigurationsdatei geschrieben. Hat man mehrere Mandanten, muss man auch mehrere Konfigurationsdateien anlegen.</para>
-
- <para>Die Konfigurationsdatei ist eine Kopie der Datei kivitendo.conf, wo in der Kategorie <varname>[task_server]</varname> die
- gewünschten Werte für <varname>client</varname> und <varname>login</varname> eingetragen werden.</para>
- <para>Der alternative Task-Server wird dann mit folgendem Befehl
- gestartet:</para>
+ <para>Wurde der Task-Server als systemd-Service eingerichtet (s.o.),
+ so startet dieser nach Beendigung automatisch erneut.</para>
- <programlisting>./scripts/task_server.pl -c config/DATEINAME.conf</programlisting>
</sect2>
- </sect1>
+ <sect2 id="Tasks-konfigurieren">
+ <title>Exemplarische Konfiguration eines Hintergrund-Jobs, der die Jahreszahl in allen Nummernkreisen zum Jahreswechsel erhöht</title>
+ <para>Hintergrund-Jobs werden über System -> Hintergrund-Jobs und Task-Server -> Aktuelle Hintergrund-Jobs anzeigen -> Aktions-Knopf 'erfassen' angelegt. </para>
+ <para>Nachdem wir über das Menü dort angelangt sind, legen wir unseren exemplarischen Hintergrund-Jobs "Erhöhung der Nummernkreise" mit folgenden Werten an:</para>
+ <itemizedlist>
+ <listitem>
+ <para><literal>Aktiv:</literal> Hier ein 'Ja' auswählen</para>
+ </listitem>
+ <listitem>
+ <para><literal>Ausführungsart:</literal> 'wiederholte Ausführung' auswählen</para>
+ </listitem>
+ <listitem>
+ <para><literal>Paketname:</literal> 'SetNumberRange' auswählen</para>
+ </listitem>
+ <listitem>
+ <para><literal>Ausführungszeitplan:</literal> Hier entsprechend Werte wie in der crontab eingeben.</para><para>Syntax:</para>
+<programlisting>* * * * *
+┬ ┬ ┬ ┬ ┬
+│ │ │ │ │
+│ │ │ │ └──── Wochentag (0-7, Sonntag ist 0 oder 7)
+│ │ │ └────── Monat (1-12)
+│ │ └──────── Tag (1-31)
+│ └────────── Stunde (0-23)
+└──────────── Minute (0-59) </programlisting>
+ <para>Die Sterne können folgende Werte haben:</para>
+ <programlisting>
+1 2 3 4 5
+
+1 = Minute (0-59)
+2 = Stunde (0-23)
+3 = Tag (0-31)
+4 = Monat (1-12)
+5 = Wochentag (0-7, Sonntag ist 0 oder 7)
+</programlisting>
+<para>Um die Ausführung auf eine Minute vor Sylvester zu setzen, müssen die folgenden Werte eingetragen werden:</para>
+<programlisting>59 23 31 12 *</programlisting>
+ </listitem>
+ <listitem>
+ <para><literal>Daten:</literal>In diesem Feld können optionale Parameter für den Hintergrund im JSON-Format gesetzt werden. Der Hintergrund-Job <literal>SetNumberRange</literal> akzeptiert zwei Variable nämlich <literal>digit_year</literal> sowieso <literal>multiplier</literal>.</para><para> <literal>digit_year</literal> kann zwei Werte haben entweder 2 oder 4, darüber wird gesteuert ob die Jahreszahl zwei oder vierstellig kodiert wird (für 2019, dann entweder 19 oder 2019). Der Standardwert ist vierstellig.</para><para> <literal>multiplier</literal> ist ein Vielfaches von 10, darüber wird die erste Nummer im Nummernkreis (die Anzahl der Stellen) wie folgt bestimmt:</para>
+<programlisting>
+multiplier Nummernkreis 2020
+10 -> 20200
+100 -> 202000
+1000 -> 2020000
+</programlisting>
+<para>Wir gehen jetzt beispielhaft von einer letzten Rechnungsnummer von RE2019456 aus. Demnach sollte ab Januar 2020 die erste Nummer RE2020001 sein. Da der Task auch Präfixe berücksichtigt, kann dies mit folgenden JSON-kodierten Werten umgesetzt werden:</para>
+<para><literal>Daten:</literal></para><programlisting>multiplier: 100
+digits_year: 4</programlisting>
+ </listitem>
+ </itemizedlist>
+ </sect2>
+ </sect1>
<sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
<title>Benutzerauthentifizierung und Administratorpasswort</title>
Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
abgelegt werden.</para>
- <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter
- entweder gegen die Authentifizierungsdatenbank oder gegen einen
- LDAP-Server überprüft werden.</para>
+ <para>Zusätzlich ermöglicht es kivitendo, dass die Benutzerpasswörter gegen die Authentifizierungsdatenbank oder gegen einen oder
+ mehrere LDAP-Server überprüft werden.</para>
<para>Welche Art der Passwortüberprüfung kivitendo benutzt und wie
kivitendo die Authentifizierungsdatenbank erreichen kann, wird in der
<sect2 id="Administratorpasswort">
<title>Administratorpasswort</title>
- <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>
+ <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">
<title>Passwortüberprüfung</title>
<para>kivitendo unterstützt Passwortüberprüfung auf zwei Arten: gegen
- die Authentifizierungsdatenbank und gegen einen externen LDAP- oder
+ die Authentifizierungsdatenbank und gegen externe LDAP- oder
Active-Directory-Server. Welche davon benutzt wird, regelt der
Parameter <varname>module</varname> im Abschnitt
<varname>[authentication]</varname>.</para>
- <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 Passwörter in
- kivitendo ändern.</para>
+ <para>Dieser Parameter listet die zu verwendenden Authentifizierungsmodule auf. Es muss mindestens ein Modul angegeben werden, es
+ können aber auch mehrere angegeben werden. Weiterhin ist es möglich, das LDAP-Modul mehrfach zu verwenden und für jede Verwendung
+ eine unterschiedliche Konfiguration zu nutzen, z.B. um einen Fallback-Server anzugeben, der benutzt wird, sofern der Hauptserver
+ nicht erreichbar ist.</para>
+
+ <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank geprüft werden, so muss der Parameter
+ <varname>module</varname> das Modul <literal>DB</literal> enthalten. Sofern das Modul in der Liste enthalten ist, egal an welcher
+ Position, können sowohl der Administrator als auch die Benutzer selber ihre Passwörter in kivitendo ändern.</para>
+
+ <para>Wenn Passwörter gegen einen oder mehrere externe LDAP- oder Active-Directory-Server geprüft werden, so muss der Parameter
+ <varname>module</varname> den Wert <literal>LDAP</literal> enthalten. In diesem Fall müssen zusätzliche Informationen über den
+ LDAP-Server im Abschnitt <literal>[authentication/ldap]</literal> angegeben werden. Das Modul kann auch mehrfach angegeben werden,
+ wobei jedes Modul eine eigene Konfiguration bekommen sollte. Der Name der Konfiguration wird dabei mit einem Doppelpunkt getrennt an
+ den Modulnamen angehängt (<literal>LDAP:Name-der-Konfiguration</literal>). Der entsprechende Abschnitt in der Konfigurationsdatei
+ lautet dann <literal>[authentication/Name-der-Konfiguration]</literal>.</para>
- <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
- benutzt werden, so muss der Parameter <varname>module</varname> auf
- <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen
- zusätzliche Informationen über den LDAP-Server im Abschnitt
- <literal>[authentication/ldap]</literal> angegeben werden:</para>
+ <para>Die verfügbaren Parameter für die LDAP-Konfiguration lauten:</para>
<variablelist>
<varlistentry>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><literal>verify</literal></term>
+
+ <listitem>
+ <para>Wenn Verbindungsverschlüsselung gewünscht und der Parameter <parameter>tls</parameter> gesetzt ist, so gibt dieser
+ Parameter an, ob das Serverzertifikat auf Gültigkeit geprüft wird. Mögliche Werte sind <literal>require</literal> (Zertifikat
+ wird überprüft und muss gültig sei; dies ist der Standard) und <literal>none</literal> (Zertifikat wird nicht
+ überpfüft).</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><literal>attribute</literal></term>
also ‘<literal>Martin Mustermann</literal>’.</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><literal>timeout</literal></term>
+
+ <listitem>
+ <para>Timeout beim Verbindungsversuch, bevor der Server als nicht erreichbar gilt; Standardwert: 10</para>
+ </listitem>
+ </varlistentry>
</variablelist>
</sect2>
<sect1 id="Benutzer--und-Gruppenverwaltung">
<title>Mandanten-, Benutzer- und Gruppenverwaltung</title>
- <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>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/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
<sect2 id="Zusammenhänge">
<title>Zusammenhänge</title>
- <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>
+ <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>
+ <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>
Anlegen können Sie die verschiedenen Bereiche wählen, auf die
Mitglieder dieser Gruppe Zugriff haben sollen.</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>
+ <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">
<title>Benutzer anlegen</title>
- <para>Beim Anlegen von Benutzern werden für viele Parameter Standardeinstellungen vorgenommen, die den Gepflogenheiten des deutschen
- Raumes entsprechen.</para>
+ <para>Beim Anlegen von Benutzern werden für viele Parameter
+ Standardeinstellungen vorgenommen, die den Gepflogenheiten des
+ deutschen Raumes entsprechen.</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
+ <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>
+ <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>
<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>
+ <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>
+
<sect1 id="Drucker--Systemverwaltung">
<title>Drucker- und Systemverwaltung</title>
- <para>Im Administrationsmenü gibt es ferner noch die beiden Menüpunkte Druckeradministration und System.</para>
+
+ <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>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>
+
<sect2 id="System">
<title>System sperren / entsperren</title>
- <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>
- <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>
+ <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>
- <sect1 id="config.sending-email" xreflabel="E-Mail-Versand aus kivitendo heraus">
- <title>E-Mail-Versand aus kivitendo heraus</title>
+ <para>Falls die Sperre gesetzt ist, erscheint anstelle der
+ Anmeldemaske die Information: 'kivitendo ist momentan zwecks
+ Wartungsarbeiten nicht zugänglich.'.</para>
- <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>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>
- <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>
+ <sect1 id="config.sending-email"
+ xreflabel="E-Mail-Versand aus kivitendo heraus">
+ <title>E-Mail-Versand aus kivitendo heraus</title>
- <sect2 id="config.sending-email.sendmail" xreflabel="E-Mail-Versand über lokalen E-Mail-Server">
+ <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>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
+ <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
+ <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>
+ <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="config.sending-email.smtp" xreflabel="E-Mail-Versand über einen SMTP-Server">
+ <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>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
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
-
- <para>Wird Verschlüsselung über TLS oder SSL aktiviert, so werden zusätzliche Perl-Module benötigt. Diese sind:</para>
-
- <itemizedlist>
- <listitem><para>TLS-Verschlüsselung: Modul <literal>Net::SSLGlue</literal> (Debian-Paketname
- <literal>libnet-sslglue-perl</literal>, Fedora Core: <literal>perl-Net-SSLGlue</literal>, openSUSE:
- <literal>perl-Net-SSLGlue</literal></para></listitem>
-
- <listitem><para>SSL-Verschlüsselung: Modul <literal>Net::SMTP::SSL</literal> (Debian-Paketname
- <literal>libnet-smtp-ssl-perl</literal>, Fedora Core: <literal>perl-Net-SMTP-SSL</literal>, openSUSE:
- <literal>perl-Net-SMTP-SSL</literal></para></listitem>
- </itemizedlist>
</sect2>
</sect1>
<sect1 id="Drucken-mit-kivitendo">
<title>Drucken mit kivitendo</title>
- <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 installiert man
- die Pakete mit:</para>
+ <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 installiert man die Pakete mit:</para>
- <para><programlisting>aptitude install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
- texlive-latex-extra texlive-lang-german texlive-generic-extra</programlisting></para>
+ <para><programlisting>apt install texlive-base-bin texlive-latex-recommended texlive-fonts-recommended \
+ texlive-latex-extra texlive-lang-german ghostscript</programlisting></para>
- <para>TODO: RPM-Pakete.</para>
+ <para>Für Fedora benötigen Sie die folgenden Pakete:</para>
+ <para><programlisting>dnf install texlive-collection-latex texlive-collection-latexextra \
+ texlive-collection-latexrecommended texlive-collection-langgerman \
+ texlive-collection-langenglish</programlisting></para>
+
+ <para>Für openSUSE benötigen Sie die folgenden Pakete:</para>
+
+ <para><programlisting>zypper install texlive-collection-latex texlive-collection-latexextra \
+ texlive-collection-latexrecommended texlive-collection-langgerman \
+ texlive-collection-langenglish</programlisting></para>
+
+ <note><para>kivitendo erwartet eine aktuelle TeX Live Umgebung, um PDF/A zu erzeugen. Aktuelle Distributionen von 2020 erfüllen diese. Überprüfbar ist dies mit dem Aufruf des installation_check.pl mit Parameter -l:</para><para><programlisting>scripts/installations_check.pl -l</programlisting></para></note>
<para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
+
<itemizedlist>
- <listitem><para>RB</para></listitem>
- <listitem><para>f-tex</para></listitem>
- <listitem><para>rev-odt</para></listitem>
+ <listitem>
+ <para>RB</para>
+ </listitem>
+ <listitem>
+ <para>marei</para>
+ </listitem>
+ <listitem>
+ <para>rev-odt</para>
+ </listitem>
</itemizedlist>
- <para>Der ehemalige Druckvorlagensatz "Standard" wurde mit der Version 3.3 entfernt, da er nicht mehr gepflegt wurde.</para>
+ <para>Der ehemalige Druckvorlagensatz "f-tex" wurde mit der Version
+ 3.5.6 entfernt, da er nicht mehr gepflegt wird.</para>
- <sect2 id="Vorlagenverzeichnis-anlegen" xreflabel="Vorlagenverzeichnis anlegen">
+ <sect2 id="Vorlagenverzeichnis-anlegen"
+ xreflabel="Vorlagenverzeichnis anlegen">
<title>Vorlagenverzeichnis anlegen</title>
- <para>Es lässt sich ein initialer Vorlagensatz erstellen. Die LaTeX-System-Abhängigkeiten hierfür kann man prüfen mit:</para>
+
+ <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>
+ <para>Der Angemeldete Benutzer muss in einer Gruppe sein, die über das
+ Recht "Konfiguration -> Mandantenverwaltung" verfügt. Siehe auch
+ <xref linkend="Gruppen-anlegen"/>.</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>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>
- <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>
+ <orderedlist>
+ <listitem>
+ <para><option>Vorlagen auswählen</option>: Wählen Sie hier den
+ Vorlagensatz aus, der kopiert werden soll
+ (<filename>RB</filename>, <filename>marei</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>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>
+ 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>
+ <itemizedlist>
+ <listitem>
+ <para>Mehrsprachenfähig, mit Deutscher und Englischer
+ Übersetzung</para>
+ </listitem>
- <para>Ein Vorlagensatz, der in wenigen Minuten alle Dokumente zur Verfügung stellt.</para>
+ <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>
- <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>mehrere vordefinierte Varianten für
+ Logos/Hintergrundbilder</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>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder
+ "Außerhalb EU"</para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
- <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>
+ <sect2 id="Vorlagen-rev-odt">
+ <title>Der Druckvorlagensatz rev-odt</title>
- <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>
+ <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>
- <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>
+ <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>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>für jede Rechnung muss eine eigene Mahnung erzeugt werden
+ (auch wenn bei einzelnen KundInnen mehrere überfällige Rechnungen
+ vorhanden sind).</para>
+ </listitem>
+ </itemizedlist>
- <listitem><para>Multisprachfähig leicht um weitere Sprachen zu erweitern, alle Übersetzungen in der Datei
- <filename>translatinos.tex</filename>.</para></listitem>
+ <para>Mehrere Mahnungen für eine Kundin / einen Kunden werden zu einer
+ PDF-Datei zusammengefasst</para>
- <listitem><para>Auflistung von Bruttopreisen für Endverbraucher.</para></listitem>
- </itemizedlist>
- </sect3>
+ <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>
- <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>
+ <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>
- <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>Fehlermeldungen, Anregungen und Wünsche bitte senden an:
+ empfang@revamp-it.ch</para>
+ </sect2>
- <para>oder etwas detaillierter:</para>
+ <sect2 id="allgemeine-hinweise-zu-latex">
+ <title>Allgemeine Hinweise zu LaTeX Vorlagen</title>
- <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>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>
- <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>
+ <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>
- <para>
- Letzlich muss <filename>letter_head.pdf</filename> auf das passende Hintergrund-PDF verweisen, welches gewünschten Briefkopf
- enthält.
- </para>
+ <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>
- 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>
-Zur Zeit gibt es in kivitendo noch keine Möglichkeit, odt-Vorlagen bei Mahnungen
-einzusetzen. Entsprechende Vorlagen sind deshalb nicht vorhanden.
-</para>
-<para>
-Inwieweit es möglich ist, für die in Version 3.2.0 neu eingeführten Pflichtenhefte
-odt-Vorlagen zu erstellen, sind wir am abklären.
-Wenn dies möglich ist, werden wir in Zukunft auch eine odt-Vorlage für Pflichtenhefte
-in diesem Vorlagensatz zur Verfügung stellen.
-</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:
+ <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>
+ <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>
+ <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>
+ <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>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>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>
<title>OpenDocument-Vorlagen</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-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
<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>
+ 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> 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>
+ <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
- 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>
+ 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 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 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>
+ <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 OpenOffice neu gestartet und die Konvertierung
- mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
- Dokumentenvorlage enthalten sein und
+ 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/mastertemplates/German/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.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>
-
- <para><literal>mv users/.openoffice.org2
- users/.openoffice</literal></para>
+ ‘<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>
- </sect1>
+ linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber erneut
+ überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.</para>
- <sect1 id="config.eur">
- <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
- EUR</title>
+ <sect2>
+ <title>OpenDocument (odt) Druckvorlagen mit Makros</title>
- <sect2 id="config.eur.introduction"
- xreflabel="Einführung in die Konfiguration zur EUR">
- <title>Einführung</title>
+ <para>OpenDocument Vorlagen können Makros enthalten, welche komplexere
+ Aufgaben erfüllen.</para>
- <para>kivitendo besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
- 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>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>
- <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
- die Mandantendatenbank verschoben und dabei auch gleich in drei
- Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
- steuern lässt.</para>
- </sect2>
+ <sect3>
+ <title>Bezeichnung der Vorlagen</title>
- <sect2 id="config.eur.parameters"
- xreflabel="Konfigurationsparameter für EUR">
- <title>Konfigurationsparameter</title>
+ <para>Rechnung: invoice_besr.odt, Auftrag:
+ sales_order_besr.odt</para>
+ </sect3>
- <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
- Versteuerungsart und die Warenbuchungsmethode regeln:</para>
+ <sect3 id="opendocument-druckvorlagen-mit-makros.vorbereitungen">
+ <title>Vorbereitungen im Adminbereich</title>
- <variablelist>
- <varlistentry>
- <term><varname>profit_determination</varname></term>
+ <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>Dieser Parameter legt die Berechnungsmethode für die
- Gewinnermittlung fest. Er enthält entweder
- <literal>balance</literal> für
- Betriebsvermögensvergleich/Bilanzierung oder
- <literal>income</literal> für die
- Einnahmen-Überschuss-Rechnung.</para>
+ <para>Druckeradministration → Drucker hinzufügen</para>
</listitem>
- </varlistentry>
-
- <varlistentry>
- <term><varname>accounting_method</varname></term>
<listitem>
- <para>Dieser Parameter steuert die Buchungs- und
- Berechnungsmethoden für die Versteuerungsart. Er enthält
- entweder <literal>accrual</literal> für die Soll-Versteuerung
- oder <literal>cash</literal> für die Ist-Versteuerung.</para>
+ <para>Mandant wählen</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term><varname>inventory_system</varname></term>
+ <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>Dieser Parameter legt die Warenbuchungsmethode fest. Er
- enthält entweder <literal>perpetual</literal> für die
- Bestandsmethode oder <literal>periodic</literal> für die
- Aufwandsmethode.</para>
+ <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>
- </varlistentry>
- </variablelist>
- <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
- <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
- Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
- bedeutete hingegen Bilanzierung, Soll-Versteuerung und
- Bestandsmethode.</para>
+ <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>
- <para>Die Konfiguration "<varname>eur</varname>" unter
- <varname>[system]</varname> in der <link
- linkend="config.config-file">Konfigurationsdatei</link>
- <filename>config/kivitendo.conf</filename> wird nun nicht mehr
- benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
- </sect2>
+ <listitem>
+ <para>speichern</para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
- <sect2 id="config.eur.setting-parameters">
- <title>Festlegen der Parameter</title>
+ <sect3>
+ <title>Benutzereinstellungen</title>
- <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
- der Admininstration können diese Optionen nun unabhängig voneinander
- eingestellt werden.</para>
+ <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>
- <para>Beim Upgrade bestehender Mandanten wird eur ausgelesen und die
- Variablen werden so gesetzt, daß sich an der Funktionalität nichts
- ändert.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Programm → Benutzereinstellungen → Druckoptionen</para>
+ </listitem>
- <para>Die aktuelle Konfiguration wird unter Nummernkreise und
- 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>
+ <listitem>
+ <para>Standardvorlagenformat → OpenDocument/OASIS</para>
+ </listitem>
- <sect2 id="config.eur.inventory-system-perpetual">
- <title>Bemerkungen zur Bestandsmethode</title>
+ <listitem>
+ <para>Standardausgabekanal → Bildschirm</para>
+ </listitem>
- <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
- funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
- Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
- werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
- anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
- der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
- Einkaufsrechnungen berechnet wird.</para>
+ <listitem>
+ <para>Standarddrucker → gewünschte Druckerbeschreibung auswählen
+ (z.B. mit Einzahlungsschein Bank xy)</para>
+ </listitem>
- <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
- wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
- im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
- wechseln.</para>
- </sect2>
+ <listitem>
+ <para>Anzahl Kopien → leer</para>
+ </listitem>
- <sect2 id="config.eur.knonw-issues">
- <title>Bekannte Probleme</title>
+ <listitem>
+ <para>speichern</para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
- <para>Bei bestimmten Berichten kann man derzeit noch inviduell
- einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
- werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
- Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
- die Konfigurationsvariable
- <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
- wurde.</para>
+ <sect3>
+ <title>Aufbau und nötige Anpassungen der Vorlagen</title>
- <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
- Optionen bewirken, z.B. mit zwei Standardfällen.</para>
- </sect2>
- </sect1>
+ <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>
- <sect1 id="config.skr04-update-3804">
- <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
+ <itemizedlist>
+ <listitem>
+ <para>Für den Einzahlungsschein ist die letzte Seite des
+ Dokuments reserviert</para>
+ </listitem>
- <sect2 id="config.skr04-update-3804.introduction">
- <title>Einführung</title>
+ <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>
- <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
- Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
- kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
- erstellt und die Steuereinstellungen korrekt einstellt. Hat der
- Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
- Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
- Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
- vielleicht schon selbst geholfen hat und mit seinen Änderungen
- zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
- ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
- Screenshots dargestellt.</para>
+ <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>
- <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
- USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
- dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
- und diese Buchungen sollten entsprechend kontrolliert werden.</para>
- </sect2>
+ <screenshot>
+ <screeninfo>Rechnungsvorlage Schweizer Bank-Einzahlungsschein - zu
+ ändernde Einträge in rot</screeninfo>
- <sect2 id="config.skr04-update-3804.create-chart">
- <title>Konto 3804 manuell anlegen</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Einzahlungsschein_Makro.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </sect3>
- <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
- erfassen</guimenuitem> das Konto angelegt.</para>
+ <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>
- <screenshot>
- <screeninfo>Konto 3804 erfassen</screeninfo>
+ <sect3>
+ <title>Makroeinstellungen in LibreOffice anpassen</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/skr04-update-3804/konto3804.png" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ <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>
- <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>
+ <itemizedlist>
+ <listitem>
+ <para>Extras → Optionen → Sicherheit → Makrosicherheit</para>
+ </listitem>
- <screenshot>
- <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
+ <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>
- <mediaobject>
- <imageobject>
- <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>
-
- <screenshot>
- <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
+ <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>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/skr04-update-3804/steuer3804.png" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ <sect2>
+ <title>Schweizer QR-Rechnung mit OpenDocument Vorlagen</title>
- <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>
+ <sect3>
+ <title>Übersicht</title>
- <screenshot>
- <screeninfo>Konto 4315 anpassen</screeninfo>
+ <para>Mit der Version 3.6.0 unterstützt Kivitendo die Erstellung von
+ Schweizer QR-Rechnungen gemäss <ulink
+ url="https://www.paymentstandards.ch/dam/downloads/ig-qr-bill-de.pdf">Swiss
+ Payment Standards, Version 2.2</ulink>. Implementiert sind hierbei die
+ Varianten:</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/skr04-update-3804/konto4315.png" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">QR-IBAN mit
+ QR-Referenz</emphasis></para>
+ </listitem>
- <para>
- Als Letztes sollte die Steuerliste unter <guimenu>System</guimenu> -> <guisubmenu>Steuern</guisubmenu> ->
- <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum Vergleich der Screenshot.
- </para>
+ <listitem>
+ <para><emphasis role="bold">IBAN ohne Referenz</emphasis></para>
+ </listitem>
+ </itemizedlist>
- <screenshot>
- <screeninfo>Steuerliste vergleichen</screeninfo>
+ <para>Der Vorlagensatz "rev-odt" enthält die Vorlage
+ <literal>invoice_qr.odt</literal>, welche für die Erstellung von
+ QR-Rechnungen vorgesehen ist. Damit diese verwendet werden kann muss
+ wie obenstehend beschrieben ein Drucker hinzugefügt werden (siehe
+ <xref linkend="opendocument-druckvorlagen-mit-makros.vorbereitungen"/>
+ ). Alternativ kann die Vorlage umbenannt werden in
+ <literal>invoice.odt</literal>.</para>
+
+ <para>Die Vorlage <literal>invoice_qr.odt</literal> kann beliebig
+ angepasst werden. Zwingend muss diese jedoch das QR-Code Platzhalter
+ Bild, als eingebettetes Bild, enthalten. Da dieses beim
+ Ausdrucken/Erzeugen der Rechnung durch das neu generierte QR-Code
+ Bild ersetzt wird.</para>
+ </sect3>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/skr04-update-3804/steuerliste.png" />
- </imageobject>
- </mediaobject>
- </screenshot>
- </sect2>
- </sect1>
- <sect1 id="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.
- </para>
- </sect1>
- <sect1 id="config.client">
- <title>Einstellungen pro Mandant</title>
+ <sect3>
+ <title>Einstellungen</title>
+
+ <sect4>
+ <title>Mandantenkonfiguration</title>
+
+ <para>Unter <emphasis>System → Mandantenkonfiguration →
+ Features</emphasis>. Im Abschnitt <emphasis>Einkauf und
+ Verkauf</emphasis>, beim Punkt <emphasis>Verkaufsrechnungen mit
+ Schweizer QR-Rechnung erzeugen</emphasis>, die gewünschte Variante
+ wählen.</para>
+ </sect4>
+
+ <sect4>
+ <title>Konfiguration der Bankkonten</title>
+
+ <para>Unter <emphasis>System → Bankkonten</emphasis> muss bei
+ mindestens einem Bankkonto die Option <emphasis>Nutzung mit
+ Schweizer QR-Rechnung</emphasis> auf <emphasis
+ role="bold">Ja</emphasis> gestellt werden.</para>
+
+ <tip>
+ <para>Für die Variante <emphasis role="bold">QR-IBAN mit
+ QR-Referenz</emphasis> muss dieses Konto unter IBAN eine gültige
+ <emphasis role="bold">QR-IBAN Nummer</emphasis> enthalten. Diese
+ unterscheidet sich von der regulären IBAN.</para>
+
+ <para>Zusätzlich muss eine gültige <emphasis role="bold">Bankkonto
+ Identifikationsnummer</emphasis> angegeben werden
+ (6-stellig).</para>
+
+ <para>Diese werden von der jeweiligen Bank vergeben.</para>
+ </tip>
+
+ <para>Sind mehrere Konten ausgewählt wird das erste
+ verwendet.</para>
+ </sect4>
+
+ <sect4>
+ <title>Rechnungen ohne Betrag</title>
+
+ <para>Für Rechnungen ohne Betrag (z.B. Spenden) kann, in der
+ jeweiligen Rechnung, die Checkbox <emphasis>QR-Rechnung ohne
+ Betrag</emphasis> aktiviert werden. Diese Checkbox erscheint nur,
+ wenn QR-Rechnungen in der Mandantenkonfiguration aktiviert sind
+ (variante ausgewählt).</para>
+
+ <para>Dies wirkt sich lediglich auf den erzeugten QR-Code aus. Die
+ Vorlage muss separat angepasst und ausgewählt werden.</para>
+ </sect4>
+ </sect3>
- <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>
+ <sect3>
+ <title>Adressdaten</title>
- <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>
+ <para>Die Adressdaten zum Zahlungsempfänger werden aus der
+ Mandantenkonfiguration entnommen. Unter <emphasis>System →
+ Mandantenkonfiguration → Verschiedenes</emphasis>, Abschnitt
+ <emphasis>Firmenname und -adresse.</emphasis></para>
- <sect1 id="kivitendo-ERP-verwenden">
- <title>kivitendo ERP verwenden</title>
+ <para>Die Adressdaten zum Zahlungspflichtigen stammen aus den
+ Kundendaten der jeweiligen Rechnung.</para>
- <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
- folgender URL erreichbar:</para>
+ <para>Die Adressen müssen inklusive Land angegeben werden. Akzeptiert
+ werden Ländername oder Ländercode, also z.B. "Schweiz" oder "CH".
+ </para>
- <para><ulink
- url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
+ <para>Diese können in der Vorlage mit den jeweiligen Variablen
+ eingetragen werden. Siehe auch: <xref
+ linkend="dokumentenvorlagen-und-variablen"/></para>
- <para>Die Administrationsseite erreichen Sie unter:</para>
+ <para>Der erzeugte QR-Code verwendet Adress-Typ "K" (Kombinierte
+ Adressfelder, 2 Zeilen).</para>
+ </sect3>
- <para><ulink
- url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
- </sect1>
- </chapter>
+ <sect3>
+ <title>Referenznummer</title>
- <chapter id="features" xreflabel="Features und Funktionen">
- <title>Features und Funktionen</title>
+ <para>Die Referenznummer wird in Kivitendo erzeugt und setzt sich
+ wiefolgt zusammen:</para>
- <sect1 id="features.periodic-invoices"
- xreflabel="Wiederkehrende Rechnungen">
- <title>Wiederkehrende Rechnungen</title>
+ <itemizedlist>
+ <listitem>
+ <para>Bankkonto Identifikationsnummer (6-stellig)</para>
+ </listitem>
- <sect2 id="features.periodic-invoices.introduction"
- xreflabel="Einführung in wiederkehrende Rechnungen">
- <title>Einführung</title>
+ <listitem>
+ <para>Kundennummer (6-stellig, mit führenden Nullen
+ aufgefüllt)</para>
+ </listitem>
- <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
- und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
- Die konfigurierten Aufträge werden später automatisch in Rechnungen
- umgewandelt, so als ob man den Workflow benutzen würde, und auch die
- Auftragsnummer wird übernommen, sodass alle wiederkehrenden
- Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
- wiederzufinden sind.</para>
- </sect2>
+ <listitem>
+ <para>Auftragsnummer (7-stellig, mit führenden Nullen
+ aufgefüllt)</para>
+ </listitem>
- <sect2 id="features.periodic-invoices.configuration"
- xreflabel="Konfiguration von wiederkehrenden Rechnungen">
- <title>Konfiguration</title>
+ <listitem>
+ <para>Rechnungsnummer (7-stellig, mit führenden Nullen
+ aufgefüllt)</para>
+ </listitem>
- <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
- findet sich beim Bearbeiten des Auftrags ein neuer Knopf
- "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
- Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
- angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
- oder nicht.</para>
+ <listitem>
+ <para>Prüfziffer (1-stellig, berechnet mittels modulo 10,
+ rekursiv)</para>
+ </listitem>
+ </itemizedlist>
- <para>Folgende Parameter kann man konfigurieren:</para>
+ <para>Es sind lediglich Ziffern erlaubt. Allfällige Prefixe mit
+ Buchstaben werden entfernt und fehlende Stellen werden mit führenden
+ Nullen aufgefüllt.</para>
+ </sect3>
- <variablelist>
- <varlistentry>
- <term>Status</term>
+ <sect3>
+ <title>Zusätzliche Variablen für Vorlage</title>
- <listitem>
- <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
- erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang eines
- neuen Monats).</para>
+ <para>Zusätzlich zu den in der Vorlage standardmässig verfügbaren
+ Variablen (siehe <xref linkend="dokumentenvorlagen-und-variablen"/>),
+ werden die folgenden Variablen erzeugt:</para>
- <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
- wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
- nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
- nächsten Periodenwechsel für alle Perioden, seit der letzten
- aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
- verhindern, muss man vorher das Startdatum neu setzen.</para>
+ <variablelist>
+ <varlistentry>
+ <term>ref_number_formatted</term>
- <para>Für gekündigte Aufträge werden nie mehr Rechnungen
- erstellt. Man kann sich diese Aufträge aber gesondert in den
- Berichten anzeigen lassen.</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Referenznummer formatiert mit Leerzeichen, z.B.: 21 00000
+ 00003 13947 14300 09017</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>Periodizität</term>
+ <varlistentry>
+ <term>iban_formatted</term>
- <listitem>
- <para>Ob monatlich, quartalsweise oder jährlich auf neue
- Rechnungen überprüft werden soll. Für jede Periode seit dem
- Startdatum wird überprüft, ob für die Periode (beginnend immer
- mit dem ersten Tag der Periode) schon eine Rechnung erstellt
- wurde. Unter Umständen können bei einem Startdatum in der
- Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>IBAN formatiert mit Leerzeichen</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term>Buchen auf</term>
+ <varlistentry>
+ <term>amount_formatted</term>
- <listitem>
- <para>Das Forderungskonto, in der Regel "Forderungen aus
- Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
- Buchungsgruppen der betreffenden Waren.</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Betrag formatiert mit Tausendertrennzeichen Leerschlag,
+ z.B.: 1 005.55</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
+ </sect2>
+ </sect1>
- <varlistentry>
- <term>Startdatum</term>
+ <sect1 id="nomenclature">
+ <title>Nomenklatur</title>
- <listitem>
- <para>ab welchem Datum auf Rechnungserstellung geprüft werden
- soll</para>
- </listitem>
- </varlistentry>
+ <sect2 id="booking.dates">
+ <title>Datum bei Buchungen</title>
- <varlistentry>
- <term>Enddatum</term>
+ <para>Seit der Version 3.5 werden für Buchungen in kivitendo
+ einheitlich folgende Bezeichnungen verwendet:</para>
- <listitem>
- <para>ab wann keine Rechnungen mehr erstellt werden
- sollen</para>
- </listitem>
- </varlistentry>
+ <itemizedlist>
+ <listitem>
+ <para><option>Erfassungsdatum</option> (en: <option>Entry
+ Date</option>, code: <option>Gldate</option>)</para>
- <varlistentry>
- <term>Automatische Verlängerung um x Monate</term>
+ <para>bezeichnet das Datum, an dem die Buchung in kivitendo
+ erfasst wurde.</para>
+ </listitem>
- <listitem>
- <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
- eingetragenen Enddatums weiterhin erstellt werden, so kann man
- hier die Anzahl der Monate eingeben, um die das Enddatum
- automatisch nach hinten geschoben wird.</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para><option>Buchungsdatum</option> (en: <option>Booking
+ Date</option>, code: <option>Transdate</option>)</para>
- <varlistentry>
- <term>Drucken</term>
+ <para>bezeichnet das buchhaltungstechnisch für eine Buchung
+ relevante Datum</para>
- <listitem>
- <para>Sind Drucker konfiguriert, so kann man sich die erstellten
- Rechnungen auch gleich ausdrucken lassen.</para>
- </listitem>
- </varlistentry>
- </variablelist>
+ <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>
- <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
- Informationen zu den erstellten Rechnungen verschickt werden.
- Konfiguriert wird dies in der <link
- linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
- <filename>config/kivitendo.conf</filename> im Abschnitt
- <varname>[periodic_invoices]</varname>.</para>
+ <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>
- <sect2 id="features.periodic-invoices.variables">
- <title>Spezielle Variablen</title>
+ <sect1 id="config.eur">
+ <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung:
+ EUR</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>
+ <sect2 id="config.eur.introduction"
+ xreflabel="Einführung in die Konfiguration zur EUR">
+ <title>Einführung</title>
- <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>kivitendo besaß bis inklusive Version 2.6.3 einen
+ Konfigurationsparameter namens <varname>eur</varname>, der sich in der
+ 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>
- Diese Variablen werden in den folgenden Elementen des Auftrags ersetzt:
- </para>
+ <para>Mit der nachfolgenden Version wurde der Parameter zum Einen in
+ die Mandantendatenbank verschoben und dabei auch gleich in drei
+ Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer
+ steuern lässt.</para>
+ </sect2>
- <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>
+ <sect2 id="config.eur.parameters"
+ xreflabel="Konfigurationsparameter für EUR">
+ <title>Konfigurationsparameter</title>
- <para>Die zur Verfügung stehenden Variablen sind die Folgenden:</para>
+ <para>Es gibt drei Parameter, die die Gewinnermittlungsart,
+ Versteuerungsart und die Warenbuchungsmethode regeln:</para>
<variablelist>
<varlistentry>
- <term><varname><%current_quarter%></varname>, <varname><%previous_quarter%></varname>, <varname><%next_quarter%></varname></term>
+ <term><varname>profit_determination</varname></term>
<listitem>
- <para>
- Aktuelles, vorheriges und nächstes Quartal als Zahl zwischen <literal>1</literal> und <literal>4</literal>.
- </para>
+ <para>Dieser Parameter legt die Berechnungsmethode für die
+ Gewinnermittlung fest. Er enthält entweder
+ <literal>balance</literal> für
+ Betriebsvermögensvergleich/Bilanzierung oder
+ <literal>income</literal> für die
+ Einnahmen-Überschuss-Rechnung.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname><%current_month%></varname>, <varname><%previous_month%></varname>, <varname><%next_month%></varname></term>
+ <term><varname>accounting_method</varname></term>
<listitem>
- <para>
- Aktueller, vorheriger und nächster Monat als Zahl zwischen <literal>1</literal> und <literal>12</literal>.
- </para>
+ <para>Dieser Parameter steuert die Buchungs- und
+ Berechnungsmethoden für die Versteuerungsart. Er enthält
+ entweder <literal>accrual</literal> für die Soll-Versteuerung
+ oder <literal>cash</literal> für die Ist-Versteuerung.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname><%current_month_long%></varname>, <varname><%previous_month_long%></varname>, <varname><%next_month_long%></varname></term>
+ <term><varname>inventory_system</varname></term>
<listitem>
- <para>
- Aktueller, vorheriger und nächster Monat als Name (<literal>Januar</literal>, <literal>Februar</literal> etc.).
- </para>
+ <para>Dieser Parameter legt die Warenbuchungsmethode fest. Er
+ enthält entweder <literal>perpetual</literal> für die
+ Bestandsmethode oder <literal>periodic</literal> für die
+ Aufwandsmethode.</para>
</listitem>
</varlistentry>
+ </variablelist>
- <varlistentry>
- <term><varname><%current_year%></varname>, <varname><%previous_year%></varname>, <varname><%next_year%></varname></term>
-
+ <para>Zum Vergleich der Funktionalität bis und nach 2.6.3:
+ <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
+ Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0
+ bedeutete hingegen Bilanzierung, Soll-Versteuerung und
+ Bestandsmethode.</para>
+
+ <para>Die Konfiguration "<varname>eur</varname>" unter
+ <varname>[system]</varname> in der <link
+ linkend="config.config-file">Konfigurationsdatei</link>
+ <filename>config/kivitendo.conf</filename> wird nun nicht mehr
+ benötigt und kann entfernt werden. Dies muss manuell geschehen.</para>
+ </sect2>
+
+ <sect2 id="config.eur.setting-parameters">
+ <title>Festlegen der Parameter</title>
+
+ <para>Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in
+ 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>
- Aktuelles, vorheriges und nächstes Jahr als vierstellige Jahreszahl (<literal>2013</literal> etc.).
- </para>
+ <para>Sollversteuerung</para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term><varname><%period_start_date%></varname>, <varname><%period_end_date%></varname></term>
+ <listitem>
+ <para>Aufwandsmethode</para>
+ </listitem>
<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>
+ <para>Bilanzierung</para>
</listitem>
- </varlistentry>
- </variablelist>
+ </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>
- 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>
+ <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" (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>
- <variablelist>
- <varlistentry>
- <term><varname>%a</varname></term>
+ <sect2 id="config.eur.inventory-system-perpetual">
+ <title>Bemerkungen zur Bestandsmethode</title>
- <listitem>
- <para>Der abgekürzte Wochentagsname.</para>
- </listitem>
- </varlistentry>
+ <para>Die Bestandsmethode ist eigentlich eine sehr elegante Methode,
+ funktioniert in kivitendo aber nur unter bestimmten Bedingungen:
+ Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt
+ werden, und man beim Jahreswechsel nicht mit einer leeren Datenbank
+ anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie
+ der Einkaufswert der Ware nach dem FIFO-Prinzip aus den
+ Einkaufsrechnungen berechnet wird.</para>
- <varlistentry>
- <term><varname>%A</varname></term>
+ <para>Die Bestandsmethode kann vom Prinzip her also nur funktioneren,
+ wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
+ im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode
+ wechseln.</para>
+ </sect2>
- <listitem>
- <para>Der ausgeschriebene Wochentagsname.</para>
- </listitem>
- </varlistentry>
+ <sect2 id="config.eur.knonw-issues">
+ <title>Bekannte Probleme</title>
- <varlistentry>
- <term><varname>%b</varname></term>
+ <para>Bei bestimmten Berichten kann man derzeit noch inviduell
+ einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es
+ werden im Code Variablen wie $accrual oder $cash gesetzt. Diese
+ Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
+ die Konfigurationsvariable
+ <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet
+ wurde.</para>
- <listitem>
- <para>Der abgekürzte Monatsname.</para>
- </listitem>
- </varlistentry>
+ <para>Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die
+ Optionen bewirken, z.B. mit zwei Standardfällen.</para>
+ </sect2>
+ </sect1>
- <varlistentry>
- <term><varname>%B</varname></term>
+ <sect1 id="config.skr04-update-3804">
+ <title>SKR04 19% Umstellung für innergemeinschaftlichen Erwerb</title>
- <listitem>
- <para>Der ausgeschriebene Monatsname.</para>
- </listitem>
- </varlistentry>
+ <sect2 id="config.skr04-update-3804.introduction">
+ <title>Einführung</title>
- <varlistentry>
- <term><varname>%C</varname></term>
+ <para>Die Umsatzsteuerumstellung auf 19% für SKR04 für die
+ Steuerschlüssel "EU ohne USt-ID Nummer" ist erst 2010 erfolgt.
+ kivitendo beinhaltet ein Upgradeskript, das das Konto 3804 automatisch
+ erstellt und die Steuereinstellungen korrekt einstellt. Hat der
+ Benutzer aber schon selber das Konto 3804 angelegt, oder gab es schon
+ Buchungen im Zeitraum nach dem 01.01.2007 auf das Konto 3803, wird das
+ Upgradeskript vorsichtshalber nicht ausgeführt, da der Benutzer sich
+ vielleicht schon selbst geholfen hat und mit seinen Änderungen
+ zufrieden ist. Die korrekten Einstellungen kann man aber auch per Hand
+ ausführen. Nachfolgend werden die entsprechenden Schritte anhand von
+ Screenshots dargestellt.</para>
- <listitem>
- <para>Das Jahrhundert (Jahr/100) als eine zweistellige Zahl.</para>
- </listitem>
- </varlistentry>
+ <para>Für den Fall, daß Buchungen mit der Steuerschlüssel "EU ohne
+ USt.-IdNr." nach dem 01.01.2007 erfolgt sind, ist davon auszugehen,
+ dass diese mit dem alten Umsatzsteuersatz von 16% gebucht worden sind,
+ und diese Buchungen sollten entsprechend kontrolliert werden.</para>
+ </sect2>
- <varlistentry>
- <term><varname>%d</varname></term>
+ <sect2 id="config.skr04-update-3804.create-chart">
+ <title>Konto 3804 manuell anlegen</title>
- <listitem>
- <para>Der Monatstag als Zahl zwischen 01 und 31.</para>
- </listitem>
- </varlistentry>
+ <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 erfassen</guimenuitem> das Konto angelegt.</para>
- <varlistentry>
- <term><varname>%D</varname></term>
+ <screenshot>
+ <screeninfo>Konto 3804 erfassen</screeninfo>
- <listitem>
- <para>Entspricht %m/%d/%y (amerikanisches Datumsformat).</para>
- </listitem>
- </varlistentry>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/skr04-update-3804/konto3804.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
- <varlistentry>
- <term><varname>%e</varname></term>
+ <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>
- <listitem>
- <para>Wie %d (Monatstag als Zahl zwischen 1 und 31), allerdings werden führende Nullen durch Leerzeichen ersetzt.</para>
- </listitem>
- </varlistentry>
+ <screenshot>
+ <screeninfo>Steuerschlüssel 13 für 3803 (16%) anpassen</screeninfo>
- <varlistentry>
- <term><varname>%F</varname></term>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/skr04-update-3804/steuer3803.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
- <listitem>
- <para>Entspricht %Y-%m-%d (das ISO-8601-Datumsformat).</para>
- </listitem>
- </varlistentry>
+ <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>
- <varlistentry>
- <term><varname>%j</varname></term>
+ <screenshot>
+ <screeninfo>Steuerschlüssel 13 für 3804 (19%) anlegen</screeninfo>
- <listitem>
- <para>Der Tag im Jahr als Zahl zwischen 001 und 366 inklusive.</para>
- </listitem>
- </varlistentry>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/skr04-update-3804/steuer3804.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
- <varlistentry>
- <term><varname>%m</varname></term>
+ <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>
- <listitem>
- <para>Der Monat als Zahl zwischen 01 und 12 inklusive.</para>
- </listitem>
- </varlistentry>
+ <screenshot>
+ <screeninfo>Konto 4315 anpassen</screeninfo>
- <varlistentry>
- <term><varname>%u</varname></term>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/skr04-update-3804/konto4315.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
- <listitem>
- <para>Der Wochentag als Zahl zwischen 1 und 7 inklusive, wobei die 1 dem Montag entspricht.</para>
- </listitem>
- </varlistentry>
+ <para>Als Letztes sollte die Steuerliste unter
+ <guimenu>System</guimenu> → <guisubmenu>Steuern</guisubmenu> →
+ <guimenuitem>Bearbeiten</guimenuitem> kontrolliert werden. Zum
+ Vergleich der Screenshot.</para>
- <varlistentry>
- <term><varname>%U</varname></term>
+ <screenshot>
+ <screeninfo>Steuerliste vergleichen</screeninfo>
- <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>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/skr04-update-3804/steuerliste.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </sect2>
+ </sect1>
- <varlistentry>
- <term><varname>%V</varname></term>
+ <sect1 id="config.bilanz">
+ <title>Verhalten des Bilanzberichts</title>
- <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>
+ <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>
- <varlistentry>
- <term><varname>%w</varname></term>
+ <para>In der Mandantenkonfiguration kann man dieses Verhalten genau
+ einstellen indem man:</para>
- <listitem>
- <para>Der Wochentag als Zahl zwischen 0 und 6 inklusive, wobei die 0 dem Sonntag entspricht.</para>
- </listitem>
- </varlistentry>
+ <itemizedlist>
+ <listitem>
+ <para>weiterhin closed_to benutzt (Default, es ändert sich nichts zu
+ vorher)</para>
+ </listitem>
- <varlistentry>
- <term><varname>%W</varname></term>
+ <listitem>
+ <para>immer den Jahresanfang nimmt (1.1. relativ zum
+ Stichtag)</para>
+ </listitem>
- <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>
+ <listitem>
+ <para>immer die letzte Eröffnungsbuchung als Startdatum nimmt</para>
- <varlistentry>
- <term><varname>%y</varname></term>
+ <para>- mit Jahresanfang als Alternative wenn es keine EB-Buchungen
+ gibt</para>
- <listitem>
- <para>Das Jahr als zweistellige Zahl zwischen 00 und 99 inklusive.</para>
- </listitem>
- </varlistentry>
+ <para>- oder mit "alle Buchungen" als Alternative"</para>
+ </listitem>
- <varlistentry>
- <term><varname>%Y</varname></term>
+ <listitem>
+ <para>mit Jahresanfang als Alternative wenn es keine EB-Buchungen
+ gibt</para>
+ </listitem>
- <listitem>
- <para>Das Jahr als vierstellige Zahl.</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>immer alle Buchungen seit Beginn der Datenbank nimmt</para>
+ </listitem>
+ </itemizedlist>
- <varlistentry>
- <term><varname>%%</varname></term>
+ <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>
- <listitem>
- <para>Das Prozentzeichen selber.</para>
- </listitem>
- </varlistentry>
- </variablelist>
+ <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>
- <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>
+ <sect1 id="config.rounding">
+ <title>Rundung in Verkaufsbelegen</title>
- <sect2 id="features.periodic-invoices.reports">
- <title>Auflisten</title>
+ <para>In der Schweiz hat die kleinste aktuell benutzte Münze den Wert
+ von 5 Rappen (0.05 CHF).</para>
- <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
- Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
- Rechnungen inaktiv", mit denen man sich einen Überglick über die
- wiederkehrenden Rechnungen verschaffen kann.</para>
- </sect2>
+ <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>
- <sect2 id="features.periodic-invoices.task-server">
- <title>Erzeugung der eigentlichen Rechnungen</title>
+ <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 zeitliche und periodische Überprüfung, ob eine
- wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
- durch den <link linkend="config.task-server">Taskserver</link>, einen
- externen Dienst, der automatisch beim Start des Servers gestartet
- werden sollte.</para>
- </sect2>
+ <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>
- <sect2 id="features.periodic-invoices.create-for-current-month">
- <title>Erste Rechnung für aktuellen Monat erstellen</title>
+ <para>Abhängig vom Wert für <varname>default_manager</varname> in
+ <filename>config/kivitendo.conf</filename> werden dabei folgende Werte
+ voreingestellt:</para>
- <para>Will man im laufenden Monat eine monatlich wiederkehrende
- Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
- auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
- den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
- generiert hat. Alternativ setzt man das Startdatum auf den
- Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
- manuell über den Workflow.</para>
- </sect2>
- </sect1>
- <sect1 id="features.bank"
- xreflabel="bankerweiterung">
- <title>Bankerweiterung</title>
+ <itemizedlist>
+ <listitem>
+ <para>0.05 (default_manager = swiss)</para>
+ </listitem>
- <sect2 id="features.bank.introduction"
- xreflabel="Einführung in die Bankerweiterung">
- <title>Einführung</title>
+ <listitem>
+ <para>0.01 (default_manager = german)</para>
+ </listitem>
+ </itemizedlist>
- <para>Die Beschreibung der Bankerweiterung befindet sich derzeit noch im Wiki und soll von dort später hierhin übernommen werden:</para>
+ <para>Der Wert wird in der Datenbank in der Tabelle <varname>defaults
+ </varname>in der Spalte <varname>precision</varname> gespeichert.</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>
+ <para>In allen Verkaufsangeboten, Verkaufsaufträgen, Verkaufsrechnungen
+ und Verkaufsgutschriften wird der Endbetrag inkl. MWST gerundet, wenn
+ dieser nicht der eingestellten Genauigkeit entspricht.</para>
- <sect2 id="dokumentenvorlagen-und-variablen.einführung">
- <title>Einführung</title>
+ <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>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
- aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
- einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
- <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>
+ <para>(Die berechnete MWST wird durch den Rundungsbetrag nicht mehr
+ verändert.)</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>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>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
- verfügbar als hier aufgelistet werden. Die meisten davon können
- allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
- werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
- diese wie folgt erhalten werden:</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>
- <itemizedlist>
- <listitem>
- <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
- Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
- </listitem>
+ <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>
- <listitem>
- <para>In <filename>Form.pm</filename> die Funktion
- <function>parse_template</function> suchen und hier die Zeile
- <command>print(STDERR Dumper($self));</command> einfügen.</para>
- </listitem>
+ <sect1 id="config.client">
+ <title>Einstellungen pro Mandant</title>
- <listitem>
- <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
- ein PDF für eine Rechnung erzeugen.</para>
- </listitem>
+ <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>
- <listitem>
- <para>Im <filename>error.log</filename> Apache steht die Ausgabe
- der Variablen <varname>$self</varname> in der Form <varname>'key'
- => 'value',</varname>. Alle <varname>key</varname>s sind
- verfügbar.</para>
- </listitem>
- </itemizedlist>
- </sect2>
-
- <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
- <title>Variablen ausgeben</title>
-
- <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
- Tags geschrieben werden, also z.B.
- <varname><%variablenname%></varname>.</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>
- <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
- die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
- <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
- werden die folgenden Flags unterstützt:</para>
+ <sect1 id="kivitendo-ERP-verwenden">
+ <title>kivitendo ERP verwenden</title>
- <itemizedlist>
- <listitem>
- <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
- den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
- mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
- damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
- </listitem>
+ <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
+ folgender URL erreichbar:</para>
- <listitem>
- <para><option>NOESCAPE</option> unterdrückt das Escapen von
- Sonderzeichen für die Vorlagensprache. Wenn also in einer
- Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
- auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
- ist dieses Flag sinnvoll.</para>
- </listitem>
- </itemizedlist>
+ <para><ulink
+ url="http://localhost/kivitendo-erp/login.pl">http://localhost/kivitendo-erp/login.pl</ulink></para>
- <para>Beispiel:</para>
+ <para>Die Administrationsseite erreichen Sie unter:</para>
- <programlisting><%quototal NOFORMAT%></programlisting>
- </sect2>
+ <para><ulink
+ url="http://localhost/kivitendo-erp/controller.pl?action=Admin/login">http://localhost/kivitendo-erp/controller.pl?action=Admin/login</ulink></para>
+ </sect1>
+ </chapter>
- <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
- <title>Verwendung in Druckbefehlen</title>
+ <chapter id="features" xreflabel="Features und Funktionen">
+ <title>Features und Funktionen</title>
- <para>In der Admininstration können Drucker definiert werden. Auch im
- dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
- und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
- den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
- <function>`...`</function> nicht zu unerwünschtem Verhalten
- führen.</para>
+ <sect1 id="features.periodic-invoices"
+ xreflabel="Wiederkehrende Rechnungen">
+ <title>Wiederkehrende Rechnungen</title>
- <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
- für das die Telefonnummer eines Ansprechpartners als Teil der
- Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
- z.B. wie folgt aussehen:</para>
+ <sect2 id="features.periodic-invoices.introduction"
+ xreflabel="Einführung in wiederkehrende Rechnungen">
+ <title>Einführung</title>
- <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
+ <para>Wiederkehrende Rechnungen werden als normale Aufträge definiert
+ und konfiguriert, mit allen dazugehörigen Kunden- und Artikelangaben.
+ Die konfigurierten Aufträge werden später automatisch in Rechnungen
+ umgewandelt, so als ob man den Workflow benutzen würde, und auch die
+ Auftragsnummer wird übernommen, sodass alle wiederkehrenden
+ Rechnungen, die aus einem Auftrag erstellt wurden, später leicht
+ wiederzufinden sind.</para>
</sect2>
- <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
- xreflabel="Anfang und Ende der Tags verändern">
- <title>Anfang und Ende der Tags verändern</title>
+ <sect2 id="features.periodic-invoices.configuration"
+ xreflabel="Konfiguration von wiederkehrenden Rechnungen">
+ <title>Konfiguration</title>
- <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
- Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
- Prozentzeichen und dem Größerzeichen endet, beispielsweise
- <function><%customer%></function>. Da diese Form aber z.B. in
- LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
- Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
- Stil umgestellt werden.</para>
+ <para>Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren,
+ findet sich beim Bearbeiten des Auftrags ein neuer Knopf
+ "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen
+ Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
+ angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist
+ oder nicht.</para>
- <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
- Format gültigen Kommentarzeichen anfangen, dann
- <function>config:</function> enthalten, die entsprechende Option
- setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
- enden. Beispiel für LaTeX:</para>
+ <para>Folgende Parameter kann man konfigurieren:</para>
- <programlisting>% config: tag-style=($ $)</programlisting>
+ <variablelist>
+ <varlistentry>
+ <term>Status</term>
- <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
- wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
- äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
+ <listitem>
+ <para>Bei aktiven Rechnungen wird automatisch eine Rechnung
+ erstellt, wenn die Periodizität erreicht ist (z.B. am Anfang
+ eines neuen Monats).</para>
- <programlisting><!-- config: tag-style=($ $) --></programlisting>
- </sect2>
+ <para>Ist ein Auftrag nicht aktiv, so werden für ihn auch keine
+ wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
+ nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim
+ nächsten Periodenwechsel für alle Perioden, seit der letzten
+ aktiven Periode, jeweils eine Rechnung erstellt. Möchte man dies
+ verhindern, muss man vorher das Startdatum neu setzen.</para>
- <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
- <title>Zuordnung von den Dateinamen zu den Funktionen</title>
+ <para>Für gekündigte Aufträge werden nie mehr Rechnungen
+ erstellt. Man kann sich diese Aufträge aber gesondert in den
+ Berichten anzeigen lassen.</para>
+ </listitem>
+ </varlistentry>
- <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
- welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
- "<filename>.ext</filename>" geeignet zu ersetzen:
- "<filename>.tex</filename>" für LaTeX-Vorlagen und
- "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
+ <varlistentry>
+ <term>Periodizität</term>
+
+ <listitem>
+ <para>Ob monatlich, quartalsweise oder jährlich auf neue
+ Rechnungen überprüft werden soll. Für jede Periode seit dem
+ Startdatum wird überprüft, ob für die Periode (beginnend immer
+ mit dem ersten Tag der Periode) schon eine Rechnung erstellt
+ wurde. Unter Umständen können bei einem Startdatum in der
+ Vergangenheit gleich mehrere Rechnungen erstellt werden.</para>
+ </listitem>
+ </varlistentry>
- <variablelist>
<varlistentry>
- <term><filename>bin_list.ext</filename></term>
+ <term>Buchen auf</term>
<listitem>
- <para>Lagerliste</para>
+ <para>Das Forderungskonto, in der Regel "Forderungen aus
+ Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den
+ Buchungsgruppen der betreffenden Waren.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><filename>check.ext</filename></term>
+ <term>Startdatum</term>
<listitem>
- <para>?</para>
+ <para>ab welchem Datum auf Rechnungserstellung geprüft werden
+ soll</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><filename>invoice.ext</filename></term>
+ <term>Enddatum</term>
<listitem>
- <para>Rechnung</para>
+ <para>ab wann keine Rechnungen mehr erstellt werden
+ sollen</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><filename>packing_list.ext</filename></term>
+ <term>Automatische Verlängerung um x Monate</term>
<listitem>
- <para>Packliste</para>
+ <para>Sollen die wiederkehrenden Rechnungen bei Erreichen des
+ eingetragenen Enddatums weiterhin erstellt werden, so kann man
+ hier die Anzahl der Monate eingeben, um die das Enddatum
+ automatisch nach hinten geschoben wird.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><filename>pick_list.ext</filename></term>
+ <term>Drucken</term>
<listitem>
- <para>Sammelliste</para>
+ <para>Sind Drucker konfiguriert, so kann man sich die erstellten
+ Rechnungen auch gleich ausdrucken lassen.</para>
</listitem>
</varlistentry>
+ </variablelist>
+
+ <para>Nach Erstellung der Rechnungen kann eine E-Mail mit
+ Informationen zu den erstellten Rechnungen verschickt werden.
+ Konfiguriert wird dies in der <link
+ linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
+ <filename>config/kivitendo.conf</filename> im Abschnitt
+ <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><filename>purchase_delivery_order.ext</filename></term>
+ <term><varname><%current_quarter%></varname>,
+ <varname><%previous_quarter%></varname>,
+ <varname><%next_quarter%></varname></term>
<listitem>
- <para>Lieferschein (Einkauf)</para>
+ <para>Aktuelles, vorheriges und nächstes Quartal als Zahl
+ zwischen <literal>1</literal> und <literal>4</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><filename>purcharse_order.ext</filename></term>
+ <term><varname><%current_month%></varname>,
+ <varname><%previous_month%></varname>,
+ <varname><%next_month%></varname></term>
<listitem>
- <para>Bestellung an Lieferanten</para>
+ <para>Aktueller, vorheriger und nächster Monat als Zahl zwischen
+ <literal>1</literal> und <literal>12</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><filename>request_quotation.ext</filename></term>
+ <term><varname><%current_month_long%></varname>,
+ <varname><%previous_month_long%></varname>,
+ <varname><%next_month_long%></varname></term>
<listitem>
- <para>Anfrage an Lieferanten</para>
+ <para>Aktueller, vorheriger und nächster Monat als Name
+ (<literal>Januar</literal>, <literal>Februar</literal>
+ etc.).</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><filename>sales_delivery_order.ext</filename></term>
+ <term><varname><%current_year%></varname>,
+ <varname><%previous_year%></varname>,
+ <varname><%next_year%></varname></term>
<listitem>
- <para>Lieferschein (Verkauf)</para>
+ <para>Aktuelles, vorheriges und nächstes Jahr als vierstellige
+ Jahreszahl (<literal>2013</literal> etc.).</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><filename>sales_order.ext</filename></term>
+ <term><varname><%period_start_date%></varname>,
+ <varname><%period_end_date%></varname></term>
<listitem>
- <para>Bestellung</para>
+ <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><filename>sales_quotation.ext</filename></term>
+ <term><varname>%a</varname></term>
<listitem>
- <para>Angebot an Kunden</para>
+ <para>Der abgekürzte Wochentagsname.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><filename>zahlungserinnerung.ext</filename></term>
+ <term><varname>%A</varname></term>
<listitem>
- <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
+ <para>Der ausgeschriebene Wochentagsname.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><filename>zahlungserinnerung_invoice.ext</filename></term>
+ <term><varname>%b</varname></term>
<listitem>
- <para>Rechnung über Mahngebühren (Dateiname im Programm
- konfigurierbar)</para>
+ <para>Der abgekürzte Monatsname.</para>
</listitem>
</varlistentry>
- </variablelist>
- </sect2>
- <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
- <title>Sprache, Drucker und E-Mail</title>
+ <varlistentry>
+ <term><varname>%B</varname></term>
- <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
- eingearbeitet. So wird aus der Vorlage
- <filename>sales_order.ext</filename> bei Sprache
- <function>de</function> und Druckerkürzel <function>lpr2</function>
- der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
- Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
- bekommen dann noch das Kürzel <filename>_email</filename>, der
- vollständige Vorlagenname wäre dann
- <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
- kann eine Standarddatei <filename>default.ext</filename> hinterlegt
- werden. Diese wird verwendet, wenn keine der anderen Varianten
- gefunden wird.</para>
+ <listitem>
+ <para>Der ausgeschriebene Monatsname.</para>
+ </listitem>
+ </varlistentry>
- <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
- der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
- verschickt wird, ist:</para>
+ <varlistentry>
+ <term><varname>%C</varname></term>
- <orderedlist>
- <listitem>
- <para><filename>sales_order_email_de_lpr2.tex</filename></para>
- </listitem>
+ <listitem>
+ <para>Das Jahrhundert (Jahr/100) als eine zweistellige
+ Zahl.</para>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para><filename>sales_order_de_lpr2.tex</filename></para>
- </listitem>
+ <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>
+
+ <para>Beim automatischen Versand der Rechnugen via E-Mail können neben diesen speziellen Variablen auch einige Eigenschaften der
+ Rechnung selber als Variablen im Betreff & dem Text der E-Mails genutzt werden. Beispiele sind
+ <varname><%invnumber%></varname> für die Rechnungsnummber oder <varname><transaction_description%></varname> für die
+ Vorgangsbezeichnung. Diese Variablen stehen beim Erzeugen der Rechnung logischerweise noch nicht zur Verfügung.</para>
+ </sect2>
+
+ <sect2 id="features.periodic-invoices.reports">
+ <title>Auflisten</title>
+
+ <para>Unter Verkauf->Berichte->Aufträge finden sich zwei neue
+ Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
+ Rechnungen inaktiv", mit denen man sich einen Überglick über die
+ wiederkehrenden Rechnungen verschaffen kann.</para>
+ </sect2>
+
+ <sect2 id="features.periodic-invoices.task-server">
+ <title>Erzeugung der eigentlichen Rechnungen</title>
+
+ <para>Die zeitliche und periodische Überprüfung, ob eine
+ wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
+ durch den <link linkend="config.task-server">Task-Server</link>, einen
+ externen Dienst, der automatisch beim Start des Servers gestartet
+ werden sollte.</para>
+ </sect2>
+
+ <sect2 id="features.periodic-invoices.create-for-current-month">
+ <title>Erste Rechnung für aktuellen Monat erstellen</title>
+
+ <para>Will man im laufenden Monat eine monatlich wiederkehrende
+ Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
+ auf den Monatsanfang und wartet ein paar Minuten, bis der Task-Server
+ den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
+ generiert hat. Alternativ setzt man das Startdatum auf den
+ Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
+ manuell über den Workflow.</para>
+ </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>
+
+ <sect2 id="dokumentenvorlagen-und-variablen.einführung">
+ <title>Einführung</title>
+
+ <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
+ aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
+ einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
+ <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>
+
+ <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
+ allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
+ werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
+ diese wie folgt erhalten werden:</para>
+
+ <itemizedlist>
<listitem>
- <para><filename>sales_order.tex</filename></para>
+ <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
+ Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
+ </listitem>
+
+ <listitem>
+ <para>In <filename>Form.pm</filename> die Funktion
+ <function>parse_template</function> suchen und hier die Zeile
+ <command>print(STDERR Dumper($self));</command> einfügen.</para>
+ </listitem>
+
+ <listitem>
+ <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
+ ein PDF für eine Rechnung erzeugen.</para>
+ </listitem>
+
+ <listitem>
+ <para>Im <filename>error.log</filename> Apache steht die Ausgabe
+ der Variablen <varname>$self</varname> in der Form <varname>'key'
+ => 'value',</varname>. Alle <varname>key</varname>s sind
+ verfügbar.</para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
+
+ <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
+ <title>Variablen ausgeben</title>
+
+ <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
+ Tags geschrieben werden, also z.B.
+ <varname><%variablenname%></varname>.</para>
+
+ <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
+ die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
+ <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
+ werden die folgenden Flags unterstützt:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
+ den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
+ mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
+ damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
</listitem>
- <listitem>
- <para><filename>default.tex</filename></para>
- </listitem>
- </orderedlist>
+ <listitem>
+ <para><option>NOESCAPE</option> unterdrückt das Escapen von
+ Sonderzeichen für die Vorlagensprache. Wenn also in einer
+ Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
+ auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
+ ist dieses Flag sinnvoll.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Beispiel:</para>
+
+ <programlisting><%quototal NOFORMAT%></programlisting>
+ </sect2>
+
+ <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
+ <title>Verwendung in Druckbefehlen</title>
+
+ <para>In der Admininstration können Drucker definiert werden. Auch im
+ dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
+ und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
+ den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
+ <function>`...`</function> nicht zu unerwünschtem Verhalten
+ führen.</para>
+
+ <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
+ für das die Telefonnummer eines Ansprechpartners als Teil der
+ Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
+ z.B. wie folgt aussehen:</para>
+
+ <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
+ </sect2>
+
+ <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
+ xreflabel="Anfang und Ende der Tags verändern">
+ <title>Anfang und Ende der Tags verändern</title>
+
+ <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
+ Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
+ Prozentzeichen und dem Größerzeichen endet, beispielsweise
+ <function><%customer%></function>. Da diese Form aber z.B. in
+ LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
+ Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
+ Stil umgestellt werden.</para>
+
+ <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
+ Format gültigen Kommentarzeichen anfangen, dann
+ <function>config:</function> enthalten, die entsprechende Option
+ setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
+ enden. Beispiel für LaTeX:</para>
+
+ <programlisting>% config: tag-style=($ $)</programlisting>
+
+ <para>Dies würde kivitendo dazu veranlassen, Variablen zu ersetzen,
+ wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
+ äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
+
+ <programlisting><!-- config: tag-style=($ $) --></programlisting>
+ </sect2>
+
+ <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
+ <title>Zuordnung von den Dateinamen zu den Funktionen</title>
+
+ <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
+ welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
+ "<filename>.ext</filename>" geeignet zu ersetzen:
+ "<filename>.tex</filename>" für LaTeX-Vorlagen und
+ "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>bin_list.ext</filename></term>
+
+ <listitem>
+ <para>Lagerliste</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>check.ext</filename></term>
+
+ <listitem>
+ <para>?</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>invoice.ext</filename></term>
+
+ <listitem>
+ <para>Rechnung</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>packing_list.ext</filename></term>
+
+ <listitem>
+ <para>Packliste</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>pick_list.ext</filename></term>
+
+ <listitem>
+ <para>Sammelliste</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>purchase_delivery_order.ext</filename></term>
+
+ <listitem>
+ <para>Lieferschein (Einkauf)</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>purcharse_order.ext</filename></term>
+
+ <listitem>
+ <para>Bestellung an Lieferanten</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>request_quotation.ext</filename></term>
+
+ <listitem>
+ <para>Anfrage an Lieferanten</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>sales_delivery_order.ext</filename></term>
+
+ <listitem>
+ <para>Lieferschein (Verkauf)</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>sales_order.ext</filename></term>
+
+ <listitem>
+ <para>Bestellung</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>sales_quotation.ext</filename></term>
+
+ <listitem>
+ <para>Angebot an Kunden</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>zahlungserinnerung.ext</filename></term>
+
+ <listitem>
+ <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>zahlungserinnerung_invoice.ext</filename></term>
+
+ <listitem>
+ <para>Rechnung über Mahngebühren (Dateiname im Programm
+ konfigurierbar)</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+
+ <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
+ <title>Sprache, Drucker und E-Mail</title>
+
+ <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
+ eingearbeitet. So wird aus der Vorlage
+ <filename>sales_order.ext</filename> bei Sprache
+ <function>de</function> und Druckerkürzel <function>lpr2</function>
+ der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
+ Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
+ bekommen dann noch das Kürzel <filename>_email</filename>, der
+ vollständige Vorlagenname wäre dann
+ <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
+ kann eine Standarddatei <filename>default.ext</filename> hinterlegt
+ werden. Diese wird verwendet, wenn keine der anderen Varianten
+ gefunden wird.</para>
+
+ <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
+ der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
+ verschickt wird, ist:</para>
+
+ <orderedlist>
+ <listitem>
+ <para><filename>sales_order_email_de_lpr2.tex</filename></para>
+ </listitem>
+
+ <listitem>
+ <para><filename>sales_order_de_lpr2.tex</filename></para>
+ </listitem>
+
+ <listitem>
+ <para><filename>sales_order.tex</filename></para>
+ </listitem>
+
+ <listitem>
+ <para><filename>default.tex</filename></para>
+ </listitem>
+ </orderedlist>
+
+ <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>
+ </sect2>
+
+ <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
+ <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
+ sind</title>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
+ xreflabel="Metainformationen zur angeforderten Vorlage">
+ <title>Metainformationen zur angeforderten Vorlage</title>
+
+ <para>Diese Variablen liefern Informationen darüber welche Variante
+ einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
+ Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
+ Formulare einbinden möchten.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><varname>template_meta.formname</varname></term>
+
+ <listitem>
+ <para>Basisname der Vorlage. Identisch mit der <link
+ linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
+ zu den Dateinamen</link> ohne die Erweiterung. Ein
+ Verkaufsauftrag enthält hier
+ <constant>sales_order</constant>.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>template_meta.language.description</varname></term>
+
+ <listitem>
+ <para>Beschreibung der verwendeten Sprache</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>template_meta.language.template_code</varname></term>
+
+ <listitem>
+ <para>Vorlagenkürzel der verwendeten Sprache, identisch mit
+ dem Kürzel das im Dateinamen verwendetet wird.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>template_meta.language.output_numberformat</varname></term>
+
+ <listitem>
+ <para>Zahlenformat der verwendeten Sprache in der Form
+ "<constant>1.000,00</constant>". Experimentell! Nur
+ interessant für Vorlagen die mit unformatierten Werten
+ arbeiten.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>template_meta.language.output_dateformat</varname></term>
+
+ <listitem>
+ <para>Datumsformat der verwendeten Sprache in der Form
+ "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
+ interessant für Vorlagen die mit unformatierten Werten
+ arbeiten.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>template_meta.format</varname></term>
+
+ <listitem>
+ <para>Das angeforderte Format. Kann im Moment die Werte
+ <constant>pdf</constant>, <constant>postscript</constant>,
+ <constant>html</constant>, <constant>opendocument</constant>,
+ <constant>opendocument_pdf</constant> und
+ <constant>excel</constant> enthalten.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>template_meta.extension</varname></term>
+
+ <listitem>
+ <para>Dateierweiterung, wie im Dateinamen. Wird aus
+ <constant>format</constant> entschieden.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>template_meta.media</varname></term>
+
+ <listitem>
+ <para>Ausgabemedium. Kann zur Zeit die Werte
+ <constant>screen</constant> für Bildschirm,
+ <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>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>template_meta.printer.description</varname></term>
+
+ <listitem>
+ <para>Beschreibung des ausgewählten Druckers</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>template_meta.printer.template_code</varname></term>
+
+ <listitem>
+ <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
+ 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>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
+ <title>Stammdaten von Kunden und Lieferanten</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><varname>account_number</varname></term>
+
+ <listitem>
+ <para>Kontonummer</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>bank</varname></term>
+
+ <listitem>
+ <para>Name der Bank</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>bank_code</varname></term>
+
+ <listitem>
+ <para>Bankleitzahl</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>bic</varname></term>
+
+ <listitem>
+ <para>Bank-Identifikations-Code (Bank Identifier Code,
+ BIC)</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>business</varname></term>
+
+ <listitem>
+ <para>Kunden-/Lieferantentyp</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>city</varname></term>
+
+ <listitem>
+ <para>Stadt</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>contact</varname></term>
+
+ <listitem>
+ <para>Kontakt</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>country</varname></term>
+
+ <listitem>
+ <para>Land</para>
+ </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>
+ <para>Email des Ansprechpartners</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>cp_givenname</varname></term>
+
+ <listitem>
+ <para>Vorname des Ansprechpartners</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>cp_greeting</varname></term>
+
+ <listitem>
+ <para>Anrede des Ansprechpartners</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>cp_name</varname></term>
+
+ <listitem>
+ <para>Name des Ansprechpartners</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>cp_phone1</varname></term>
+
+ <listitem>
+ <para>Telefonnummer 1 des Ansprechpartners</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>cp_phone2</varname></term>
+
+ <listitem>
+ <para>Telefonnummer 2 des Ansprechpartners</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>cp_title</varname></term>
+
+ <listitem>
+ <para>Titel des Ansprechpartners</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>creditlimit</varname></term>
+
+ <listitem>
+ <para>Kreditlimit</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>customeremail</varname></term>
+
+ <listitem>
+ <para>Email des Kunden; nur für Kunden</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>customerfax</varname></term>
+
+ <listitem>
+ <para>Faxnummer des Kunden; nur für Kunden</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>customernotes</varname></term>
+
+ <listitem>
+ <para>Bemerkungen beim Kunden; nur für Kunden</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>customernumber</varname></term>
+
+ <listitem>
+ <para>Kundennummer; nur für Kunden</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>customerphone</varname></term>
+
+ <listitem>
+ <para>Telefonnummer des Kunden; nur für Kunden</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>discount</varname></term>
+
+ <listitem>
+ <para>Rabatt</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>email</varname></term>
+
+ <listitem>
+ <para>Emailadresse</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>fax</varname></term>
+
+ <listitem>
+ <para>Faxnummer</para>
+ </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>
+
+ <listitem>
+ <para>Homepage</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>iban</varname></term>
+
+ <listitem>
+ <para>Internationale Kontonummer (International Bank Account
+ Number, IBAN)</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>language</varname></term>
+
+ <listitem>
+ <para>Sprache</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>name</varname></term>
+
+ <listitem>
+ <para>Firmenname</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>natural_person</varname></term>
+
+ <listitem>
+ <para>Flag "natürliche Person"; Siehe auch
+ <xref linkend="dokumentenvorlagen-und-variablen.anrede"/></para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>payment_description</varname></term>
+
+ <listitem>
+ <para>Name der Zahlart</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>payment_terms</varname></term>
+
+ <listitem>
+ <para>Zahlungskonditionen</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>phone</varname></term>
+
+ <listitem>
+ <para>Telefonnummer</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>shiptocity</varname></term>
+
+ <listitem>
+ <para>Stadt (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>shiptocontact</varname></term>
- <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>
- </sect2>
+ <listitem>
+ <para>Kontakt (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ </listitem>
+ </varlistentry>
- <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
- <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
- sind</title>
+ <varlistentry>
+ <term><varname>shiptocountry</varname></term>
- <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
- xreflabel="Metainformationen zur angeforderten Vorlage">
- <title>Metainformationen zur angeforderten Vorlage</title>
+ <listitem>
+ <para>Land (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ </listitem>
+ </varlistentry>
- <para>Diese Variablen liefern Informationen darüber welche Variante
- einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
- Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
- Formulare einbinden möchten.</para>
+ <varlistentry>
+ <term><varname>shiptodepartment_1</varname></term>
+
+ <listitem>
+ <para>Abteilung 1 (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ </listitem>
+ </varlistentry>
- <variablelist>
<varlistentry>
- <term><varname>template_meta.formname</varname></term>
+ <term><varname>shiptodepartment_2</varname></term>
<listitem>
- <para>Basisname der Vorlage. Identisch mit der <link
- linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
- zu den Dateinamen</link> ohne die Erweiterung. Ein
- Verkaufsauftrag enthält hier
- <constant>sales_order</constant>.</para>
+ <para>Abteilung 2 (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>template_meta.language.description</varname></term>
+ <term><varname>shiptoemail</varname></term>
<listitem>
- <para>Beschreibung der verwendeten Sprache</para>
+ <para>Email (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>template_meta.language.template_code</varname></term>
+ <term><varname>shiptofax</varname></term>
<listitem>
- <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
- Kürzel das im Dateinamen verwendetet wird.</para>
+ <para>Fax (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>template_meta.language.output_numberformat</varname></term>
+ <term><varname>shiptogln</varname></term>
<listitem>
- <para>Zahlenformat der verwendeten Sprache in der Form
- "<constant>1.000,00</constant>". Experimentell! Nur
- interessant für Vorlagen die mit unformatierten Werten
- arbeiten.</para>
+ <para>GLN (Globale Lokationsnummer) (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>template_meta.language.output_dateformat</varname></term>
+ <term><varname>shiptoname</varname></term>
<listitem>
- <para>Datumsformat der verwendeten Sprache in der Form
- "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
- interessant für Vorlagen die mit unformatierten Werten
- arbeiten.</para>
+ <para>Firmenname (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>template_meta.format</varname></term>
+ <term><varname>shiptophone</varname></term>
<listitem>
- <para>Das angeforderte Format. Kann im Moment die Werte
- <constant>pdf</constant>, <constant>postscript</constant>,
- <constant>html</constant>, <constant>opendocument</constant>,
- <constant>opendocument_pdf</constant> und
- <constant>excel</constant> enthalten.</para>
+ <para>Telefonnummer (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>template_meta.extension</varname></term>
+ <term><varname>shiptostreet</varname></term>
<listitem>
- <para>Dateierweiterung, wie im Dateinamen. Wird aus
- <constant>format</constant> entschieden.</para>
+ <para>Straße und Hausnummer (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>template_meta.media</varname></term>
+ <term><varname>shiptozipcode</varname></term>
<listitem>
- <para>Ausgabemedium. Kann zur Zeit die Werte
- <constant>screen</constant> für Bildschirm,
- <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>
+ <para>Postleitzahl (Lieferadresse) <link
+ linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>template_meta.printer.description</varname></term>
+ <term><varname>street</varname></term>
<listitem>
- <para>Beschreibung des ausgewählten Druckers</para>
+ <para>Straße und Hausnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>template_meta.printer.template_code</varname></term>
+ <term><varname>taxnumber</varname></term>
<listitem>
- <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
- dem Kürzel das im Dateinamen verwendetet wird.</para>
+ <para>Steuernummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>template_meta.tmpfile</varname></term>
+ <term><varname>ustid</varname></term>
<listitem>
- <para>Datei-Prefix für temporäre Dateien.</para>
+ <para>Umsatzsteuer-Identifikationsnummer</para>
</listitem>
</varlistentry>
- </variablelist>
- </sect3>
- <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
- <title>Stammdaten von Kunden und Lieferanten</title>
+ <varlistentry>
+ <term><varname>vendoremail</varname></term>
+
+ <listitem>
+ <para>Email des Lieferanten; nur für Lieferanten</para>
+ </listitem>
+ </varlistentry>
- <variablelist>
<varlistentry>
- <term><varname>account_number</varname></term>
+ <term><varname>vendorfax</varname></term>
<listitem>
- <para>Kontonummer</para>
+ <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>bank</varname></term>
+ <term><varname>vendornotes</varname></term>
<listitem>
- <para>Name der Bank</para>
+ <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>bank_code</varname></term>
+ <term><varname>vendornumber</varname></term>
<listitem>
- <para>Bankleitzahl</para>
+ <para>Lieferantennummer; nur für Lieferanten</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>bic</varname></term>
+ <term><varname>vendorphone</varname></term>
<listitem>
- <para>Bank-Identifikations-Code (Bank Identifier Code,
- BIC)</para>
+ <para>Telefonnummer des Lieferanten; nur für
+ Lieferanten</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>business</varname></term>
+ <term><varname>zipcode</varname></term>
<listitem>
- <para>Kunden-/Lieferantentyp</para>
+ <para>Postleitzahl</para>
</listitem>
</varlistentry>
+ </variablelist>
+
+ <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
+ <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
+ Stammdaten nicht eingetragen, so haben die Variablen
+ <varname>shipto*</varname> den gleichen Wert wie die die
+ entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
+ einige <varname>shipto*</varname>-Variablen so nicht in den
+ Stammdaten wiederfinden sondern schlicht Kopien der
+ Lieferdatenvariablen sind (z.B.
+ <varname>shiptocontact</varname>).</para>
+ </note>
+ </sect3>
+ <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
+ <title>Informationen über den Bearbeiter</title>
+
+ <variablelist>
<varlistentry>
- <term><varname>city</varname></term>
+ <term><varname>employee_address</varname></term>
<listitem>
- <para>Stadt</para>
+ <para>Adressfeld</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>contact</varname></term>
+ <term><varname>employee_businessnumber</varname></term>
<listitem>
- <para>Kontakt</para>
+ <para>Firmennummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>country</varname></term>
+ <term><varname>employee_company</varname></term>
<listitem>
- <para>Land</para>
+ <para>Firmenname</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>c_vendor_id</varname></term>
+ <term><varname>employee_co_ustid</varname></term>
<listitem>
- <para>Lieferantennummer beim Kunden (nur Kunden)</para>
+ <para>Usatzsteuer-Identifikationsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>v_customer_id</varname></term>
+ <term><varname>employee_duns</varname></term>
<listitem>
- <para>Kundennummer beim Lieferanten (nur Lieferanten)</para>
+ <para>DUNS-Nummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>cp_email</varname></term>
+ <term><varname>employee_email</varname></term>
<listitem>
- <para>Email des Ansprechpartners</para>
+ <para>Email</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>cp_givenname</varname></term>
+ <term><varname>employee_fax</varname></term>
<listitem>
- <para>Vorname des Ansprechpartners</para>
+ <para>Fax</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>cp_greeting</varname></term>
+ <term><varname>employee_name</varname></term>
<listitem>
- <para>Anrede des Ansprechpartners</para>
+ <para>voller Name</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>cp_name</varname></term>
+ <term><varname>employee_signature</varname></term>
<listitem>
- <para>Name des Ansprechpartners</para>
+ <para>Signatur</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>cp_phone1</varname></term>
+ <term><varname>employee_taxnumber</varname></term>
<listitem>
- <para>Telefonnummer 1 des Ansprechpartners</para>
+ <para>Steuernummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>cp_phone2</varname></term>
+ <term><varname>employee_tel</varname></term>
<listitem>
- <para>Telefonnummer 2 des Ansprechpartners</para>
+ <para>Telefonnummer</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
+ <title>Informationen über den Verkäufer</title>
+ <variablelist>
<varlistentry>
- <term><varname>cp_title</varname></term>
+ <term><varname>salesman_address</varname></term>
<listitem>
- <para>Titel des Ansprechpartners</para>
+ <para>Adressfeld</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>creditlimit</varname></term>
+ <term><varname>salesman_businessnumber</varname></term>
<listitem>
- <para>Kreditlimit</para>
+ <para>Firmennummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>customeremail</varname></term>
+ <term><varname>salesman_company</varname></term>
<listitem>
- <para>Email des Kunden; nur für Kunden</para>
+ <para>Firmenname</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>customerfax</varname></term>
+ <term><varname>salesman_co_ustid</varname></term>
<listitem>
- <para>Faxnummer des Kunden; nur für Kunden</para>
+ <para>Usatzsteuer-Identifikationsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>customernotes</varname></term>
+ <term><varname>salesman_duns</varname></term>
<listitem>
- <para>Bemerkungen beim Kunden; nur für Kunden</para>
+ <para>DUNS-Nummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>customernumber</varname></term>
+ <term><varname>salesman_email</varname></term>
<listitem>
- <para>Kundennummer; nur für Kunden</para>
+ <para>Email</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>customerphone</varname></term>
+ <term><varname>salesman_fax</varname></term>
<listitem>
- <para>Telefonnummer des Kunden; nur für Kunden</para>
+ <para>Fax</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>discount</varname></term>
+ <term><varname>salesman_name</varname></term>
<listitem>
- <para>Rabatt</para>
+ <para>voller Name</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>email</varname></term>
+ <term><varname>salesman_signature</varname></term>
+
+ <listitem>
+ <para>Signatur</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>salesman_taxnumber</varname></term>
<listitem>
- <para>Emailadresse</para>
+ <para>Steuernummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>fax</varname></term>
+ <term><varname>salesman_tel</varname></term>
<listitem>
- <para>Faxnummer</para>
+ <para>Telefonnummer</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+ <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
+ <title>Variablen für die einzelnen Steuern</title>
+
+ <variablelist>
<varlistentry>
- <term><varname>greeting</varname></term>
+ <term><varname>tax</varname></term>
<listitem>
- <para>Anrede</para>
+ <para>Steuer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>homepage</varname></term>
+ <term><varname>taxbase</varname></term>
<listitem>
- <para>Homepage</para>
+ <para>zu versteuernder Betrag</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>iban</varname></term>
+ <term><varname>taxdescription</varname></term>
<listitem>
- <para>Internationale Kontonummer (International Bank Account
- Number, IBAN)</para>
+ <para>Name der Steuer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>language</varname></term>
+ <term><varname>taxrate</varname></term>
<listitem>
- <para>Sprache</para>
+ <para>Steuersatz</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.allgemein-lieferbedingungen">
+ <title>Variablen für Lieferbedingungen</title>
+ <variablelist>
<varlistentry>
- <term><varname>name</varname></term>
+ <term><varname>delivery_term</varname></term>
<listitem>
- <para>Firmenname</para>
+ <para>Datenbank-Objekt der Lieferbedingung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>payment_description</varname></term>
+ <term><varname>delivery_term.description</varname></term>
<listitem>
- <para>Name der Zahlart</para>
+ <para>Beschreibung der Lieferbedingung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>payment_terms</varname></term>
+ <term><varname>delivery_term.description_long</varname></term>
<listitem>
- <para>Zahlungskonditionen</para>
+ <para>Langtext bzw. übersetzter Langtext der
+ Lieferbedingung</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.abweichende-rechnungsadresse">
+ <title>Informationen über abweichende Rechnungsadressen (nur Verkaufsbelege)</title>
+
+ <para>
+ Abweichende Rechnungsadressen gibt es nur in Verkaufsbelegen. Die entsprechenden Variablen sind nur dann mit Inhalt gefüllt,
+ wenn im Beleg eine abweichende Rechnungsadresse ausgewählt wurde. Ob eine Adresse überhaupt ausgewählt wurde, kann über die
+ Variable <literal>billing_address_id</literal> getestet werden, die die Datenbank-ID der abweichenden Rechnungsadresse enthält,
+ wenn eine ausgewählt ist.
+ </para>
+
+ <para>
+ Die Variablennamen starten alle mit dem Präfix <literal>billing_address_</literal> und heißen anschließend so, wie ihre Pendants
+ aus der Standard-Rechnungsadresse des Kunden. Beispiel: die Postleitzahl, die in der normalen Rechnungsadresse in
+ <literal>zipcode</literal> steht, steht für die abweichende Rechnungsadresse in <literal>billing_address_zipcode</literal>.
+ </para>
+
+ <para>
+ Die folgenden Variablen stehen so zur Verfügung: <literal>billing_address_name</literal>,
+ <literal>billing_address_department_1</literal>, <literal>billing_address_department_2</literal>,
+ <literal>billing_address_contact</literal>, <literal>billing_address_street</literal>,
+ <literal>billing_address_zipcode</literal>, <literal>billing_address_city</literal>, <literal>billing_address_country</literal>,
+ <literal>billing_address_gln</literal>, <literal>billing_address_email</literal>, <literal>billing_address_phone</literal> und
+ <literal>billing_address_fax</literal>.
+ </para>
+ </sect3>
+ </sect2>
+
+ <sect2 id="dokumentenvorlagen-und-variablen.invoice">
+ <title>Variablen in Rechnungen</title>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
+ <title>Allgemeine Variablen</title>
+ <variablelist>
<varlistentry>
- <term><varname>phone</varname></term>
+ <term><varname>creditremaining</varname></term>
<listitem>
- <para>Telefonnummer</para>
+ <para>Verbleibender Kredit</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>shiptocity</varname></term>
+ <term><varname>currency</varname></term>
<listitem>
- <para>Stadt (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>Währung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>shiptocontact</varname></term>
+ <term><varname>cusordnumber</varname></term>
<listitem>
- <para>Kontakt (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>Bestellnummer beim Kunden</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>shiptocountry</varname></term>
+ <term><varname>deliverydate</varname></term>
<listitem>
- <para>Land (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>Lieferdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>shiptodepartment1</varname></term>
+ <term><varname>duedate</varname></term>
<listitem>
- <para>Abteilung 1 (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>Fälligkeitsdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>shiptodepartment2</varname></term>
+ <term><varname>globalprojectnumber</varname></term>
<listitem>
- <para>Abteilung 2 (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>Projektnummer des ganzen Beleges</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>shiptoemail</varname></term>
+ <term><varname>globalprojectdescription</varname></term>
<listitem>
- <para>Email (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>Projekbeschreibung des ganzen Beleges</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>shiptofax</varname></term>
+ <term><varname>intnotes</varname></term>
<listitem>
- <para>Fax (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>Interne Bemerkungen</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>shiptoname</varname></term>
+ <term><varname>invdate</varname></term>
<listitem>
- <para>Firmenname (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>Rechnungsdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>shiptophone</varname></term>
+ <term><varname>invnumber</varname></term>
<listitem>
- <para>Telefonnummer (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>Rechnungsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>shiptostreet</varname></term>
+ <term><varname>invtotal</varname></term>
<listitem>
- <para>Straße und Hausnummer (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>gesamter Rechnungsbetrag</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>shiptozipcode</varname></term>
+ <term><varname>notes</varname></term>
<listitem>
- <para>Postleitzahl (Lieferadresse) <link
- linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
+ <para>Bemerkungen der Rechnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>street</varname></term>
+ <term><varname>orddate</varname></term>
<listitem>
- <para>Straße und Hausnummer</para>
+ <para>Auftragsdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>taxnumber</varname></term>
+ <term><varname>ordnumber</varname></term>
<listitem>
- <para>Steuernummer</para>
+ <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
+ erstellt wurde</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>ustid</varname></term>
+ <term><varname>payment_description</varname></term>
<listitem>
- <para>Umsatzsteuer-Identifikationsnummer</para>
+ <para>Name der Zahlart</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>vendoremail</varname></term>
+ <term><varname>payment_terms</varname></term>
<listitem>
- <para>Email des Lieferanten; nur für Lieferanten</para>
+ <para>Zahlungskonditionen</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>vendorfax</varname></term>
+ <term><varname>quodate</varname></term>
<listitem>
- <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
+ <para>Angebotsdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>vendornotes</varname></term>
+ <term><varname>quonumber</varname></term>
<listitem>
- <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
+ <para>Angebotsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>vendornumber</varname></term>
+ <term><varname>rounding</varname></term>
<listitem>
- <para>Lieferantennummer; nur für Lieferanten</para>
+ <para>Betrag, um den <varname>invtotal</varname> gerundet
+ wurde (kann positiv oder negativ sein)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>vendorphone</varname></term>
+ <term><varname>shippingpoint</varname></term>
<listitem>
- <para>Telefonnummer des Lieferanten; nur für
- Lieferanten</para>
+ <para>Versandort</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>zipcode</varname></term>
+ <term><varname>shipvia</varname></term>
<listitem>
- <para>Postleitzahl</para>
+ <para>Transportmittel</para>
</listitem>
</varlistentry>
- </variablelist>
-
- <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
- <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
- Stammdaten nicht eingetragen, so haben die Variablen
- <varname>shipto*</varname> den gleichen Wert wie die die
- entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
- einige <varname>shipto*</varname>-Variablen so nicht in den
- Stammdaten wiederfinden sondern schlicht Kopien der
- Lieferdatenvariablen sind (z.B.
- <varname>shiptocontact</varname>).</para>
- </note>
- </sect3>
-
- <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
- <title>Informationen über den Bearbeiter</title>
- <variablelist>
<varlistentry>
- <term><varname>employee_address</varname></term>
+ <term><varname>subtotal</varname></term>
<listitem>
- <para>Adressfeld</para>
+ <para>Zwischensumme aller Posten ohne Steuern</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>employee_businessnumber</varname></term>
+ <term><varname>total</varname></term>
<listitem>
- <para>Firmennummer</para>
+ <para>Restsumme der Rechnung (Summe abzüglich bereits
+ bezahlter Posten)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>employee_company</varname></term>
+ <term><varname>transaction_description</varname></term>
<listitem>
- <para>Firmenname</para>
+ <para>Vorgangsbezeichnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>employee_co_ustid</varname></term>
+ <term><varname>transdate</varname></term>
<listitem>
- <para>Usatzsteuer-Identifikationsnummer</para>
+ <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
+ erstellt wurde</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
+ <title>Variablen für jeden Posten auf der Rechnung</title>
+ <variablelist>
<varlistentry>
- <term><varname>employee_duns</varname></term>
+ <term><varname>bin</varname></term>
<listitem>
- <para>DUNS-Nummer</para>
+ <para>Stellage</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>employee_email</varname></term>
+ <term><varname>description</varname></term>
<listitem>
- <para>Email</para>
+ <para>Artikelbeschreibung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>employee_fax</varname></term>
+ <term><varname>cusordnumber_oe</varname></term>
<listitem>
- <para>Fax</para>
+ <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der
+ Posten ursprünglich stammt (nur Verkauf)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>employee_name</varname></term>
+ <term><varname>discount</varname></term>
<listitem>
- <para>voller Name</para>
+ <para>Rabatt als Betrag</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>employee_signature</varname></term>
+ <term><varname>discount_sub</varname></term>
<listitem>
- <para>Signatur</para>
+ <para>Zwischensumme mit Rabatt</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>employee_taxnumber</varname></term>
+ <term><varname>donumber_do</varname></term>
<listitem>
- <para>Steuernummer</para>
+ <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>employee_tel</varname></term>
+ <term><varname>drawing</varname></term>
<listitem>
- <para>Telefonnummer</para>
+ <para>Zeichnung</para>
</listitem>
</varlistentry>
- </variablelist>
- </sect3>
-
- <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
- <title>Informationen über den Verkäufer</title>
- <variablelist>
<varlistentry>
- <term><varname>salesman_address</varname></term>
+ <term><varname>ean</varname></term>
<listitem>
- <para>Adressfeld</para>
+ <para>EAN-Code</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>salesman_businessnumber</varname></term>
+ <term><varname>image</varname></term>
<listitem>
- <para>Firmennummer</para>
+ <para>Grafik</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>salesman_company</varname></term>
+ <term><varname>linetotal</varname></term>
<listitem>
- <para>Firmenname</para>
+ <para>Zeilensumme (Anzahl * Einzelpreis)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>salesman_co_ustid</varname></term>
+ <term><varname>longdescription</varname></term>
<listitem>
- <para>Usatzsteuer-Identifikationsnummer</para>
+ <para>Langtext, vorbelegt mit dem Feld Bemerkungen der entsprechenden Ware</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>salesman_duns</varname></term>
+ <term><varname>microfiche</varname></term>
<listitem>
- <para>DUNS-Nummer</para>
+ <para>Mikrofilm</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>salesman_email</varname></term>
+ <term><varname>netprice</varname></term>
<listitem>
- <para>Email</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>
<varlistentry>
- <term><varname>salesman_fax</varname></term>
+ <term><varname>nodiscount_linetotal</varname></term>
<listitem>
- <para>Fax</para>
+ <para>Zeilensumme ohne Rabatt</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>salesman_name</varname></term>
+ <term><varname>nodiscount_sub</varname></term>
<listitem>
- <para>voller Name</para>
+ <para>Zwischensumme ohne Rabatt</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>salesman_signature</varname></term>
+ <term><varname>number</varname></term>
<listitem>
- <para>Signatur</para>
+ <para>Artikelnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>salesman_taxnumber</varname></term>
+ <term><varname>ordnumber_oe</varname></term>
<listitem>
- <para>Steuernummer</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>
<varlistentry>
- <term><varname>salesman_tel</varname></term>
+ <term><varname>p_discount</varname></term>
<listitem>
- <para>Telefonnummer</para>
+ <para>Rabatt in Prozent</para>
</listitem>
</varlistentry>
- </variablelist>
- </sect3>
-
- <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
- <title>Variablen für die einzelnen Steuern</title>
- <variablelist>
<varlistentry>
- <term><varname>tax</varname></term>
+ <term><varname>partnotes</varname></term>
<listitem>
- <para>Steuer</para>
+ <para>Die beim Artikel gespeicherten Bemerkungen</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>taxbase</varname></term>
+ <term><varname>partsgroup</varname></term>
<listitem>
- <para>zu versteuernder Betrag</para>
+ <para>Warengruppe</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>taxdescription</varname></term>
+ <term><varname>price_factor</varname></term>
<listitem>
- <para>Name der Steuer</para>
+ <para>Der Preisfaktor als Zahl, sofern einer eingestellt
+ ist</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>taxrate</varname></term>
+ <term><varname>price_factor_name</varname></term>
<listitem>
- <para>Steuersatz</para>
+ <para>Der Name des Preisfaktors, sofern einer eingestellt
+ ist</para>
</listitem>
</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">
- <title>Variablen in Rechnungen</title>
+ <term><varname>projectnumber</varname></term>
- <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
- <title>Allgemeine Variablen</title>
+ <listitem>
+ <para>Projektnummer</para>
+ </listitem>
+ </varlistentry>
- <variablelist>
<varlistentry>
- <term><varname>creditremaining</varname></term>
+ <term><varname>projectdescription</varname></term>
<listitem>
- <para>Verbleibender Kredit</para>
+ <para>Projektbeschreibung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>currency</varname></term>
+ <term><varname>qty</varname></term>
<listitem>
- <para>Währung</para>
+ <para>Anzahl</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>cusordnumber</varname></term>
+ <term><varname>reqdate</varname></term>
<listitem>
- <para>Bestellnummer beim Kunden</para>
+ <para>Lieferdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>deliverydate</varname></term>
+ <term><varname>runningnumber</varname></term>
<listitem>
- <para>Lieferdatum</para>
+ <para>Position auf der Rechnung (1, 2, 3...)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>duedate</varname></term>
+ <term><varname>sellprice</varname></term>
<listitem>
- <para>Fälligkeitsdatum</para>
+ <para>Verkaufspreis</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>globalprojectnumber</varname></term>
+ <term><varname>serialnumber</varname></term>
<listitem>
- <para>Projektnummer des ganzen Beleges</para>
+ <para>Seriennummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>globalprojectdescription</varname></term>
+ <term><varname>tax_rate</varname></term>
<listitem>
- <para>Projekbeschreibung des ganzen Beleges</para>
+ <para>Steuersatz</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>intnotes</varname></term>
+ <term><varname>transdate_do</varname></term>
<listitem>
- <para>Interne Bemerkungen</para>
+ <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des
+ Workflows aus einem Lieferschein stammte.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>invdate</varname></term>
+ <term><varname>transdate_oe</varname></term>
<listitem>
- <para>Rechnungsdatum</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>invnumber</varname></term>
+ <term><varname>transdate_quo</varname></term>
<listitem>
- <para>Rechnungsnummer</para>
+ <para>Datum des Angebots, wenn die Position im Rahmen des
+ Workflows aus einem Angebot stammte.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>invtotal</varname></term>
+ <term><varname>unit</varname></term>
<listitem>
- <para>gesamter Rechnungsbetrag</para>
+ <para>Einheit</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>notes</varname></term>
+ <term><varname>weight</varname></term>
<listitem>
- <para>Bemerkungen der Rechnung</para>
+ <para>Gewicht</para>
</listitem>
</varlistentry>
+ </variablelist>
+
+ <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
+ über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
+ einer <function>foreach</function>-Schleife ausgegeben werden, da
+ für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
+ können. Die Variablen dafür lauten:</para>
+ <variablelist>
<varlistentry>
- <term><varname>orddate</varname></term>
+ <term><varname>make</varname></term>
<listitem>
- <para>Auftragsdatum</para>
+ <para>Lieferant</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>ordnumber</varname></term>
+ <term><varname>model</varname></term>
<listitem>
- <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
- erstellt wurde</para>
+ <para>Lieferantenartikelnummer</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+ <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
+ <title>Variablen für die einzelnen Zahlungseingänge</title>
+
+ <variablelist>
<varlistentry>
- <term><varname>payment_description</varname></term>
+ <term><varname>payment</varname></term>
<listitem>
- <para>Name der Zahlart</para>
+ <para>Betrag</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>payment_terms</varname></term>
+ <term><varname>paymentaccount</varname></term>
<listitem>
- <para>Zahlungskonditionen</para>
+ <para>Konto</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>quodate</varname></term>
+ <term><varname>paymentdate</varname></term>
<listitem>
- <para>Angebotsdatum</para>
+ <para>Datum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>quonumber</varname></term>
+ <term><varname>paymentmemo</varname></term>
<listitem>
- <para>Angebotsnummer</para>
+ <para>Memo</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>shippingpoint</varname></term>
+ <term><varname>paymentsource</varname></term>
<listitem>
- <para>Versandort</para>
+ <para>Beleg</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
+ <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
+
+ <para>Die vom Benutzer definierten Variablen für Kunden und
+ Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
+ ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
+ <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
+ Variablennamen zusammen.</para>
+
+ <para>Beispiel: Der Benutzer hat eine Variable namens
+ <varname>number_of_employees</varname> definiert, die die Anzahl der
+ 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>
+
+ <para>Analog stehen die benutzerdefinierten Variablen für
+ Ansprechpersonen mit dem Namenspräfix <varname>cp_cvar_</varname>
+ zur Verfügung.</para>
+ </sect3>
+ </sect2>
+
+ <sect2 id="dokumentenvorlagen-und-variablen.dunning">
+ <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
+ <title>Namen der Vorlagen</title>
+
+ <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
+ eingegeben. Wird für ein Mahnlevel die Option zur automatischen
+ Erstellung einer Rechnung über die Mahngebühren und Zinsen
+ aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
+ Vorlagenname für diese Mahnstufe mit dem Zusatz
+ <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
+ für die ausgewählte Sprache und den ausgewählten Drucker
+ angehängt.</para>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
+ <title>Allgemeine Variablen in Mahnungen</title>
+ <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. 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>
+
+ <variablelist>
<varlistentry>
- <term><varname>shipvia</varname></term>
+ <term><varname>dunning_date</varname></term>
<listitem>
- <para>Transportmittel</para>
+ <para>Datum der Mahnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>subtotal</varname></term>
+ <term><varname>dunning_duedate</varname></term>
<listitem>
- <para>Zwischensumme aller Posten ohne Steuern</para>
+ <para>Fälligkeitsdatum für diese Mahhnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>total</varname></term>
+ <term><varname>dunning_id</varname></term>
<listitem>
- <para>Restsumme der Rechnung (Summe abzüglich bereits
- bezahlter Posten)</para>
+ <para>Mahnungsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>transaction_description</varname></term>
+ <term><varname>fee</varname></term>
<listitem>
- <para>Vorgangsbezeichnung</para>
+ <para>Kumulative Mahngebühren</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>transdate</varname></term>
+ <term><varname>interest_rate</varname></term>
<listitem>
- <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
- erstellt wurde</para>
+ <para>Zinssatz per anno in Prozent</para>
</listitem>
</varlistentry>
- </variablelist>
- </sect3>
-
- <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
- <title>Variablen für jeden Posten auf der Rechnung</title>
- <variablelist>
<varlistentry>
- <term><varname>bin</varname></term>
+ <term><varname>total_amount</varname></term>
<listitem>
- <para>Stellage</para>
+ <para>Gesamter noch zu zahlender Betrag als
+ <function>fee</function> + <function>total_interest</function>
+ + <function>total_open_amount</function></para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>description</varname></term>
+ <term><varname>total_interest</varname></term>
<listitem>
- <para>Artikelbeschreibung</para>
+ <para>Zinsen per anno über alle Rechnungen</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>cusordnumber_oe</varname></term>
+ <term><varname>total_open_amount</varname></term>
<listitem>
- <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der Posten ursprünglich stammt (nur Verkauf)</para>
+ <para>Summe über alle offene Beträge der Rechnungen</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
+ <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
+ <variablelist>
<varlistentry>
- <term><varname>discount</varname></term>
+ <term><varname>dn_amount</varname></term>
<listitem>
- <para>Rabatt als Betrag</para>
+ <para>Rechnungssumme (brutto)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>discount_sub</varname></term>
+ <term><varname>dn_duedate</varname></term>
<listitem>
- <para>Zwischensumme mit Rabatt</para>
+ <para>Originales Fälligkeitsdatum der Rechnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>donumber_do</varname></term>
+ <term><varname>dn_dunning_date</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>
+ <para>Datum der Mahnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>drawing</varname></term>
+ <term><varname>dn_dunning_duedate</varname></term>
<listitem>
- <para>Zeichnung</para>
+ <para>Fälligkeitsdatum der Mahnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>ean</varname></term>
+ <term><varname>dn_fee</varname></term>
<listitem>
- <para>EAN-Code</para>
+ <para>Kummulative Mahngebühr</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>image</varname></term>
+ <term><varname>dn_interest</varname></term>
<listitem>
- <para>Grafik</para>
+ <para>Zinsen per anno für diese Rechnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>linetotal</varname></term>
+ <term><varname>dn_invnumber</varname></term>
<listitem>
- <para>Zeilensumme (Anzahl * Einzelpreis)</para>
+ <para>Rechnungsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>longdescription</varname></term>
+ <term><varname>dn_linetotal</varname></term>
<listitem>
- <para>Langtext</para>
+ <para>Noch zu zahlender Betrag (ergibt sich aus
+ <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
+ + <varname>dn_interest</varname>)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>microfiche</varname></term>
+ <term><varname>dn_netamount</varname></term>
<listitem>
- <para>Mikrofilm</para>
+ <para>Rechnungssumme (netto)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>netprice</varname></term>
+ <term><varname>dn_open_amount</varname></term>
<listitem>
- <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>
+ <para>Offener Rechnungsbetrag</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>nodiscount_linetotal</varname></term>
+ <term><varname>dn_ordnumber</varname></term>
<listitem>
- <para>Zeilensumme ohne Rabatt</para>
+ <para>Bestellnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>nodiscount_sub</varname></term>
+ <term><varname>dn_transdate</varname></term>
<listitem>
- <para>Zwischensumme ohne Rabatt</para>
+ <para>Rechnungsdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>number</varname></term>
+ <term><varname>dn_curr</varname></term>
<listitem>
- <para>Artikelnummer</para>
+ <para>Währung, in der die Rechnung erstellt wurde. (Die
+ Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
+ <title>Variablen in automatisch erzeugten Rechnungen über
+ Mahngebühren</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>,
+ <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>
+
+ <para>Weitere Variablen beinhalten:</para>
+
+ <variablelist>
<varlistentry>
- <term><varname>ordnumber_oe</varname></term>
+ <term><varname>duedate</varname></term>
<listitem>
- <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>
+ <para>Fälligkeitsdatum der Rechnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>p_discount</varname></term>
+ <term><varname>dunning_id</varname></term>
<listitem>
- <para>Rabatt in Prozent</para>
+ <para>Mahnungsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>partnotes</varname></term>
+ <term><varname>fee</varname></term>
<listitem>
- <para>Die beim Artikel gespeicherten Bemerkungen</para>
+ <para>Mahngebühren</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>partsgroup</varname></term>
+ <term><varname>interest</varname></term>
<listitem>
- <para>Warengruppe</para>
+ <para>Zinsen</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>price_factor</varname></term>
+ <term><varname>invamount</varname></term>
<listitem>
- <para>Der Preisfaktor als Zahl, sofern einer eingestellt
- ist</para>
+ <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
+ <varname>interest</varname>)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>price_factor_name</varname></term>
+ <term><varname>invdate</varname></term>
<listitem>
- <para>Der Name des Preisfaktors, sofern einer eingestellt
- ist</para>
+ <para>Rechnungsdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>projectnumber</varname></term>
+ <term><varname>invnumber</varname></term>
<listitem>
- <para>Projektnummer</para>
+ <para>Rechnungsnummer</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+ </sect2>
+
+ <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
+ <title>Variablen in anderen Vorlagen</title>
+
+ <sect3>
+ <title>Einführung</title>
+
+ <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
+ Rechnung. Allerdings heißen die Variablen, die mit
+ <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
+ fangen sie mit <varname>quo</varname> für "quotation" an:
+ <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
+ wiederum fangen sie mit <varname>ord</varname> für "order" an:
+ <varname>ordnumber</varname> für Bestellnummer etc.</para>
+
+ <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
+ vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
+ sind Variablen, die vom Geschäftsablauf her in der entsprechenden
+ Vorlage keine Bedeutung haben oder noch nicht belegt sein
+ können.</para>
+ <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
+ in Rechnungen aufgeführt.</para>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
+ <title>Angebote und Preisanfragen</title>
+
+ <variablelist>
<varlistentry>
- <term><varname>projectdescription</varname></term>
+ <term><varname>quonumber</varname></term>
<listitem>
- <para>Projektbeschreibung</para>
+ <para>Angebots- bzw. Anfragenummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>qty</varname></term>
+ <term><varname>reqdate</varname></term>
<listitem>
- <para>Anzahl</para>
+ <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
+ Preisanfragen)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>reqdate</varname></term>
+ <term><varname>transdate</varname></term>
<listitem>
- <para>Lieferdatum</para>
+ <para>Angebots- bzw. Anfragedatum</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
+ <title>Auftragsbestätigungen und Lieferantenaufträge</title>
+ <variablelist>
<varlistentry>
- <term><varname>runningnumber</varname></term>
+ <term><varname>ordnumber</varname></term>
<listitem>
- <para>Position auf der Rechnung (1, 2, 3...)</para>
+ <para>Auftragsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>sellprice</varname></term>
+ <term><varname>reqdate</varname></term>
<listitem>
- <para>Verkaufspreis</para>
+ <para>Lieferdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>serialnumber</varname></term>
+ <term><varname>transdate</varname></term>
<listitem>
- <para>Seriennummer</para>
+ <para>Auftragsdatum</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
+ <title>Lieferscheine (Verkauf und Einkauf)</title>
+ <variablelist>
<varlistentry>
- <term><varname>tax_rate</varname></term>
+ <term><varname>cusordnumber</varname></term>
<listitem>
- <para>Steuersatz</para>
+ <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
+ des Lieferanten (im Einkauf)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>transdate_do</varname></term>
+ <term><varname>donumber</varname></term>
<listitem>
- <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des Workflows aus einem Lieferschein stammte.</para>
+ <para>Lieferscheinnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>transdate_oe</varname></term>
+ <term><varname>transdate</varname></term>
<listitem>
- <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>
+ <para>Lieferscheindatum</para>
</listitem>
</varlistentry>
+ </variablelist>
+
+ <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
+ mit den Informationen darüber, von welchem Lager und Lagerplatz aus
+ die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
+ Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
+ <function>foreach</function>-Schleife ausgegeben werden. Diese
+ Variablen sind:</para>
+ <variablelist>
<varlistentry>
- <term><varname>transdate_quo</varname></term>
+ <term><varname>si_bin</varname></term>
<listitem>
- <para>Datum des Angebots, wenn die Position im Rahmen des Workflows aus einem Angebot stammte.</para>
+ <para>Lagerplatz</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>unit</varname></term>
+ <term><varname>si_chargenumber</varname></term>
<listitem>
- <para>Einheit</para>
+ <para>Chargennummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>weight</varname></term>
+ <term><varname>si_bestbefore</varname></term>
<listitem>
- <para>Gewicht</para>
+ <para>Mindesthaltbarkeit</para>
</listitem>
</varlistentry>
- </variablelist>
-
- <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
- über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
- einer <function>foreach</function>-Schleife ausgegeben werden, da
- für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
- können. Die Variablen dafür lauten:</para>
- <variablelist>
<varlistentry>
- <term><varname>make</varname></term>
+ <term><varname>si_number</varname></term>
<listitem>
- <para>Lieferant</para>
+ <para>Artikelnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>model</varname></term>
+ <term><varname>si_qty</varname></term>
<listitem>
- <para>Lieferantenartikelnummer</para>
+ <para>Anzahl bzw. Menge</para>
</listitem>
</varlistentry>
- </variablelist>
- </sect3>
-
- <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
- <title>Variablen für die einzelnen Zahlungseingänge</title>
- <variablelist>
<varlistentry>
- <term><varname>payment</varname></term>
+ <term><varname>si_runningnumber</varname></term>
<listitem>
- <para>Betrag</para>
+ <para>Positionsnummer (1, 2, 3 etc)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>paymentaccount</varname></term>
+ <term><varname>si_unit</varname></term>
<listitem>
- <para>Konto</para>
+ <para>Einheit</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>paymentdate</varname></term>
+ <term><varname>si_warehouse</varname></term>
<listitem>
- <para>Datum</para>
+ <para>Lager</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+ <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
+ <title>Variablen für Sammelrechnung</title>
+
+ <variablelist>
<varlistentry>
- <term><varname>paymentmemo</varname></term>
+ <term><varname>c0total</varname></term>
<listitem>
- <para>Memo</para>
+ <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
+ Tage</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>paymentsource</varname></term>
+ <term><varname>c30total</varname></term>
<listitem>
- <para>Beleg</para>
+ <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
+ und < 60 Tage</para>
</listitem>
</varlistentry>
- </variablelist>
- </sect3>
- <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
- <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
-
- <para>Die vom Benutzer definierten Variablen für Kunden und
- Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
- ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
- <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
- Variablennamen zusammen.</para>
-
- <para>Beispiel: Der Benutzer hat eine Variable namens
- <varname>number_of_employees</varname> definiert, die die Anzahl der
- Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
- unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
- Verfügung.</para>
- </sect3>
- </sect2>
+ <varlistentry>
+ <term><varname>c60total</varname></term>
- <sect2 id="dokumentenvorlagen-und-variablen.dunning">
- <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
+ <listitem>
+ <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
+ und < 90 Tage</para>
+ </listitem>
+ </varlistentry>
- <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
- <title>Namen der Vorlagen</title>
+ <varlistentry>
+ <term><varname>c90total</varname></term>
- <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
- eingegeben. Wird für ein Mahnlevel die Option zur automatischen
- Erstellung einer Rechnung über die Mahngebühren und Zinsen
- aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
- Vorlagenname für diese Mahnstufe mit dem Zusatz
- <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
- für die ausgewählte Sprache und den ausgewählten Drucker
- angehängt.</para>
- </sect3>
+ <listitem>
+ <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
+ Tage</para>
+ </listitem>
+ </varlistentry>
- <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
- <title>Allgemeine Variablen in Mahnungen</title>
+ <varlistentry>
+ <term><varname>total</varname></term>
- <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>,
- <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>
+ <listitem>
+ <para>Gesamtbetrag aller Rechnungen</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
- <para>Weitere Variablen beinhalten:</para>
+ <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
<variablelist>
<varlistentry>
- <term><varname>dunning_date</varname></term>
+ <term><varname>invnumber</varname></term>
<listitem>
- <para>Datum der Mahnung</para>
+ <para>Rechnungsnummer</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>dunning_duedate</varname></term>
+ <term><varname>invdate</varname></term>
<listitem>
- <para>Fälligkeitsdatum für diese Mahhnung</para>
+ <para>Rechnungsdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>dunning_id</varname></term>
+ <term><varname>duedate</varname></term>
<listitem>
- <para>Mahnungsnummer</para>
+ <para>Fälligkeitsdatum</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>fee</varname></term>
+ <term><varname>amount</varname></term>
<listitem>
- <para>Kummulative Mahngebühren</para>
+ <para>Summe der Rechnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>interest_rate</varname></term>
+ <term><varname>open</varname></term>
<listitem>
- <para>Zinssatz per anno in Prozent</para>
+ <para>Noch offener Betrag der Rechnung</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>total_amount</varname></term>
+ <term><varname>c0</varname></term>
<listitem>
- <para>Gesamter noch zu zahlender Betrag als
- <function>fee</function> + <function>total_interest</function>
- + <function>total_open_amount</function></para>
+ <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
+ Tage</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>total_interest</varname></term>
+ <term><varname>c30</varname></term>
<listitem>
- <para>Zinsen per anno über alle Rechnungen</para>
+ <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
+ < 60 Tage</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><varname>total_open_amount</varname></term>
+ <term><varname>c60</varname></term>
<listitem>
- <para>Summe über alle offene Beträge der Rechnungen</para>
+ <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
+ < 90 Tage</para>
</listitem>
</varlistentry>
- </variablelist>
- </sect3>
-
- <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
- <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
- <variablelist>
<varlistentry>
- <term><varname>dn_amount</varname></term>
+ <term><varname>c90</varname></term>
<listitem>
- <para>Rechnungssumme (brutto)</para>
+ <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
+ Tage</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </sect3>
+ </sect2>
+
+ <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
+ <title>Blöcke, bedingte Anweisungen und Schleifen</title>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
+ <title>Einführung</title>
+
+ <para>Der Parser kennt neben den Variablen einige weitere
+ Konstrukte, die gesondert behandelt werden. Diese sind wie
+ Variablennamen in spezieller Weise markiert:
+ <command><%anweisung%> ... <%end%></command></para>
+
+ <para>Anmerkung zum <command><%end%></command>: Der besseren
+ Verständlichkeit halber kann man nach dem <command>end</command>
+ noch beliebig weitere Wörter schreiben, um so zu markieren, welche
+ Anweisung (z.B. <command>if</command> oder
+ <command>foreach</command>) damit abgeschlossen wird.</para>
+
+ <para>Beispiel: Lautet der Beginn eines Blockes z.B.
+ <command><%if type == "sales_quotation"%></command>, so könnte
+ er mit <command><%end%></command> genauso abgeschlossen werden
+ wie mit <command><%end if%></command> oder auch
+ <command><%end type == "sales_quotation"%></command>.</para>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
+ <title>Der if-Block</title>
+
+ <programlisting><%if variablenname%>
+...
+<%end%></programlisting>
+
+ <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
+ 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>
+
+ <programlisting><%if not cp_greeting%>
+...
+<%end%></programlisting>
+
+ <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
+ oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
+ einer Variablen mit einer festen Zeichenkette oder einer anderen
+ Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
+ oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
+ die rechte Seite des Vergleichsoperators in Anführungszeichen
+ gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
+ anderer Variablen). Zwei Beispiele, die beide Vergleiche
+ zeigen:</para>
+
+ <programlisting><%if var1 == "Wert"%></programlisting>
+
+ <para>Testet die Variable <varname>var1</varname> auf
+ übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
+ Mittels <function>!=</function> anstelle von <function>==</function>
+ würde auf Ungleichheit getestet.</para>
+
+ <programlisting><%if var1 == var2%></programlisting>
+
+ <para>Testet die Variable <varname>var1</varname> auf
+ übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
+ <function>!=</function> anstelle von <function>==</function> würde
+ 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
+ Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
+ dieselbe Syntax wie oben nur mit <function>=~</function> und
+ <function>!~</function> als Vergleichsoperatoren.</para>
+
+ <para>Beispiel für einen Test, ob die Variable
+ <varname>intnotes</varname> (interne Bemerkungen) das Wort
+ <constant>schwierig</constant> enthält:</para>
+
+ <programlisting><%if intnotes =~ "schwierig"%></programlisting>
+ </sect3>
+
+ <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
+ <title>Der foreach-Block</title>
+
+ <programlisting><%foreach variablenname%>
+...
+<%end%></programlisting>
+
+ <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
+ wie das Perl-Array der Variablen <varname>variablenname</varname>
+ Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
+ Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
+ benutzt. In jedem Durchlauf werden die <link
+ linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
+ Variablen</link> jeweils auf den Wert für die aktuelle Position
+ gesetzt.</para>
+
+ <para>Die Syntax sieht normalerweise wie folgt aus:</para>
+
+ <programlisting><%foreach number%>
+Position: <%runningnumber%>
+Anzahl: <%qty%>
+Artikelnummer: <%number%>
+Beschreibung: <%description%>
+...
+<%end%></programlisting>
+
+ <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
+ <function><%foreach%></function>-Block innerhalb einer
+ Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
+ wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
+ Inhalt zwischen <function><%foreach%></function> und
+ <function><%end%></function> wiederholt, nicht aber die
+ komplette Zeile, in der er steht.</para>
+ </sect3>
+ </sect2>
+
+ <sect2 id="dokumentenvorlagen-und-variablen.markup">
+ <title>Markup-Code zur Textformatierung innerhalb von
+ Formularen</title>
+
+ <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
+ anders formatiert haben möchte, so ist dies begrenzt möglich.
+ kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
+ Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
+ Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
+ dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
+ (HTML oder PDF über LaTeX) umgesetzt.</para>
+
+ <para>Die unterstützen Formatierungen sind:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><b>Text</b></term>
+
+ <listitem>
+ <para>Text wird in Fettdruck gesetzt.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><i>Text</i></term>
+
+ <listitem>
+ <para>Text wird kursiv gesetzt.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><u>Text</u></term>
+
+ <listitem>
+ <para>Text wird unterstrichen.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><varname>dn_duedate</varname></term>
+ <varlistentry>
+ <term><s>Text</s></term>
- <listitem>
- <para>Originales Fälligkeitsdatum der Rechnung</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Text wird durchgestrichen. Diese Formatierung ist nicht
+ bei der Ausgabe als PDF über LaTeX verfügbar.</para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><varname>dn_dunning_date</varname></term>
+ <varlistentry>
+ <term><bullet></term>
- <listitem>
- <para>Datum der Mahnung</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
+ unten).</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
- <varlistentry>
- <term><varname>dn_dunning_duedate</varname></term>
+ <para>Der Befehl <command><bullet></command> funktioniert
+ momentan auch nur in Latex-Vorlagen.</para>
+ </sect2>
- <listitem>
- <para>Fälligkeitsdatum der Mahnung</para>
- </listitem>
- </varlistentry>
+ <sect2 id="dokumentenvorlagen-und-variablen.anrede"
+ xreflabel="Hinweise zur Anrede">
+ <title>Hinweise zur Anrede</title>
+
+ <para>Das Flag "natürliche Person"
+ (<varname>natural_person</varname>) aus den Kunden- oder
+ Lieferantenstammdaten kann in den Druckvorlagen zusammen mit
+ dem Feld "Anrede" (<varname>greeting</varname>) z.B. dafür
+ verwendet werden, die Anrede zwischen einer allgemeinen und
+ einer persönlichen Anrede zu unterscheiden.
+ <programlisting><%if natural_person%><%greeting%> <%name%><%else%>Sehr geehrte Damen und Herren<%end if%></programlisting>
+ </para>
+ </sect2>
- <varlistentry>
- <term><varname>dn_fee</varname></term>
+ </sect1>
- <listitem>
- <para>Kummulative Mahngebühr</para>
- </listitem>
- </varlistentry>
+ <sect1 id="excel-templates">
+ <title>Excel-Vorlagen</title>
- <varlistentry>
- <term><varname>dn_interest</varname></term>
+ <sect2 id="excel-templates.summary">
+ <title>Zusammenfassung</title>
- <listitem>
- <para>Zinsen per anno für diese Rechnung</para>
- </listitem>
- </varlistentry>
+ <para>Dieses Dokument beschreibt den Mechanismus, mit dem
+ Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
+ einhergehen.</para>
+ </sect2>
- <varlistentry>
- <term><varname>dn_invnumber</varname></term>
+ <sect2 id="excel-templates.usage">
+ <title>Bedienung</title>
- <listitem>
- <para>Rechnungsnummer</para>
- </listitem>
- </varlistentry>
+ <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
+ werden. Die Konfigurationsoption heißt <varname>excel_templates =
+ 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
- <varlistentry>
- <term><varname>dn_linetotal</varname></term>
+ <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
+ anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
+ werden. In den normalen Verkaufsmasken taucht nun
+ <constant>Excel</constant> als auswählbares Format auf und kann von da
+ an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
- <listitem>
- <para>Noch zu zahlender Betrag (ergibt sich aus
- <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
- + <varname>dn_interest</varname>)</para>
- </listitem>
- </varlistentry>
+ <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
+ eine Angebotsvorlage und wird unter dem internen Namen der Angebote
+ <filename>sales_quotation.xls</filename> gespeichert.</para>
+ </sect2>
- <varlistentry>
- <term><varname>dn_netamount</varname></term>
+ <sect2 id="excel-templates.syntax">
+ <title>Variablensyntax</title>
- <listitem>
- <para>Rechnungssumme (netto)</para>
- </listitem>
- </varlistentry>
+ <para>Einfache Syntax:
+ <command><<varname>></command></para>
- <varlistentry>
- <term><varname>dn_open_amount</varname></term>
+ <para>Dabei sind <constant><<</constant> und
+ <constant>>></constant> die Delimiter. Da Excel auf festen
+ Breiten besteht, kann der Tag künstlich verlängert werden, indem
+ weitere <constant><</constant> oder <constant>></constant>
+ eingefügt werden. Der Tag muss nicht symmetrisch sein.
+ Beispiel:</para>
- <listitem>
- <para>Offener Rechnungsbetrag</para>
- </listitem>
- </varlistentry>
+ <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
- <varlistentry>
- <term><varname>dn_ordnumber</varname></term>
+ <para>Um die Limitierung der festen Breite zu reduzieren, können
+ weitere Variablen in einem Block interpoliert werden. Whitespace wird
+ dazwishen dann erhalten. Beispiel:</para>
- <listitem>
- <para>Bestellnummer</para>
- </listitem>
- </varlistentry>
+ <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
- <varlistentry>
- <term><varname>dn_transdate</varname></term>
+ <para>Die Variablen werden interpoliert, und linksbündig mit
+ Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
+ lang, werden überzählige Zeichen abgeschnitten.</para>
- <listitem>
- <para>Rechnungsdatum</para>
- </listitem>
- </varlistentry>
+ <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
+ der Block mit einem Leerzeichen anfängt. Beispiel:</para>
- <varlistentry>
- <term><varname>dn_curr</varname></term>
+ <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
- <listitem>
- <para>Währung, in der die Rechnung erstellt wurde. (Die
- Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect3>
+ <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
+ Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
+ entfernt.</para>
+ </sect2>
- <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
- <title>Variablen in automatisch erzeugten Rechnungen über
- Mahngebühren</title>
+ <sect2 id="excel-templates.limitations">
+ <title>Einschränkungen</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>,
- <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>
+ <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>Weitere Variablen beinhalten:</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>
- <variablelist>
- <varlistentry>
- <term><varname>duedate</varname></term>
+ <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>
- <listitem>
- <para>Fälligkeitsdatum der Rechnung</para>
- </listitem>
- </varlistentry>
+ <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>
- <varlistentry>
- <term><varname>dunning_id</varname></term>
+ <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>
- <listitem>
- <para>Mahnungsnummer</para>
- </listitem>
- </varlistentry>
+ <para>Zusätzliche Funktionshinweise:</para>
- <varlistentry>
- <term><varname>fee</varname></term>
+ <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>Mahngebühren</para>
- </listitem>
- </varlistentry>
+ <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>
- <varlistentry>
- <term><varname>interest</varname></term>
+ <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>
- <listitem>
- <para>Zinsen</para>
- </listitem>
- </varlistentry>
+ <sect1 id="features.part_classification">
+ <title>Artikelklassifizierung</title>
- <varlistentry>
- <term><varname>invamount</varname></term>
+ <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>
- <listitem>
- <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
- <varname>interest</varname>)</para>
- </listitem>
- </varlistentry>
+ <sect2>
+ <title>Basisklassifizierung</title>
- <varlistentry>
- <term><varname>invdate</varname></term>
+ <para>Als Basisklassifizierungen gibt es</para>
- <listitem>
- <para>Rechnungsdatum</para>
- </listitem>
- </varlistentry>
+ <itemizedlist>
+ <listitem>
+ <para>Einkauf</para>
+ </listitem>
- <varlistentry>
- <term><varname>invnumber</varname></term>
+ <listitem>
+ <para>Verkauf</para>
+ </listitem>
- <listitem>
- <para>Rechnungsnummer</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect3>
- </sect2>
+ <listitem>
+ <para>Handelsware</para>
+ </listitem>
- <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
- <title>Variablen in anderen Vorlagen</title>
+ <listitem>
+ <para>Produktion</para>
+ </listitem>
- <sect3>
- <title>Einführung</title>
+ <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>
- <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
- Rechnung. Allerdings heißen die Variablen, die mit
- <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
- fangen sie mit <varname>quo</varname> für "quotation" an:
- <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
- wiederum fangen sie mit <varname>ord</varname> für "order" an:
- <varname>ordnumber</varname> für Bestellnummer etc.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Lieferung (Logistik, Transport) mit Kürzel L</para>
+ </listitem>
- <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
- vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
- sind Variablen, die vom Geschäftsablauf her in der entsprechenden
- Vorlage keine Bedeutung haben oder noch nicht belegt sein
- können.</para>
+ <listitem>
+ <para>Material (Verpackungsmaterial) mit Kürzel M</para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
- <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
- in Rechnungen aufgeführt.</para>
- </sect3>
+ <sect2>
+ <title>Attribute</title>
- <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
- <title>Angebote und Preisanfragen</title>
+ <para>Bisher haben die Klassifizierungen folgende Attribute, die auch
+ alle gleichzeitg gültig sein können</para>
- <variablelist>
- <varlistentry>
- <term><varname>quonumber</varname></term>
+ <itemizedlist>
+ <listitem>
+ <para>gültig für Verkauf - dieser Artikel kann im Verkauf genutzt
+ werden</para>
+ </listitem>
- <listitem>
- <para>Angebots- bzw. Anfragenummer</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>gültig für Einkauf - dieser Artikel kann im Einkauf genutzt
+ werden</para>
+ </listitem>
- <varlistentry>
- <term><varname>reqdate</varname></term>
+ <listitem>
+ <para>separat ausweisen - hierzu gibt es zur Dokumentengenerierung
+ (LaTeX) eine zusätzliche Variable</para>
+ </listitem>
+ </itemizedlist>
- <listitem>
- <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
- Preisanfragen)</para>
- </listitem>
- </varlistentry>
+ <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>
- <varlistentry>
- <term><varname>transdate</varname></term>
+ <sect2>
+ <title>Zwei-Zeichen Abkürzung</title>
- <listitem>
- <para>Angebots- bzw. Anfragedatum</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect3>
+ <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>
- <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
- <title>Auftragsbestätigungen und Lieferantenaufträge</title>
+ <para>Der zweite Buchstabe (und ggf. auch ein dritter, falls nötig)
+ entspricht der lokalisierten Abkürzung der Klassifizierung.</para>
- <variablelist>
- <varlistentry>
- <term><varname>ordnumber</varname></term>
+ <para>Diese Abkürzung wird überall beim Auflisten von Artikeln zur
+ Erleichterung mit dargestellt.</para>
+ </sect2>
+ </sect1>
- <listitem>
- <para>Auftragsnummer</para>
- </listitem>
- </varlistentry>
+ <sect1 id="features.file_managment">
+ <title>Dateiverwaltung (Mini-DMS)</title>
- <varlistentry>
- <term><varname>reqdate</varname></term>
+ <sect2>
+ <title>Übersicht</title>
- <listitem>
- <para>Lieferdatum</para>
- </listitem>
- </varlistentry>
+ <para>Parallel zum alten WebDAV gibt es ein Datei-Management-System,
+ das Dateien verschiedenen Typs verwaltet. Dies können</para>
- <varlistentry>
- <term><varname>transdate</varname></term>
+ <orderedlist>
+ <listitem>
+ <para>aus ERP-Daten per LaTeX Template erzeugte
+ PDF-Dokumente,</para>
+ </listitem>
- <listitem>
- <para>Auftragsdatum</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect3>
+ <listitem>
+ <para>zu bestimmten ERP-Daten gehörende Anhangdateien
+ unterschiedlichen Formats,</para>
+ </listitem>
- <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
- <title>Lieferscheine (Verkauf und Einkauf)</title>
+ <listitem>
+ <para>per Scanner eingelesene PDF-Dateien,</para>
+ </listitem>
- <variablelist>
- <varlistentry>
- <term><varname>cusordnumber</varname></term>
+ <listitem>
+ <para>per E-Mail empfangene Dateianhänge unterschiedlichen
+ Formats,</para>
+ </listitem>
- <listitem>
- <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
- des Lieferanten (im Einkauf)</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>sowie speziel für Artikel hochgeladene Bilder sein.</para>
+ </listitem>
+ </orderedlist>
- <varlistentry>
- <term><varname>donumber</varname></term>
+ <screenshot>
+ <screeninfo>Übersicht</screeninfo>
- <listitem>
- <para>Lieferscheinnummer</para>
- </listitem>
- </varlistentry>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="600" fileref="images/DMS-Overview.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </sect2>
- <varlistentry>
- <term><varname>transdate</varname></term>
+ <sect2>
+ <title>Struktur</title>
- <listitem>
- <para>Lieferscheindatum</para>
- </listitem>
- </varlistentry>
- </variablelist>
+ <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>
- <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
- mit den Informationen darüber, von welchem Lager und Lagerplatz aus
- die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
- Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
- <function>foreach</function>-Schleife ausgegeben werden. Diese
- Variablen sind:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Dateisystem</para>
+ </listitem>
- <variablelist>
- <varlistentry>
- <term><varname>si_bin</varname></term>
+ <listitem>
+ <para>WebDAV</para>
+ </listitem>
- <listitem>
- <para>Lagerplatz</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Schnittstelle zu externen
+ Dokumenten-Management-Systemen</para>
+ </listitem>
- <varlistentry>
- <term><varname>si_chargenumber</varname></term>
+ <listitem>
+ <para>andere Datenbank</para>
+ </listitem>
- <listitem>
- <para>Chargennummer</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>etc ...</para>
+ </listitem>
+ </itemizedlist>
- <varlistentry>
- <term><varname>si_bestbefore</varname></term>
+ <para>Es gibt unterschiedliche Typen von Dateien. Jedem Typ läßt sich
+ in der Mandantenkonfiguration ein bestimmtes Backend zuordnen.</para>
- <listitem>
- <para>Mindesthaltbarkeit</para>
- </listitem>
- </varlistentry>
+ <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>
- <varlistentry>
- <term><varname>si_number</varname></term>
+ <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>Artikelnummer</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>"image": Bilder für Artikel. Diese können auch verkleinert
+ in einer Vorschau (Thumbnail) angezeigt werden.</para>
+ </listitem>
+ </itemizedlist>
- <varlistentry>
- <term><varname>si_qty</varname></term>
+ <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>
- <listitem>
- <para>Anzahl bzw. Menge</para>
- </listitem>
- </varlistentry>
+ <itemizedlist>
+ <listitem>
+ <para>"created": vom System erzeugte Dokumente"</para>
+ </listitem>
- <varlistentry>
- <term><varname>si_runningnumber</varname></term>
+ <listitem>
+ <para>"uploaded": hochgeladene Dokumente</para>
+ </listitem>
- <listitem>
- <para>Positionsnummer (1, 2, 3 etc)</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>"email": vom Mail-System empfangene Dateien</para>
+ </listitem>
- <varlistentry>
- <term><varname>si_unit</varname></term>
+ <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>
- <listitem>
- <para>Einheit</para>
- </listitem>
- </varlistentry>
+ <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>
- <varlistentry>
- <term><varname>si_warehouse</varname></term>
+ <sect2>
+ <title>Anwendung</title>
- <listitem>
- <para>Lager</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect3>
+ <para>Die Daten werden bei den ERP-Objekten als extra Reiter
+ dargestellt. Eine Verkaufsrechnung z.B. hat die Reiter "Dokumente" und
+ "Dateianhänge".</para>
- <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
- <title>Variablen für Sammelrechnung</title>
+ <screenshot>
+ <screeninfo>Reiter "Dateianhänge"</screeninfo>
- <variablelist>
- <varlistentry>
- <term><varname>c0total</varname></term>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/DMS-Anhaenge.png" scale="50"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
- <listitem>
- <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
- Tage</para>
- </listitem>
- </varlistentry>
+ <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>
- <varlistentry>
- <term><varname>c30total</varname></term>
+ <screenshot>
+ <screeninfo>Reiter "Dateianhänge"</screeninfo>
- <listitem>
- <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
- und < 60 Tage</para>
- </listitem>
- </varlistentry>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="40"
+ fileref="images/DMS-Anhaenge-hochladen.png"
+ width="100"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
- <varlistentry>
- <term><varname>c60total</varname></term>
+ <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>
- <listitem>
- <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
- und < 90 Tage</para>
- </listitem>
- </varlistentry>
+ <screenshot>
+ <screeninfo>Reiter "Dokumente"</screeninfo>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/DMS-Dokumente.png" width="500"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
- <varlistentry>
- <term><varname>c90total</varname></term>
+ <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>
- <listitem>
- <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
- Tage</para>
- </listitem>
- </varlistentry>
+ <screenshot>
+ <screeninfo>Reiter "Dokumente"</screeninfo>
- <varlistentry>
- <term><varname>total</varname></term>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="600"
+ fileref="images/DMS-Dokumente-Scanner.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
- <listitem>
- <para>Gesamtbetrag aller Rechnungen</para>
- </listitem>
- </varlistentry>
- </variablelist>
+ <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>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
+ <para>Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie
+ sind bisher nur bei Bildern relevant.</para>
+ </sect2>
- <variablelist>
- <varlistentry>
- <term><varname>invnumber</varname></term>
+ <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 fileref="images/DMS-ClientConfig.png" width="500"/>
+ </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 fileref="images/DMS-Allgemeine-Dokumentenanhaenge.png"
+ width="500"/>
+ </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>
- <listitem>
- <para>Rechnungsnummer</para>
- </listitem>
- </varlistentry>
+ <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>
- <varlistentry>
- <term><varname>invdate</varname></term>
+ <sect3 id="file_management.kiviconfig"
+ xreflabel="kivitendo-Konfigurationsdatei">
+ <title>kivitendo-Konfigurationsdatei</title>
- <listitem>
- <para>Rechnungsdatum</para>
- </listitem>
- </varlistentry>
+ <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>
- <varlistentry>
- <term><varname>duedate</varname></term>
+ <programlisting>
+[paths]
+document_path = /var/local/kivi_documents
+ </programlisting>
- <listitem>
- <para>Fälligkeitsdatum</para>
- </listitem>
- </varlistentry>
+ <para>Unter diesem Wurzelverzeichnis wird pro Mandant automatisch
+ ein Unterverzeichnis mit der ID des Mandanten angelegt.</para>
+ </sect3>
+ </sect2>
+ </sect1>
- <varlistentry>
- <term><varname>amount</varname></term>
+ <sect1>
+ <title>Webshop-Api</title>
- <listitem>
- <para>Summe der Rechnung</para>
- </listitem>
- </varlistentry>
+ <para>Das Shopmodul bietet die Möglichkeit Onlineshopartikel und
+ Onlineshopbestellungen zu verwalten und zu bearbeiten.</para>
- <varlistentry>
- <term><varname>open</varname></term>
+ <para>Es ist Multishopfähig, d.h. Artikel können mehreren oder
+ unterschiedlichen Shops zugeordnet werden. Bestellungen können aus
+ mehreren Shops geholt werden.</para>
- <listitem>
- <para>Noch offener Betrag der Rechnung</para>
- </listitem>
- </varlistentry>
+ <para>Zur Zeit bietet das Modul nur einen Connector zur REST-Api von
+ Shopware. Weitere Connectoren können dazu programmiert und eingerichtet
+ werden.</para>
- <varlistentry>
- <term><varname>c0</varname></term>
+ <sect2>
+ <title>Rechte für die Webshopapi</title>
- <listitem>
- <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
- Tage</para>
- </listitem>
- </varlistentry>
+ <para>In der Administration können folgende Rechte vergeben
+ werden</para>
- <varlistentry>
- <term><varname>c30</varname></term>
+ <itemizedlist>
+ <listitem>
+ <para>Webshopartikel anlegen und bearbeiten</para>
+ </listitem>
- <listitem>
- <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
- < 60 Tage</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Shopbestellungen holen und bearbeiten</para>
+ </listitem>
- <varlistentry>
- <term><varname>c60</varname></term>
+ <listitem>
+ <para>Shop anlegen und bearbeiten</para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
- <listitem>
- <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
- < 90 Tage</para>
- </listitem>
- </varlistentry>
+ <sect2>
+ <title>Konfiguration</title>
- <varlistentry>
- <term><varname>c90</varname></term>
+ <para>Unter System->Webshops können Shops angelegt und konfiguriert
+ werden</para>
- <listitem>
- <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
- Tage</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect3>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentdepth="500" contentwidth="700"
+ fileref="images/Shop_Listing.png"/>
+ </imageobject>
+ </mediaobject>
</sect2>
- <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
- <title>Blöcke, bedingte Anweisungen und Schleifen</title>
+ <sect2>
+ <title>Webshopartikel</title>
- <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
- <title>Einführung</title>
+ <sect3>
+ <title>Shopvariablenreiter in Artikelstammdaten</title>
- <para>Der Parser kennt neben den Variablen einige weitere
- Konstrukte, die gesondert behandelt werden. Diese sind wie
- Variablennamen in spezieller Weise markiert:
- <command><%anweisung%> ... <%end%></command></para>
+ <para>Mit dem Recht "Shopartikel anlegen und bearbeiten" und des
+ Markers <emphasis role="bold">"Shopartikel" in den Basisdaten
+ </emphasis>zeigt sich der Reiter "Shopvariablen" in den
+ Artikelstammdaten. Hier können jetzt die Artikel mit
+ unterschiedlichen Beschreibung und/oder Preisen für die
+ konfigutierten Shops angelegt und bearbeitet werden. An dieser
+ Stelle können auch beliebig viele Bilder dem Shopartikel zugeordnet
+ werden. Artikelbilder gelten für alle Shops.</para>
- <para>Anmerkung zum <command><%end%></command>: Der besseren
- Verständlichkeit halber kann man nach dem <command>end</command>
- noch beliebig weitere Wörter schreiben, um so zu markieren, welche
- Anweisung (z.B. <command>if</command> oder
- <command>foreach</command>) damit abgeschlossen wird.</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentdepth="500" contentwidth="600"
+ fileref="images/Shop_Artikel.png"/>
+ </imageobject>
+ </mediaobject>
- <para>Beispiel: Lautet der Beginn eines Blockes z.B.
- <command><%if type == "sales_quotation"%></command>, so könnte
- er mit <command><%end%></command> genauso abgeschlossen werden
- wie mit <command><%end if%></command> oder auch
- <command><%end type == "sales_quotation"%></command>.</para>
+ <para>Die Artikelgruppen werden direkt vom Shopsystem geholt somit
+ ist es möglich einen Artikel auch mehreren Gruppen
+ zuzuordenen</para>
</sect3>
- <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
- <title>Der if-Block</title>
+ <sect3>
+ <title>Shopartikelliste</title>
- <programlisting><%if variablenname%>
-...
-<%end%></programlisting>
+ <para>Unter dem Menu Webshop->Webshop Artikel hat man nochmal
+ eine Gesamtübersicht. Von hier aus ist es möglich Artikel im Stapel
+ unter verschiedenen Kriterien <alles><nur Preis><nur
+ Bestand><Preis und Bestand> an die jeweiligen Shops
+ hochzuladen.</para>
- <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
- und dem "end" werden nur ausgegeben, wenn die Variable
- <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Shop_Artikel_Listing.png"/>
+ </imageobject>
+ </mediaobject>
+ </sect3>
+ </sect2>
- <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>
+ <sect2>
+ <title>Bestellimport</title>
- <programlisting><%if payment%>
-Zahlungseingänge:
- <%foreach payment%>
- Am <%paymentdate%>: <%payment%> €
- <%end foreach%>
-<%end if%></programlisting>
+ <para>Unter dem Menupunkt Webshop->Webshop Import öffnet sich die
+ Bestellimportsliste. Hier ist sind Möglichkeiten gegeben Neue
+ Bestellungen vom Shop abzuholen, geholte Bestellungen im Stapel oder
+ einzeln als Auftrag zu transferieren. Die Liste kann nach
+ verschiedenen Kriterien gefiltert werden.</para>
- <para>Die Bedingung kann auch negiert werden, indem das Wort
- <function>not</function> nach dem <filename>if</filename> verwendet
- wird. Beispiel:</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Shop_Bestell.png"/>
+ </imageobject>
+ </mediaobject>
- <programlisting><%if not cp_greeting%>
-...
-<%end%></programlisting>
+ <para>Bei Einträgen in der Liste.</para>
- <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
- oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
- einer Variablen mit einer festen Zeichenkette oder einer anderen
- Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
- oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
- die rechte Seite des Vergleichsoperators in Anführungszeichen
- gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
- anderer Variablen). Zwei Beispiele, die beide Vergleiche
- zeigen:</para>
+ <itemizedlist>
+ <listitem>
+ <para>keine Kundennummer: Es gibt ähnliche Kundendatensätze und
+ der Datensatz konnte nicht eindeutig zugewiesen werden.</para>
+ </listitem>
- <programlisting><%if var1 == "Wert"%></programlisting>
+ <listitem>
+ <para>Kundennummer und Rechnungen rot hinterlegt: Der Kunde hat
+ offene Posten und kann deswegen nicht im Stapel übernommen
+ werden.</para>
+ </listitem>
- <para>Testet die Variable <varname>var1</varname> auf
- übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
- Mittels <function>!=</function> anstelle von <function>==</function>
- würde auf Ungleichheit getestet.</para>
+ <listitem>
+ <para>Rechnungsadresse grün hinterlegt: Der Kunde konnte eindeutig
+ einem Datensatz zugeordnet werden. Die Shopbestellung kann im
+ Stapel mit dem Button "Anwenden" und wenn markiert als Auftrag
+ übernommen werden.</para>
+ </listitem>
- <programlisting><%if var1 == var2%></programlisting>
+ <listitem>
+ <para>Kundennummer vorhanden, aber die Checkbox "Auftrag
+ erstellen" fehlt. Der Kunde hat vermutlich eine
+ Shopauftragssperre.</para>
+ </listitem>
- <para>Testet die Variable <varname>var1</varname> auf
- übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
- <function>!=</function> anstelle von <function>==</function> würde
- auf Ungleichheit getestet.</para>
+ <listitem>
+ <para>Lieferadresse grau hinterlegt: Optische Anzeige, dass es
+ sich um eine unterschiedliche Lieferadresse handelt.
+ Lieferadressen werden aber grundsätzlich beim Transferieren zu
+ Aufträgen mit übernommen.</para>
+ </listitem>
- <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
- auch Tests auf Übereinstimmung 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>
+ <listitem>
+ <para>In der Spalte Positionen/Betrag/Versandkosten zeigt sich ein
+ tooltip zu den Positionen.</para>
+ </listitem>
+ </itemizedlist>
- <para>Beispiel für einen Test, ob die Variable
- <varname>intnotes</varname> (interne Bemerkungen) das Wort
- <constant>schwierig</constant> enthält:</para>
+ <para>Maske Auftrag erstellen</para>
- <programlisting><%if intnotes =~ "schwierig"%></programlisting>
- </sect3>
+ <para>Viele Shopsysteme haben drei verschieden Adresstypen Kunden-,
+ Rechnungs-, und Lieferadresse, die sich auch alle unterscheiden
+ können. Diese werden im oberen Bereich angezeigt. Es ist möglich jede
+ dieser Adresse einzeln in kivitendo als Kunde zu übernehmen. Es werden
+ die Werte Formulareingabe übernommen. Es wird bei einer Änderung
+ allerdings nur diese in die kivitendo Kundenstammdaten übernommen, die
+ Shopbestellung bleibt bestehen.</para>
- <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
- <title>Der foreach-Block</title>
+ <para>Mit der mittleren Adresse(Rechnungsadresse) im oberen Bereich,
+ kann ich den ausgewählten kivitendodatensatz des mittleren Bereich
+ überschreiben. Das ist sinnvoll, wenn ich erkenne, das der Kunde z.B.
+ umgezogen ist.</para>
- <programlisting><%foreach variablenname%>
-...
-<%end%></programlisting>
+ <para>Im mittleren Bereich das Adresslisting zeigt:</para>
- <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
- wie das Perl-Array der Variablen <varname>variablenname</varname>
- Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
- Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
- benutzt. In jedem Durchlauf werden die <link
- linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
- Variablen</link> jeweils auf den Wert für die aktuelle Position
- gesetzt.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Rot hinterlegt: Kunde hat eine Shopauftragssperre, diese
+ muss zuerst deaktiviert werden bevor ich diesem Kunden eine
+ Shopbestellung zuordnen kann.</para>
+ </listitem>
- <para>Die Syntax sieht normalerweise wie folgt aus:</para>
+ <listitem>
+ <para>Kundenname fett und rot: Hier hat der Kunde eine Bemerkung
+ in den Stammdaten. Ein Tooltip zeigt diese Bemerkung. Das kann dan
+ auch der Grund für die Auftragssperre sein.</para>
+ </listitem>
- <programlisting><%foreach number%>
-Position: <%runningnumber%>
-Anzahl: <%qty%>
-Artikelnummer: <%number%>
-Beschreibung: <%description%>
-...
-<%end%></programlisting>
+ <listitem>
+ <para>Die Buttons "Auftrag erstellen" und "Kunde mit
+ Rechnungsadresse überschreiben" zeigen sich erst, wenn ein Kunde
+ aus dem Listing ausgewählt ist.</para>
+ </listitem>
- <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
- <function><%foreach%></function>-Block innerhalb einer
- Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
- wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
- Inhalt zwischen <function><%foreach%></function> und
- <function><%end%></function> wiederholt, nicht aber die
- komplette Zeile, in der er steht.</para>
- </sect3>
+ <listitem>
+ <para>Es ist aber möglich die Shopbestellung zu löschen.</para>
+ </listitem>
+
+ <listitem>
+ <para>Ist eine Bestellung schon übernommen, zeigen sich an dieser
+ Stelle, die dazugehörigen Belegverknüpfungen.</para>
+ </listitem>
+ </itemizedlist>
</sect2>
- <sect2 id="dokumentenvorlagen-und-variablen.markup">
- <title>Markup-Code zur Textformatierung innerhalb von
- Formularen</title>
+ <sect2>
+ <title>Mapping der Daten</title>
+
+ <para>Das Mapping der kivitendo Daten mit den Shopdaten geschieht in
+ der Datei SL/ShopConnector/<SHOPCONNECTORNAME>.pm
+ z.B.:SL/ShopConnector/Shopware.pm</para>
+
+ <para>In dieser Datei gibt es einen Bereich wo die Bestellpostionen,
+ die Bestellkopfdaten und die Artikeldaten gemapt werden. In dieser
+ Datei kann ein individelles Mapping dann gemacht werden. Zu Shopware
+ gibt es hier eine sehr gute Dokumentation: <ulink
+ url="https://developers.shopware.com/developers-guide/rest-api/">https://developers.shopware.com/developers-guide/rest-api/</ulink></para>
+ </sect2>
+ </sect1>
+ <sect1 id="features.zugferd">
+ <title>ZUGFeRD Rechnungen</title>
+ <sect2 id="features.zugferd.preamble">
+ <title>Vorbedingung</title>
+ <para>
+ Für die Erstellung von ZUGFeRD PDFs wird TexLive2018 oder höher benötigt.
+ </para>
+ <note>
+ <para>
+ Wer kein TexLive2018 oder höher installieren kann, kann eine lokale Umgebung nur für kivitendo wie folgt erzeugen:
+ </para>
+ <programlisting>
+ 1. Download des offiziellen Installers von https://www.tug.org/texlive/quickinstall.html
+
+ 2. Installer ausführen, Standard-Ort für Installation belassen, evtl. ein paar Pakete abwählen, installieren lassen
- <para>Wenn der Benutzer innhalb von Formularen in kivitendo Text
- anders formatiert haben möchte, so ist dies begrenzt möglich.
- kivitendo unterstützt die Textformatierung mit HTML-ähnlichen Tags.
- Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
- Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
- dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
- (HTML oder PDF über LaTeX) umgesetzt.</para>
+ 3. Ein kleine Script »run_pdflatex.sh« anlegen, das den PATH auf das Installationsverezichnis setzt und pdflatex ausführt:
- <para>Die unterstützen Formatierungen sind:</para>
+ ------------------------------------------------------------
+ #!/bin/bash
- <variablelist>
- <varlistentry>
- <term><b>Text</b></term>
+ export PATH=/usr/local/texlive/2020/bin/x86_64-linux:$PATH
+ hash -r
- <listitem>
- <para>Text wird in Fettdruck gesetzt.</para>
- </listitem>
- </varlistentry>
+ exec pdflatex "$@"
+ ------------------------------------------------------------
- <varlistentry>
- <term><i>Text</i></term>
+ 4. In config/kivitendo.conf den Parameter »latex« auf den Pfad zu »run_pdflatex.sh« setzen
- <listitem>
- <para>Text wird kursiv gesetzt.</para>
- </listitem>
- </varlistentry>
+ 5. Webserver neu starten
+ </programlisting>
+ </note>
+ </sect2>
+ <sect2 id="features.zugferd.summary">
+ <title>Übersicht</title>
+
+ <para>Mit der Version 3.5.6 bietet kivitendo die Möglichkeit ZUGFeRD
+ Rechnungen zu erstellen, sowie auch ZUGFeRD Rechnungen direkt in
+ kivitendo einzulesen. </para>
+
+ <para>Bei ZUGFeRD Rechnungen handelt es sich um eine PDF Datei in
+ der eine XML-Datei eingebettet ist. Der Aufbau der XML-Datei ist
+ standardisiert und ermöglicht so den Austausch zwischen
+ den verschiedenen Softwareprodukten. Kivitendo setzt mit der
+ Version 3.5.6 den ZUGFeRD 2.1 Standard um.</para>
+
+ <para>Weiter Details zu ZUGFeRD sind unter diesem Link zu finden:
+ <ulink url="https://www.ferd-net.de/standards/was-ist-zugferd/index.html">https://www.ferd-net.de/standards/was-ist-zugferd/index.html</ulink>
+ </para>
+ </sect2>
- <varlistentry>
- <term><u>Text</u></term>
+ <sect2 id="features.zugferd.create_zugferd_bills">
- <listitem>
- <para>Text wird unterstrichen.</para>
- </listitem>
- </varlistentry>
+ <title>Erstellen von ZUGFeRD Rechnungen in Kivitendo</title>
+ <para>Für die Erstellung von ZUGFeRD Rechnungen bedarf es in
+ kivitendo zwei Dinge:</para>
- <varlistentry>
- <term><s>Text</s></term>
+ <orderedlist>
- <listitem>
- <para>Text wird durchgestrichen. Diese Formatierung ist nicht
- bei der Ausgabe als PDF über LaTeX verfügbar.</para>
- </listitem>
- </varlistentry>
+ <listitem>
+ <para>Die Erstellung muss in der Mandantenkonfiguration
+ aktiviert sein</para>
+ </listitem>
- <varlistentry>
- <term><bullet></term>
+ <listitem>
+ <para>Beim mindestens einem Bankkonto muss die Option
+ „Nutzung von ZUGFeRD“ aktiviert sein</para>
+ </listitem>
- <listitem>
- <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
- unten).</para>
- </listitem>
- </varlistentry>
- </variablelist>
+ </orderedlist>
+ <sect3>
+ <title>Mandantenkonfiguration</title>
- <para>Der Befehl <command><bullet></command> funktioniert
- momentan auch nur in Latex-Vorlagen.</para>
- </sect2>
- </sect1>
+ <para>Die Einstellung für die Erstellung von ZUGFeRD Rechnungen
+ erfolgt unter „System“ → „Mandatenkonfiguration“ → „Features“.
+ Im Abschnitt „Einkauf und Verkauf“ finden Sie die Einstellung
+ „Verkaufsrechnungen mit ZUGFeRD-Daten erzeugen“.
+ Hier besteht die Auswahl zwischen:</para>
- <sect1 id="excel-templates">
- <title>Excel-Vorlagen</title>
+ <itemizedlist>
+ <listitem>
+ <para>ZUGFeRD-Rechnungen erzeugen</para>
+ </listitem>
- <sect2 id="excel-templates.summary">
- <title>Zusammenfassung</title>
+ <listitem>
+ <para>ZUGFeRD-Rechnungen im Testmodus erzeugen</para>
+ </listitem>
- <para>Dieses Dokument beschreibt den Mechanismus, mit dem
- Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
- einhergehen.</para>
- </sect2>
+ <listitem>
+ <para>Keine ZUGFeRD Rechnungen erzeugen</para>
+ </listitem>
- <sect2 id="excel-templates.usage">
- <title>Bedienung</title>
+ </itemizedlist>
- <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
- werden. Die Konfigurationsoption heißt <varname>excel_templates =
- 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
+ <para>Rechnungen die als PDF erzeugt werden, werden je nach
+ Einstellung nun im ZUGFeRD Format ausgegeben.</para>
- <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
- anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
- werden. In den normalen Verkaufsmasken taucht nun
- <constant>Excel</constant> als auswählbares Format auf und kann von da
- an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
+ </sect3>
- <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
- eine Angebotsvorlage und wird unter dem internen Namen der Angebote
- <filename>sales_quotation.xls</filename> gespeichert.</para>
- </sect2>
+ <sect3>
+ <title>Konfiguration der Bankkonten</title>
- <sect2 id="excel-templates.syntax">
- <title>Variablensyntax</title>
+ <para>Unter „System → Bankkonten“ muss bei mindestens einem
+ Bankkonto die Option „Nutzung mit ZUGFeRD“ auf „Ja“ gestellt
+ werden.</para>
+ </sect3>
- <para>Einfache Syntax:
- <command><<varname>></command></para>
+ </sect2>
- <para>Dabei sind <constant><<</constant> und
- <constant>>></constant> die Delimiter. Da Excel auf festen
- Breiten besteht, kann der Tag künstlich verlängert werden, indem
- weitere <constant><</constant> oder <constant>></constant>
- eingefügt werden. Der Tag muss nicht symmetrisch sein.
- Beispiel:</para>
+ <sect2 id="features.zugferd.read_zugferd_bills">
- <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
+ <title>Einlesen von ZUGFeRD Rechnungen in Kivitendo</title>
- <para>Um die Limitierung der festen Breite zu reduzieren, können
- weitere Variablen in einem Block interpoliert werden. Whitespace wird
- dazwishen dann erhalten. Beispiel:</para>
+ <para>Es lassen sich auch Rechnungen von Kreditoren, die im
+ ZUGFeRD Format erstellt wurden, nach Kivitendo importieren.
+ Hierfür müssen auch zwei Voraussetzungen erfüllt werden:
+ </para>
- <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
+ <orderedlist>
- <para>Die Variablen werden interpoliert, und linksbündig mit
- Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
- lang, werden überzählige Zeichen abgeschnitten.</para>
+ <listitem>
+ <para>Beim Lieferanten muss die Umsatzsteuer-ID und das
+ Bankkonto hinterlegt sein</para>
+ </listitem>
- <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
- der Block mit einem Leerzeichen anfängt. Beispiel:</para>
+ <listitem>
+ <para>Für den Kreditoren muss eine Buchungsvorlage existieren.</para>
+ </listitem>
- <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
+ </orderedlist>
- <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
- Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
- entfernt.</para>
- </sect2>
+ <para>Wenn diese Voraussetzungen erfüllt sind, kann die Rechnung
+ über „Finanzbuchhaltung“ → „Factur-X-/ZUGFeRD-Import“ über die „Durchsuchen“
+ Schaltfläche ausgewählt werden und über die Schaltfläche „Import“
+ eingeladen werden. Es öffnet sich daraufhin die Kreditorenbuchung.
+ Die auslesbaren Daten aus dem eingebetteten XML der PDF Datei
+ werden in der Kreditorenbuchung ergänzt.</para>
- <sect2 id="excel-templates.limitations">
- <title>Einschränkungen</title>
+ </sect2>
- <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>
+ </sect1>
- <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>
- 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.
- <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>
- Zusätzliche Funktionshinweise:
- <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>
</chapter>
<chapter>
</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>
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
+ <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>
</sect2>
</sect1>
+ <sect1 id="dev-programmatic-api-calls" xreflabel="Programmatische API-Aufrufe">
+ <title>Programmatische API-Aufrufe</title>
+
+ <sect2 id="dev-programmatic-api-calls.introduction" xreflabel="Einführung in programmatische API-Aufrufe">
+ <title>Einführung</title>
+
+ <para>
+ Es ist möglich, Funktionen in kivitendo programmatisch aus anderen Programmen aufzurufen. Dazu ist nötig, dass
+ Authentifizierungsinformationen in jedem Aufruf mitgegeben werden. Dafür gibt es zwei Methoden: die HTTP-»Basic«-Authentifizierung
+ oder die Übergabe als spziell benannte GET-Parameter. Neben den Authentifizierungsinformationen muss auch der zu verwendende Mandant
+ übergeben werden.
+ </para>
+ </sect2>
+
+ <sect2 id="dev-programmatic-api-calls.client_selection" xreflabel="Mandantenauswahl bei programmatischen API-Aufrufen">
+ <title>Wahl des Mandanten</title>
+
+ <para>
+ Der zu verwendende Mandant kann als Parameter <varname>{AUTH}client_id</varname> mit jedem Request mitgeschickt werden. Der Wert
+ muss dabei die Datenbank-ID des Mandanten sein. kivitendo prüft, ob der Account, der über die Authentifizierungsinformationen
+ übergeben wurde, Zugriff auf den angegebenen Mandanten hat.
+ </para>
+
+ <para>
+ Wird in einem Request kein Mandant mitgegeben, so wird derjenige Mandant genommen, wer als Standardmandant markiert wurde. Gibt es
+ keinen solchen, kommt es zu einer Fehlermeldung.
+ </para>
+ </sect2>
+
+ <sect2 id="dev-programmatic-api-calls.http_basic_authentication" xreflabel="Programmatische API-Aufrufe mit HTTP-»Basic« authentifizieren">
+ <title>HTTP-»Basic«-Authentifizierung</title>
+
+ <para>
+ Für diese Methode muss jedem Request der bekannte HTTP-Header <constant>Authorization</constant> mitgeschickt werden (siehe <ulink
+ url="https://tools.ietf.org/html/rfc7617">RFC 7617</ulink>). Unterstützt wird ausschließlich die »Basic«-Methode. Loginname und
+ Passwort werden bei dieser Methode durch einen Doppelpunkt getrennt und Base64-encodiert im genannten HTTP-Header übertragen.
+ </para>
+
+ <para>
+ Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei Benutzung über den Webbrowser, ob
+ dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
+ </para>
+
+ <para>
+ Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
+ erfolgen.
+ </para>
+ </sect2>
+
+ <sect2 id="dev-programmatic-api-calls.authentication_via_parameters" xreflabel="Programmatische API-Aufrufe mit Parametern authentifizieren">
+ <title>Authentifizierung mit Parametern</title>
+
+ <para>
+ Für diese Methode müssen jedem Request zwei Parameter mitgegeben werden: <varname>{AUTH}login</varname> und
+ <varname>{AUTH}password</varname>. Diese Informationen müssen einen vorhandenen Account benennen. kivitendo prüft genau wie bei
+ Benutzung über den Webbrowser, ob dieser Account Zugriff auf den Mandanten sowie auf die angeforderte Funktion hat.
+ </para>
+
+ <para>
+ Da die Logininformationen im Klartext im Request stehen, sollte der Zugriff auf kivitendo ausschließlich über HTTPS verschlüsselt
+ erfolgen.
+ </para>
+
+ <note>
+ <para>
+ Die Verwendung dieser Methode ist veraltet. Statt dessen sollte die oben erwähnte HTTP-»Basic«-Authentifizierung verwendet werden.
+ </para>
+ </note>
+ </sect2>
+
+ <sect2 id="dev-programmatic-api-calls.examples">
+ <title>Beispiele</title>
+
+ <para>
+ Das folgende Beispiel nutzt das Kommandozeilenprogramm »curl« und ruft die Funktion auf, die eine vorhandene Telefonnummer in den
+ Ansprechpersonen sucht und dazu Informationen zurückliefert. Dabei wird die HTTP-»Basic«-Authentifizierung genutzt.
+ </para>
+
+ <programlisting>$ curl --silent --user 'jdoe:SecretPassword!' \
+ 'https://…/controller.pl?action=PhoneNumber/look_up&number=053147110815'</programlisting>
+ </sect2>
+ </sect1>
+
<sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
<title>SQL-Upgradedateien</title>
xreflabel="Einführung in die Datenbank-Upgradedateien">
<title>Einführung</title>
- <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>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 <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>
+ <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>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
+ <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"
<term><varname>charset</varname></term>
<listitem>
- <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 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>
+ <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 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>
</variablelist>
</sect2>
- <sect2 id="db-upgrade-files.format-perl-files" xreflabel="Format von Perl-Upgradedateien">
- <title>Format von in Perl geschriebenen Datenbankupgradescripten</title>
+ <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>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>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>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>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>
+ <para>Ein Mindestgerüst eines gültigen Perl-Upgradescriptes sieht wie
+ folgt aus:</para>
- <programlisting># @tag: beispiel-upgrade-file42
+
<programlisting># @tag: beispiel-upgrade-file42
# @description: Ein schönes Beispielscript
# @depends: release_3_1_0
package SL::DBUpgrade2::beispiel_upgrade_file42;
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>
-
- <para>A stub version of French is included but not functunal at this
- point.</para>
</sect2>
<sect2 id="translations-languages.character-set"
xreflabel="Character set">
<title>Character set</title>
- <para>All files included in a language pack must use UTF-8 as their encoding.</para>
+ <para>All files included in a language pack must use UTF-8 as their
+ encoding.</para>
</sect2>
<sect2 id="translations-languages.file-structure"
Template/OpenDocument
filenames</programlisting>
- <para>The last of which is very machine dependant. Remember that
+ <para>The last of which is very machine dependent. 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>
<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>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>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>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>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>
+ <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>
+ <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 Core:
- <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 Core:
- <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 Core:
- <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 Core: <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 Core:
- <literal>perl-URI-Find</literal>; openSUSE: <literal>perl-URI-Find</literal>)</para></listitem>
+ <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>
+ <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>
+
+ <para>Der so angegebene Benutzer muss nicht zwingend über
+ Super-User-Rechte verfügen. Allerdings gibt es einige
+ Datenbank-Upgrades, die genau diese Rechte benötigen. Für den Fall
+ kann man in diesem Konfigurationsabschnitt einen weiteren
+ Benutzeraccount angeben, der dann über Super-User-Rechte verfügt, und
+ mit dem die betroffenen Upgrades durchgeführt werden. In der
+ Beispiel-Konfigurationsdatei finden Sie die benötigten
+ Parameter.</para>
</sect2>
<sect2 id="devel.testsuite.execution">
- <title>
- Existierende Tests ausführen
- </title>
+ <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>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>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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <title>Ideen für neue Test-Scripte, die keine konkreten Funktionen
+ testen</title>
- <para> Ideen, die abgesehen von Funktionen noch nicht umgesetzt wurden:</para>
+ <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>
+ <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>
+ <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>
+ <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>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>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>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>
+ <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>
+ <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>
+ <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;
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
+ <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 <code>Support::TestSetup::login();</code>
- weggelassen werden, was die Ausführungszeit des Scripts leicht verringert.</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>
</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