<!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.2.0: Installation, Konfiguration, Entwicklung</title>
+ <title>kivitendo 3.3.0: Installation, Konfiguration, Entwicklung</title>
<chapter id="Aktuelle-Hinweise">
<title>Aktuelle Hinweise</title>
<itemizedlist>
<listitem>
- <para>im kivitendo-Forum: <ulink
- url="https://forum.kivitendo.org:32443">https://forum.kivitendo.org:32443</ulink></para>
+ <para>im Community-Forum: <ulink
+ url="https://forum.kivitendo.de:32443">https://forum.kivitendo.de:32443</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>
<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.2.0.tgz</filename>) wird im Dokumentenverzeichnis des Webservers
+ <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>
<programlisting>cd /var/www
-tar xvzf kivitendo-erp-3.2.0.tgz</programlisting>
+tar xvzf kivitendo-erp-3.3.0.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 Version 3.2.0 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>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>
+ 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>
führen Sie die folgenden Kommandos aus:</para>
- <programlisting>create language 'plpgsql';
+ <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';
\q</programlisting>
+ </note>
+
</sect2>
<sect2 id="Datenbankbenutzer-anlegen">
anderen Datei hinzu, die beim Starten des Webservers eingelesen
wird:</para>
- <programlisting>AddHandler cgi-script .pl
+ <programlisting>AliasMatch ^/kivitendo-erp/[^/]+\.pl /var/www/kivitendo-erp/dispatcher.pl
Alias /kivitendo-erp/ /var/www/kivitendo-erp/
<Directory /var/www/kivitendo-erp>
+ AddHandler cgi-script .pl
Options ExecCGI Includes FollowSymlinks
</Directory>
<note>
<para>Vor den einzelnen Optionen muss bei einigen Distributionen ein
Plus ‘<literal>+</literal>’ gesetzt werden.</para>
+ <para>Bei einigen Distribution (Ubuntu ab 14.04, Debian ab 8.2) muss noch explizit
+ das cgi-Modul mittels <programlisting>a2enmod cgi</programlisting> aktiviert
+ werden.</para>
</note>
<para>Auf einigen Webservern werden manchmal die Grafiken und
FastCGI-Version.</para>
</sect3>
</sect2>
+ <sect2>
+ <title>Weitergehende Konfiguration</title>
+ <para>Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung von kivitendo
+ nur über https-verschlüsselten Verbindungen, sowie weiteren Zusatzmassnahmen,
+ wie beispielsweise Basic Authenticate.
+ Die Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser Anleitung, hier ein
+ Hinweis auf einen entsprechenden <ulink
+ url="http://redmine.kivitendo-premium.de/boards/1/topics/142">Foreneintrag (Stand Sept. 2015)</ulink></para>
+ </sect2>
</sect1>
<sect1 id="config.task-server">
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>
+
<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>
Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
(siehe see <xref
linkend="Manuelle-Installation-des-Programmpaketes" />). Daher
- ist es sinnvoll, hier denselben Systembenutzer einzutragen,
+ 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>
<sect2 id="Administratorpasswort">
<title>Administratorpasswort</title>
- <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface
+ <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
<para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank
gespeichert werden, so muss der Parameter <varname>module</varname>
den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl
- der Administrator als auch die Benutzer selber ihre Psaswörter in
+ der Administrator als auch die Benutzer selber ihre Passwörter in
kivitendo ändern.</para>
<para>Soll hingegen ein externer LDAP- oder Active-Directory-Server
<para>kivitendo bringt drei alternative Vorlagensätze mit:</para>
<itemizedlist>
- <listitem><para>Standard</para></listitem>
- <listitem><para>f-tex</para></listitem>
<listitem><para>RB</para></listitem>
+ <listitem><para>f-tex</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>
+
<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>
<orderedlist>
<listitem><para><option>Vorlagen auswählen</option>: Wählen Sie hier den Vorlagensatz aus, der kopiert werden soll
- (<filename>Standard</filename>, <filename>f-tex</filename> oder <filename>RB</filename>.)</para></listitem>
+ (<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>
</sect2>
- <sect2 id="Vorlagen-Standard">
- <title>Standard</title>
- <para>Der Standard-Vorlagensatz von kivitendo. Wie unter <ulink url="https://www.kivitendo.de">https://www.kivitendo.de</ulink> zu
- sehen.</para>
+ <sect2 id="Vorlagen-RB">
+ <title>Der Druckvorlagensatz RB</title>
+
+ <para>Hierbei handelt es sich um einen vollständigen LaTeX Dokumentensatz mit alternativem Design. Die odt oder html-Varianten sind nicht gepflegt.</para>
+ <para>Die konzeptionelle Idee der Vorlagen wird <ulink
+ url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
+ auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die eigenen Firmendaten finden sich in der Datei Readme.tex im Vorlagenverzeichnis.</para>
+
+ <para>Eine kurze Übersicht der Features:</para>
+ <itemizedlist>
+ <listitem><para>Mehrsprachenfähig, mit Deutscher und Englischer Übersetzung</para></listitem>
+ <listitem><para>Zentrale Konfigurationsdateien, die für alle Belege benutzt werden, z.B. für Kopf- und Fußzeilen, und Infos wie Bankdaten</para></listitem>
+ <listitem><para>mehrere vordefinierte Varianten für Logos/Hintergrundbilder</para></listitem>
+ <listitem><para>Berücksichtigung für Steuerzonen "EU mit USt-ID Nummer" oder "Außerhalb EU"</para></listitem>
+ </itemizedlist>
</sect2>
</sect3>
</sect2>
- <sect2 id="Vorlagen-RB">
- <title>Der Druckvorlagensatz RB</title>
+ <sect2 id="Vorlagen-rev-odt">
+ <title>Der Druckvorlagensatz rev-odt</title>
- <para>Hierbei handelt es sich um einen vollständigen \LaTeX Dokumentensatz mit alternativem Design. Die odt oder html-Varianten sind nicht gepflegt.</para>
- <para>Die konzeptionelle Idee der Vorlagen wird <ulink
- url="http://www.kivitendo-support.de/vortraege/Lx-Office%20Anwendertreffen%20LaTeX-Druckvorlagen-Teil3-finale.pdf">hier</ulink>
- auf Folie 5 bis 10 vorgestellt. Informationen zur Anpassung an die eigenen Firmendaten finden sich in der Datei Readme.tex im Vorlagenverzeichnis.</para>
+ <para>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>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>
+<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>
<title>Features und Funktionen</title>
<sect1 id="features.periodic-invoices"
- xreflabel="Wiedekehrende Rechnungen">
+ xreflabel="Wiederkehrende Rechnungen">
<title>Wiederkehrende Rechnungen</title>
<sect2 id="features.periodic-invoices.introduction"
manuell über den Workflow.</para>
</sect2>
</sect1>
- <sect1 id="dokumentenvorlagen-und-variablen">
+ <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">
<term><varname>template_meta.language.template_code</varname></term>
<listitem>
- <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
+ <para>Vorlagenkürzel der verwendeten Sprache, identisch mit dem
Kürzel das im Dateinamen verwendetet wird.</para>
</listitem>
</varlistentry>
</varlistentry>
<varlistentry>
- <term><varname>shiptodepartment1</varname></term>
+ <term><varname>shiptodepartment_1</varname></term>
<listitem>
<para>Abteilung 1 (Lieferadresse) <link
</varlistentry>
<varlistentry>
- <term><varname>shiptodepartment2</varname></term>
+ <term><varname>shiptodepartment_2</varname></term>
<listitem>
<para>Abteilung 2 (Lieferadresse) <link
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><varname>cusordnumber_oe</varname></term>
+
+ <listitem>
+ <para>Bestellnummer des Kunden aus dem Auftrag, aus dem der Posten ursprünglich stammt (nur Verkauf)</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><varname>discount</varname></term>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><varname>donumber_do</varname></term>
+
+ <listitem>
+ <para>Lieferscheinnummer des Lieferscheins, aus dem die Position ursprünglich stammt, wenn die Rechnung im Rahmen des Workflows aus einem Lieferschein erstellt wurde.</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><varname>drawing</varname></term>
<term><varname>ordnumber_oe</varname></term>
<listitem>
- <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
- aus einem Sammelauftrag erstellt wurde</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><varname>donumber_do</varname></term>
-
- <listitem>
- <para>Lieferscheinnummer desjenigen Lieferscheins, aus dem die Position stammt, sofern die Rechnung aus einem oder
- mehreren Lieferscheinen erstellt wurde</para>
+ <para>Auftragsnummer des Originalauftrags, aus dem der Posten ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In letzterem Fall wird die unsprüngliche Auftragsnummer angezeigt.</para>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><varname>transdate_do</varname></term>
+
+ <listitem>
+ <para>Datum des Lieferscheins, wenn die Rechnung im Rahmen des Workflows aus einem Lieferschein stammte.</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><varname>transdate_oe</varname></term>
<listitem>
- <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
- aus einem Sammelauftrag erstellt wurde</para>
+ <para>Datum des Auftrags, wenn die Rechnung im Rahmen des Workflows aus einem Auftrag erstellt wurde. Wenn es Sammelaufträge gab wird das Datum des ursprünglichen Auftrags genommen.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>transdate_quo</varname></term>
+
+ <listitem>
+ <para>Datum des Angebots, wenn die Position im Rahmen des Workflows aus einem Angebot stammte.</para>
</listitem>
</varlistentry>
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"
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>
projects / kivitendo-erp.git / blobdiff